Skip to content
GitLab
Commit da441083 authored by Walter Featherstone's avatar Walter Featherstone
Browse files

Merge branch 'develop' into 'master' 

MEC028 v2.2.1 update - OAS & Proto3 representation updated

OAS & Proto3 representation have been updated to v2.2.1 specification.

Update followed [OpenAPI development guidelines](https://mecwiki.etsi.org/index.php?title=OpenAPI_development_guidelines)
- Generation using doc2oas *(a separate merge request has been created for the config file update)*
- Level-1 validation passing *(no warnings in Swagger-Editor, swagger-cli validate, speccy lint)*
- Level-2 validation passing *(no error in Swagger-UI, visual inspection)*
- Level-3 validation passing *(swagger code generation)*
- Proto3 generation passing
- Proto3 code generation passing
- Jenkins validation passing

See merge request !5
parents 4b527617 0f2db027
Pipeline #9934 passed with stage
in 0 seconds
Show whitespace changes
Inline Side-by-side
README.md
View file @ da441083
......@@ -4,9 +4,9 @@ This repository contains OpenAPIs descriptions for the interfaces specified in E
## Online resources
* [Specification document](https://www.etsi.org/deliver/etsi_gs/MEC/001_099/028/02.01.01_60/gs_MEC028v020101p.pdf)
* [Navigate the API in the browser](https://forge.etsi.org/swagger/ui/?url=https://forge.etsi.org/rep/mec/gs028-wai-api/raw/v2.1.1/WlanInformationApi.yaml).
* [Edit the API online](https://forge.etsi.org/swagger/editor/?url=https://forge.etsi.org/rep/mec/gs028-wai-api/raw/v2.1.1/WlanInformationApi.yaml).
* [Specification document](https://www.etsi.org/deliver/etsi_gs/MEC/001_099/028/02.02.01_60/gs_MEC028v020201p.pdf)
* [Navigate the API in the browser](https://forge.etsi.org/swagger/ui/?url=https://forge.etsi.org/rep/mec/gs028-wai-api/raw/v2.2.1/WlanInformationApi.yaml).
* [Edit the API online](https://forge.etsi.org/swagger/editor/?url=https://forge.etsi.org/rep/mec/gs028-wai-api/raw/v2.2.1/WlanInformationApi.yaml).
## License
......
WlanInformationApi.json
View file @ da441083
......@@ -5,7 +5,7 @@
"url": "https://forge.etsi.org/rep/mec/gs028-wai-api"
},
"title": "ETSI GS MEC 028 - WLAN Access Information API",
"version": "2.1.1",
"version": "2.2.1",
"description": "The ETSI MEC ISG MEC028 WLAN Access Information API described using OpenAPI",
"license": {
"name": "BSD-3-Clause",
......@@ -13,8 +13,8 @@
}
},
"externalDocs": {
"description": "ETSI MEC028 V2.1.1 WLAN Information API",
"url": "http://www.etsi.org/deliver/etsi_gs/MEC/001_099/028/02.01.01_60/gs_mec028v020101p.pdf"
"description": "ETSI MEC028 V2.2.1 WLAN Information API",
"url": "https://www.etsi.org/deliver/etsi_gs/MEC/001_099/028/02.02.01_60/gs_mec028v020201p.pdf"
},
"servers": [
{
......@@ -232,9 +232,13 @@
"nanoSeconds": 0
},
"apId": {
"macId": "005C0A0A0A0A",
"ssid": "myNetworkSsid",
"ipAddress": "10.10.100.1"
"bssid": "005C0A0A0A0A",
"ssid": [
"myNetworkSsid"
],
"ipAddress": [
"10.10.100.1"
]
}
}
}
......@@ -261,9 +265,13 @@
"nanoSeconds": 0
},
"apId": {
"macId": "005C0A0A0A0A",
"ssid": "myNetworkSsid",
"ipAddress": "10.10.100.1"
"bssid": "005C0A0A0A0A",
"ssid": [
"myNetworkSsid"
],
"ipAddress": [
"10.10.100.1"
]
}
}
}
......@@ -316,9 +324,13 @@
"nanoseconds": 0
},
"apId": {
"macId": "005C0A0A0A0A",
"ssid": "myNetworkSsid",
"ipAddress": "10.10.100.1"
"bssid": "005C0A0A0A0A",
"ssid": [
"myNetworkSsid"
],
"ipAddress": [
"10.10.100.1"
]
},
"staId": {
"macId": "005C01111111",
......@@ -327,7 +339,9 @@
"myOtherNetworkSsid"
],
"aid": "1122",
"ipAddress": "10.10.1.255"
"ipAddress": [
"10.10.1.255"
]
}
}
}
......@@ -378,9 +392,13 @@
"nanoSeconds": 0
},
"apId": {
"macId": "005C0A0A0A0A",
"ssid": "myNetworkSsid",
"ipAddress": "10.10.100.1"
"bssid": "005C0A0A0A0A",
"ssid": [
"myNetworkSsid"
],
"ipAddress": [
"10.10.100.1"
]
}
}
}
......@@ -434,9 +452,13 @@
"nanoSeconds": 0
},
"apId": {
"macId": "005C0A0A0A0A",
"ssid": "myNetworkSsid",
"ipAddress": "10.10.100.1"
"bssid": "005C0A0A0A0A",
"ssid": [
"myNetworkSsid"
],
"ipAddress": [
"10.10.100.1"
]
}
}
}
......@@ -463,7 +485,13 @@
},
"callbackReference": "http://my.callback.com/wai/some-id",
"apId": {
"macId": "005C0A0A0A0A"
"bssid": "005C0A0A0A0A",
"ssid": [
"myNetworkSsid"
],
"ipAddress": [
"10.10.100.1"
]
}
}
}
......@@ -525,165 +553,493 @@
}
}
}
}
},
"components": {
"/measurements": {
"get": {
"tags": [
"wai"
],
"summary": "Retrieve information on measurements configuration",
"description": "Queries information on measurements configuration",
"operationId": "measurementLinkList_measurementsGET",
"responses": {
"200": {
"description": "OK"
},
"204": {
"description": "No Content"
},
"400": {
"description": "Bad Request : used to indicate that incorrect parameters were passed to the request.",
"description": "Response body contains the list of links to requestors measurement configurations.",
"content": {
"application/problem+json": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
"$ref": "#/components/schemas/MeasurementConfigLinkList"
},
"example": {
"_links": {
"self": {
"href": "http://meAppServer.example.com/wai/v2/measurements"
}
},
"401": {
"description": "Unauthorized : used when the client did not submit credentials.",
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
"measurementConfig": [
{
"href": "http://meAppServer.example.com/wai/v2/measurements/meas123",
"measurementId": "myId1"
}
]
}
}
}
},
"400": {
"$ref": "#/components/responses/400"
},
"401": {
"$ref": "#/components/responses/401"
},
"403": {
"description": "Forbidden : operation is not allowed given the current status of the resource.",
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
"$ref": "#/components/responses/403"
},
"404": {
"description": "Not Found : used when a client provided a URI that cannot be mapped to a valid resource URI.",
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
"$ref": "#/components/responses/404"
},
"406": {
"$ref": "#/components/responses/406"
},
"429": {
"$ref": "#/components/responses/429"
}
}
},
"406": {
"description": "Not Acceptable : used to indicate that the server cannot provide the any of the content formats supported by the client.",
"post": {
"tags": [
"wai"
],
"summary": "Create a new measurement configuration",
"description": "Creates a new measurement configuration",
"operationId": "measurementsPOST",
"requestBody": {
"description": "Measurement configuration information",
"required": true,
"content": {
"application/problem+json": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
"$ref": "#/components/schemas/MeasurementConfig"
},
"example": {
"staId": {
"macId": "005C01111111",
"ssid": [
"myNetworkSsid",
"myOtherNetworkSsid"
]
},
"measurementId": "myId1",
"measurementInfo": {}
}
}
}
},
"412": {
"description": "Precondition failed : used when a condition has failed during conditional requests, e.g. when using ETags to avoid write conflicts when using PUT",
"responses": {
"201": {
"description": "Successful measurement configuration response",
"content": {
"application/problem+json": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
"$ref": "#/components/schemas/MeasurementConfig"
},
"example": {
"_links": {
"self": {
"href": "http://meAppServer.example.com/wai/v2/measurements/meas123"
}
},
"staId": {
"macId": "005C01111111",
"ssid": [
"myNetworkSsid",
"myOtherNetworkSsid"
]
},
"measurementId": "myId1",
"measurementInfo": {}
}
}
}
},
"400": {
"$ref": "#/components/responses/400"
},
"401": {
"$ref": "#/components/responses/401"
},
"403": {
"$ref": "#/components/responses/403"
},
"404": {
"$ref": "#/components/responses/404"
},
"406": {
"$ref": "#/components/responses/406"
},
"415": {
"description": "Unsupported Media Type : used to indicate that the server or the client does not support the content type of the entity body.",
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
"$ref": "#/components/responses/415"
},
"422": {
"$ref": "#/components/responses/422"
},
"429": {
"$ref": "#/components/responses/429"
}
}
}
},
"422": {
"description": "Unprocessable Entity : used to indicate that the server understands the content type of the request entity and that the syntax of the request entity is correct but that the server is unable to process the contained instructions. This error condition can occur if an JSON request body is syntactically correct but semantically incorrect, for example if the target area for the request is considered too large. This error condition can also occur if the capabilities required by the request are not supported.",
"/measurements/{measurementConfigId}": {
"get": {
"tags": [
"wai"
],
"summary": "Retrieve information on an existing measurement configuration",
"description": "Queries information about an existing measurement configuration, identified by its self-referring URI returned on creation (initial POST)",
"operationId": "measurementsGET",
"parameters": [
{
"$ref": "#/components/parameters/Path.measurementConfigId"
}
],
"responses": {
"200": {
"description": "Measurement configuration information",
"content": {
"application/problem+json": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
"$ref": "#/components/schemas/MeasurementConfig"
},
"example": {
"application/problem+json": {
"type": "https://meAppServer.example.com/wai/v2/probs/too-many targets",
"title": "Too many targets",
"status": "422",
"detail": "The target area for the request is considered too large",
"instance": "/meAppClient.example.com/77777/msgs/abc"
"_links": {
"self": {
"href": "http://meAppServer.example.com/wai/v2/measurements/meas123"
}
},
"staId": {
"macId": "005C01111111",
"ssid": [
"myNetworkSsid",
"myOtherNetworkSsid"
]
},
"measurementId": "myId1",
"measurementInfo": {}
}
}
}
},
"400": {
"$ref": "#/components/responses/400"
},
"401": {
"$ref": "#/components/responses/401"
},
"403": {
"$ref": "#/components/responses/403"
},
"404": {
"$ref": "#/components/responses/404"
},
"406": {
"$ref": "#/components/responses/406"
},
"429": {
"description": "Too Many Requests : used when a rate limiter has triggered.",
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
"$ref": "#/components/responses/429"
}
}
},
"parameters": {
"Path.subscrId": {
"name": "subscriptionId",
"in": "path",
"description": "Subscription Id, specifically the \"self\" returned in the subscription request",
"put": {
"tags": [
"wai"
],
"summary": "Modify an existing measurement configuration",
"description": "Updates an existing measurement configuration, identified by its self-referring URI returned on creation (initial POST)",
"operationId": "measurementsPUT",
"requestBody": {
"description": "Measurement configuration to be modified",
"required": true,
"content": {
"application/json": {
"schema": {
"type": "string",
"format": "uri"
}
"$ref": "#/components/schemas/MeasurementConfig"
},
"Query.Filter": {
"name": "filter",
"in": "query",
"description": "Attribute-based filtering expression according to clause 6.19 of ETSI GS MEC 009. .",
"required": false,
"schema": {
"type": "string"
"example": {
"_links": {
"self": {
"href": "http://meAppServer.example.com/wai/v2/measurements/meas123"
}
},
"Query.AllFields": {
"name": "all_fields",
"in": "query",
"description": "Include all complex attributes in the response. See clause 6.18 of ETSI GS MEC 009 for details.",
"required": false,
"schema": {
"type": "string"
}
"staId": {
"macId": "005C01111111",
"ssid": [
"myNetworkSsid",
"myOtherNetworkSsid"
]
},
"Query.Fields": {
"name": "fields",
"in": "query",
"description": "Complex attributes to be included into the response. See clause 6.18 of ETSI GS MEC 009 for details.",
"required": false,
"schema": {
"type": "array",
"items": {
"type": "string"
"measurementId": "myId1",
"measurementInfo": {}
}
}
}
},
"Query.ExcludeFields": {
"name": "exclude_fields",
"in": "query",
"description": "Complex attributes to be excluded from the response. See clause 6.18 of ETSI GS MEC 009 for details.",
"required": false,
"schema": {
"type": "array",
"items": {
"parameters": [
{
"$ref": "#/components/parameters/Path.measurementConfigId"
}
],
"responses": {
"200": {
"description": "Successful measurement configuration modification",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/MeasurementConfig"
},
"example": {
"_links": {
"self": {
"href": "http://meAppServer.example.com/wai/v2/measurements/123"
}
},
"staId": {
"macId": "005C01111111",
"ssid": [
"myNetworkSsid",
"myOtherNetworkSsid"
]
},
"measurementId": "myId1",
"measurementInfo": {}
}
}
}
},
"400": {
"$ref": "#/components/responses/400"
},
"401": {
"$ref": "#/components/responses/401"
},
"403": {
"$ref": "#/components/responses/403"
},
"404": {
"$ref": "#/components/responses/404"
},
"406": {
"$ref": "#/components/responses/406"
},
"412": {
"$ref": "#/components/responses/412"
},
"422": {
"$ref": "#/components/responses/422"
},
"429": {
"$ref": "#/components/responses/429"
}
}
},
"delete": {
"tags": [
"wai"
],
"summary": "Cancel a measurement configuration",
"description": "Cancels an existing measurement configuration, identified by its self-referring URI returned on creation (initial POST)",
"operationId": "measurementsDELETE",
"parameters": [
{
"$ref": "#/components/parameters/Path.measurementConfigId"
}
],
"responses": {
"204": {
"$ref": "#/components/responses/204"
},
"401": {
"$ref": "#/components/responses/401"
},
"403": {
"$ref": "#/components/responses/403"
},
"404": {
"$ref": "#/components/responses/404"
},
"429": {
"$ref": "#/components/responses/429"
}
}
}
}
},
"components": {
"responses": {
"200": {
"description": "OK"
},
"204": {
"description": "No Content"
},
"400": {
"description": "Bad Request : used to indicate that incorrect parameters were passed to the request.",
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"401": {
"description": "Unauthorized : used when the client did not submit credentials.",
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"403": {
"description": "Forbidden : operation is not allowed given the current status of the resource.",
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"404": {
"description": "Not Found : used when a client provided a URI that cannot be mapped to a valid resource URI.",
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}