From 8bfc99f028d15f38d4dd818046ac8649a3e5bdd8 Mon Sep 17 00:00:00 2001 From: Michel Roy Date: Sat, 24 Oct 2020 10:53:15 -0400 Subject: [PATCH 1/8] added v2.1.1 draft versions --- README.md | 11 +- WlanInformationApi.json | 3308 +++++++++++++++++++++++++++++++++++++++ WlanInformationApi.yaml | 2342 +++++++++++++++++++++++++++ 3 files changed, 5656 insertions(+), 5 deletions(-) create mode 100644 WlanInformationApi.json create mode 100644 WlanInformationApi.yaml diff --git a/README.md b/README.md index d6098fb..beef4df 100644 --- a/README.md +++ b/README.md @@ -1,13 +1,14 @@ # Multi-access Edge Computing WLAN Information API -This repository contains OpenAPIs descriptions for the interfaces specified in ETSI MEC GS 028 "MEC WLAN Information API". +This repository contains OpenAPIs descriptions for the interfaces specified in ETSI MEC GS 028 -More information and download options for the specification are available -[here](https://portal.etsi.org/webapp/WorkProgram/Report_WorkItem.asp?WKI_ID=53995). +## Online resources -**{-NOTE: The OpenAPI definitions are under development. The API as defined in GS MEC 028 takes precedence.-}** + +* [Navigate the API in the browser](https://forge.etsi.org/swagger/ui/?url=https://forge.etsi.org/gitlab/mec/gs028-wai-api/raw/stf593/WlanInformationApi.yaml). +* [Edit the API online](https://forge.etsi.org/swagger/editor/?url=https://forge.etsi.org/gitlab/mec/gs028-wai-api/raw/stf593/WlanInformationApi.yaml). ## License Unless specified otherwise, the content of this repository and the files contained are released under the BSD-3-Clause license. -See the attached LICENSE file or visit https://forge.etsi.org/legal-matters. \ No newline at end of file +See the attached LICENSE file or visit https://forge.etsi.org/legal-matters. diff --git a/WlanInformationApi.json b/WlanInformationApi.json new file mode 100644 index 0000000..c850514 --- /dev/null +++ b/WlanInformationApi.json @@ -0,0 +1,3308 @@ +{ + "openapi": "3.0.0", + "info": { + "title": "ETSI GS MEC 028 - WLAN Access Information API", + "version": "2.1.1", + "description": "The ETSI MEC ISG MEC028 WLAN Access Information API described using OpenAPI", + "license": { + "name": "BSD-3-Clause", + "url": "https://forge.etsi.org/legal-matters" + } + }, + "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" + }, + "servers": [ + { + "url": "https://{apiRoot}/wai/v2" + } + ], + "paths": { + "/queries/ap/ap_information": { + "get": { + "tags": [ + "" + ], + "summary": "Retrieve information on existing Access Points", + "description": "Queries information about existing WLAN Access Points", + "operationId": "apInfoGET", + "parameters": [ + { + "$ref": "#/components/parameters/Query.Filter" + }, + { + "$ref": "#/components/parameters/Query.AllFields" + }, + { + "$ref": "#/components/parameters/Query.Fields" + }, + { + "$ref": "#/components/parameters/Query.ExcludeFields" + }, + { + "$ref": "#/components/parameters/Query.ExcludeDefault" + } + ], + "responses": { + "200": { + "description": "Successful response to ap_info request", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "apInfo": { + "type": "array", + "items": { + "$ref": "#/components/schemas/ApInfo" + } + } + } + } + } + } + }, + "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": { + "$ref": "#/components/responses/429" + } + } + } + }, + "/queries/sta/sta_information": { + "get": { + "tags": [ + "" + ], + "summary": "Retrieve information on existing Stations", + "description": "Queries information about existing WLAN stations", + "operationId": "staInfoGET", + "parameters": [ + { + "$ref": "#/components/parameters/Query.Filter" + }, + { + "$ref": "#/components/parameters/Query.AllFields" + }, + { + "$ref": "#/components/parameters/Query.Fields" + }, + { + "$ref": "#/components/parameters/Query.ExcludeFields" + }, + { + "$ref": "#/components/parameters/Query.ExcludeDefault" + } + ], + "responses": { + "200": { + "description": "Successful response to sta_info request", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "staInfo": { + "type": "array", + "items": { + "$ref": "#/components/schemas/StaInfo" + } + } + } + } + } + } + }, + "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": { + "$ref": "#/components/responses/429" + } + } + } + }, + "/subscriptions/": { + "get": { + "tags": [ + "" + ], + "summary": "Retrieve information on subscriptions for notifications", + "description": "Queries information on subscriptions for notifications", + "operationId": "subscriptionLinkList_subscriptionsGET", + "parameters": [ + { + "$ref": "#/components/parameters/Query.SubscriptionType" + } + ], + "responses": { + "200": { + "description": "Response body contains the list of links to requestors subscriptions.", + "content": { + "application/json": { + "schema": { + "type": "object", + "required": [ + "subscriptionLinkList" + ], + "properties": { + "subscriptionLinkList": { + "$ref": "#/components/schemas/SubscriptionLinkList" + } + } + }, + "example": { + "subscriptionLinkList": { + "_links": { + "self": { + "href": "http://meAppServer.example.com/wai/v2/subscriptions" + } + }, + "subscription": [ + { + "_links": { + "self": { + "href": "http://meAppServer.example.com/wai/v2/subscriptions/sub123" + } + }, + "callbackReference": "http://my.callback.com/wai/assocStaSubscription/some-id", + "subscriptionType": "AssocStaSubscription" + } + ] + } + } + } + } + }, + "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": { + "$ref": "#/components/responses/429" + } + } + }, + "post": { + "tags": [ + "" + ], + "summary": "Create a new subscription", + "description": "Creates a new subscription to WLAN Access Information notifications", + "operationId": "subscriptionsPOST", + "requestBody": { + "description": "Subscription to be created", + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "notificationSubscription": { + "oneOf": [ + { + "$ref": "#/components/schemas/AssocStaSubscription" + }, + { + "$ref": "#/components/schemas/StaDataRateSubscription" + } + ], + "discriminator": { + "propertyName": "subscriptionType" + } + } + }, + "example": { + "notificationSubscription": { + "subscriptionType": "AssocStaSubscription", + "callbackReference": "http://meAppClient.example.com/wai/v2/notifications/1", + "expiryDeadline": { + "seconds": 1977836800, + "nanoSeconds": 0 + }, + "apId": { + "macId": "005C0A0A0A0A", + "ssid": "myNetworkSsid", + "ipAddress": "10.10.100.1" + } + } + } + } + } + } + }, + "responses": { + "201": { + "description": "Successful subscription response", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "notificationSubscription": { + "oneOf": [ + { + "$ref": "#/components/schemas/AssocStaSubscription" + }, + { + "$ref": "#/components/schemas/StaDataRateSubscription" + } + ], + "discriminator": { + "propertyName": "subscriptionType" + } + } + } + }, + "example": { + "notificationSubscription": { + "subscriptionType": "AssocStaSubscription", + "callbackReference": "http://meAppClient.example.com/wai/v2/notifications/1", + "_links": { + "self": { + "href": "http://meAppServer.example.com/wai/v2/subscriptions/sub123" + } + }, + "expiryDeadline": { + "seconds": 1977836800, + "nanoSeconds": 0 + }, + "apId": { + "macId": "005C0A0A0A0A", + "ssid": "myNetworkSsid", + "ipAddress": "10.10.100.1" + } + } + } + } + } + }, + "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": { + "$ref": "#/components/responses/415" + }, + "422": { + "$ref": "#/components/responses/422" + }, + "429": { + "$ref": "#/components/responses/429" + } + }, + "callbacks": { + "notification": { + "{$request.body#/callbackReference}": { + "post": { + "summary": "Callback POST used to send a notification", + "description": "Notification from WAIS, content based on subscription type", + "operationId": "notificationPOST", + "requestBody": { + "description": "Subscription notification", + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "notification": { + "oneOf": [ + { + "$ref": "#/components/schemas/AssocStaNotification" + }, + { + "$ref": "#/components/schemas/StaDataRateNotification" + } + ], + "discriminator": { + "propertyName": "notificationType" + } + } + }, + "example": { + "notification": { + "notificationType": "AssocStaNotification", + "timeStamp": { + "seconds": 1977836800, + "nanoseconds": 0 + }, + "apId": { + "macId": "005C0A0A0A0A", + "ssid": "myNetworkSsid", + "ipAddress": "10.10.100.1" + }, + "staId": { + "macId": "005C01111111", + "ssid": [ + "myNetworkSsid", + "myOtherNetworkSsid" + ], + "aid": "1122", + "ipAddress": "10.10.1.255" + } + } + } + } + } + } + }, + "responses": { + "204": { + "$ref": "#/components/responses/204" + } + } + } + } + } + } + } + }, + "/subscriptions/{subscriptionId}": { + "get": { + "tags": [ + "" + ], + "summary": "Retrieve information on current specific subscription", + "description": "Queries information about an existing subscription, identified by its self-referring URI returned on creation (initial POST)", + "operationId": "subscriptionsGET", + "parameters": [ + { + "$ref": "#/components/parameters/Path.subscrId" + } + ], + "responses": { + "200": { + "description": "Subscription information regarding subscription notifications", + "content": { + "application/json": { + "schema": { + "type": "object", + "required": [ + "notificationSubscription" + ], + "properties": { + "notificationSubscription": { + "oneOf": [ + { + "$ref": "#/components/schemas/AssocStaSubscription" + }, + { + "$ref": "#/components/schemas/StaDataRateSubscription" + } + ], + "discriminator": { + "propertyName": "subscriptionType" + } + } + } + }, + "example": { + "notificationSubscription": { + "subscriptionType": "AssocStaSubscription", + "callbackReference": "http://meAppClient.example.com/wai/v2/notifications/1", + "_links": { + "self": { + "href": "http://meAppServer.example.com/wai/v2/subscriptions/sub123" + } + }, + "expiryDeadline": { + "seconds": 1977836800, + "nanoSeconds": 0 + }, + "apId": { + "macId": "005C0A0A0A0A", + "ssid": "myNetworkSsid", + "ipAddress": "10.10.100.1" + } + } + } + } + } + }, + "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": { + "$ref": "#/components/responses/429" + } + } + }, + "put": { + "tags": [ + "" + ], + "summary": "Modify an existing subscription", + "description": "Updates an existing subscription, identified by its self-referring URI returned on creation (initial POST)", + "operationId": "subscriptionsPUT", + "requestBody": { + "description": "Subscription to be modified", + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "notificationSubscription": { + "oneOf": [ + { + "$ref": "#/components/schemas/AssocStaSubscription" + }, + { + "$ref": "#/components/schemas/StaDataRateSubscription" + } + ], + "discriminator": { + "propertyName": "subscriptionType" + } + } + }, + "example": { + "notificationSubscription": { + "subscriptionType": "AssocStaSubscription", + "callbackReference": "http://meAppClient.example.com/wai/v2/notifications/1", + "_links": { + "self": { + "href": "http://meAppServer.example.com/wai/v2/subscriptions/sub123" + } + }, + "expiryDeadline": { + "seconds": 1977836800, + "nanoSeconds": 0 + }, + "apId": { + "macId": "005C0A0A0A0A", + "ssid": "myNetworkSsid", + "ipAddress": "10.10.100.1" + } + } + } + } + } + } + }, + "parameters": [ + { + "$ref": "#/components/parameters/Path.subscrId" + } + ], + "responses": { + "200": { + "description": "Successful subscription modification", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "subscription": { + "oneOf": [ + { + "$ref": "#/components/schemas/AssocStaSubscription" + }, + { + "$ref": "#/components/schemas/StaDataRateSubscription" + } + ], + "discriminator": { + "propertyName": "subscriptionType" + } + } + } + }, + "example": { + "subscription": { + "_links": { + "self": { + "href": "http://[hostIP]/sbox-xyz123/wai/v2/subscriptions/sub123" + } + }, + "callbackReference": "http://my.callback.com/wai/some-id", + "apId": { + "macId": "005C0A0A0A0A" + } + } + } + } + } + }, + "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": [ + "" + ], + "summary": "Cancel an existing subscription", + "description": "Cancels an existing subscription, identified by its self-referring URI returned on creation (initial POST)", + "operationId": "subscriptionsDELETE", + "parameters": [ + { + "$ref": "#/components/parameters/Path.subscrId" + } + ], + "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/json": { + "schema": { + "type": "object", + "properties": { + "problemDetails": { + "$ref": "#/components/schemas/ProblemDetails" + } + } + } + } + } + }, + "401": { + "description": "Unauthorized : used when the client did not submit credentials.", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "problemDetails": { + "$ref": "#/components/schemas/ProblemDetails" + } + } + } + } + } + }, + "403": { + "description": "Forbidden : operation is not allowed given the current status of the resource.", + "content": { + "application/json": { + "schema": { + "type": "object", + "required": [ + "problemDetails" + ], + "properties": { + "problemDetails": { + "$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/json": { + "schema": { + "type": "object", + "properties": { + "problemDetails": { + "$ref": "#/components/schemas/ProblemDetails" + } + } + } + } + } + }, + "406": { + "description": "Not Acceptable : used to indicate that the server cannot provide the any of the content formats supported by the client.", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "problemDetails": { + "$ref": "#/components/schemas/ProblemDetails" + } + } + } + } + } + }, + "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", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "problemDetails": { + "$ref": "#/components/schemas/ProblemDetails" + } + } + } + } + } + }, + "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/json": { + "schema": { + "type": "object", + "properties": { + "problemDetails": { + "$ref": "#/components/schemas/ProblemDetails" + } + } + } + } + } + }, + "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.", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "problemDetails": { + "$ref": "#/components/schemas/ProblemDetails" + } + } + }, + "example": { + "application/problem+json": { + "ProblemDetails": { + "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" + } + } + } + } + } + }, + "429": { + "description": "Too Many Requests : used when a rate limiter has triggered.", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "problemDetails": { + "$ref": "#/components/schemas/ProblemDetails" + } + } + } + } + } + } + }, + "parameters": { + "Path.subscrId": { + "name": "subscriptionId", + "in": "path", + "description": "Subscription Id, specifically the \"self\" returned in the subscription request", + "required": true, + "schema": { + "type": "string", + "format": "uri" + } + }, + "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" + } + }, + "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" + } + }, + "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" + } + } + }, + "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": { + "type": "string" + } + } + }, + "Query.ExcludeDefault": { + "name": "exclude_default", + "in": "query", + "description": "Indicates to exclude the following complex attributes from the response. See clause 6.18 of ETSI GS MEC 009 for details. The following attributes shall be excluded from the structure in the response body if this parameter is provided, or none of the parameters \"all_fields\", \"fields\", \"exclude_fields\", \"exclude_default\" are provided: Not applicable", + "required": false, + "schema": { + "type": "array", + "items": { + "type": "string" + } + } + }, + "Query.SubscriptionType": { + "name": "subscription_type", + "in": "query", + "description": "Filter on a specific subscription type. Permitted values: assoc_sta, sta_data_rate.", + "required": false, + "schema": { + "type": "string" + } + } + }, + "schemas": { + "ApAssociated": { + "properties": { + "assocId": { + "description": "Unique number which identifies a particular association between the station and Access Point.", + "type": "string", + "x-etsi-mec-cardinality": "0..1", + "x-etsi-mec-origin-type": "string" + }, + "ipAddress": { + "description": "IPv4 or IPv6 address allocated for the Access Point.", + "items": { + "type": "string" + }, + "minItems": 0, + "type": "array", + "x-etsi-mec-cardinality": "0..N", + "x-etsi-mec-origin-type": "string" + }, + "macId": { + "description": "Unique identifier assigned to the Access Point (as network interface controller) for communications at the data link layer of a network segment.", + "type": "string", + "x-etsi-mec-cardinality": "1", + "x-etsi-mec-origin-type": "string" + }, + "ssid": { + "description": "Service Set Identifier to identify logical networks.", + "items": { + "type": "string" + }, + "minItems": 0, + "type": "array", + "x-etsi-mec-cardinality": "0..N", + "x-etsi-mec-origin-type": "String" + } + }, + "required": [ + "macId" + ], + "type": "object", + "x-etsi-ref": "6.5.12" + }, + "ApIdentity": { + "properties": { + "ipAddress": { + "description": "IPv4 or IPv6 address allocated for the Access Point.", + "items": { + "type": "string" + }, + "minItems": 0, + "type": "array", + "x-etsi-mec-cardinality": "0..N", + "x-etsi-mec-origin-type": "String" + }, + "macId": { + "description": "Unique Identifier assigned to an Access Point (as network interface controller) for communications at the data link layer of a network segment.", + "type": "string", + "x-etsi-mec-cardinality": "1", + "x-etsi-mec-origin-type": "String" + }, + "ssid": { + "description": "Service Set Identifier to identify logical networks including Basic Service Set and Extended Service Set.", + "items": { + "type": "string" + }, + "minItems": 0, + "type": "array", + "x-etsi-mec-cardinality": "0..N", + "x-etsi-mec-origin-type": "String" + } + }, + "required": [ + "macId" + ], + "type": "object", + "x-etsi-ref": "6.5.3" + }, + "ApInfo": { + "properties": { + "apId": { + "allOf": [ + { + "$ref": "#/components/schemas/ApIdentity" + }, + { + "description": "Identifier(s) to uniquely specify the Access Point whose information is exposed within this data type." + }, + { + "x-etsi-mec-cardinality": "1" + }, + { + "x-etsi-mec-origin-type": "ApIdentity" + } + ] + }, + "apLocation": { + "allOf": [ + { + "$ref": "#/components/schemas/ApLocation" + }, + { + "description": "The location on the Access Point." + }, + { + "x-etsi-mec-cardinality": "0..1" + }, + { + "x-etsi-mec-origin-type": "ApLocation" + } + ] + }, + "apNeighbor": { + "allOf": [ + { + "$ref": "#/components/schemas/NeighborReport" + }, + { + "description": "Information about neighbor Access Points." + }, + { + "x-etsi-mec-cardinality": "0..1" + }, + { + "x-etsi-mec-origin-type": "NeighborReport" + } + ] + }, + "bssLoad": { + "allOf": [ + { + "$ref": "#/components/schemas/BssLoad" + }, + { + "description": "BSS Load attribute contains information on the current STA population and traffic levels in the BSS as defined in IEEE 802.11-2016 [8]." + }, + { + "x-etsi-mec-cardinality": "0..1" + }, + { + "x-etsi-mec-origin-type": "BssLoad" + } + ] + }, + "channel": { + "type": "integer", + "format": "uint32", + "description": "Channel configured for the Access Point.", + "x-etsi-mec-cardinality": "0..1", + "x-etsi-mec-origin-type": "Uint32" + }, + "extBssLoad": { + "allOf": [ + { + "$ref": "#/components/schemas/ExtBssLoad" + }, + { + "description": "Extended BSS Load attribute contains more detailed information on the current STA population and traffic levels in the BSS as per ETSI GS MEC 002 [i.4]." + }, + { + "x-etsi-mec-cardinality": "0..1" + }, + { + "x-etsi-mec-origin-type": "ExtBssLoad" + } + ] + }, + "timeStamp": { + "allOf": [ + { + "$ref": "#/components/schemas/TimeStamp" + }, + { + "description": "Time stamp." + }, + { + "x-etsi-mec-cardinality": "0..1" + }, + { + "x-etsi-mec-origin-type": "TimeStamp" + } + ] + }, + "wanMetrics": { + "allOf": [ + { + "$ref": "#/components/schemas/WanMetrics" + }, + { + "description": "WAN Metrics element provides information about the WAN link connecting an IEEE 802.11 Access Node and the Internet. Transmission characteristics such as the speed of the WAN connection to the Internet are included in Hotspot 2.0 Technical Specification v1.0.0 [i.3]." + }, + { + "x-etsi-mec-cardinality": "0..1" + }, + { + "x-etsi-mec-origin-type": "WanMetrics" + } + ] + }, + "wlanCap": { + "allOf": [ + { + "$ref": "#/components/schemas/WlanCapabilities" + }, + { + "description": "WLAN capabilities of Access Point." + }, + { + "x-etsi-mec-cardinality": "0..1" + }, + { + "x-etsi-mec-origin-type": "WlanCapabilities" + } + ] + } + }, + "required": [ + "apId" + ], + "type": "object", + "x-etsi-ref": "6.2.2" + }, + "ApLocation": { + "properties": { + "civicLocation": { + "allOf": [ + { + "$ref": "#/components/schemas/CivicLocation" + }, + { + "description": "Civic Location of the AP as described in IETF RFC 4776 [7]." + }, + { + "x-etsi-mec-cardinality": "0..1" + }, + { + "x-etsi-mec-origin-type": "CivicLocation" + } + ] + }, + "geolocation": { + "allOf": [ + { + "$ref": "#/components/schemas/GeoLocation" + }, + { + "description": "Geospatial Location of the AP as defined in IEEE 802.11-2016 [8]." + }, + { + "x-etsi-mec-cardinality": "0..1" + }, + { + "x-etsi-mec-origin-type": "GeoLocation" + } + ] + } + }, + "type": "object", + "x-etsi-ref": "6.5.9" + }, + "AssocStaNotification": { + "properties": { + "apId": { + "allOf": [ + { + "$ref": "#/components/schemas/ApIdentity" + }, + { + "description": "Identifier(s) to uniquely specify the Access Point to which the client stations are associated." + }, + { + "x-etsi-mec-cardinality": "1" + }, + { + "x-etsi-mec-origin-type": "ApIdentity" + } + ] + }, + "notificationType": { + "description": "Shall be set to \"AssocStaNotification\".", + "type": "string", + "x-etsi-mec-cardinality": "1", + "x-etsi-mec-origin-type": "String" + }, + "staId": { + "description": "Identifier(s) to uniquely specify the client station(s) associated.", + "items": { + "$ref": "#/components/schemas/StaIdentity" + }, + "minItems": 0, + "type": "array", + "x-etsi-mec-cardinality": "0..N", + "x-etsi-mec-origin-type": "StaIdentity" + }, + "timeStamp": { + "allOf": [ + { + "$ref": "#/components/schemas/TimeStamp" + }, + { + "description": "Time stamp." + }, + { + "x-etsi-mec-cardinality": "0..1" + }, + { + "x-etsi-mec-origin-type": "TimeStamp" + } + ] + } + }, + "required": [ + "notificationType", + "apId" + ], + "type": "object", + "x-etsi-ref": "6.4.2" + }, + "AssocStaSubscription": { + "properties": { + "_links": { + "description": "Hyperlink related to the resource. This shall be only included in the HTTP responses and in HTTP PUT requests.", + "properties": { + "self": { + "allOf": [ + { + "$ref": "#/components/schemas/LinkType" + }, + { + "description": "URI referring to a resource" + }, + { + "x-etsi-mec-cardinality": 1 + }, + { + "x-etsi-mec-origin-type": "LinkType" + } + ] + } + }, + "type": "object", + "x-etsi-mec-cardinality": "0..1", + "x-etsi-mec-origin-type": "Structure (inlined)" + }, + "apId": { + "allOf": [ + { + "$ref": "#/components/schemas/ApIdentity" + }, + { + "description": "Identifier(s) to uniquely specify the target Access Point for the subscription" + }, + { + "x-etsi-mec-cardinality": "1" + }, + { + "x-etsi-mec-origin-type": "ApIdentity" + } + ] + }, + "callbackReference": { + "description": "URI selected by the service consumer to receive notifications on the subscribed WLAN information. This shall be included both in the request and in response.", + "format": "uri", + "type": "string", + "x-etsi-mec-cardinality": "1", + "x-etsi-mec-origin-type": "URI" + }, + "expiryDeadline": { + "allOf": [ + { + "$ref": "#/components/schemas/TimeStamp" + }, + { + "description": "The expiration time of the subscription determined by the WLAN Access Information Service." + }, + { + "x-etsi-mec-cardinality": "0..1" + }, + { + "x-etsi-mec-origin-type": "TimeStamp" + } + ] + }, + "subscriptionType": { + "description": "Shall be set to \"AssocStaSubscription\".", + "type": "string", + "x-etsi-mec-cardinality": "1", + "x-etsi-mec-origin-type": "String" + } + }, + "required": [ + "subscriptionType", + "callbackReference", + "apId" + ], + "type": "object", + "x-etsi-ref": "6.3.2" + }, + "AssociatedStations": { + "properties": { + "assocId": { + "description": "Unique number which identifies a particular association between an Access Point and a station.", + "type": "string", + "x-etsi-mec-cardinality": "0..1", + "x-etsi-mec-origin-type": "string" + }, + "ipAddress": { + "description": "IPv4 or IPv6 address allocated for the station associated with the Access Point.", + "items": { + "type": "string" + }, + "minItems": 0, + "type": "array", + "x-etsi-mec-cardinality": "0..N", + "x-etsi-mec-origin-type": "string" + }, + "macId": { + "description": "Unique identifier assigned to a station (as network interface controller) for communications at the data link layer of a network segment.", + "type": "string", + "x-etsi-mec-cardinality": "1", + "x-etsi-mec-origin-type": "string" + } + }, + "required": [ + "macId" + ], + "type": "object", + "x-etsi-ref": "6.5.5" + }, + "BeaconReport": { + "properties": { + "bssId": { + "description": "The BSSID field indicates the BSSID of the BSS(s) for which a beacon report has been received.", + "items": { + "type": "string" + }, + "minItems": 1, + "type": "array", + "x-etsi-mec-cardinality": "1..N", + "x-etsi-mec-origin-type": "String" + }, + "channelId": { + "description": "Channel number where the beacon was received.", + "type": "integer", + "x-etsi-mec-cardinality": "1", + "x-etsi-mec-origin-type": "Integer" + }, + "measurementId": { + "description": "Measurement ID of the Measurement configuration applied to this Beacon Report.", + "type": "string", + "x-etsi-mec-cardinality": "1", + "x-etsi-mec-origin-type": "String" + }, + "reportingCondition": { + "description": "As in table T9-89 of IEEE 802.11-2012 [8].", + "type": "integer", + "x-etsi-mec-cardinality": "1", + "x-etsi-mec-origin-type": "Integer" + }, + "ssId": { + "description": "(Optional) The SSID subelement indicates the ESS(s) or IBSS(s) for which a beacon report is received.", + "items": { + "type": "string" + }, + "minItems": 1, + "type": "array", + "x-etsi-mec-cardinality": "1..N", + "x-etsi-mec-origin-type": "String" + }, + "staId": { + "allOf": [ + { + "$ref": "#/components/schemas/StaIdentity" + }, + { + "description": "Identifier to uniquely specify the station whose information is exposed within this data type." + }, + { + "x-etsi-mec-cardinality": "1" + }, + { + "x-etsi-mec-origin-type": "StaIdentity" + } + ] + } + }, + "required": [ + "staId", + "measurementId", + "channelId", + "bssId", + "ssId", + "reportingCondition" + ], + "type": "object", + "x-etsi-ref": "6.5.27" + }, + "BeaconRequestConfig": { + "properties": { + "bssId": { + "description": "The BSSID field indicates the BSSID of the BSS(s) for which a beacon report is requested. When requesting beacon reports for all BSSs on the channel, the BSSID field contains the wildcard BSSID.", + "items": { + "type": "string" + }, + "minItems": 1, + "type": "array", + "x-etsi-mec-cardinality": "1..N", + "x-etsi-mec-origin-type": "String" + }, + "channelId": { + "description": "Channel number to scan. A Channel Number of 0 indicates a request to make iterative measurements for all supported channels in the Operating Class where the measurement is permitted on the channel and the channel is valid for the current regulatory domain. A Channel Number of 255 indicates a request to make iterative measurements for all supported channels in the current Operating Class listed in the latest AP Channel Report received from the serving AP.", + "type": "integer", + "x-etsi-mec-cardinality": "1", + "x-etsi-mec-origin-type": "Integer" + }, + "measurementMode": { + "description": "0 for passive.\n1 for active.\n2 for beacon table.", + "type": "integer", + "x-etsi-mec-cardinality": "1", + "x-etsi-mec-origin-type": "Integer" + }, + "reportingCondition": { + "description": "As in table T9-89 of IEEE 802.11-2012 [8].", + "type": "integer", + "x-etsi-mec-cardinality": "1", + "x-etsi-mec-origin-type": "Integer" + }, + "ssId": { + "description": "(Optional) The SSID subelement indicates the ESS(s) or IBSS(s) for which a beacon report is requested.", + "items": { + "type": "string" + }, + "minItems": 1, + "type": "array", + "x-etsi-mec-cardinality": "1..N", + "x-etsi-mec-origin-type": "String" + }, + "staId": { + "allOf": [ + { + "$ref": "#/components/schemas/StaIdentity" + }, + { + "description": "Identifier to uniquely specify the station whose information is exposed within this data type." + }, + { + "x-etsi-mec-cardinality": "1" + }, + { + "x-etsi-mec-origin-type": "StaIdentity" + } + ] + } + }, + "required": [ + "staId", + "channelId", + "measurementMode", + "bssId", + "ssId", + "reportingCondition" + ], + "type": "object", + "x-etsi-ref": "6.5.25" + }, + "BssLoad": { + "properties": { + "availAdmCap": { + "type": "integer", + "description": "Available Admission Capacity that specifies the remaining amount of medium time available via explicit admission control, in units of 32 s/s.", + "x-etsi-mec-cardinality": "1", + "x-etsi-mec-origin-type": "Uint16" + }, + "channelUtilization": { + "type": "integer", + "description": "The percentage of time, linearly scaled with 255 representing 100 %, that the AP sensed the medium was busy, as indicated by either the physical or virtual Carrier Sense (CS) mechanism.", + "x-etsi-mec-cardinality": "1", + "x-etsi-mec-origin-type": "UInt8" + }, + "staCount": { + "type": "integer", + "description": "An unsigned integer that indicates the total number of STAs currently associated with this BSS.", + "x-etsi-mec-cardinality": "1", + "x-etsi-mec-origin-type": "UInt16" + } + }, + "required": [ + "staCount", + "channelUtilization", + "availAdmCap" + ], + "type": "object", + "x-etsi-ref": "6.5.7" + }, + "ChannelLoadConfig": { + "properties": { + "apId": { + "allOf": [ + { + "$ref": "#/components/schemas/ApIdentity" + }, + { + "description": "Identifier(s) to uniquely specify the target Access Point" + }, + { + "x-etsi-mec-cardinality": "1" + }, + { + "x-etsi-mec-origin-type": "ApIdentity" + } + ] + }, + "cChannelId": { + "description": "Channel number which load is reported", + "type": "integer", + "x-etsi-mec-cardinality": "1", + "x-etsi-mec-origin-type": "Integer" + }, + "channelLoad": { + "description": "Channel load as per IEEE 802.11-2012 [8], section 11.11.9.3", + "type": "integer", + "x-etsi-mec-cardinality": "1", + "x-etsi-mec-origin-type": "Integer" + } + }, + "required": [ + "apId", + "cChannelId", + "channelLoad" + ], + "type": "object", + "x-etsi-ref": "6.5.24" + }, + "CivicLocation": { + "properties": { + "ca0": { + "description": "Language", + "type": "string", + "x-etsi-mec-cardinality": "0..1", + "x-etsi-mec-origin-type": "String" + }, + "ca1": { + "description": "National subdivisions (state, canton, region,province, prefecture) ", + "type": "string", + "x-etsi-mec-cardinality": "0..1", + "x-etsi-mec-origin-type": "String" + }, + "ca128": { + "description": "Script", + "type": "string", + "x-etsi-mec-cardinality": "0..1", + "x-etsi-mec-origin-type": "String" + }, + "ca16": { + "description": "Leading street direction", + "type": "string", + "x-etsi-mec-cardinality": "0..1", + "x-etsi-mec-origin-type": "String" + }, + "ca17": { + "description": "Trailing street suffix", + "type": "string", + "x-etsi-mec-cardinality": "0..1", + "x-etsi-mec-origin-type": "String" + }, + "ca18": { + "description": "Street suffix or type", + "type": "string", + "x-etsi-mec-cardinality": "0..1", + "x-etsi-mec-origin-type": "String" + }, + "ca19": { + "description": "House number", + "type": "string", + "x-etsi-mec-cardinality": "0..1", + "x-etsi-mec-origin-type": "String" + }, + "ca2": { + "description": "County, parish, gun (JP), district (IN)", + "type": "string", + "x-etsi-mec-cardinality": "0..1", + "x-etsi-mec-origin-type": "String" + }, + "ca20": { + "description": "House number suffix", + "type": "string", + "x-etsi-mec-cardinality": "0..1", + "x-etsi-mec-origin-type": "String" + }, + "ca21": { + "description": "Landmark of vanity address", + "type": "string", + "x-etsi-mec-cardinality": "0..1", + "x-etsi-mec-origin-type": "String" + }, + "ca22": { + "description": "Additional location information", + "type": "string", + "x-etsi-mec-cardinality": "0..1", + "x-etsi-mec-origin-type": "String" + }, + "ca23": { + "description": "Name (residence and office occupant)", + "type": "string", + "x-etsi-mec-cardinality": "0..1", + "x-etsi-mec-origin-type": "String" + }, + "ca24": { + "description": "Postal/zip code", + "type": "string", + "x-etsi-mec-cardinality": "0..1", + "x-etsi-mec-origin-type": "String" + }, + "ca25": { + "description": "Building (structure)", + "type": "string", + "x-etsi-mec-cardinality": "0..1", + "x-etsi-mec-origin-type": "String" + }, + "ca26": { + "description": "Unit (apartment/suite)", + "type": "string", + "x-etsi-mec-cardinality": "0..1", + "x-etsi-mec-origin-type": "String" + }, + "ca27": { + "description": "Floor", + "type": "string", + "x-etsi-mec-cardinality": "0..1", + "x-etsi-mec-origin-type": "String" + }, + "ca28": { + "description": "Room", + "type": "string", + "x-etsi-mec-cardinality": "0..1", + "x-etsi-mec-origin-type": "String" + }, + "ca29": { + "description": "Type of place", + "type": "string", + "x-etsi-mec-cardinality": "0..1", + "x-etsi-mec-origin-type": "String" + }, + "ca3": { + "description": "City, township, shi (JP)", + "type": "string", + "x-etsi-mec-cardinality": "0..1", + "x-etsi-mec-origin-type": "String" + }, + "ca30": { + "description": "Postal community name", + "type": "string", + "x-etsi-mec-cardinality": "0..1", + "x-etsi-mec-origin-type": "String" + }, + "ca31": { + "description": "Post office box", + "type": "string", + "x-etsi-mec-cardinality": "0..1", + "x-etsi-mec-origin-type": "String" + }, + "ca32": { + "description": "Additional code", + "type": "string", + "x-etsi-mec-cardinality": "0..1", + "x-etsi-mec-origin-type": "String" + }, + "ca33": { + "description": "Seat (desk.cubicle, workstation)", + "type": "string", + "x-etsi-mec-cardinality": "0..1", + "x-etsi-mec-origin-type": "String" + }, + "ca34": { + "description": "Primary road name", + "type": "string", + "x-etsi-mec-cardinality": "0..1", + "x-etsi-mec-origin-type": "String" + }, + "ca35": { + "description": "Road section", + "type": "string", + "x-etsi-mec-cardinality": "0..1", + "x-etsi-mec-origin-type": "String" + }, + "ca36": { + "description": "Branch road name", + "type": "string", + "x-etsi-mec-cardinality": "0..1", + "x-etsi-mec-origin-type": "String" + }, + "ca37": { + "description": "Sub-branch road name", + "type": "string", + "x-etsi-mec-cardinality": "0..1", + "x-etsi-mec-origin-type": "String" + }, + "ca38": { + "description": "Street name pre-modifier", + "type": "string", + "x-etsi-mec-cardinality": "0..1", + "x-etsi-mec-origin-type": "String" + }, + "ca39": { + "description": "Street name post-modifier", + "type": "string", + "x-etsi-mec-cardinality": "0..1", + "x-etsi-mec-origin-type": "String" + }, + "ca4": { + "description": "City division, borough, city district, ward, chou (JP)", + "type": "string", + "x-etsi-mec-cardinality": "0..1", + "x-etsi-mec-origin-type": "String" + }, + "ca5": { + "description": "Neighborhood, block", + "type": "string", + "x-etsi-mec-cardinality": "0..1", + "x-etsi-mec-origin-type": "String" + }, + "ca6": { + "description": "Group of streets below the neighborhood level ", + "type": "string", + "x-etsi-mec-cardinality": "0..1", + "x-etsi-mec-origin-type": "String" + }, + "country": { + "description": "The two-letter ISO 3166 [i.9] country code in capital ASCII letters, e.g. DE or US, as per ISO 3166 [i.9]", + "type": "string", + "x-etsi-mec-cardinality": "1", + "x-etsi-mec-origin-type": "String" + } + }, + "required": [ + "country" + ], + "type": "object", + "x-etsi-ref": "6.5.20" + }, + "DmgCapabilities": { + "properties": { + "ExtScMcsCap": { + "description": "Extended SC MCS capabilities as defined in draft IEEE P802.11/D4.0 [i.11]", + "type": "integer", + "x-etsi-mec-cardinality": "1", + "x-etsi-mec-origin-type": "Uint8" + }, + "dmgApOrPcpCapInfo": { + "type": "integer", + "description": "DMG AP or PCP capabilities information as defined in draft IEEE P802.11/D4.0 [i.11]", + "x-etsi-mec-cardinality": "1", + "x-etsi-mec-origin-type": "Uint16" + }, + "dmgStaBeamTrackTimeLimit": { + "type": "integer", + "description": "DMG station beam tracking time limit as defined in draft IEEE P802.11/D4.0 [i.11]", + "x-etsi-mec-cardinality": "1", + "x-etsi-mec-origin-type": "Uint16" + }, + "dmgStaCapInfo": { + "type": "integer", + "description": "DMG station capabilities information as defined in draft IEEE P802.11/D4.0 [i.11]", + "x-etsi-mec-cardinality": "1", + "x-etsi-mec-origin-type": "Uint64" + }, + "maxNrBasicAmsduSubframes": { + "description": "Number of basic A-MSDU subframes in A-MSDU as defined in draft IEEE P802.11/D4.0 [i.11]", + "type": "integer", + "x-etsi-mec-cardinality": "1", + "x-etsi-mec-origin-type": "Uint8" + }, + "maxNrShortAmsduSubframes": { + "description": "Number of short A-MSDU subframes in A-MSDU as defined in draft IEEE P802.11/D4.0 [i.11]", + "type": "integer", + "x-etsi-mec-cardinality": "1", + "x-etsi-mec-origin-type": "Uint8" + }, + "sarCap": { + "description": "SAR capabilities as defined in draft IEEE P802.11/D4.0 [i.11]", + "type": "integer", + "x-etsi-mec-cardinality": "1", + "x-etsi-mec-origin-type": "Uint8" + }, + "tddCap": { + "type": "integer", + "description": "TDD capabilities as defined in draft IEEE P802.11/D4.0 [i.11]", + "x-etsi-mec-cardinality": "1", + "x-etsi-mec-origin-type": "Uint16" + } + }, + "required": [ + "dmgStaCapInfo", + "dmgApOrPcpCapInfo", + "dmgStaBeamTrackTimeLimit", + "ExtScMcsCap", + "maxNrBasicAmsduSubframes", + "maxNrShortAmsduSubframes", + "tddCap", + "sarCap" + ], + "type": "object", + "x-etsi-ref": "6.5.17" + }, + "EdmgCapabilities": { + "properties": { + "ampduParameters": { + "description": "A-MPDU parameters as defined in draft IEEE P802.11/D4.0 [i.11]", + "type": "integer", + "x-etsi-mec-cardinality": "1", + "x-etsi-mec-origin-type": "Uint8" + }, + "reserved": { + "description": "", + "type": "integer", + "x-etsi-mec-cardinality": "0..1", + "x-etsi-mec-origin-type": "Uint8" + }, + "supportedMcs": { + "type": "integer", + "format": "uint32", + "description": "Supported MCS as defined in draft IEEE P802.11/D4.0 [i.11]", + "x-etsi-mec-cardinality": "1", + "x-etsi-mec-origin-type": "Uint32" + }, + "trnParameters": { + "type": "integer", + "description": "Training parameters as defined in draft IEEE P802.11/D4.0 [i.11]", + "x-etsi-mec-cardinality": "1", + "x-etsi-mec-origin-type": "Uint16" + } + }, + "required": [ + "ampduParameters", + "trnParameters", + "supportedMcs" + ], + "type": "object", + "x-etsi-ref": "6.5.18" + }, + "ExtBssLoad": { + "properties": { + "muMimoStaCount": { + "type": "integer", + "description": "Indicates the total number of STAs currently associated with this BSS that have a 1 in the MU Beamformee Capable field of their VHT Capabilities element.", + "x-etsi-mec-cardinality": "1", + "x-etsi-mec-origin-type": "UInt16" + }, + "obsSec20MhzUtil": { + "description": "Observable loading on each of the secondary 20 MHz channel.", + "type": "integer", + "x-etsi-mec-cardinality": "1", + "x-etsi-mec-origin-type": "Uint8" + }, + "obsSec40MhzUtil": { + "description": "Observable loading on each of the secondary 40 MHz channel.", + "type": "integer", + "x-etsi-mec-cardinality": "1", + "x-etsi-mec-origin-type": "Uint8" + }, + "obsSec80MhzUtil": { + "description": "Observable loading on each of the secondary 80 MHz channel.", + "type": "integer", + "x-etsi-mec-cardinality": "1", + "x-etsi-mec-origin-type": "Uint8" + }, + "spatStreamUnderUtil": { + "type": "integer", + "description": "The percentage of time, linearly scaled with 255 representing 100 %, that the AP has underutilized spatial domain resources for given busy time of the medium.", + "x-etsi-mec-cardinality": "1", + "x-etsi-mec-origin-type": "UInt8" + } + }, + "required": [ + "muMimoStaCount", + "spatStreamUnderUtil", + "obsSec20MhzUtil", + "obsSec40MhzUtil", + "obsSec80MhzUtil" + ], + "type": "object", + "x-etsi-ref": "6.5.8" + }, + "GeoLocation": { + "properties": { + "altitude": { + "type": "integer", + "format": "uint32", + "description": "The altitude value of location as defined in IETF RFC 6225 [6]", + "x-etsi-mec-cardinality": "0..1", + "x-etsi-mec-origin-type": "Uint32" + }, + "altitudeType": { + "description": "The type description for altitude information e.g. floors or meters as defined in IETF RFC 6225 [6]", + "type": "integer", + "x-etsi-mec-cardinality": "0..1", + "x-etsi-mec-origin-type": "Uint8" + }, + "altitudeUncertainty": { + "description": "The uncertainty for altitude information as defined in IETF RFC 6225 [6]", + "type": "integer", + "x-etsi-mec-cardinality": "0..1", + "x-etsi-mec-origin-type": "Uint8" + }, + "datum": { + "description": "The datum value to express how coordinates are organized and related to real world as defined in IETF RFC 6225 [6]", + "type": "integer", + "x-etsi-mec-cardinality": "1", + "x-etsi-mec-origin-type": "Uint8" + }, + "lat": { + "type": "integer", + "description": "The latitude value of location as defined in IETF RFC 6225 [6]", + "x-etsi-mec-cardinality": "1", + "x-etsi-mec-origin-type": "Uint64" + }, + "latUncertainty": { + "description": "The uncertainty for Latitude information as defined in IETF RFC 6225 [6]", + "type": "integer", + "x-etsi-mec-cardinality": "1", + "x-etsi-mec-origin-type": "Uint8" + }, + "long": { + "type": "integer", + "description": "The longitude value of location as defined in IETF RFC 6225 [6]", + "x-etsi-mec-cardinality": "1", + "x-etsi-mec-origin-type": "Uint64" + }, + "longUncertainty": { + "description": "The uncertainty for Longitude information as defined in IETF RFC 6225 [6]", + "type": "integer", + "x-etsi-mec-cardinality": "1", + "x-etsi-mec-origin-type": "Uint8" + } + }, + "required": [ + "latUncertainty", + "lat", + "longUncertainty", + "long", + "datum" + ], + "type": "object", + "x-etsi-ref": "6.5.19" + }, + "HeCapabilities": { + "properties": { + "heMacCapInfo": { + "description": "MAC capabilities of an Access Point.", + "type": "integer", + "x-etsi-mec-cardinality": "1", + "x-etsi-mec-origin-type": "Uint8" + }, + "hePhyCapinfo": { + "description": "PHY capabilities of an Access Point.", + "type": "integer", + "x-etsi-mec-cardinality": "1", + "x-etsi-mec-origin-type": "Uint8" + }, + "ppeThresholds": { + "description": "PPE Threshold determines the nominal packet padding value for a HE PPDU.", + "type": "integer", + "x-etsi-mec-cardinality": "0..1", + "x-etsi-mec-origin-type": "not defined" + }, + "supportedHeMcsNssSet": { + "description": "Supported MCS and NSS Set.", + "type": "integer", + "x-etsi-mec-cardinality": "1", + "x-etsi-mec-origin-type": "Uint8" + } + }, + "required": [ + "heMacCapInfo", + "hePhyCapinfo", + "supportedHeMcsNssSet" + ], + "type": "object", + "x-etsi-ref": "6.5.16" + }, + "HtCapabilities": { + "properties": { + "ampduParameters": { + "type": "integer", + "description": "A-MPDU parameters as defined in IEEE 802.11-2016 [8].", + "x-etsi-mec-cardinality": "1", + "x-etsi-mec-origin-type": "UInt8" + }, + "aselCap": { + "type": "integer", + "description": "ASEL capabilities as defined in IEEE 802.11-2016 [8].", + "x-etsi-mec-cardinality": "1", + "x-etsi-mec-origin-type": "UInt8" + }, + "htCapabilityInfo": { + "type": "integer", + "description": "HT Capability Information as defined in IEEE 802.11-2016 [8].", + "x-etsi-mec-cardinality": "1", + "x-etsi-mec-origin-type": "UInt16" + }, + "htExtendedCap": { + "type": "integer", + "description": "Extended HT Capabilities as defined in IEEE 802.11-2016 [8].", + "x-etsi-mec-cardinality": "1", + "x-etsi-mec-origin-type": "UInt16" + }, + "supportedMcsSet": { + "type": "integer", + "format": "uint64", + "description": "Supported MCS set as defined in IEEE 802.11-2016 [8].", + "x-etsi-mec-cardinality": "1", + "x-etsi-mec-origin-type": "Uint128" + }, + "txBeamFormCap": { + "type": "integer", + "format": "uint32", + "description": "Transmit Beamforming Capabilities as defined in IEEE 802.11-2016 [8].", + "x-etsi-mec-cardinality": "1", + "x-etsi-mec-origin-type": "UInt32" + } + }, + "required": [ + "htCapabilityInfo", + "ampduParameters", + "supportedMcsSet", + "htExtendedCap", + "txBeamFormCap", + "aselCap" + ], + "type": "object", + "x-etsi-ref": "6.5.14" + }, + "LinkType": { + "properties": { + "href": { + "description": "URI referring to a resource", + "type": "string", + "x-etsi-mec-cardinality": "1", + "x-etsi-mec-origin-type": "String" + } + }, + "required": [ + "href" + ], + "type": "object", + "x-etsi-ref": "6.5.23" + }, + "MeasurementConfig": { + "properties": { + "beaconRequest": { + "allOf": [ + { + "$ref": "#/components/schemas/BeaconRequestConfig" + }, + { + "description": "Configuration related to Beacon Request." + }, + { + "x-etsi-mec-cardinality": "0..1" + }, + { + "x-etsi-mec-origin-type": "BeaconRequestConfig" + } + ] + }, + "channelLoad": { + "allOf": [ + { + "$ref": "#/components/schemas/ChannelLoadConfig" + }, + { + "description": "Configuration related to the Channel Load." + }, + { + "x-etsi-mec-cardinality": "0..1" + }, + { + "x-etsi-mec-origin-type": "ChannelLoadConfig" + } + ] + }, + "measurementDuration": { + "description": "Duration of the measurement, shall be lower than Maximum Measurement Duration in TU as defined in section 11.11.4 of IEEE 802.11 [8].", + "type": "integer", + "x-etsi-mec-cardinality": "1", + "x-etsi-mec-origin-type": "Integer" + }, + "measurementId": { + "description": "Identifier of this measurement configuration.", + "type": "string", + "x-etsi-mec-cardinality": "1", + "x-etsi-mec-origin-type": "String" + }, + "randomnInterval": { + "description": "Random interval to be used for starting the measurement. In units of TU as specifed in section 11.11.3 of IEEE 802.11 [8].", + "type": "integer", + "x-etsi-mec-cardinality": "1", + "x-etsi-mec-origin-type": "Integer" + }, + "staStatistics": { + "allOf": [ + { + "$ref": "#/components/schemas/StaStatisticsConfig" + }, + { + "description": "Configuration related to the statistics provided by STAs." + }, + { + "x-etsi-mec-cardinality": "0..1" + }, + { + "x-etsi-mec-origin-type": "StaStatisticsConfig" + } + ] + } + }, + "required": [ + "measurementId", + "measurementDuration", + "randomnInterval" + ], + "type": "object", + "x-etsi-notes": "NOTE:\tThis element enables the configuration of the channelLoad, beaconRequest and staStatistics in a single resource data type, although only one of each measurement. Multiple measurement configurations of each kind are not allowed.", + "x-etsi-ref": "6.2.4" + }, + "NeighborReport": { + "properties": { + "bssid": { + "description": "BSS Id of the Access Point that is being reported.", + "type": "string", + "x-etsi-mec-cardinality": "1", + "x-etsi-mec-origin-type": "String" + }, + "bssidInfo": { + "description": "Additional information related to Access Point that is being reported such as AP reachability, security, key scope, Mobility Domain, HT/VHT capability and Fine Time Measurements.", + "format": "uint32", + "type": "integer", + "x-etsi-mec-cardinality": "1", + "x-etsi-mec-origin-type": "UInt32" + }, + "channel": { + "description": "The channel currently used by this Access Point.", + "type": "integer", + "x-etsi-mec-cardinality": "1", + "x-etsi-mec-origin-type": "Uint8" + }, + "operatingClass": { + "description": "The channel set of the AP indicated by this BSSID.", + "type": "integer", + "x-etsi-mec-cardinality": "1", + "x-etsi-mec-origin-type": "Uint8" + }, + "phyType": { + "description": "PHY type of the AP indicated by this BSSID. It is an integer value coded according to the value of the dot11PHYType.", + "type": "integer", + "x-etsi-mec-cardinality": "1", + "x-etsi-mec-origin-type": "Uint8" + } + }, + "required": [ + "bssid", + "bssidInfo", + "operatingClass", + "channel", + "phyType" + ], + "type": "object", + "x-etsi-ref": "6.5.10" + }, + "ProblemDetails": { + "properties": { + "detail": { + "description": "A human-readable explanation specific to this occurrence of the problem", + "type": "string", + "x-etsi-mec-cardinality": "0..1", + "x-etsi-mec-origin-type": "String" + }, + "instance": { + "description": "A URI reference that identifies the specific occurrence of the problem", + "format": "uri", + "type": "string", + "x-etsi-mec-cardinality": "0..1", + "x-etsi-mec-origin-type": "URI" + }, + "status": { + "description": "The HTTP status code for this occurrence of the problem", + "format": "uint32", + "type": "integer", + "x-etsi-mec-cardinality": "0..1", + "x-etsi-mec-origin-type": "Uint32" + }, + "title": { + "description": "A short, human-readable summary of the problem type", + "type": "string", + "x-etsi-mec-cardinality": "0..1", + "x-etsi-mec-origin-type": "String" + }, + "type": { + "description": "A URI reference according to IETF RFC 3986 that identifies the problem type", + "format": "uri", + "type": "string", + "x-etsi-mec-cardinality": "0..1", + "x-etsi-mec-origin-type": "URI" + } + }, + "type": "object" + }, + "Rssi": { + "properties": { + "rssi": { + "description": "The Received Signal Strength Indicator from a station", + "type": "integer", + "x-etsi-mec-cardinality": "1", + "x-etsi-mec-origin-type": "Uint8" + } + }, + "required": [ + "rssi" + ], + "type": "object", + "x-etsi-ref": "6.5.21" + }, + "StaDataRate": { + "properties": { + "staId": { + "allOf": [ + { + "$ref": "#/components/schemas/StaIdentity" + }, + { + "description": "Identifier(s) to uniquely specify the client station(s) associated." + }, + { + "x-etsi-mec-cardinality": "0..1" + }, + { + "x-etsi-mec-origin-type": "StaIdentity" + } + ] + }, + "staLastDataDownlinkRate": { + "description": "The data transmit rate in kbps that was most recently used for transmission of data PPDUs from the access point to the station.", + "format": "uint32", + "type": "integer", + "x-etsi-mec-cardinality": "0..1", + "x-etsi-mec-origin-type": "Uint32" + }, + "staLastDataUplinkRate": { + "description": "The data transmit rate in Kbps that was most recently used for transmission of data PPDUs from the associated station to the access point.", + "format": "uint32", + "type": "integer", + "x-etsi-mec-cardinality": "0..1", + "x-etsi-mec-origin-type": "Uint32" + } + }, + "type": "object", + "x-etsi-ref": "6.5.22" + }, + "StaDataRateNotification": { + "properties": { + "notificationType": { + "description": "Shall be set to \"StaDataRateNotification\".", + "type": "string", + "x-etsi-mec-cardinality": "1", + "x-etsi-mec-origin-type": "String" + }, + "staDataRate": { + "description": "Data rates of a client station.", + "items": { + "$ref": "#/components/schemas/StaDataRate" + }, + "minItems": 0, + "type": "array", + "x-etsi-mec-cardinality": "0..N", + "x-etsi-mec-origin-type": "StaDataRate" + }, + "timeStamp": { + "allOf": [ + { + "$ref": "#/components/schemas/TimeStamp" + }, + { + "description": "Time stamp." + }, + { + "x-etsi-mec-cardinality": "0..1" + }, + { + "x-etsi-mec-origin-type": "TimeStamp" + } + ] + } + }, + "required": [ + "notificationType" + ], + "type": "object", + "x-etsi-ref": "6.4.3" + }, + "StaDataRateSubscription": { + "properties": { + "_links": { + "description": "Hyperlink related to the resource. This shall be only included in the HTTP responses and in HTTP PUT requests.", + "properties": { + "self": { + "allOf": [ + { + "$ref": "#/components/schemas/LinkType" + }, + { + "description": "URI referring to a resource" + }, + { + "x-etsi-mec-cardinality": 1 + }, + { + "x-etsi-mec-origin-type": "LinkType" + } + ] + } + }, + "type": "object", + "x-etsi-mec-cardinality": "0..1", + "x-etsi-mec-origin-type": "Structure (inlined)" + }, + "callbackReference": { + "description": "URI selected by the service consumer to receive notifications on the subscribed WLAN Access Information Service. This shall be included both in the request and in response.", + "format": "uri", + "type": "string", + "x-etsi-mec-cardinality": "1", + "x-etsi-mec-origin-type": "URI" + }, + "expiryDeadline": { + "allOf": [ + { + "$ref": "#/components/schemas/TimeStamp" + }, + { + "description": "The expiration time of the subscription determined by the WLAN Access Information Service." + }, + { + "x-etsi-mec-cardinality": "0..1" + }, + { + "x-etsi-mec-origin-type": "TimeStamp" + } + ] + }, + "staId": { + "description": "Identifier(s) to uniquely specify the target client station(s) for the subscription", + "items": { + "$ref": "#/components/schemas/StaIdentity" + }, + "minItems": 1, + "type": "array", + "x-etsi-mec-cardinality": "1..N", + "x-etsi-mec-origin-type": "StaIdentity" + }, + "subscriptionType": { + "description": "Shall be set to \"StaDataRateSubscription\".", + "type": "string", + "x-etsi-mec-cardinality": "1", + "x-etsi-mec-origin-type": "String" + } + }, + "required": [ + "subscriptionType", + "callbackReference", + "staId" + ], + "type": "object", + "x-etsi-ref": "6.3.3" + }, + "StaIdentity": { + "properties": { + "aid": { + "description": "Number which identifies a particular association between a station and an Access Point ", + "type": "string", + "x-etsi-mec-cardinality": "0..1", + "x-etsi-mec-origin-type": "String" + }, + "ipAddress": { + "description": "IPv4 or IPv6 address allocated for the station.", + "items": { + "type": "string" + }, + "minItems": 0, + "type": "array", + "x-etsi-mec-cardinality": "0..N", + "x-etsi-mec-origin-type": "String" + }, + "macId": { + "description": "Unique identifier assigned to station (as network interface controller) for communications at the data link layer of a network segment.", + "type": "string", + "x-etsi-mec-cardinality": "1", + "x-etsi-mec-origin-type": "String" + }, + "ssid": { + "description": "Service Set Identifier to identify logical networks.", + "items": { + "type": "string" + }, + "minItems": 0, + "type": "array", + "x-etsi-mec-cardinality": "0..N", + "x-etsi-mec-origin-type": "String" + } + }, + "required": [ + "macId" + ], + "type": "object", + "x-etsi-ref": "6.5.11" + }, + "StaInfo": { + "properties": { + "apAssociated": { + "allOf": [ + { + "$ref": "#/components/schemas/ApAssociated" + }, + { + "description": "Information about the Access Point that this Client Station is associated to." + }, + { + "x-etsi-mec-cardinality": "0..1" + }, + { + "x-etsi-mec-origin-type": "ApAssociated" + } + ] + }, + "beaconReport": { + "allOf": [ + { + "$ref": "#/components/schemas/BeaconReport" + }, + { + "description": "Beacon Report as defined in Wi-Fi Agile Multiband Specification [9]." + }, + { + "x-etsi-mec-cardinality": "0..1" + }, + { + "x-etsi-mec-origin-type": "BeaconReport" + } + ] + }, + "channel": { + "type": "integer", + "format": "uint32", + "description": "Channel currently used by the station.", + "x-etsi-mec-cardinality": "0..1", + "x-etsi-mec-origin-type": "Uint32" + }, + "rssi": { + "allOf": [ + { + "$ref": "#/components/schemas/Rssi" + }, + { + "description": "Receive Signal Strength Indicator." + }, + { + "x-etsi-mec-cardinality": "0..1" + }, + { + "x-etsi-mec-origin-type": "Rssi" + } + ] + }, + "staDataRate": { + "allOf": [ + { + "$ref": "#/components/schemas/StaDataRate" + }, + { + "description": "Station Data Rate as defined in IEEE 802.11-2016 [8]." + }, + { + "x-etsi-mec-cardinality": "0..1" + }, + { + "x-etsi-mec-origin-type": "StaDataRate" + } + ] + }, + "staId": { + "allOf": [ + { + "$ref": "#/components/schemas/StaIdentity" + }, + { + "description": "0 to N identifiers to uniquely specify the station whose information is exposed within this data type." + }, + { + "x-etsi-mec-cardinality": "1" + }, + { + "x-etsi-mec-origin-type": "StaIdentity" + } + ] + }, + "staStatistics": { + "allOf": [ + { + "$ref": "#/components/schemas/StaStatistics" + }, + { + "description": "Statistics as defined in IEEE 802.11-2016 [8] for the client station collected over measurement duration." + }, + { + "x-etsi-mec-cardinality": "0..1" + }, + { + "x-etsi-mec-origin-type": "StaStatistics" + } + ] + }, + "timeStamp": { + "allOf": [ + { + "$ref": "#/components/schemas/TimeStamp" + }, + { + "description": "Time stamp." + }, + { + "x-etsi-mec-cardinality": "0..1" + }, + { + "x-etsi-mec-origin-type": "TimeStamp" + } + ] + } + }, + "required": [ + "staId" + ], + "type": "object", + "x-etsi-ref": "6.2.3" + }, + "StaStatistics": { + "properties": { + "groupIdentity": { + "description": "Indicates the requested statistics group describing the Statistics Group Data according to table 9-114 of IEEE 802.11-2016 [8].", + "type": "integer", + "x-etsi-mec-cardinality": "1", + "x-etsi-mec-origin-type": "UInt8" + }, + "md": { + "description": "Measurement Duration.", + "type": "integer", + "x-etsi-mec-cardinality": "1", + "x-etsi-mec-origin-type": "UInt16" + }, + "statisticsGroupData": { + "allOf": [ + { + "$ref": "#/components/schemas/StatisticsGroupData" + }, + { + "description": "Statistics Group Data as defined in Annex C of IEEE 802.112016  [8]." + }, + { + "x-etsi-mec-cardinality": "1" + }, + { + "x-etsi-mec-origin-type": "not specified" + } + ] + } + }, + "required": [ + "md", + "groupIdentity", + "statisticsGroupData" + ], + "type": "object", + "x-etsi-ref": "6.5.13" + }, + "StaStatisticsConfig": { + "properties": { + "groupIdentity": { + "description": "As per table T 9-114 of IEEE 802.11-2012 [8].", + "type": "integer", + "x-etsi-mec-cardinality": "1", + "x-etsi-mec-origin-type": "Integer" + }, + "staId": { + "allOf": [ + { + "$ref": "#/components/schemas/StaIdentity" + }, + { + "description": "Identifier to uniquely specify the station whose information is exposed within this data type." + }, + { + "x-etsi-mec-cardinality": "1" + }, + { + "x-etsi-mec-origin-type": "StaIdentity" + } + ] + }, + "triggerCondition": { + "type": "integer", + "description": "As per Figure 9-161 of IEEE 802.11. This bitmap defines what are the metrics returned by the STA Statistics Report.", + "x-etsi-mec-cardinality": "1", + "x-etsi-mec-origin-type": "16bits bitmap" + }, + "triggerTimeout": { + "description": "The Trigger Timeout field contains a value in units of 100 TUs during which a measuring STA does not generate further triggered STA Statistics Reports after a trigger condition has been met.", + "type": "integer", + "x-etsi-mec-cardinality": "1", + "x-etsi-mec-origin-type": "Integer" + }, + "triggeredReport": { + "type": "boolean", + "description": "Yes, use triggered report.", + "x-etsi-mec-cardinality": "1", + "x-etsi-mec-origin-type": "Bool" + } + }, + "required": [ + "staId", + "groupIdentity", + "triggeredReport", + "triggerTimeout", + "triggerCondition" + ], + "type": "object", + "x-etsi-ref": "6.5.26" + }, + "StatisticsGroupData": { + "properties": { + "dot11AMPDUDelimiterCRCErrorCount": { + "format": "uint32", + "type": "integer", + "x-etsi-mec-cardinality": "0..1", + "x-etsi-mec-origin-type": "Uint32" + }, + "dot11AMPDUReceivedCount": { + "format": "uint32", + "type": "integer", + "x-etsi-mec-cardinality": "0..1", + "x-etsi-mec-origin-type": "Uint32" + }, + "dot11AMSDUAckFailureCount": { + "format": "uint32", + "type": "integer", + "x-etsi-mec-cardinality": "0..1", + "x-etsi-mec-origin-type": "Uint32" + }, + "dot11AckFailureCount": { + "format": "uint32", + "type": "integer", + "x-etsi-mec-cardinality": "0..1", + "x-etsi-mec-origin-type": "Uint32" + }, + "dot11BeamformingFrameCount": { + "format": "uint32", + "type": "integer", + "x-etsi-mec-cardinality": "0..1", + "x-etsi-mec-origin-type": "Uint32" + }, + "dot11ChannelWidthSwitchCount": { + "format": "uint32", + "type": "integer", + "x-etsi-mec-cardinality": "0..1", + "x-etsi-mec-origin-type": "Uint32" + }, + "dot11DualCTSFailureCount": { + "format": "uint32", + "type": "integer", + "x-etsi-mec-cardinality": "0..1", + "x-etsi-mec-origin-type": "Uint32" + }, + "dot11DualCTSSuccessCount": { + "format": "uint32", + "type": "integer", + "x-etsi-mec-cardinality": "0..1", + "x-etsi-mec-origin-type": "Uint32" + }, + "dot11ExplicitBARFailureCount": { + "format": "uint32", + "type": "integer", + "x-etsi-mec-cardinality": "0..1", + "x-etsi-mec-origin-type": "Uint32" + }, + "dot11FCSErrorCount": { + "format": "uint32", + "type": "integer", + "x-etsi-mec-cardinality": "0..1", + "x-etsi-mec-origin-type": "Uint32" + }, + "dot11FailedAMSDUCount": { + "format": "uint32", + "type": "integer", + "x-etsi-mec-cardinality": "0..1", + "x-etsi-mec-origin-type": "Uint32" + }, + "dot11FailedCount": { + "format": "uint32", + "type": "integer", + "x-etsi-mec-cardinality": "0..1", + "x-etsi-mec-origin-type": "Uint32" + }, + "dot11FortyMHzFrameReceivedCount": { + "format": "uint32", + "type": "integer", + "x-etsi-mec-cardinality": "0..1", + "x-etsi-mec-origin-type": "Uint32" + }, + "dot11FortyMHzFrameTransmittedCount": { + "format": "uint32", + "type": "integer", + "x-etsi-mec-cardinality": "0..1", + "x-etsi-mec-origin-type": "Uint32" + }, + "dot11FrameDuplicateCount": { + "format": "uint32", + "type": "integer", + "x-etsi-mec-cardinality": "0..1", + "x-etsi-mec-origin-type": "Uint32" + }, + "dot11GrantedRDGUnusedCount": { + "format": "uint32", + "type": "integer", + "x-etsi-mec-cardinality": "0..1", + "x-etsi-mec-origin-type": "Uint32" + }, + "dot11GrantedRDGUsedCount": { + "format": "uint32", + "type": "integer", + "x-etsi-mec-cardinality": "0..1", + "x-etsi-mec-origin-type": "Uint32" + }, + "dot11GroupReceivedFrameCount": { + "format": "uint32", + "type": "integer", + "x-etsi-mec-cardinality": "0..1", + "x-etsi-mec-origin-type": "Uint32" + }, + "dot11GroupTransmittedFrameCount": { + "format": "uint32", + "type": "integer", + "x-etsi-mec-cardinality": "0..1", + "x-etsi-mec-origin-type": "Uint32" + }, + "dot11ImplicitBARFailureCount": { + "format": "uint32", + "type": "integer", + "x-etsi-mec-cardinality": "0..1", + "x-etsi-mec-origin-type": "Uint32" + }, + "dot11MPDUInReceivedAMPDUCount": { + "format": "uint32", + "type": "integer", + "x-etsi-mec-cardinality": "0..1", + "x-etsi-mec-origin-type": "Uint32" + }, + "dot11MultipleRetryAMSDUCount": { + "format": "uint32", + "type": "integer", + "x-etsi-mec-cardinality": "0..1", + "x-etsi-mec-origin-type": "Uint32" + }, + "dot11MultipleRetryCount": { + "format": "uint32", + "type": "integer", + "x-etsi-mec-cardinality": "0..1", + "x-etsi-mec-origin-type": "Uint32" + }, + "dot11PSMPUTTGrantDuration": { + "format": "uint32", + "type": "integer", + "x-etsi-mec-cardinality": "0..1", + "x-etsi-mec-origin-type": "Uint32" + }, + "dot11PSMPUTTUsedDuration": { + "format": "uint32", + "type": "integer", + "x-etsi-mec-cardinality": "0..1", + "x-etsi-mec-origin-type": "Uint32" + }, + "dot11QosAckFailureCount": { + "format": "uint32", + "type": "integer", + "x-etsi-mec-cardinality": "0..1", + "x-etsi-mec-origin-type": "Uint32" + }, + "dot11QosDiscardedFrameCount": { + "format": "uint32", + "type": "integer", + "x-etsi-mec-cardinality": "0..1", + "x-etsi-mec-origin-type": "Uint32" + }, + "dot11QosFailedCount": { + "format": "uint32", + "type": "integer", + "x-etsi-mec-cardinality": "0..1", + "x-etsi-mec-origin-type": "Uint32" + }, + "dot11QosFrameDuplicateCount": { + "format": "uint32", + "type": "integer", + "x-etsi-mec-cardinality": "0..1", + "x-etsi-mec-origin-type": "Uint32" + }, + "dot11QosMPDUsReceivedCount": { + "format": "uint32", + "type": "integer", + "x-etsi-mec-cardinality": "0..1", + "x-etsi-mec-origin-type": "Uint32" + }, + "dot11QosMultipleRetryCount": { + "format": "uint32", + "type": "integer", + "x-etsi-mec-cardinality": "0..1", + "x-etsi-mec-origin-type": "Uint32" + }, + "dot11QosRTSFailureCount": { + "format": "uint32", + "type": "integer", + "x-etsi-mec-cardinality": "0..1", + "x-etsi-mec-origin-type": "Uint32" + }, + "dot11QosRTSSuccessCount": { + "format": "uint32", + "type": "integer", + "x-etsi-mec-cardinality": "0..1", + "x-etsi-mec-origin-type": "Uint32" + }, + "dot11QosReceivedFragmentCount": { + "format": "uint32", + "type": "integer", + "x-etsi-mec-cardinality": "0..1", + "x-etsi-mec-origin-type": "Uint32" + }, + "dot11QosRetriesReceivedCount": { + "format": "uint32", + "type": "integer", + "x-etsi-mec-cardinality": "0..1", + "x-etsi-mec-origin-type": "Uint32" + }, + "dot11QosRetryCount": { + "format": "uint32", + "type": "integer", + "x-etsi-mec-cardinality": "0..1", + "x-etsi-mec-origin-type": "Uint32" + }, + "dot11QosTransmittedFragmentCount": { + "format": "uint32", + "type": "integer", + "x-etsi-mec-cardinality": "0..1", + "x-etsi-mec-origin-type": "Uint32" + }, + "dot11QosTransmittedFrameCount": { + "format": "uint32", + "type": "integer", + "x-etsi-mec-cardinality": "0..1", + "x-etsi-mec-origin-type": "Uint32" + }, + "dot11RSNAStatsBIPMICErrors": { + "format": "uint32", + "type": "integer", + "x-etsi-mec-cardinality": "0..1", + "x-etsi-mec-origin-type": "Uint32" + }, + "dot11RSNAStatsCCMPDecryptErrors": { + "format": "uint32", + "type": "integer", + "x-etsi-mec-cardinality": "0..1", + "x-etsi-mec-origin-type": "Uint32" + }, + "dot11RSNAStatsCCMPReplays": { + "format": "uint32", + "type": "integer", + "x-etsi-mec-cardinality": "0..1", + "x-etsi-mec-origin-type": "Uint32" + }, + "dot11RSNAStatsCMACReplays": { + "format": "uint32", + "type": "integer", + "x-etsi-mec-cardinality": "0..1", + "x-etsi-mec-origin-type": "Uint32" + }, + "dot11RSNAStatsRobustMgmtCCMPReplays": { + "format": "uint32", + "type": "integer", + "x-etsi-mec-cardinality": "0..1", + "x-etsi-mec-origin-type": "Uint32" + }, + "dot11RSNAStatsTKIPICVErrors": { + "format": "uint32", + "type": "integer", + "x-etsi-mec-cardinality": "0..1", + "x-etsi-mec-origin-type": "Uint32" + }, + "dot11RSNAStatsTKIPReplays": { + "format": "uint32", + "type": "integer", + "x-etsi-mec-cardinality": "0..1", + "x-etsi-mec-origin-type": "Uint32" + }, + "dot11RTSFailureCount": { + "format": "uint32", + "type": "integer", + "x-etsi-mec-cardinality": "0..1", + "x-etsi-mec-origin-type": "Uint32" + }, + "dot11RTSLSIGFailureCount": { + "format": "uint32", + "type": "integer", + "x-etsi-mec-cardinality": "0..1", + "x-etsi-mec-origin-type": "Uint32" + }, + "dot11RTSLSIGSuccessCount": { + "format": "uint32", + "type": "integer", + "x-etsi-mec-cardinality": "0..1", + "x-etsi-mec-origin-type": "Uint32" + }, + "dot11RTSSuccessCount": { + "format": "uint32", + "type": "integer", + "x-etsi-mec-cardinality": "0..1", + "x-etsi-mec-origin-type": "Uint32" + }, + "dot11ReceivedAMSDUCount": { + "format": "uint32", + "type": "integer", + "x-etsi-mec-cardinality": "0..1", + "x-etsi-mec-origin-type": "Uint32" + }, + "dot11ReceivedFragmentCount": { + "format": "uint32", + "type": "integer", + "x-etsi-mec-cardinality": "0..1", + "x-etsi-mec-origin-type": "Uint32" + }, + "dot11ReceivedOctetsInAMPDUCount": { + "format": "uint64", + "type": "integer", + "x-etsi-mec-cardinality": "0..1", + "x-etsi-mec-origin-type": "Uint64" + }, + "dot11ReceivedOctetsInAMSDUCount": { + "format": "uint64", + "type": "integer", + "x-etsi-mec-cardinality": "0..1", + "x-etsi-mec-origin-type": "Uint64" + }, + "dot11RetryAMSDUCount": { + "format": "uint32", + "type": "integer", + "x-etsi-mec-cardinality": "0..1", + "x-etsi-mec-origin-type": "Uint32" + }, + "dot11RetryCount": { + "format": "uint32", + "type": "integer", + "x-etsi-mec-cardinality": "0..1", + "x-etsi-mec-origin-type": "Uint32" + }, + "dot11STAStatisticsAPAverageAccessDelay": { + "type": "integer", + "x-etsi-mec-cardinality": "0..1", + "x-etsi-mec-origin-type": "Uint8" + }, + "dot11STAStatisticsAverageAccessDelayBackGround": { + "type": "integer", + "x-etsi-mec-cardinality": "0..1", + "x-etsi-mec-origin-type": "Uint8" + }, + "dot11STAStatisticsAverageAccessDelayBestEffort": { + "type": "integer", + "x-etsi-mec-cardinality": "0..1", + "x-etsi-mec-origin-type": "Uint8" + }, + "dot11STAStatisticsAverageAccessDelayVideo": { + "type": "integer", + "x-etsi-mec-cardinality": "0..1", + "x-etsi-mec-origin-type": "Uint8" + }, + "dot11STAStatisticsAverageAccessDelayVoice": { + "type": "integer", + "x-etsi-mec-cardinality": "0..1", + "x-etsi-mec-origin-type": "Uint8" + }, + "dot11STAStatisticsChannelUtilization": { + "type": "integer", + "x-etsi-mec-cardinality": "0..1", + "x-etsi-mec-origin-type": "Uint8" + }, + "dot11STAStatisticsStationCount": { + "type": "integer", + "x-etsi-mec-cardinality": "0..1", + "x-etsi-mec-origin-type": "Uint8" + }, + "dot11STBCCTSFailureCount": { + "format": "uint32", + "type": "integer", + "x-etsi-mec-cardinality": "0..1", + "x-etsi-mec-origin-type": "Uint32" + }, + "dot11STBCCTSSuccessCount": { + "format": "uint32", + "type": "integer", + "x-etsi-mec-cardinality": "0..1", + "x-etsi-mec-origin-type": "Uint32" + }, + "dot11TransmittedAMPDUCount": { + "format": "uint32", + "type": "integer", + "x-etsi-mec-cardinality": "0..1", + "x-etsi-mec-origin-type": "Uint32" + }, + "dot11TransmittedAMSDUCount": { + "format": "uint32", + "type": "integer", + "x-etsi-mec-cardinality": "0..1", + "x-etsi-mec-origin-type": "Uint32" + }, + "dot11TransmittedFragmentCount": { + "format": "uint32", + "type": "integer", + "x-etsi-mec-cardinality": "0..1", + "x-etsi-mec-origin-type": "Uint32" + }, + "dot11TransmittedFrameCount": { + "format": "uint32", + "type": "integer", + "x-etsi-mec-cardinality": "0..1", + "x-etsi-mec-origin-type": "Uint32" + }, + "dot11TransmittedFramesInGrantedRDGCount": { + "format": "uint32", + "type": "integer", + "x-etsi-mec-cardinality": "0..1", + "x-etsi-mec-origin-type": "Uint32" + }, + "dot11TransmittedMPDUsInAMPDUCount": { + "format": "uint32", + "type": "integer", + "x-etsi-mec-cardinality": "0..1", + "x-etsi-mec-origin-type": "Uint32" + }, + "dot11TransmittedOctetsInAMPDUCount": { + "format": "uint64", + "type": "integer", + "x-etsi-mec-cardinality": "0..1", + "x-etsi-mec-origin-type": "Uint64" + }, + "dot11TransmittedOctetsInAMSDUCount": { + "format": "uint64", + "type": "integer", + "x-etsi-mec-cardinality": "0..1", + "x-etsi-mec-origin-type": "Uint32" + }, + "dot11TransmittedOctetsInGrantedRDGCount": { + "format": "uint32", + "type": "integer", + "x-etsi-mec-cardinality": "0..1", + "x-etsi-mec-origin-type": "Uint32" + }, + "dot11TwentyMHzFrameReceivedCount": { + "format": "uint32", + "type": "integer", + "x-etsi-mec-cardinality": "0..1", + "x-etsi-mec-origin-type": "Uint32" + }, + "dot11TwentyMHzFrameTransmittedCount": { + "format": "uint32", + "type": "integer", + "x-etsi-mec-cardinality": "0..1", + "x-etsi-mec-origin-type": "Uint32" + }, + "dot11nonSTBCCTSFailureCount": { + "format": "uint32", + "type": "integer", + "x-etsi-mec-cardinality": "0..1", + "x-etsi-mec-origin-type": "Uint32" + }, + "dot11nonSTBCCTSSuccessCount": { + "format": "uint32", + "type": "integer", + "x-etsi-mec-cardinality": "0..1", + "x-etsi-mec-origin-type": "Uint32" + } + }, + "type": "object" + }, + "SubscriptionLinkList": { + "properties": { + "_links": { + "description": "Hyperlink related to the resource. This shall be only included in the HTTP responses and in HTTP PUT requests.", + "properties": { + "self": { + "allOf": [ + { + "$ref": "#/components/schemas/LinkType" + }, + { + "description": "URI referring to a resource" + }, + { + "x-etsi-mec-cardinality": 1 + }, + { + "x-etsi-mec-origin-type": "LinkType" + } + ] + } + }, + "type": "object", + "x-etsi-mec-cardinality": "0..1", + "x-etsi-mec-origin-type": "Structure (inlined)" + }, + "assocStaSubscription": { + "items": { + "$ref": "#/components/schemas/AssocStaSubscription" + }, + "type": "array", + "x-etsi-mec-cardinality": "0..N", + "x-etsi-mec-origin-type": "AssocStaSubscription" + }, + "staDataRateSubscription": { + "items": { + "$ref": "#/components/schemas/StaDataRateSubscription" + }, + "type": "array", + "x-etsi-mec-cardinality": "0..N", + "x-etsi-mec-origin-type": "StaDataRateSubscription" + } + }, + "required": [ + "_links" + ], + "type": "object" + }, + "TimeStamp": { + "properties": { + "nanoSeconds": { + "type": "integer", + "format": "uint32", + "description": "The nanoseconds part of the time. Time is defined as Unix-time since January 1, 1970, 00:00:00 UTC.", + "x-etsi-mec-cardinality": "1", + "x-etsi-mec-origin-type": "Uint32" + }, + "seconds": { + "type": "integer", + "format": "uint32", + "description": "The seconds part of the time. Time is defined as Unixtime since January 1, 1970, 00:00:00 UTC.", + "x-etsi-mec-cardinality": "1", + "x-etsi-mec-origin-type": "Uint32" + } + }, + "required": [ + "seconds", + "nanoSeconds" + ], + "type": "object", + "x-etsi-ref": "6.5.2" + }, + "VhtCapabilities": { + "properties": { + "vhtCapInfo": { + "type": "integer", + "format": "uint32", + "description": "VHT capabilities Info as defined in IEEE 802.11-2016 [8].", + "x-etsi-mec-cardinality": "1", + "x-etsi-mec-origin-type": "UInt32" + }, + "vhtMcsNss": { + "type": "integer", + "description": "Supported VHT-MCS and NSS Set as defined in IEEE 802.11-2016 [8].", + "x-etsi-mec-cardinality": "1", + "x-etsi-mec-origin-type": "UInt64" + } + }, + "required": [ + "vhtCapInfo", + "vhtMcsNss" + ], + "type": "object", + "x-etsi-ref": "6.5.15" + }, + "WanMetrics": { + "properties": { + "downlinkLoad": { + "type": "integer", + "description": "1-octet positive integer representing the current percentage loading of the downlink WAN connection, scaled linearly with 255 representing 100 %, as measured over an interval the duration of which is reported in Load Measurement Duration. In cases where the downlink load is unknown to the AP, the value is set to zero.", + "x-etsi-mec-cardinality": "1", + "x-etsi-mec-origin-type": "UInt8" + }, + "downlinkSpeed": { + "type": "integer", + "format": "uint32", + "description": "4-octet positive integer whose value is an estimate of the WAN Backhaul link current downlink speed in kilobits per second.", + "x-etsi-mec-cardinality": "1", + "x-etsi-mec-origin-type": "Uint32" + }, + "lmd": { + "type": "integer", + "description": "The LMD (Load Measurement Duration) field is a 2-octet positive integer representing the duration over which the Downlink Load and Uplink Load have been measured, in tenths of a second. When the actual load measurement duration is greater than the maximum value, the maximum value will be reported. The value of the LMD field is set to 0 when neither the uplink nor downlink load can be computed. When the uplink and downlink loads are computed over different intervals, the maximum interval is reported.", + "x-etsi-mec-cardinality": "1", + "x-etsi-mec-origin-type": "Uint16" + }, + "uplinkLoad": { + "description": "1-octet positive integer representing the current percentage loading of the uplink WAN connection, scaled linearly with 255 representing 100 %, as measured over an interval, the duration of which is reported in Load Measurement Duration. In cases where the uplink load is unknown to the AP, the value is set to zero.", + "type": "integer", + "x-etsi-mec-cardinality": "1", + "x-etsi-mec-origin-type": "Uint8" + }, + "uplinkSpeed": { + "type": "integer", + "format": "uint32", + "description": "4-octet positive integer whose value is an estimate of the WAN Backhaul link's current uplink speed in kilobits per second.", + "x-etsi-mec-cardinality": "1", + "x-etsi-mec-origin-type": "UInt32" + }, + "wanInfo": { + "description": "Info about WAN link status, link symmetricity and capacity currently used.", + "type": "integer", + "x-etsi-mec-cardinality": "1", + "x-etsi-mec-origin-type": "Uint8" + } + }, + "required": [ + "wanInfo", + "downlinkSpeed", + "uplinkSpeed", + "downlinkLoad", + "uplinkLoad", + "lmd" + ], + "type": "object", + "x-etsi-ref": "6.5.6" + }, + "WlanCapabilities": { + "properties": { + "dmg": { + "allOf": [ + { + "$ref": "#/components/schemas/DmgCapabilities" + }, + { + "description": "Information about Access Point DMG capabilities as defined in IEEE 802.11-2016 [8]." + }, + { + "x-etsi-mec-cardinality": "0..1" + }, + { + "x-etsi-mec-origin-type": "DmgCapabilities" + } + ] + }, + "edmg": { + "allOf": [ + { + "$ref": "#/components/schemas/EdmgCapabilities" + }, + { + "description": "Information about Access Point EDMG capabilities as defined in draft IEEE P802.11/D4.0 [i.11]." + }, + { + "x-etsi-mec-cardinality": "0..1" + }, + { + "x-etsi-mec-origin-type": "EdmgCapabilities" + } + ] + }, + "he": { + "allOf": [ + { + "$ref": "#/components/schemas/HeCapabilities" + }, + { + "description": "Information about Access Point HE capabilities as defined in FFS." + }, + { + "x-etsi-mec-cardinality": "0..1" + }, + { + "x-etsi-mec-origin-type": "HeCapabilities" + } + ] + }, + "ht": { + "allOf": [ + { + "$ref": "#/components/schemas/HtCapabilities" + }, + { + "description": "Information about Access Point HT capabilities as defined in IEEE 802.11-2016 [8]." + }, + { + "x-etsi-mec-cardinality": "0..1" + }, + { + "x-etsi-mec-origin-type": "HtCapabilities" + } + ] + }, + "vht": { + "allOf": [ + { + "$ref": "#/components/schemas/VhtCapabilities" + }, + { + "description": "Information about Access Point VHT capabilities as defined in IEEE 802.11-2016 [8]." + }, + { + "x-etsi-mec-cardinality": "0..1" + }, + { + "x-etsi-mec-origin-type": "VhtCapabilities" + } + ] + } + }, + "type": "object", + "x-etsi-ref": "6.5.4" + } + } + } +} \ No newline at end of file diff --git a/WlanInformationApi.yaml b/WlanInformationApi.yaml new file mode 100644 index 0000000..672748a --- /dev/null +++ b/WlanInformationApi.yaml @@ -0,0 +1,2342 @@ +openapi: 3.0.0 +info: + title: ETSI GS MEC 028 - WLAN Access Information API + version: 2.1.1 + description: The ETSI MEC ISG MEC028 WLAN Access Information API described using OpenAPI + license: + name: BSD-3-Clause + url: 'https://forge.etsi.org/legal-matters' +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' +servers: + - url: 'https://{apiRoot}/wai/v2' +paths: + /queries/ap/ap_information: + get: + tags: + - '' + summary: 'Retrieve information on existing Access Points' + description: 'Queries information about existing WLAN Access Points' + operationId: apInfoGET + parameters: + - $ref: '#/components/parameters/Query.Filter' + - $ref: '#/components/parameters/Query.AllFields' + - $ref: '#/components/parameters/Query.Fields' + - $ref: '#/components/parameters/Query.ExcludeFields' + - $ref: '#/components/parameters/Query.ExcludeDefault' + responses: + '200': + description: Successful response to ap_info request + content: + application/json: + schema: + type: object + properties: + apInfo: + type: array + items: + $ref: '#/components/schemas/ApInfo' + '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': + $ref: '#/components/responses/429' + /queries/sta/sta_information: + get: + tags: + - '' + summary: 'Retrieve information on existing Stations' + description: 'Queries information about existing WLAN stations' + operationId: staInfoGET + parameters: + - $ref: '#/components/parameters/Query.Filter' + - $ref: '#/components/parameters/Query.AllFields' + - $ref: '#/components/parameters/Query.Fields' + - $ref: '#/components/parameters/Query.ExcludeFields' + - $ref: '#/components/parameters/Query.ExcludeDefault' + responses: + '200': + description: Successful response to sta_info request + content: + application/json: + schema: + type: object + properties: + staInfo: + type: array + items: + $ref: '#/components/schemas/StaInfo' + '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': + $ref: '#/components/responses/429' + /subscriptions/: + get: + tags: + - '' + summary: 'Retrieve information on subscriptions for notifications' + description: 'Queries information on subscriptions for notifications' + operationId: subscriptionLinkList_subscriptionsGET + parameters: + - $ref: '#/components/parameters/Query.SubscriptionType' + responses: + '200': + description: 'Response body contains the list of links to requestors subscriptions.' + content: + application/json: + schema: + type: object + required: + - subscriptionLinkList + properties: + subscriptionLinkList: + $ref: '#/components/schemas/SubscriptionLinkList' + example: + subscriptionLinkList: + _links: + self: + href: 'http://meAppServer.example.com/wai/v2/subscriptions' + subscription: + - _links: + self: + href: 'http://meAppServer.example.com/wai/v2/subscriptions/sub123' + callbackReference: 'http://my.callback.com/wai/assocStaSubscription/some-id' + subscriptionType: AssocStaSubscription + '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': + $ref: '#/components/responses/429' + post: + tags: + - '' + summary: 'Create a new subscription' + description: 'Creates a new subscription to WLAN Access Information notifications' + operationId: subscriptionsPOST + requestBody: + description: Subscription to be created + required: true + content: + application/json: + schema: + type: object + properties: + notificationSubscription: + oneOf: + - $ref: '#/components/schemas/AssocStaSubscription' + - $ref: '#/components/schemas/StaDataRateSubscription' + discriminator: + propertyName: subscriptionType + example: + notificationSubscription: + subscriptionType: AssocStaSubscription + callbackReference: 'http://meAppClient.example.com/wai/v2/notifications/1' + expiryDeadline: + seconds: 1977836800 + nanoSeconds: 0 + apId: + macId: 005C0A0A0A0A + ssid: 'myNetworkSsid' + ipAddress: 10.10.100.1 + responses: + '201': + description: Successful subscription response + content: + application/json: + schema: + type: object + properties: + notificationSubscription: + oneOf: + - $ref: '#/components/schemas/AssocStaSubscription' + - $ref: '#/components/schemas/StaDataRateSubscription' + discriminator: + propertyName: subscriptionType + example: + notificationSubscription: + subscriptionType: AssocStaSubscription + callbackReference: 'http://meAppClient.example.com/wai/v2/notifications/1' + _links: + self: + href: 'http://meAppServer.example.com/wai/v2/subscriptions/sub123' + expiryDeadline: + seconds: 1977836800 + nanoSeconds: 0 + apId: + macId: 005C0A0A0A0A + ssid: 'myNetworkSsid' + ipAddress: 10.10.100.1 + '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': + $ref: '#/components/responses/415' + '422': + $ref: '#/components/responses/422' + '429': + $ref: '#/components/responses/429' + callbacks: + notification: + '{$request.body#/callbackReference}': + post: + summary: 'Callback POST used to send a notification' + description: 'Notification from WAIS, content based on subscription type' + operationId: notificationPOST + requestBody: + description: Subscription notification + required: true + content: + application/json: + schema: + type: object + properties: + notification: + oneOf: + - $ref: '#/components/schemas/AssocStaNotification' + - $ref: '#/components/schemas/StaDataRateNotification' + discriminator: + propertyName: notificationType + example: + notification: + notificationType: AssocStaNotification + timeStamp: + seconds: 1977836800 + nanoseconds: 0 + apId: + macId: 005C0A0A0A0A + ssid: 'myNetworkSsid' + ipAddress: 10.10.100.1 + staId: + macId: 005C01111111 + ssid: + - 'myNetworkSsid' + - 'myOtherNetworkSsid' + aid: '1122' + ipAddress: 10.10.1.255 + responses: + '204': + $ref: '#/components/responses/204' + '/subscriptions/{subscriptionId}': + get: + tags: + - '' + summary: 'Retrieve information on current specific subscription' + description: 'Queries information about an existing subscription, identified by its self-referring URI returned on creation (initial POST)' + operationId: subscriptionsGET + parameters: + - $ref: '#/components/parameters/Path.subscrId' + responses: + '200': + description: Subscription information regarding subscription notifications + content: + application/json: + schema: + type: object + required: + - notificationSubscription + properties: + notificationSubscription: + oneOf: + - $ref: '#/components/schemas/AssocStaSubscription' + - $ref: '#/components/schemas/StaDataRateSubscription' + discriminator: + propertyName: subscriptionType + example: + notificationSubscription: + subscriptionType: AssocStaSubscription + callbackReference: 'http://meAppClient.example.com/wai/v2/notifications/1' + _links: + self: + href: 'http://meAppServer.example.com/wai/v2/subscriptions/sub123' + expiryDeadline: + seconds: 1977836800 + nanoSeconds: 0 + apId: + macId: 005C0A0A0A0A + ssid: 'myNetworkSsid' + ipAddress: 10.10.100.1 + '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': + $ref: '#/components/responses/429' + put: + tags: + - '' + summary: 'Modify an existing subscription' + description: 'Updates an existing subscription, identified by its self-referring URI returned on creation (initial POST)' + operationId: subscriptionsPUT + requestBody: + description: Subscription to be modified + required: true + content: + application/json: + schema: + type: object + properties: + notificationSubscription: + oneOf: + - $ref: '#/components/schemas/AssocStaSubscription' + - $ref: '#/components/schemas/StaDataRateSubscription' + discriminator: + propertyName: subscriptionType + example: + notificationSubscription: + subscriptionType: AssocStaSubscription + callbackReference: 'http://meAppClient.example.com/wai/v2/notifications/1' + _links: + self: + href: 'http://meAppServer.example.com/wai/v2/subscriptions/sub123' + expiryDeadline: + seconds: 1977836800 + nanoSeconds: 0 + apId: + macId: 005C0A0A0A0A + ssid: 'myNetworkSsid' + ipAddress: 10.10.100.1 + parameters: + - $ref: '#/components/parameters/Path.subscrId' + responses: + '200': + description: Successful subscription modification + content: + application/json: + schema: + type: object + properties: + subscription: + oneOf: + - $ref: '#/components/schemas/AssocStaSubscription' + - $ref: '#/components/schemas/StaDataRateSubscription' + discriminator: + propertyName: subscriptionType + example: + subscription: + _links: + self: + href: 'http://[hostIP]/sbox-xyz123/wai/v2/subscriptions/sub123' + callbackReference: 'http://my.callback.com/wai/some-id' + apId: + macId: 005C0A0A0A0A + '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: + - '' + summary: 'Cancel an existing subscription' + description: 'Cancels an existing subscription, identified by its self-referring URI returned on creation (initial POST)' + operationId: subscriptionsDELETE + parameters: + - $ref: '#/components/parameters/Path.subscrId' + 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/json: + schema: + type: object + properties: + problemDetails: + $ref: '#/components/schemas/ProblemDetails' + 401: + description: 'Unauthorized : used when the client did not submit credentials.' + content: + application/json: + schema: + type: object + properties: + problemDetails: + $ref: '#/components/schemas/ProblemDetails' + 403: + description: 'Forbidden : operation is not allowed given the current status of the resource.' + content: + application/json: + schema: + type: object + required: + - problemDetails + properties: + problemDetails: + $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/json: + schema: + type: object + properties: + problemDetails: + $ref: '#/components/schemas/ProblemDetails' + 406: + description: 'Not Acceptable : used to indicate that the server cannot provide the any of the content formats supported by the client.' + content: + application/json: + schema: + type: object + properties: + problemDetails: + $ref: '#/components/schemas/ProblemDetails' + 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' + content: + application/json: + schema: + type: object + properties: + problemDetails: + $ref: '#/components/schemas/ProblemDetails' + 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/json: + schema: + type: object + properties: + problemDetails: + $ref: '#/components/schemas/ProblemDetails' + 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.' + content: + application/json: + schema: + type: object + properties: + problemDetails: + $ref: '#/components/schemas/ProblemDetails' + example: + application/problem+json: + ProblemDetails: + 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 + 429: + description: 'Too Many Requests : used when a rate limiter has triggered.' + content: + application/json: + schema: + type: object + properties: + problemDetails: + $ref: '#/components/schemas/ProblemDetails' + parameters: + Path.subscrId: + name: subscriptionId + in: path + description: 'Subscription Id, specifically the "self" returned in the subscription request' + required: true + schema: + type: string + format: uri + 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 + 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 + 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 + 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: + type: string + Query.ExcludeDefault: + name: exclude_default + in: query + description: 'Indicates to exclude the following complex attributes from the response. See clause 6.18 of ETSI GS MEC 009 for details. + The following attributes shall be excluded from the structure in the response body if this parameter is provided, or none of the parameters + "all_fields", "fields", "exclude_fields", "exclude_default" are provided: Not applicable' + required: false + schema: + type: array + items: + type: string + Query.SubscriptionType: + name: subscription_type + in: query + description: 'Filter on a specific subscription type. Permitted values: assoc_sta, sta_data_rate.' + required: false + schema: + type: string + schemas: + ApAssociated: + properties: + assocId: + description: Unique number which identifies a particular association between + the station and Access Point. + type: string + x-etsi-mec-cardinality: 0..1 + x-etsi-mec-origin-type: string + ipAddress: + description: IPv4 or IPv6 address allocated for the Access Point. + items: + type: string + minItems: 0 + type: array + x-etsi-mec-cardinality: 0..N + x-etsi-mec-origin-type: string + macId: + description: Unique identifier assigned to the Access Point (as network + interface controller) for communications at the data link layer of a network + segment. + type: string + x-etsi-mec-cardinality: '1' + x-etsi-mec-origin-type: string + ssid: + description: Service Set Identifier to identify logical networks. + items: + type: string + minItems: 0 + type: array + x-etsi-mec-cardinality: 0..N + x-etsi-mec-origin-type: String + required: + - macId + type: object + x-etsi-ref: 6.5.12 + ApIdentity: + properties: + ipAddress: + description: IPv4 or IPv6 address allocated for the Access Point. + items: + type: string + minItems: 0 + type: array + x-etsi-mec-cardinality: 0..N + x-etsi-mec-origin-type: String + macId: + description: Unique Identifier assigned to an Access Point (as network interface + controller) for communications at the data link layer of a network segment. + type: string + x-etsi-mec-cardinality: '1' + x-etsi-mec-origin-type: String + ssid: + description: Service Set Identifier to identify logical networks including + Basic Service Set and Extended Service Set. + items: + type: string + minItems: 0 + type: array + x-etsi-mec-cardinality: 0..N + x-etsi-mec-origin-type: String + required: + - macId + type: object + x-etsi-ref: 6.5.3 + ApInfo: + properties: + apId: + allOf: + - $ref: '#/components/schemas/ApIdentity' + - description: Identifier(s) to uniquely specify the Access Point whose information is exposed within this data type. + - x-etsi-mec-cardinality: '1' + - x-etsi-mec-origin-type: ApIdentity + apLocation: + allOf: + - $ref: '#/components/schemas/ApLocation' + - description: The location on the Access Point. + - x-etsi-mec-cardinality: 0..1 + - x-etsi-mec-origin-type: ApLocation + apNeighbor: + allOf: + - $ref: '#/components/schemas/NeighborReport' + - description: Information about neighbor Access Points. + - x-etsi-mec-cardinality: 0..1 + - x-etsi-mec-origin-type: NeighborReport + bssLoad: + allOf: + - $ref: '#/components/schemas/BssLoad' + - description: "BSS Load attribute contains information on the current STA\ + \ population and traffic levels in the BSS as defined in IEEE\_802.11-2016\ + \ [8]." + - x-etsi-mec-cardinality: 0..1 + - x-etsi-mec-origin-type: BssLoad + channel: + type: integer + format: uint32 + description: Channel configured for the Access Point. + x-etsi-mec-cardinality: 0..1 + x-etsi-mec-origin-type: Uint32 + extBssLoad: + allOf: + - $ref: '#/components/schemas/ExtBssLoad' + - description: 'Extended BSS Load attribute contains more detailed information + on the current STA population and traffic levels in the BSS as per ETSI + GS MEC 002 [i.4].' + - x-etsi-mec-cardinality: 0..1 + - x-etsi-mec-origin-type: ExtBssLoad + timeStamp: + allOf: + - $ref: '#/components/schemas/TimeStamp' + - description: Time stamp. + - x-etsi-mec-cardinality: 0..1 + - x-etsi-mec-origin-type: TimeStamp + wanMetrics: + allOf: + - $ref: '#/components/schemas/WanMetrics' + - description: "WAN Metrics element provides information about the WAN link\ + \ connecting an IEEE 802.11 Access Node and the Internet. Transmission\ + \ characteristics such as the speed of the WAN connection to the Internet\ + \ are included in Hotspot\_2.0 Technical Specification v1.0.0 [i.3]." + - x-etsi-mec-cardinality: 0..1 + - x-etsi-mec-origin-type: WanMetrics + wlanCap: + allOf: + - $ref: '#/components/schemas/WlanCapabilities' + - description: WLAN capabilities of Access Point. + - x-etsi-mec-cardinality: 0..1 + - x-etsi-mec-origin-type: WlanCapabilities + required: + - apId + type: object + x-etsi-ref: 6.2.2 + ApLocation: + properties: + civicLocation: + allOf: + - $ref: '#/components/schemas/CivicLocation' + - description: Civic Location of the AP as described in IETF RFC 4776 [7]. + - x-etsi-mec-cardinality: 0..1 + - x-etsi-mec-origin-type: CivicLocation + geolocation: + allOf: + - $ref: '#/components/schemas/GeoLocation' + - description: Geospatial Location of the AP as defined in IEEE 802.11-2016 [8]. + - x-etsi-mec-cardinality: 0..1 + - x-etsi-mec-origin-type: GeoLocation + type: object + x-etsi-ref: 6.5.9 + AssocStaNotification: + properties: + apId: + allOf: + - $ref: '#/components/schemas/ApIdentity' + - description: Identifier(s) to uniquely specify the Access Point to which the client stations are associated. + - x-etsi-mec-cardinality: '1' + - x-etsi-mec-origin-type: ApIdentity + notificationType: + description: Shall be set to "AssocStaNotification". + type: string + x-etsi-mec-cardinality: '1' + x-etsi-mec-origin-type: String + staId: + description: Identifier(s) to uniquely specify the client station(s) associated. + items: + $ref: '#/components/schemas/StaIdentity' + minItems: 0 + type: array + x-etsi-mec-cardinality: 0..N + x-etsi-mec-origin-type: StaIdentity + timeStamp: + allOf: + - $ref: '#/components/schemas/TimeStamp' + - description: Time stamp. + - x-etsi-mec-cardinality: 0..1 + - x-etsi-mec-origin-type: TimeStamp + required: + - notificationType + - apId + type: object + x-etsi-ref: 6.4.2 + AssocStaSubscription: + properties: + _links: + description: Hyperlink related to the resource. This shall be only included + in the HTTP responses and in HTTP PUT requests. + properties: + self: + allOf: + - $ref: '#/components/schemas/LinkType' + - description: URI referring to a resource + - x-etsi-mec-cardinality: 1 + - x-etsi-mec-origin-type: LinkType + type: object + x-etsi-mec-cardinality: 0..1 + x-etsi-mec-origin-type: Structure (inlined) + apId: + allOf: + - $ref: '#/components/schemas/ApIdentity' + - description: Identifier(s) to uniquely specify the target Access Point + for the subscription + - x-etsi-mec-cardinality: '1' + - x-etsi-mec-origin-type: ApIdentity + callbackReference: + description: URI selected by the service consumer to receive notifications + on the subscribed WLAN information. This shall be included both in the + request and in response. + format: uri + type: string + x-etsi-mec-cardinality: '1' + x-etsi-mec-origin-type: URI + expiryDeadline: + allOf: + - $ref: '#/components/schemas/TimeStamp' + - description: The expiration time of the subscription determined by the + WLAN Access Information Service. + - x-etsi-mec-cardinality: 0..1 + - x-etsi-mec-origin-type: TimeStamp + subscriptionType: + description: Shall be set to "AssocStaSubscription". + type: string + x-etsi-mec-cardinality: '1' + x-etsi-mec-origin-type: String + required: + - subscriptionType + - callbackReference + - apId + type: object + x-etsi-ref: 6.3.2 + AssociatedStations: + properties: + assocId: + description: Unique number which identifies a particular association between + an Access Point and a station. + type: string + x-etsi-mec-cardinality: 0..1 + x-etsi-mec-origin-type: string + ipAddress: + description: IPv4 or IPv6 address allocated for the station associated with + the Access Point. + items: + type: string + minItems: 0 + type: array + x-etsi-mec-cardinality: 0..N + x-etsi-mec-origin-type: string + macId: + description: Unique identifier assigned to a station (as network interface + controller) for communications at the data link layer of a network segment. + type: string + x-etsi-mec-cardinality: '1' + x-etsi-mec-origin-type: string + required: + - macId + type: object + x-etsi-ref: 6.5.5 + BeaconReport: + properties: + bssId: + description: The BSSID field indicates the BSSID of the BSS(s) for which + a beacon report has been received. + items: + type: string + minItems: 1 + type: array + x-etsi-mec-cardinality: 1..N + x-etsi-mec-origin-type: String + channelId: + description: Channel number where the beacon was received. + type: integer + x-etsi-mec-cardinality: '1' + x-etsi-mec-origin-type: Integer + measurementId: + description: Measurement ID of the Measurement configuration applied to + this Beacon Report. + type: string + x-etsi-mec-cardinality: '1' + x-etsi-mec-origin-type: String + reportingCondition: + description: As in table T9-89 of IEEE 802.11-2012 [8]. + type: integer + x-etsi-mec-cardinality: '1' + x-etsi-mec-origin-type: Integer + ssId: + description: (Optional) The SSID subelement indicates the ESS(s) or IBSS(s) + for which a beacon report is received. + items: + type: string + minItems: 1 + type: array + x-etsi-mec-cardinality: 1..N + x-etsi-mec-origin-type: String + staId: + allOf: + - $ref: '#/components/schemas/StaIdentity' + - description: Identifier to uniquely specify the station whose information is exposed within this data type. + - x-etsi-mec-cardinality: '1' + - x-etsi-mec-origin-type: StaIdentity + required: + - staId + - measurementId + - channelId + - bssId + - ssId + - reportingCondition + type: object + x-etsi-ref: 6.5.27 + BeaconRequestConfig: + properties: + bssId: + description: The BSSID field indicates the BSSID of the BSS(s) for which + a beacon report is requested. When requesting beacon reports for all BSSs + on the channel, the BSSID field contains the wildcard BSSID. + items: + type: string + minItems: 1 + type: array + x-etsi-mec-cardinality: 1..N + x-etsi-mec-origin-type: String + channelId: + description: Channel number to scan. A Channel Number of 0 indicates a request + to make iterative measurements for all supported channels in the Operating + Class where the measurement is permitted on the channel and the channel + is valid for the current regulatory domain. A Channel Number of 255 indicates + a request to make iterative measurements for all supported channels in + the current Operating Class listed in the latest AP Channel Report received + from the serving AP. + type: integer + x-etsi-mec-cardinality: '1' + x-etsi-mec-origin-type: Integer + measurementMode: + description: '0 for passive. + + 1 for active. + + 2 for beacon table.' + type: integer + x-etsi-mec-cardinality: '1' + x-etsi-mec-origin-type: Integer + reportingCondition: + description: As in table T9-89 of IEEE 802.11-2012 [8]. + type: integer + x-etsi-mec-cardinality: '1' + x-etsi-mec-origin-type: Integer + ssId: + description: (Optional) The SSID subelement indicates the ESS(s) or IBSS(s) + for which a beacon report is requested. + items: + type: string + minItems: 1 + type: array + x-etsi-mec-cardinality: 1..N + x-etsi-mec-origin-type: String + staId: + allOf: + - $ref: '#/components/schemas/StaIdentity' + - description: Identifier to uniquely specify the station whose information is exposed within this data type. + - x-etsi-mec-cardinality: '1' + - x-etsi-mec-origin-type: StaIdentity + required: + - staId + - channelId + - measurementMode + - bssId + - ssId + - reportingCondition + type: object + x-etsi-ref: 6.5.25 + BssLoad: + properties: + availAdmCap: + type: integer + description: Available Admission Capacity that specifies the remaining amount + of medium time available via explicit admission control, in units of 32 + s/s. + x-etsi-mec-cardinality: '1' + x-etsi-mec-origin-type: Uint16 + channelUtilization: + type: integer + description: "The percentage of time, linearly scaled with 255 representing\ + \ 100\_%, that the AP sensed the medium was busy, as indicated by either\ + \ the physical or virtual Carrier Sense (CS) mechanism." + x-etsi-mec-cardinality: '1' + x-etsi-mec-origin-type: UInt8 + staCount: + type: integer + description: An unsigned integer that indicates the total number of STAs + currently associated with this BSS. + x-etsi-mec-cardinality: '1' + x-etsi-mec-origin-type: UInt16 + required: + - staCount + - channelUtilization + - availAdmCap + type: object + x-etsi-ref: 6.5.7 + ChannelLoadConfig: + properties: + apId: + allOf: + - $ref: '#/components/schemas/ApIdentity' + - description: Identifier(s) to uniquely specify the target Access Point + - x-etsi-mec-cardinality: '1' + - x-etsi-mec-origin-type: ApIdentity + cChannelId: + description: Channel number which load is reported + type: integer + x-etsi-mec-cardinality: '1' + x-etsi-mec-origin-type: Integer + channelLoad: + description: Channel load as per IEEE 802.11-2012 [8], section 11.11.9.3 + type: integer + x-etsi-mec-cardinality: '1' + x-etsi-mec-origin-type: Integer + required: + - apId + - cChannelId + - channelLoad + type: object + x-etsi-ref: 6.5.24 + CivicLocation: + properties: + ca0: + description: Language + type: string + x-etsi-mec-cardinality: 0..1 + x-etsi-mec-origin-type: String + ca1: + description: 'National subdivisions (state, canton, region,province, prefecture) ' + type: string + x-etsi-mec-cardinality: 0..1 + x-etsi-mec-origin-type: String + ca128: + description: Script + type: string + x-etsi-mec-cardinality: 0..1 + x-etsi-mec-origin-type: String + ca16: + description: Leading street direction + type: string + x-etsi-mec-cardinality: 0..1 + x-etsi-mec-origin-type: String + ca17: + description: Trailing street suffix + type: string + x-etsi-mec-cardinality: 0..1 + x-etsi-mec-origin-type: String + ca18: + description: Street suffix or type + type: string + x-etsi-mec-cardinality: 0..1 + x-etsi-mec-origin-type: String + ca19: + description: House number + type: string + x-etsi-mec-cardinality: 0..1 + x-etsi-mec-origin-type: String + ca2: + description: County, parish, gun (JP), district (IN) + type: string + x-etsi-mec-cardinality: 0..1 + x-etsi-mec-origin-type: String + ca20: + description: House number suffix + type: string + x-etsi-mec-cardinality: 0..1 + x-etsi-mec-origin-type: String + ca21: + description: Landmark of vanity address + type: string + x-etsi-mec-cardinality: 0..1 + x-etsi-mec-origin-type: String + ca22: + description: Additional location information + type: string + x-etsi-mec-cardinality: 0..1 + x-etsi-mec-origin-type: String + ca23: + description: Name (residence and office occupant) + type: string + x-etsi-mec-cardinality: 0..1 + x-etsi-mec-origin-type: String + ca24: + description: Postal/zip code + type: string + x-etsi-mec-cardinality: 0..1 + x-etsi-mec-origin-type: String + ca25: + description: Building (structure) + type: string + x-etsi-mec-cardinality: 0..1 + x-etsi-mec-origin-type: String + ca26: + description: Unit (apartment/suite) + type: string + x-etsi-mec-cardinality: 0..1 + x-etsi-mec-origin-type: String + ca27: + description: Floor + type: string + x-etsi-mec-cardinality: 0..1 + x-etsi-mec-origin-type: String + ca28: + description: Room + type: string + x-etsi-mec-cardinality: 0..1 + x-etsi-mec-origin-type: String + ca29: + description: Type of place + type: string + x-etsi-mec-cardinality: 0..1 + x-etsi-mec-origin-type: String + ca3: + description: City, township, shi (JP) + type: string + x-etsi-mec-cardinality: 0..1 + x-etsi-mec-origin-type: String + ca30: + description: Postal community name + type: string + x-etsi-mec-cardinality: 0..1 + x-etsi-mec-origin-type: String + ca31: + description: Post office box + type: string + x-etsi-mec-cardinality: 0..1 + x-etsi-mec-origin-type: String + ca32: + description: Additional code + type: string + x-etsi-mec-cardinality: 0..1 + x-etsi-mec-origin-type: String + ca33: + description: Seat (desk.cubicle, workstation) + type: string + x-etsi-mec-cardinality: 0..1 + x-etsi-mec-origin-type: String + ca34: + description: Primary road name + type: string + x-etsi-mec-cardinality: 0..1 + x-etsi-mec-origin-type: String + ca35: + description: Road section + type: string + x-etsi-mec-cardinality: 0..1 + x-etsi-mec-origin-type: String + ca36: + description: Branch road name + type: string + x-etsi-mec-cardinality: 0..1 + x-etsi-mec-origin-type: String + ca37: + description: Sub-branch road name + type: string + x-etsi-mec-cardinality: 0..1 + x-etsi-mec-origin-type: String + ca38: + description: Street name pre-modifier + type: string + x-etsi-mec-cardinality: 0..1 + x-etsi-mec-origin-type: String + ca39: + description: Street name post-modifier + type: string + x-etsi-mec-cardinality: 0..1 + x-etsi-mec-origin-type: String + ca4: + description: City division, borough, city district, ward, chou (JP) + type: string + x-etsi-mec-cardinality: 0..1 + x-etsi-mec-origin-type: String + ca5: + description: Neighborhood, block + type: string + x-etsi-mec-cardinality: 0..1 + x-etsi-mec-origin-type: String + ca6: + description: 'Group of streets below the neighborhood level ' + type: string + x-etsi-mec-cardinality: 0..1 + x-etsi-mec-origin-type: String + country: + description: The two-letter ISO 3166 [i.9] country code in capital ASCII + letters, e.g. DE or US, as per ISO 3166 [i.9] + type: string + x-etsi-mec-cardinality: '1' + x-etsi-mec-origin-type: String + required: + - country + type: object + x-etsi-ref: 6.5.20 + DmgCapabilities: + properties: + ExtScMcsCap: + description: Extended SC MCS capabilities as defined in draft IEEE P802.11/D4.0 + [i.11] + type: integer + x-etsi-mec-cardinality: '1' + x-etsi-mec-origin-type: Uint8 + dmgApOrPcpCapInfo: + type: integer + description: DMG AP or PCP capabilities information as defined in draft + IEEE P802.11/D4.0 [i.11] + x-etsi-mec-cardinality: '1' + x-etsi-mec-origin-type: Uint16 + dmgStaBeamTrackTimeLimit: + type: integer + description: DMG station beam tracking time limit as defined in draft IEEE + P802.11/D4.0 [i.11] + x-etsi-mec-cardinality: '1' + x-etsi-mec-origin-type: Uint16 + dmgStaCapInfo: + type: integer + description: DMG station capabilities information as defined in draft IEEE + P802.11/D4.0 [i.11] + x-etsi-mec-cardinality: '1' + x-etsi-mec-origin-type: Uint64 + maxNrBasicAmsduSubframes: + description: Number of basic A-MSDU subframes in A-MSDU as defined in draft + IEEE P802.11/D4.0 [i.11] + type: integer + x-etsi-mec-cardinality: '1' + x-etsi-mec-origin-type: Uint8 + maxNrShortAmsduSubframes: + description: Number of short A-MSDU subframes in A-MSDU as defined in draft + IEEE P802.11/D4.0 [i.11] + type: integer + x-etsi-mec-cardinality: '1' + x-etsi-mec-origin-type: Uint8 + sarCap: + description: SAR capabilities as defined in draft IEEE P802.11/D4.0 [i.11] + type: integer + x-etsi-mec-cardinality: '1' + x-etsi-mec-origin-type: Uint8 + tddCap: + type: integer + description: TDD capabilities as defined in draft IEEE P802.11/D4.0 [i.11] + x-etsi-mec-cardinality: '1' + x-etsi-mec-origin-type: Uint16 + required: + - dmgStaCapInfo + - dmgApOrPcpCapInfo + - dmgStaBeamTrackTimeLimit + - ExtScMcsCap + - maxNrBasicAmsduSubframes + - maxNrShortAmsduSubframes + - tddCap + - sarCap + type: object + x-etsi-ref: 6.5.17 + EdmgCapabilities: + properties: + ampduParameters: + description: A-MPDU parameters as defined in draft IEEE P802.11/D4.0 [i.11] + type: integer + x-etsi-mec-cardinality: '1' + x-etsi-mec-origin-type: Uint8 + reserved: + description: '' + type: integer + x-etsi-mec-cardinality: 0..1 + x-etsi-mec-origin-type: Uint8 + supportedMcs: + type: integer + format: uint32 + description: Supported MCS as defined in draft IEEE P802.11/D4.0 [i.11] + x-etsi-mec-cardinality: '1' + x-etsi-mec-origin-type: Uint32 + trnParameters: + type: integer + description: Training parameters as defined in draft IEEE P802.11/D4.0 [i.11] + x-etsi-mec-cardinality: '1' + x-etsi-mec-origin-type: Uint16 + required: + - ampduParameters + - trnParameters + - supportedMcs + type: object + x-etsi-ref: 6.5.18 + ExtBssLoad: + properties: + muMimoStaCount: + type: integer + description: Indicates the total number of STAs currently associated with + this BSS that have a 1 in the MU Beamformee Capable field of their VHT + Capabilities element. + x-etsi-mec-cardinality: '1' + x-etsi-mec-origin-type: UInt16 + obsSec20MhzUtil: + description: Observable loading on each of the secondary 20 MHz channel. + type: integer + x-etsi-mec-cardinality: '1' + x-etsi-mec-origin-type: Uint8 + obsSec40MhzUtil: + description: Observable loading on each of the secondary 40 MHz channel. + type: integer + x-etsi-mec-cardinality: '1' + x-etsi-mec-origin-type: Uint8 + obsSec80MhzUtil: + description: Observable loading on each of the secondary 80 MHz channel. + type: integer + x-etsi-mec-cardinality: '1' + x-etsi-mec-origin-type: Uint8 + spatStreamUnderUtil: + type: integer + description: "The percentage of time, linearly scaled with 255 representing\ + \ 100\_%, that the AP has underutilized spatial domain resources for given\ + \ busy time of the medium." + x-etsi-mec-cardinality: '1' + x-etsi-mec-origin-type: UInt8 + required: + - muMimoStaCount + - spatStreamUnderUtil + - obsSec20MhzUtil + - obsSec40MhzUtil + - obsSec80MhzUtil + type: object + x-etsi-ref: 6.5.8 + GeoLocation: + properties: + altitude: + type: integer + format: uint32 + description: "The altitude value of location as defined in IETF RFC\_6225\ + \ [6]" + x-etsi-mec-cardinality: 0..1 + x-etsi-mec-origin-type: Uint32 + altitudeType: + description: The type description for altitude information e.g. floors or + meters as defined in IETF RFC 6225 [6] + type: integer + x-etsi-mec-cardinality: 0..1 + x-etsi-mec-origin-type: Uint8 + altitudeUncertainty: + description: The uncertainty for altitude information as defined in IETF + RFC 6225 [6] + type: integer + x-etsi-mec-cardinality: 0..1 + x-etsi-mec-origin-type: Uint8 + datum: + description: The datum value to express how coordinates are organized and + related to real world as defined in IETF RFC 6225 [6] + type: integer + x-etsi-mec-cardinality: '1' + x-etsi-mec-origin-type: Uint8 + lat: + type: integer + description: "The latitude value of location as defined in IETF RFC\_6225\ + \ [6]" + x-etsi-mec-cardinality: '1' + x-etsi-mec-origin-type: Uint64 + latUncertainty: + description: The uncertainty for Latitude information as defined in IETF + RFC 6225 [6] + type: integer + x-etsi-mec-cardinality: '1' + x-etsi-mec-origin-type: Uint8 + long: + type: integer + description: "The longitude value of location as defined in IETF RFC\_6225\ + \ [6]" + x-etsi-mec-cardinality: '1' + x-etsi-mec-origin-type: Uint64 + longUncertainty: + description: The uncertainty for Longitude information as defined in IETF + RFC 6225 [6] + type: integer + x-etsi-mec-cardinality: '1' + x-etsi-mec-origin-type: Uint8 + required: + - latUncertainty + - lat + - longUncertainty + - long + - datum + type: object + x-etsi-ref: 6.5.19 + HeCapabilities: + properties: + heMacCapInfo: + description: MAC capabilities of an Access Point. + type: integer + x-etsi-mec-cardinality: '1' + x-etsi-mec-origin-type: Uint8 + hePhyCapinfo: + description: PHY capabilities of an Access Point. + type: integer + x-etsi-mec-cardinality: '1' + x-etsi-mec-origin-type: Uint8 + ppeThresholds: + description: PPE Threshold determines the nominal packet padding value for + a HE PPDU. + type: integer + x-etsi-mec-cardinality: 0..1 + x-etsi-mec-origin-type: not defined + supportedHeMcsNssSet: + description: Supported MCS and NSS Set. + type: integer + x-etsi-mec-cardinality: '1' + x-etsi-mec-origin-type: Uint8 + required: + - heMacCapInfo + - hePhyCapinfo + - supportedHeMcsNssSet + type: object + x-etsi-ref: 6.5.16 + HtCapabilities: + properties: + ampduParameters: + type: integer + description: A-MPDU parameters as defined in IEEE 802.11-2016 [8]. + x-etsi-mec-cardinality: '1' + x-etsi-mec-origin-type: UInt8 + aselCap: + type: integer + description: ASEL capabilities as defined in IEEE 802.11-2016 [8]. + x-etsi-mec-cardinality: '1' + x-etsi-mec-origin-type: UInt8 + htCapabilityInfo: + type: integer + description: HT Capability Information as defined in IEEE 802.11-2016 [8]. + x-etsi-mec-cardinality: '1' + x-etsi-mec-origin-type: UInt16 + htExtendedCap: + type: integer + description: Extended HT Capabilities as defined in IEEE 802.11-2016 [8]. + x-etsi-mec-cardinality: '1' + x-etsi-mec-origin-type: UInt16 + supportedMcsSet: + type: integer + format: uint64 + description: Supported MCS set as defined in IEEE 802.11-2016 [8]. + x-etsi-mec-cardinality: '1' + x-etsi-mec-origin-type: Uint128 + txBeamFormCap: + type: integer + format: uint32 + description: Transmit Beamforming Capabilities as defined in IEEE 802.11-2016 + [8]. + x-etsi-mec-cardinality: '1' + x-etsi-mec-origin-type: UInt32 + required: + - htCapabilityInfo + - ampduParameters + - supportedMcsSet + - htExtendedCap + - txBeamFormCap + - aselCap + type: object + x-etsi-ref: 6.5.14 + LinkType: + properties: + href: + description: URI referring to a resource + type: string + x-etsi-mec-cardinality: '1' + x-etsi-mec-origin-type: String + required: + - href + type: object + x-etsi-ref: 6.5.23 + MeasurementConfig: + properties: + beaconRequest: + allOf: + - $ref: '#/components/schemas/BeaconRequestConfig' + - description: Configuration related to Beacon Request. + - x-etsi-mec-cardinality: 0..1 + - x-etsi-mec-origin-type: BeaconRequestConfig + channelLoad: + allOf: + - $ref: '#/components/schemas/ChannelLoadConfig' + - description: Configuration related to the Channel Load. + - x-etsi-mec-cardinality: 0..1 + - x-etsi-mec-origin-type: ChannelLoadConfig + measurementDuration: + description: Duration of the measurement, shall be lower than Maximum Measurement + Duration in TU as defined in section 11.11.4 of IEEE 802.11 [8]. + type: integer + x-etsi-mec-cardinality: '1' + x-etsi-mec-origin-type: Integer + measurementId: + description: Identifier of this measurement configuration. + type: string + x-etsi-mec-cardinality: '1' + x-etsi-mec-origin-type: String + randomnInterval: + description: "Random interval to be used for starting the measurement. In\ + \ units of TU as specifed in section\_11.11.3 of IEEE 802.11 [8]." + type: integer + x-etsi-mec-cardinality: '1' + x-etsi-mec-origin-type: Integer + staStatistics: + allOf: + - $ref: '#/components/schemas/StaStatisticsConfig' + - description: Configuration related to the statistics provided by STAs. + - x-etsi-mec-cardinality: 0..1 + - x-etsi-mec-origin-type: StaStatisticsConfig + required: + - measurementId + - measurementDuration + - randomnInterval + type: object + x-etsi-notes: "NOTE:\tThis element enables the configuration of the channelLoad,\ + \ beaconRequest and staStatistics in a single resource data type, although\ + \ only one of each measurement. Multiple measurement configurations of each\ + \ kind are not allowed." + x-etsi-ref: 6.2.4 + NeighborReport: + properties: + bssid: + description: BSS Id of the Access Point that is being reported. + type: string + x-etsi-mec-cardinality: '1' + x-etsi-mec-origin-type: String + bssidInfo: + description: Additional information related to Access Point that is being + reported such as AP reachability, security, key scope, Mobility Domain, + HT/VHT capability and Fine Time Measurements. + format: uint32 + type: integer + x-etsi-mec-cardinality: '1' + x-etsi-mec-origin-type: UInt32 + channel: + description: The channel currently used by this Access Point. + type: integer + x-etsi-mec-cardinality: '1' + x-etsi-mec-origin-type: Uint8 + operatingClass: + description: The channel set of the AP indicated by this BSSID. + type: integer + x-etsi-mec-cardinality: '1' + x-etsi-mec-origin-type: Uint8 + phyType: + description: PHY type of the AP indicated by this BSSID. It is an integer + value coded according to the value of the dot11PHYType. + type: integer + x-etsi-mec-cardinality: '1' + x-etsi-mec-origin-type: Uint8 + required: + - bssid + - bssidInfo + - operatingClass + - channel + - phyType + type: object + x-etsi-ref: 6.5.10 + ProblemDetails: + properties: + detail: + description: A human-readable explanation specific to this occurrence of + the problem + type: string + x-etsi-mec-cardinality: 0..1 + x-etsi-mec-origin-type: String + instance: + description: A URI reference that identifies the specific occurrence of + the problem + format: uri + type: string + x-etsi-mec-cardinality: 0..1 + x-etsi-mec-origin-type: URI + status: + description: The HTTP status code for this occurrence of the problem + format: uint32 + type: integer + x-etsi-mec-cardinality: 0..1 + x-etsi-mec-origin-type: Uint32 + title: + description: A short, human-readable summary of the problem type + type: string + x-etsi-mec-cardinality: 0..1 + x-etsi-mec-origin-type: String + type: + description: A URI reference according to IETF RFC 3986 that identifies + the problem type + format: uri + type: string + x-etsi-mec-cardinality: 0..1 + x-etsi-mec-origin-type: URI + type: object + Rssi: + properties: + rssi: + description: The Received Signal Strength Indicator from a station + type: integer + x-etsi-mec-cardinality: '1' + x-etsi-mec-origin-type: Uint8 + required: + - rssi + type: object + x-etsi-ref: 6.5.21 + StaDataRate: + properties: + staId: + allOf: + - $ref: '#/components/schemas/StaIdentity' + - description: Identifier(s) to uniquely specify the client station(s) associated. + - x-etsi-mec-cardinality: 0..1 + - x-etsi-mec-origin-type: StaIdentity + staLastDataDownlinkRate: + description: The data transmit rate in kbps that was most recently used + for transmission of data PPDUs from the access point to the station. + format: uint32 + type: integer + x-etsi-mec-cardinality: 0..1 + x-etsi-mec-origin-type: Uint32 + staLastDataUplinkRate: + description: The data transmit rate in Kbps that was most recently used + for transmission of data PPDUs from the associated station to the access + point. + format: uint32 + type: integer + x-etsi-mec-cardinality: 0..1 + x-etsi-mec-origin-type: Uint32 + type: object + x-etsi-ref: 6.5.22 + StaDataRateNotification: + properties: + notificationType: + description: Shall be set to "StaDataRateNotification". + type: string + x-etsi-mec-cardinality: '1' + x-etsi-mec-origin-type: String + staDataRate: + description: Data rates of a client station. + items: + $ref: '#/components/schemas/StaDataRate' + minItems: 0 + type: array + x-etsi-mec-cardinality: 0..N + x-etsi-mec-origin-type: StaDataRate + timeStamp: + allOf: + - $ref: '#/components/schemas/TimeStamp' + - description: Time stamp. + - x-etsi-mec-cardinality: 0..1 + - x-etsi-mec-origin-type: TimeStamp + required: + - notificationType + type: object + x-etsi-ref: 6.4.3 + StaDataRateSubscription: + properties: + _links: + description: Hyperlink related to the resource. This shall be only included + in the HTTP responses and in HTTP PUT requests. + properties: + self: + allOf: + - $ref: '#/components/schemas/LinkType' + - description: URI referring to a resource + - x-etsi-mec-cardinality: 1 + - x-etsi-mec-origin-type: LinkType + type: object + x-etsi-mec-cardinality: 0..1 + x-etsi-mec-origin-type: Structure (inlined) + callbackReference: + description: URI selected by the service consumer to receive notifications + on the subscribed WLAN Access Information Service. This shall be included + both in the request and in response. + format: uri + type: string + x-etsi-mec-cardinality: '1' + x-etsi-mec-origin-type: URI + expiryDeadline: + allOf: + - $ref: '#/components/schemas/TimeStamp' + - description: The expiration time of the subscription determined by the + WLAN Access Information Service. + - x-etsi-mec-cardinality: 0..1 + - x-etsi-mec-origin-type: TimeStamp + staId: + description: Identifier(s) to uniquely specify the target client station(s) + for the subscription + items: + $ref: '#/components/schemas/StaIdentity' + minItems: 1 + type: array + x-etsi-mec-cardinality: 1..N + x-etsi-mec-origin-type: StaIdentity + subscriptionType: + description: Shall be set to "StaDataRateSubscription". + type: string + x-etsi-mec-cardinality: '1' + x-etsi-mec-origin-type: String + required: + - subscriptionType + - callbackReference + - staId + type: object + x-etsi-ref: 6.3.3 + StaIdentity: + properties: + aid: + description: 'Number which identifies a particular association between a + station and an Access Point ' + type: string + x-etsi-mec-cardinality: 0..1 + x-etsi-mec-origin-type: String + ipAddress: + description: IPv4 or IPv6 address allocated for the station. + items: + type: string + minItems: 0 + type: array + x-etsi-mec-cardinality: 0..N + x-etsi-mec-origin-type: String + macId: + description: Unique identifier assigned to station (as network interface + controller) for communications at the data link layer of a network segment. + type: string + x-etsi-mec-cardinality: '1' + x-etsi-mec-origin-type: String + ssid: + description: Service Set Identifier to identify logical networks. + items: + type: string + minItems: 0 + type: array + x-etsi-mec-cardinality: 0..N + x-etsi-mec-origin-type: String + required: + - macId + type: object + x-etsi-ref: 6.5.11 + StaInfo: + properties: + apAssociated: + allOf: + - $ref: '#/components/schemas/ApAssociated' + - description: Information about the Access Point that this Client Station is associated to. + - x-etsi-mec-cardinality: 0..1 + - x-etsi-mec-origin-type: ApAssociated + beaconReport: + allOf: + - $ref: '#/components/schemas/BeaconReport' + - description: Beacon Report as defined in Wi-Fi Agile Multiband Specification [9]. + - x-etsi-mec-cardinality: 0..1 + - x-etsi-mec-origin-type: BeaconReport + channel: + type: integer + format: uint32 + description: Channel currently used by the station. + x-etsi-mec-cardinality: 0..1 + x-etsi-mec-origin-type: Uint32 + rssi: + allOf: + - $ref: '#/components/schemas/Rssi' + - description: Receive Signal Strength Indicator. + - x-etsi-mec-cardinality: 0..1 + - x-etsi-mec-origin-type: Rssi + staDataRate: + allOf: + - $ref: '#/components/schemas/StaDataRate' + - description: Station Data Rate as defined in IEEE 802.11-2016 [8]. + - x-etsi-mec-cardinality: 0..1 + - x-etsi-mec-origin-type: StaDataRate + staId: + allOf: + - $ref: '#/components/schemas/StaIdentity' + - description: 0 to N identifiers to uniquely specify the station whose information is exposed within this data type. + - x-etsi-mec-cardinality: '1' + - x-etsi-mec-origin-type: StaIdentity + staStatistics: + allOf: + - $ref: '#/components/schemas/StaStatistics' + - description: Statistics as defined in IEEE 802.11-2016 [8] for the client station collected over measurement duration. + - x-etsi-mec-cardinality: 0..1 + - x-etsi-mec-origin-type: StaStatistics + timeStamp: + allOf: + - $ref: '#/components/schemas/TimeStamp' + - description: Time stamp. + - x-etsi-mec-cardinality: 0..1 + - x-etsi-mec-origin-type: TimeStamp + required: + - staId + type: object + x-etsi-ref: 6.2.3 + StaStatistics: + properties: + groupIdentity: + description: Indicates the requested statistics group describing the Statistics + Group Data according to table 9-114 of IEEE 802.11-2016 [8]. + type: integer + x-etsi-mec-cardinality: '1' + x-etsi-mec-origin-type: UInt8 + md: + description: Measurement Duration. + type: integer + x-etsi-mec-cardinality: '1' + x-etsi-mec-origin-type: UInt16 + statisticsGroupData: + allOf: + - $ref: '#/components/schemas/StatisticsGroupData' + - description: "Statistics Group Data as defined in Annex C of IEEE 802.112016\_\ [8]." + - x-etsi-mec-cardinality: '1' + - x-etsi-mec-origin-type: not specified + required: + - md + - groupIdentity + - statisticsGroupData + type: object + x-etsi-ref: 6.5.13 + StaStatisticsConfig: + properties: + groupIdentity: + description: As per table T 9-114 of IEEE 802.11-2012 [8]. + type: integer + x-etsi-mec-cardinality: '1' + x-etsi-mec-origin-type: Integer + staId: + allOf: + - $ref: '#/components/schemas/StaIdentity' + - description: Identifier to uniquely specify the station whose information is exposed within this data type. + - x-etsi-mec-cardinality: '1' + - x-etsi-mec-origin-type: StaIdentity + triggerCondition: + type: integer + description: As per Figure 9-161 of IEEE 802.11. This bitmap defines what + are the metrics returned by the STA Statistics Report. + x-etsi-mec-cardinality: '1' + x-etsi-mec-origin-type: 16bits bitmap + triggerTimeout: + description: The Trigger Timeout field contains a value in units of 100 + TUs during which a measuring STA does not generate further triggered STA + Statistics Reports after a trigger condition has been met. + type: integer + x-etsi-mec-cardinality: '1' + x-etsi-mec-origin-type: Integer + triggeredReport: + type: boolean + description: Yes, use triggered report. + x-etsi-mec-cardinality: '1' + x-etsi-mec-origin-type: Bool + required: + - staId + - groupIdentity + - triggeredReport + - triggerTimeout + - triggerCondition + type: object + x-etsi-ref: 6.5.26 + StatisticsGroupData: + properties: + dot11AMPDUDelimiterCRCErrorCount: + format: uint32 + type: integer + x-etsi-mec-cardinality: 0..1 + x-etsi-mec-origin-type: Uint32 + dot11AMPDUReceivedCount: + format: uint32 + type: integer + x-etsi-mec-cardinality: 0..1 + x-etsi-mec-origin-type: Uint32 + dot11AMSDUAckFailureCount: + format: uint32 + type: integer + x-etsi-mec-cardinality: 0..1 + x-etsi-mec-origin-type: Uint32 + dot11AckFailureCount: + format: uint32 + type: integer + x-etsi-mec-cardinality: 0..1 + x-etsi-mec-origin-type: Uint32 + dot11BeamformingFrameCount: + format: uint32 + type: integer + x-etsi-mec-cardinality: 0..1 + x-etsi-mec-origin-type: Uint32 + dot11ChannelWidthSwitchCount: + format: uint32 + type: integer + x-etsi-mec-cardinality: 0..1 + x-etsi-mec-origin-type: Uint32 + dot11DualCTSFailureCount: + format: uint32 + type: integer + x-etsi-mec-cardinality: 0..1 + x-etsi-mec-origin-type: Uint32 + dot11DualCTSSuccessCount: + format: uint32 + type: integer + x-etsi-mec-cardinality: 0..1 + x-etsi-mec-origin-type: Uint32 + dot11ExplicitBARFailureCount: + format: uint32 + type: integer + x-etsi-mec-cardinality: 0..1 + x-etsi-mec-origin-type: Uint32 + dot11FCSErrorCount: + format: uint32 + type: integer + x-etsi-mec-cardinality: 0..1 + x-etsi-mec-origin-type: Uint32 + dot11FailedAMSDUCount: + format: uint32 + type: integer + x-etsi-mec-cardinality: 0..1 + x-etsi-mec-origin-type: Uint32 + dot11FailedCount: + format: uint32 + type: integer + x-etsi-mec-cardinality: 0..1 + x-etsi-mec-origin-type: Uint32 + dot11FortyMHzFrameReceivedCount: + format: uint32 + type: integer + x-etsi-mec-cardinality: 0..1 + x-etsi-mec-origin-type: Uint32 + dot11FortyMHzFrameTransmittedCount: + format: uint32 + type: integer + x-etsi-mec-cardinality: 0..1 + x-etsi-mec-origin-type: Uint32 + dot11FrameDuplicateCount: + format: uint32 + type: integer + x-etsi-mec-cardinality: 0..1 + x-etsi-mec-origin-type: Uint32 + dot11GrantedRDGUnusedCount: + format: uint32 + type: integer + x-etsi-mec-cardinality: 0..1 + x-etsi-mec-origin-type: Uint32 + dot11GrantedRDGUsedCount: + format: uint32 + type: integer + x-etsi-mec-cardinality: 0..1 + x-etsi-mec-origin-type: Uint32 + dot11GroupReceivedFrameCount: + format: uint32 + type: integer + x-etsi-mec-cardinality: 0..1 + x-etsi-mec-origin-type: Uint32 + dot11GroupTransmittedFrameCount: + format: uint32 + type: integer + x-etsi-mec-cardinality: 0..1 + x-etsi-mec-origin-type: Uint32 + dot11ImplicitBARFailureCount: + format: uint32 + type: integer + x-etsi-mec-cardinality: 0..1 + x-etsi-mec-origin-type: Uint32 + dot11MPDUInReceivedAMPDUCount: + format: uint32 + type: integer + x-etsi-mec-cardinality: 0..1 + x-etsi-mec-origin-type: Uint32 + dot11MultipleRetryAMSDUCount: + format: uint32 + type: integer + x-etsi-mec-cardinality: 0..1 + x-etsi-mec-origin-type: Uint32 + dot11MultipleRetryCount: + format: uint32 + type: integer + x-etsi-mec-cardinality: 0..1 + x-etsi-mec-origin-type: Uint32 + dot11PSMPUTTGrantDuration: + format: uint32 + type: integer + x-etsi-mec-cardinality: 0..1 + x-etsi-mec-origin-type: Uint32 + dot11PSMPUTTUsedDuration: + format: uint32 + type: integer + x-etsi-mec-cardinality: 0..1 + x-etsi-mec-origin-type: Uint32 + dot11QosAckFailureCount: + format: uint32 + type: integer + x-etsi-mec-cardinality: 0..1 + x-etsi-mec-origin-type: Uint32 + dot11QosDiscardedFrameCount: + format: uint32 + type: integer + x-etsi-mec-cardinality: 0..1 + x-etsi-mec-origin-type: Uint32 + dot11QosFailedCount: + format: uint32 + type: integer + x-etsi-mec-cardinality: 0..1 + x-etsi-mec-origin-type: Uint32 + dot11QosFrameDuplicateCount: + format: uint32 + type: integer + x-etsi-mec-cardinality: 0..1 + x-etsi-mec-origin-type: Uint32 + dot11QosMPDUsReceivedCount: + format: uint32 + type: integer + x-etsi-mec-cardinality: 0..1 + x-etsi-mec-origin-type: Uint32 + dot11QosMultipleRetryCount: + format: uint32 + type: integer + x-etsi-mec-cardinality: 0..1 + x-etsi-mec-origin-type: Uint32 + dot11QosRTSFailureCount: + format: uint32 + type: integer + x-etsi-mec-cardinality: 0..1 + x-etsi-mec-origin-type: Uint32 + dot11QosRTSSuccessCount: + format: uint32 + type: integer + x-etsi-mec-cardinality: 0..1 + x-etsi-mec-origin-type: Uint32 + dot11QosReceivedFragmentCount: + format: uint32 + type: integer + x-etsi-mec-cardinality: 0..1 + x-etsi-mec-origin-type: Uint32 + dot11QosRetriesReceivedCount: + format: uint32 + type: integer + x-etsi-mec-cardinality: 0..1 + x-etsi-mec-origin-type: Uint32 + dot11QosRetryCount: + format: uint32 + type: integer + x-etsi-mec-cardinality: 0..1 + x-etsi-mec-origin-type: Uint32 + dot11QosTransmittedFragmentCount: + format: uint32 + type: integer + x-etsi-mec-cardinality: 0..1 + x-etsi-mec-origin-type: Uint32 + dot11QosTransmittedFrameCount: + format: uint32 + type: integer + x-etsi-mec-cardinality: 0..1 + x-etsi-mec-origin-type: Uint32 + dot11RSNAStatsBIPMICErrors: + format: uint32 + type: integer + x-etsi-mec-cardinality: 0..1 + x-etsi-mec-origin-type: Uint32 + dot11RSNAStatsCCMPDecryptErrors: + format: uint32 + type: integer + x-etsi-mec-cardinality: 0..1 + x-etsi-mec-origin-type: Uint32 + dot11RSNAStatsCCMPReplays: + format: uint32 + type: integer + x-etsi-mec-cardinality: 0..1 + x-etsi-mec-origin-type: Uint32 + dot11RSNAStatsCMACReplays: + format: uint32 + type: integer + x-etsi-mec-cardinality: 0..1 + x-etsi-mec-origin-type: Uint32 + dot11RSNAStatsRobustMgmtCCMPReplays: + format: uint32 + type: integer + x-etsi-mec-cardinality: 0..1 + x-etsi-mec-origin-type: Uint32 + dot11RSNAStatsTKIPICVErrors: + format: uint32 + type: integer + x-etsi-mec-cardinality: 0..1 + x-etsi-mec-origin-type: Uint32 + dot11RSNAStatsTKIPReplays: + format: uint32 + type: integer + x-etsi-mec-cardinality: 0..1 + x-etsi-mec-origin-type: Uint32 + dot11RTSFailureCount: + format: uint32 + type: integer + x-etsi-mec-cardinality: 0..1 + x-etsi-mec-origin-type: Uint32 + dot11RTSLSIGFailureCount: + format: uint32 + type: integer + x-etsi-mec-cardinality: 0..1 + x-etsi-mec-origin-type: Uint32 + dot11RTSLSIGSuccessCount: + format: uint32 + type: integer + x-etsi-mec-cardinality: 0..1 + x-etsi-mec-origin-type: Uint32 + dot11RTSSuccessCount: + format: uint32 + type: integer + x-etsi-mec-cardinality: 0..1 + x-etsi-mec-origin-type: Uint32 + dot11ReceivedAMSDUCount: + format: uint32 + type: integer + x-etsi-mec-cardinality: 0..1 + x-etsi-mec-origin-type: Uint32 + dot11ReceivedFragmentCount: + format: uint32 + type: integer + x-etsi-mec-cardinality: 0..1 + x-etsi-mec-origin-type: Uint32 + dot11ReceivedOctetsInAMPDUCount: + format: uint64 + type: integer + x-etsi-mec-cardinality: 0..1 + x-etsi-mec-origin-type: Uint64 + dot11ReceivedOctetsInAMSDUCount: + format: uint64 + type: integer + x-etsi-mec-cardinality: 0..1 + x-etsi-mec-origin-type: Uint64 + dot11RetryAMSDUCount: + format: uint32 + type: integer + x-etsi-mec-cardinality: 0..1 + x-etsi-mec-origin-type: Uint32 + dot11RetryCount: + format: uint32 + type: integer + x-etsi-mec-cardinality: 0..1 + x-etsi-mec-origin-type: Uint32 + dot11STAStatisticsAPAverageAccessDelay: + type: integer + x-etsi-mec-cardinality: 0..1 + x-etsi-mec-origin-type: Uint8 + dot11STAStatisticsAverageAccessDelayBackGround: + type: integer + x-etsi-mec-cardinality: 0..1 + x-etsi-mec-origin-type: Uint8 + dot11STAStatisticsAverageAccessDelayBestEffort: + type: integer + x-etsi-mec-cardinality: 0..1 + x-etsi-mec-origin-type: Uint8 + dot11STAStatisticsAverageAccessDelayVideo: + type: integer + x-etsi-mec-cardinality: 0..1 + x-etsi-mec-origin-type: Uint8 + dot11STAStatisticsAverageAccessDelayVoice: + type: integer + x-etsi-mec-cardinality: 0..1 + x-etsi-mec-origin-type: Uint8 + dot11STAStatisticsChannelUtilization: + type: integer + x-etsi-mec-cardinality: 0..1 + x-etsi-mec-origin-type: Uint8 + dot11STAStatisticsStationCount: + type: integer + x-etsi-mec-cardinality: 0..1 + x-etsi-mec-origin-type: Uint8 + dot11STBCCTSFailureCount: + format: uint32 + type: integer + x-etsi-mec-cardinality: 0..1 + x-etsi-mec-origin-type: Uint32 + dot11STBCCTSSuccessCount: + format: uint32 + type: integer + x-etsi-mec-cardinality: 0..1 + x-etsi-mec-origin-type: Uint32 + dot11TransmittedAMPDUCount: + format: uint32 + type: integer + x-etsi-mec-cardinality: 0..1 + x-etsi-mec-origin-type: Uint32 + dot11TransmittedAMSDUCount: + format: uint32 + type: integer + x-etsi-mec-cardinality: 0..1 + x-etsi-mec-origin-type: Uint32 + dot11TransmittedFragmentCount: + format: uint32 + type: integer + x-etsi-mec-cardinality: 0..1 + x-etsi-mec-origin-type: Uint32 + dot11TransmittedFrameCount: + format: uint32 + type: integer + x-etsi-mec-cardinality: 0..1 + x-etsi-mec-origin-type: Uint32 + dot11TransmittedFramesInGrantedRDGCount: + format: uint32 + type: integer + x-etsi-mec-cardinality: 0..1 + x-etsi-mec-origin-type: Uint32 + dot11TransmittedMPDUsInAMPDUCount: + format: uint32 + type: integer + x-etsi-mec-cardinality: 0..1 + x-etsi-mec-origin-type: Uint32 + dot11TransmittedOctetsInAMPDUCount: + format: uint64 + type: integer + x-etsi-mec-cardinality: 0..1 + x-etsi-mec-origin-type: Uint64 + dot11TransmittedOctetsInAMSDUCount: + format: uint64 + type: integer + x-etsi-mec-cardinality: 0..1 + x-etsi-mec-origin-type: Uint32 + dot11TransmittedOctetsInGrantedRDGCount: + format: uint32 + type: integer + x-etsi-mec-cardinality: 0..1 + x-etsi-mec-origin-type: Uint32 + dot11TwentyMHzFrameReceivedCount: + format: uint32 + type: integer + x-etsi-mec-cardinality: 0..1 + x-etsi-mec-origin-type: Uint32 + dot11TwentyMHzFrameTransmittedCount: + format: uint32 + type: integer + x-etsi-mec-cardinality: 0..1 + x-etsi-mec-origin-type: Uint32 + dot11nonSTBCCTSFailureCount: + format: uint32 + type: integer + x-etsi-mec-cardinality: 0..1 + x-etsi-mec-origin-type: Uint32 + dot11nonSTBCCTSSuccessCount: + format: uint32 + type: integer + x-etsi-mec-cardinality: 0..1 + x-etsi-mec-origin-type: Uint32 + type: object + SubscriptionLinkList: + properties: + _links: + description: Hyperlink related to the resource. This shall be only included + in the HTTP responses and in HTTP PUT requests. + properties: + self: + allOf: + - $ref: '#/components/schemas/LinkType' + - description: URI referring to a resource + - x-etsi-mec-cardinality: 1 + - x-etsi-mec-origin-type: LinkType + type: object + x-etsi-mec-cardinality: 0..1 + x-etsi-mec-origin-type: Structure (inlined) + assocStaSubscription: + items: + $ref: '#/components/schemas/AssocStaSubscription' + type: array + x-etsi-mec-cardinality: 0..N + x-etsi-mec-origin-type: AssocStaSubscription + staDataRateSubscription: + items: + $ref: '#/components/schemas/StaDataRateSubscription' + type: array + x-etsi-mec-cardinality: 0..N + x-etsi-mec-origin-type: StaDataRateSubscription + required: + - _links + type: object + TimeStamp: + properties: + nanoSeconds: + type: integer + format: uint32 + description: The nanoseconds part of the time. Time is defined as Unix-time + since January 1, 1970, 00:00:00 UTC. + x-etsi-mec-cardinality: '1' + x-etsi-mec-origin-type: Uint32 + seconds: + type: integer + format: uint32 + description: The seconds part of the time. Time is defined as Unixtime since + January 1, 1970, 00:00:00 UTC. + x-etsi-mec-cardinality: '1' + x-etsi-mec-origin-type: Uint32 + required: + - seconds + - nanoSeconds + type: object + x-etsi-ref: 6.5.2 + VhtCapabilities: + properties: + vhtCapInfo: + type: integer + format: uint32 + description: VHT capabilities Info as defined in IEEE 802.11-2016 [8]. + x-etsi-mec-cardinality: '1' + x-etsi-mec-origin-type: UInt32 + vhtMcsNss: + type: integer + description: Supported VHT-MCS and NSS Set as defined in IEEE 802.11-2016 + [8]. + x-etsi-mec-cardinality: '1' + x-etsi-mec-origin-type: UInt64 + required: + - vhtCapInfo + - vhtMcsNss + type: object + x-etsi-ref: 6.5.15 + WanMetrics: + properties: + downlinkLoad: + type: integer + description: 1-octet positive integer representing the current percentage + loading of the downlink WAN connection, scaled linearly with 255 representing + 100 %, as measured over an interval the duration of which is reported + in Load Measurement Duration. In cases where the downlink load is unknown + to the AP, the value is set to zero. + x-etsi-mec-cardinality: '1' + x-etsi-mec-origin-type: UInt8 + downlinkSpeed: + type: integer + format: uint32 + description: 4-octet positive integer whose value is an estimate of the + WAN Backhaul link current downlink speed in kilobits per second. + x-etsi-mec-cardinality: '1' + x-etsi-mec-origin-type: Uint32 + lmd: + type: integer + description: The LMD (Load Measurement Duration) field is a 2-octet positive + integer representing the duration over which the Downlink Load and Uplink + Load have been measured, in tenths of a second. When the actual load measurement + duration is greater than the maximum value, the maximum value will be + reported. The value of the LMD field is set to 0 when neither the uplink + nor downlink load can be computed. When the uplink and downlink loads + are computed over different intervals, the maximum interval is reported. + x-etsi-mec-cardinality: '1' + x-etsi-mec-origin-type: Uint16 + uplinkLoad: + description: 1-octet positive integer representing the current percentage + loading of the uplink WAN connection, scaled linearly with 255 representing + 100 %, as measured over an interval, the duration of which is reported + in Load Measurement Duration. In cases where the uplink load is unknown + to the AP, the value is set to zero. + type: integer + x-etsi-mec-cardinality: '1' + x-etsi-mec-origin-type: Uint8 + uplinkSpeed: + type: integer + format: uint32 + description: 4-octet positive integer whose value is an estimate of the + WAN Backhaul link's current uplink speed in kilobits per second. + x-etsi-mec-cardinality: '1' + x-etsi-mec-origin-type: UInt32 + wanInfo: + description: Info about WAN link status, link symmetricity and capacity + currently used. + type: integer + x-etsi-mec-cardinality: '1' + x-etsi-mec-origin-type: Uint8 + required: + - wanInfo + - downlinkSpeed + - uplinkSpeed + - downlinkLoad + - uplinkLoad + - lmd + type: object + x-etsi-ref: 6.5.6 + WlanCapabilities: + properties: + dmg: + allOf: + - $ref: '#/components/schemas/DmgCapabilities' + - description: Information about Access Point DMG capabilities as defined in IEEE 802.11-2016 [8]. + - x-etsi-mec-cardinality: 0..1 + - x-etsi-mec-origin-type: DmgCapabilities + edmg: + allOf: + - $ref: '#/components/schemas/EdmgCapabilities' + - description: Information about Access Point EDMG capabilities as defined in draft IEEE P802.11/D4.0 [i.11]. + - x-etsi-mec-cardinality: 0..1 + - x-etsi-mec-origin-type: EdmgCapabilities + he: + allOf: + - $ref: '#/components/schemas/HeCapabilities' + - description: Information about Access Point HE capabilities as defined in FFS. + - x-etsi-mec-cardinality: 0..1 + - x-etsi-mec-origin-type: HeCapabilities + ht: + allOf: + - $ref: '#/components/schemas/HtCapabilities' + - description: "Information about Access Point HT capabilities as defined\ + \ in IEEE\_802.11-2016 [8]." + - x-etsi-mec-cardinality: 0..1 + - x-etsi-mec-origin-type: HtCapabilities + vht: + allOf: + - $ref: '#/components/schemas/VhtCapabilities' + - description: Information about Access Point VHT capabilities as defined in IEEE 802.11-2016 [8]. + - x-etsi-mec-cardinality: 0..1 + - x-etsi-mec-origin-type: VhtCapabilities + type: object + x-etsi-ref: 6.5.4 -- GitLab From a6373bd611a28e865996d6413b09fa7633f35d2d Mon Sep 17 00:00:00 2001 From: Michele Carignani Date: Mon, 26 Oct 2020 18:17:44 +0100 Subject: [PATCH 2/8] update ci to oas 3 --- .jenkins.sh | 18 ++++++++++++++++++ 1 file changed, 18 insertions(+) create mode 100644 .jenkins.sh diff --git a/.jenkins.sh b/.jenkins.sh new file mode 100644 index 0000000..74d0370 --- /dev/null +++ b/.jenkins.sh @@ -0,0 +1,18 @@ +#!/bin/bash + +specfiles=$(ls | egrep "^[^.]*.(json|yaml)") + +fres=0 +for i in $specfiles ; do + echo "-- Validating and linting OpenAPI file $i..." + swagger-cli validate $i + res=$? + speccy lint "$i" + res2=$? + fres=$(($fres||$res||$res2)) + echo "--- Validator returned $res, linter returned $res2." +done + +echo "-- Final validator returns $fres." +exit $fres + -- GitLab From 6c6f29a00f95311a3226b3fb5e702484c526414a Mon Sep 17 00:00:00 2001 From: Michel Roy Date: Fri, 6 Nov 2020 02:10:33 -0500 Subject: [PATCH 3/8] review update --- WlanInformationApi.json | 911 ++------ WlanInformationApi.yaml | 4580 +++++++++++++++++++-------------------- 2 files changed, 2457 insertions(+), 3034 deletions(-) diff --git a/WlanInformationApi.json b/WlanInformationApi.json index c850514..b0e3263 100644 --- a/WlanInformationApi.json +++ b/WlanInformationApi.json @@ -1,6 +1,9 @@ { "openapi": "3.0.0", "info": { + "contact": { + "url": "https://forge.etsi.org/rep/mec/gs028-wai-api" + }, "title": "ETSI GS MEC 028 - WLAN Access Information API", "version": "2.1.1", "description": "The ETSI MEC ISG MEC028 WLAN Access Information API described using OpenAPI", @@ -15,14 +18,19 @@ }, "servers": [ { - "url": "https://{apiRoot}/wai/v2" + "url": "https://localhost/wai/v2" + } + ], + "tags": [ + { + "name": "wai" } ], "paths": { "/queries/ap/ap_information": { "get": { "tags": [ - "" + "wai" ], "summary": "Retrieve information on existing Access Points", "description": "Queries information about existing WLAN Access Points", @@ -87,7 +95,7 @@ "/queries/sta/sta_information": { "get": { "tags": [ - "" + "wai" ], "summary": "Retrieve information on existing Stations", "description": "Queries information about existing WLAN stations", @@ -149,10 +157,10 @@ } } }, - "/subscriptions/": { + "/subscriptions": { "get": { "tags": [ - "" + "wai" ], "summary": "Retrieve information on subscriptions for notifications", "description": "Queries information on subscriptions for notifications", @@ -223,7 +231,7 @@ }, "post": { "tags": [ - "" + "wai" ], "summary": "Create a new subscription", "description": "Creates a new subscription to WLAN Access Information notifications", @@ -410,7 +418,7 @@ "/subscriptions/{subscriptionId}": { "get": { "tags": [ - "" + "wai" ], "summary": "Retrieve information on current specific subscription", "description": "Queries information about an existing subscription, identified by its self-referring URI returned on creation (initial POST)", @@ -491,7 +499,7 @@ }, "put": { "tags": [ - "" + "wai" ], "summary": "Modify an existing subscription", "description": "Updates an existing subscription, identified by its self-referring URI returned on creation (initial POST)", @@ -614,7 +622,7 @@ }, "delete": { "tags": [ - "" + "wai" ], "summary": "Cancel an existing subscription", "description": "Cancels an existing subscription, identified by its self-referring URI returned on creation (initial POST)", @@ -957,139 +965,35 @@ "ApInfo": { "properties": { "apId": { - "allOf": [ - { - "$ref": "#/components/schemas/ApIdentity" - }, - { - "description": "Identifier(s) to uniquely specify the Access Point whose information is exposed within this data type." - }, - { - "x-etsi-mec-cardinality": "1" - }, - { - "x-etsi-mec-origin-type": "ApIdentity" - } - ] + "$ref": "#/components/schemas/ApIdentity" }, "apLocation": { - "allOf": [ - { - "$ref": "#/components/schemas/ApLocation" - }, - { - "description": "The location on the Access Point." - }, - { - "x-etsi-mec-cardinality": "0..1" - }, - { - "x-etsi-mec-origin-type": "ApLocation" - } - ] + "$ref": "#/components/schemas/ApLocation" }, "apNeighbor": { - "allOf": [ - { - "$ref": "#/components/schemas/NeighborReport" - }, - { - "description": "Information about neighbor Access Points." - }, - { - "x-etsi-mec-cardinality": "0..1" - }, - { - "x-etsi-mec-origin-type": "NeighborReport" - } - ] + "$ref": "#/components/schemas/NeighborReport" }, "bssLoad": { - "allOf": [ - { - "$ref": "#/components/schemas/BssLoad" - }, - { - "description": "BSS Load attribute contains information on the current STA population and traffic levels in the BSS as defined in IEEE 802.11-2016 [8]." - }, - { - "x-etsi-mec-cardinality": "0..1" - }, - { - "x-etsi-mec-origin-type": "BssLoad" - } - ] + "$ref": "#/components/schemas/BssLoad" }, "channel": { - "type": "integer", - "format": "uint32", "description": "Channel configured for the Access Point.", + "format": "int32", + "type": "integer", "x-etsi-mec-cardinality": "0..1", "x-etsi-mec-origin-type": "Uint32" }, "extBssLoad": { - "allOf": [ - { - "$ref": "#/components/schemas/ExtBssLoad" - }, - { - "description": "Extended BSS Load attribute contains more detailed information on the current STA population and traffic levels in the BSS as per ETSI GS MEC 002 [i.4]." - }, - { - "x-etsi-mec-cardinality": "0..1" - }, - { - "x-etsi-mec-origin-type": "ExtBssLoad" - } - ] + "$ref": "#/components/schemas/ExtBssLoad" }, "timeStamp": { - "allOf": [ - { - "$ref": "#/components/schemas/TimeStamp" - }, - { - "description": "Time stamp." - }, - { - "x-etsi-mec-cardinality": "0..1" - }, - { - "x-etsi-mec-origin-type": "TimeStamp" - } - ] + "$ref": "#/components/schemas/TimeStamp" }, "wanMetrics": { - "allOf": [ - { - "$ref": "#/components/schemas/WanMetrics" - }, - { - "description": "WAN Metrics element provides information about the WAN link connecting an IEEE 802.11 Access Node and the Internet. Transmission characteristics such as the speed of the WAN connection to the Internet are included in Hotspot 2.0 Technical Specification v1.0.0 [i.3]." - }, - { - "x-etsi-mec-cardinality": "0..1" - }, - { - "x-etsi-mec-origin-type": "WanMetrics" - } - ] + "$ref": "#/components/schemas/WanMetrics" }, "wlanCap": { - "allOf": [ - { - "$ref": "#/components/schemas/WlanCapabilities" - }, - { - "description": "WLAN capabilities of Access Point." - }, - { - "x-etsi-mec-cardinality": "0..1" - }, - { - "x-etsi-mec-origin-type": "WlanCapabilities" - } - ] + "$ref": "#/components/schemas/WlanCapabilities" } }, "required": [ @@ -1101,36 +1005,10 @@ "ApLocation": { "properties": { "civicLocation": { - "allOf": [ - { - "$ref": "#/components/schemas/CivicLocation" - }, - { - "description": "Civic Location of the AP as described in IETF RFC 4776 [7]." - }, - { - "x-etsi-mec-cardinality": "0..1" - }, - { - "x-etsi-mec-origin-type": "CivicLocation" - } - ] + "$ref": "#/components/schemas/CivicLocation" }, "geolocation": { - "allOf": [ - { - "$ref": "#/components/schemas/GeoLocation" - }, - { - "description": "Geospatial Location of the AP as defined in IEEE 802.11-2016 [8]." - }, - { - "x-etsi-mec-cardinality": "0..1" - }, - { - "x-etsi-mec-origin-type": "GeoLocation" - } - ] + "$ref": "#/components/schemas/GeoLocation" } }, "type": "object", @@ -1139,20 +1017,7 @@ "AssocStaNotification": { "properties": { "apId": { - "allOf": [ - { - "$ref": "#/components/schemas/ApIdentity" - }, - { - "description": "Identifier(s) to uniquely specify the Access Point to which the client stations are associated." - }, - { - "x-etsi-mec-cardinality": "1" - }, - { - "x-etsi-mec-origin-type": "ApIdentity" - } - ] + "$ref": "#/components/schemas/ApIdentity" }, "notificationType": { "description": "Shall be set to \"AssocStaNotification\".", @@ -1171,20 +1036,7 @@ "x-etsi-mec-origin-type": "StaIdentity" }, "timeStamp": { - "allOf": [ - { - "$ref": "#/components/schemas/TimeStamp" - }, - { - "description": "Time stamp." - }, - { - "x-etsi-mec-cardinality": "0..1" - }, - { - "x-etsi-mec-origin-type": "TimeStamp" - } - ] + "$ref": "#/components/schemas/TimeStamp" } }, "required": [ @@ -1200,41 +1052,18 @@ "description": "Hyperlink related to the resource. This shall be only included in the HTTP responses and in HTTP PUT requests.", "properties": { "self": { - "allOf": [ - { - "$ref": "#/components/schemas/LinkType" - }, - { - "description": "URI referring to a resource" - }, - { - "x-etsi-mec-cardinality": 1 - }, - { - "x-etsi-mec-origin-type": "LinkType" - } - ] + "$ref": "#/components/schemas/LinkType" } }, + "required": [ + "self" + ], "type": "object", "x-etsi-mec-cardinality": "0..1", "x-etsi-mec-origin-type": "Structure (inlined)" }, "apId": { - "allOf": [ - { - "$ref": "#/components/schemas/ApIdentity" - }, - { - "description": "Identifier(s) to uniquely specify the target Access Point for the subscription" - }, - { - "x-etsi-mec-cardinality": "1" - }, - { - "x-etsi-mec-origin-type": "ApIdentity" - } - ] + "$ref": "#/components/schemas/ApIdentity" }, "callbackReference": { "description": "URI selected by the service consumer to receive notifications on the subscribed WLAN information. This shall be included both in the request and in response.", @@ -1244,20 +1073,7 @@ "x-etsi-mec-origin-type": "URI" }, "expiryDeadline": { - "allOf": [ - { - "$ref": "#/components/schemas/TimeStamp" - }, - { - "description": "The expiration time of the subscription determined by the WLAN Access Information Service." - }, - { - "x-etsi-mec-cardinality": "0..1" - }, - { - "x-etsi-mec-origin-type": "TimeStamp" - } - ] + "$ref": "#/components/schemas/TimeStamp" }, "subscriptionType": { "description": "Shall be set to \"AssocStaSubscription\".", @@ -1346,20 +1162,7 @@ "x-etsi-mec-origin-type": "String" }, "staId": { - "allOf": [ - { - "$ref": "#/components/schemas/StaIdentity" - }, - { - "description": "Identifier to uniquely specify the station whose information is exposed within this data type." - }, - { - "x-etsi-mec-cardinality": "1" - }, - { - "x-etsi-mec-origin-type": "StaIdentity" - } - ] + "$ref": "#/components/schemas/StaIdentity" } }, "required": [ @@ -1414,20 +1217,7 @@ "x-etsi-mec-origin-type": "String" }, "staId": { - "allOf": [ - { - "$ref": "#/components/schemas/StaIdentity" - }, - { - "description": "Identifier to uniquely specify the station whose information is exposed within this data type." - }, - { - "x-etsi-mec-cardinality": "1" - }, - { - "x-etsi-mec-origin-type": "StaIdentity" - } - ] + "$ref": "#/components/schemas/StaIdentity" } }, "required": [ @@ -1444,20 +1234,23 @@ "BssLoad": { "properties": { "availAdmCap": { - "type": "integer", "description": "Available Admission Capacity that specifies the remaining amount of medium time available via explicit admission control, in units of 32 s/s.", + "format": "int32", + "type": "integer", "x-etsi-mec-cardinality": "1", "x-etsi-mec-origin-type": "Uint16" }, "channelUtilization": { - "type": "integer", "description": "The percentage of time, linearly scaled with 255 representing 100 %, that the AP sensed the medium was busy, as indicated by either the physical or virtual Carrier Sense (CS) mechanism.", + "format": "int32", + "type": "integer", "x-etsi-mec-cardinality": "1", "x-etsi-mec-origin-type": "UInt8" }, "staCount": { - "type": "integer", "description": "An unsigned integer that indicates the total number of STAs currently associated with this BSS.", + "format": "int32", + "type": "integer", "x-etsi-mec-cardinality": "1", "x-etsi-mec-origin-type": "UInt16" } @@ -1473,20 +1266,7 @@ "ChannelLoadConfig": { "properties": { "apId": { - "allOf": [ - { - "$ref": "#/components/schemas/ApIdentity" - }, - { - "description": "Identifier(s) to uniquely specify the target Access Point" - }, - { - "x-etsi-mec-cardinality": "1" - }, - { - "x-etsi-mec-origin-type": "ApIdentity" - } - ] + "$ref": "#/components/schemas/ApIdentity" }, "cChannelId": { "description": "Channel number which load is reported", @@ -1720,49 +1500,57 @@ "properties": { "ExtScMcsCap": { "description": "Extended SC MCS capabilities as defined in draft IEEE P802.11/D4.0 [i.11]", + "format": "int32", "type": "integer", "x-etsi-mec-cardinality": "1", "x-etsi-mec-origin-type": "Uint8" }, "dmgApOrPcpCapInfo": { - "type": "integer", "description": "DMG AP or PCP capabilities information as defined in draft IEEE P802.11/D4.0 [i.11]", + "format": "int32", + "type": "integer", "x-etsi-mec-cardinality": "1", "x-etsi-mec-origin-type": "Uint16" }, "dmgStaBeamTrackTimeLimit": { - "type": "integer", "description": "DMG station beam tracking time limit as defined in draft IEEE P802.11/D4.0 [i.11]", + "format": "int32", + "type": "integer", "x-etsi-mec-cardinality": "1", "x-etsi-mec-origin-type": "Uint16" }, "dmgStaCapInfo": { - "type": "integer", "description": "DMG station capabilities information as defined in draft IEEE P802.11/D4.0 [i.11]", + "format": "int64", + "type": "integer", "x-etsi-mec-cardinality": "1", "x-etsi-mec-origin-type": "Uint64" }, "maxNrBasicAmsduSubframes": { "description": "Number of basic A-MSDU subframes in A-MSDU as defined in draft IEEE P802.11/D4.0 [i.11]", + "format": "int32", "type": "integer", "x-etsi-mec-cardinality": "1", "x-etsi-mec-origin-type": "Uint8" }, "maxNrShortAmsduSubframes": { "description": "Number of short A-MSDU subframes in A-MSDU as defined in draft IEEE P802.11/D4.0 [i.11]", + "format": "int32", "type": "integer", "x-etsi-mec-cardinality": "1", "x-etsi-mec-origin-type": "Uint8" }, "sarCap": { "description": "SAR capabilities as defined in draft IEEE P802.11/D4.0 [i.11]", + "format": "int32", "type": "integer", "x-etsi-mec-cardinality": "1", "x-etsi-mec-origin-type": "Uint8" }, "tddCap": { - "type": "integer", "description": "TDD capabilities as defined in draft IEEE P802.11/D4.0 [i.11]", + "format": "int32", + "type": "integer", "x-etsi-mec-cardinality": "1", "x-etsi-mec-origin-type": "Uint16" } @@ -1784,26 +1572,29 @@ "properties": { "ampduParameters": { "description": "A-MPDU parameters as defined in draft IEEE P802.11/D4.0 [i.11]", + "format": "Uint8", "type": "integer", "x-etsi-mec-cardinality": "1", "x-etsi-mec-origin-type": "Uint8" }, "reserved": { "description": "", + "format": "int32", "type": "integer", "x-etsi-mec-cardinality": "0..1", "x-etsi-mec-origin-type": "Uint8" }, "supportedMcs": { - "type": "integer", - "format": "uint32", "description": "Supported MCS as defined in draft IEEE P802.11/D4.0 [i.11]", + "format": "int32", + "type": "integer", "x-etsi-mec-cardinality": "1", "x-etsi-mec-origin-type": "Uint32" }, "trnParameters": { - "type": "integer", "description": "Training parameters as defined in draft IEEE P802.11/D4.0 [i.11]", + "format": "int32", + "type": "integer", "x-etsi-mec-cardinality": "1", "x-etsi-mec-origin-type": "Uint16" } @@ -1819,32 +1610,37 @@ "ExtBssLoad": { "properties": { "muMimoStaCount": { - "type": "integer", "description": "Indicates the total number of STAs currently associated with this BSS that have a 1 in the MU Beamformee Capable field of their VHT Capabilities element.", + "format": "int32", + "type": "integer", "x-etsi-mec-cardinality": "1", "x-etsi-mec-origin-type": "UInt16" }, "obsSec20MhzUtil": { "description": "Observable loading on each of the secondary 20 MHz channel.", + "format": "int32", "type": "integer", "x-etsi-mec-cardinality": "1", "x-etsi-mec-origin-type": "Uint8" }, "obsSec40MhzUtil": { "description": "Observable loading on each of the secondary 40 MHz channel.", + "format": "int32", "type": "integer", "x-etsi-mec-cardinality": "1", "x-etsi-mec-origin-type": "Uint8" }, "obsSec80MhzUtil": { "description": "Observable loading on each of the secondary 80 MHz channel.", + "format": "int32", "type": "integer", "x-etsi-mec-cardinality": "1", "x-etsi-mec-origin-type": "Uint8" }, "spatStreamUnderUtil": { - "type": "integer", "description": "The percentage of time, linearly scaled with 255 representing 100 %, that the AP has underutilized spatial domain resources for given busy time of the medium.", + "format": "int32", + "type": "integer", "x-etsi-mec-cardinality": "1", "x-etsi-mec-origin-type": "UInt8" } @@ -1862,50 +1658,57 @@ "GeoLocation": { "properties": { "altitude": { - "type": "integer", - "format": "uint32", "description": "The altitude value of location as defined in IETF RFC 6225 [6]", + "format": "int32", + "type": "integer", "x-etsi-mec-cardinality": "0..1", "x-etsi-mec-origin-type": "Uint32" }, "altitudeType": { "description": "The type description for altitude information e.g. floors or meters as defined in IETF RFC 6225 [6]", + "format": "int32", "type": "integer", "x-etsi-mec-cardinality": "0..1", "x-etsi-mec-origin-type": "Uint8" }, "altitudeUncertainty": { "description": "The uncertainty for altitude information as defined in IETF RFC 6225 [6]", + "format": "int32", "type": "integer", "x-etsi-mec-cardinality": "0..1", "x-etsi-mec-origin-type": "Uint8" }, "datum": { "description": "The datum value to express how coordinates are organized and related to real world as defined in IETF RFC 6225 [6]", + "format": "int32", "type": "integer", "x-etsi-mec-cardinality": "1", "x-etsi-mec-origin-type": "Uint8" }, "lat": { - "type": "integer", "description": "The latitude value of location as defined in IETF RFC 6225 [6]", + "format": "int64", + "type": "integer", "x-etsi-mec-cardinality": "1", "x-etsi-mec-origin-type": "Uint64" }, "latUncertainty": { "description": "The uncertainty for Latitude information as defined in IETF RFC 6225 [6]", + "format": "int32", "type": "integer", "x-etsi-mec-cardinality": "1", "x-etsi-mec-origin-type": "Uint8" }, "long": { - "type": "integer", "description": "The longitude value of location as defined in IETF RFC 6225 [6]", + "format": "int64", + "type": "integer", "x-etsi-mec-cardinality": "1", "x-etsi-mec-origin-type": "Uint64" }, "longUncertainty": { "description": "The uncertainty for Longitude information as defined in IETF RFC 6225 [6]", + "format": "int32", "type": "integer", "x-etsi-mec-cardinality": "1", "x-etsi-mec-origin-type": "Uint8" @@ -1959,40 +1762,44 @@ "HtCapabilities": { "properties": { "ampduParameters": { - "type": "integer", "description": "A-MPDU parameters as defined in IEEE 802.11-2016 [8].", + "format": "int32", + "type": "integer", "x-etsi-mec-cardinality": "1", "x-etsi-mec-origin-type": "UInt8" }, "aselCap": { - "type": "integer", "description": "ASEL capabilities as defined in IEEE 802.11-2016 [8].", + "format": "int32", + "type": "integer", "x-etsi-mec-cardinality": "1", "x-etsi-mec-origin-type": "UInt8" }, "htCapabilityInfo": { - "type": "integer", "description": "HT Capability Information as defined in IEEE 802.11-2016 [8].", + "format": "int32", + "type": "integer", "x-etsi-mec-cardinality": "1", "x-etsi-mec-origin-type": "UInt16" }, "htExtendedCap": { - "type": "integer", "description": "Extended HT Capabilities as defined in IEEE 802.11-2016 [8].", + "format": "int32", + "type": "integer", "x-etsi-mec-cardinality": "1", "x-etsi-mec-origin-type": "UInt16" }, "supportedMcsSet": { - "type": "integer", - "format": "uint64", "description": "Supported MCS set as defined in IEEE 802.11-2016 [8].", + "format": "int64", + "type": "integer", "x-etsi-mec-cardinality": "1", "x-etsi-mec-origin-type": "Uint128" }, "txBeamFormCap": { - "type": "integer", - "format": "uint32", "description": "Transmit Beamforming Capabilities as defined in IEEE 802.11-2016 [8].", + "format": "int32", + "type": "integer", "x-etsi-mec-cardinality": "1", "x-etsi-mec-origin-type": "UInt32" } @@ -2026,36 +1833,10 @@ "MeasurementConfig": { "properties": { "beaconRequest": { - "allOf": [ - { - "$ref": "#/components/schemas/BeaconRequestConfig" - }, - { - "description": "Configuration related to Beacon Request." - }, - { - "x-etsi-mec-cardinality": "0..1" - }, - { - "x-etsi-mec-origin-type": "BeaconRequestConfig" - } - ] + "$ref": "#/components/schemas/BeaconRequestConfig" }, "channelLoad": { - "allOf": [ - { - "$ref": "#/components/schemas/ChannelLoadConfig" - }, - { - "description": "Configuration related to the Channel Load." - }, - { - "x-etsi-mec-cardinality": "0..1" - }, - { - "x-etsi-mec-origin-type": "ChannelLoadConfig" - } - ] + "$ref": "#/components/schemas/ChannelLoadConfig" }, "measurementDuration": { "description": "Duration of the measurement, shall be lower than Maximum Measurement Duration in TU as defined in section 11.11.4 of IEEE 802.11 [8].", @@ -2076,20 +1857,7 @@ "x-etsi-mec-origin-type": "Integer" }, "staStatistics": { - "allOf": [ - { - "$ref": "#/components/schemas/StaStatisticsConfig" - }, - { - "description": "Configuration related to the statistics provided by STAs." - }, - { - "x-etsi-mec-cardinality": "0..1" - }, - { - "x-etsi-mec-origin-type": "StaStatisticsConfig" - } - ] + "$ref": "#/components/schemas/StaStatisticsConfig" } }, "required": [ @@ -2111,7 +1879,7 @@ }, "bssidInfo": { "description": "Additional information related to Access Point that is being reported such as AP reachability, security, key scope, Mobility Domain, HT/VHT capability and Fine Time Measurements.", - "format": "uint32", + "format": "int32", "type": "integer", "x-etsi-mec-cardinality": "1", "x-etsi-mec-origin-type": "UInt32" @@ -2162,7 +1930,7 @@ }, "status": { "description": "The HTTP status code for this occurrence of the problem", - "format": "uint32", + "format": "int32", "type": "integer", "x-etsi-mec-cardinality": "0..1", "x-etsi-mec-origin-type": "Uint32" @@ -2187,6 +1955,7 @@ "properties": { "rssi": { "description": "The Received Signal Strength Indicator from a station", + "format": "int32", "type": "integer", "x-etsi-mec-cardinality": "1", "x-etsi-mec-origin-type": "Uint8" @@ -2201,31 +1970,18 @@ "StaDataRate": { "properties": { "staId": { - "allOf": [ - { - "$ref": "#/components/schemas/StaIdentity" - }, - { - "description": "Identifier(s) to uniquely specify the client station(s) associated." - }, - { - "x-etsi-mec-cardinality": "0..1" - }, - { - "x-etsi-mec-origin-type": "StaIdentity" - } - ] + "$ref": "#/components/schemas/StaIdentity" }, "staLastDataDownlinkRate": { "description": "The data transmit rate in kbps that was most recently used for transmission of data PPDUs from the access point to the station.", - "format": "uint32", + "format": "int32", "type": "integer", "x-etsi-mec-cardinality": "0..1", "x-etsi-mec-origin-type": "Uint32" }, "staLastDataUplinkRate": { "description": "The data transmit rate in Kbps that was most recently used for transmission of data PPDUs from the associated station to the access point.", - "format": "uint32", + "format": "int32", "type": "integer", "x-etsi-mec-cardinality": "0..1", "x-etsi-mec-origin-type": "Uint32" @@ -2253,20 +2009,7 @@ "x-etsi-mec-origin-type": "StaDataRate" }, "timeStamp": { - "allOf": [ - { - "$ref": "#/components/schemas/TimeStamp" - }, - { - "description": "Time stamp." - }, - { - "x-etsi-mec-cardinality": "0..1" - }, - { - "x-etsi-mec-origin-type": "TimeStamp" - } - ] + "$ref": "#/components/schemas/TimeStamp" } }, "required": [ @@ -2281,22 +2024,12 @@ "description": "Hyperlink related to the resource. This shall be only included in the HTTP responses and in HTTP PUT requests.", "properties": { "self": { - "allOf": [ - { - "$ref": "#/components/schemas/LinkType" - }, - { - "description": "URI referring to a resource" - }, - { - "x-etsi-mec-cardinality": 1 - }, - { - "x-etsi-mec-origin-type": "LinkType" - } - ] + "$ref": "#/components/schemas/LinkType" } }, + "required": [ + "self" + ], "type": "object", "x-etsi-mec-cardinality": "0..1", "x-etsi-mec-origin-type": "Structure (inlined)" @@ -2309,20 +2042,7 @@ "x-etsi-mec-origin-type": "URI" }, "expiryDeadline": { - "allOf": [ - { - "$ref": "#/components/schemas/TimeStamp" - }, - { - "description": "The expiration time of the subscription determined by the WLAN Access Information Service." - }, - { - "x-etsi-mec-cardinality": "0..1" - }, - { - "x-etsi-mec-origin-type": "TimeStamp" - } - ] + "$ref": "#/components/schemas/TimeStamp" }, "staId": { "description": "Identifier(s) to uniquely specify the target client station(s) for the subscription", @@ -2393,123 +2113,32 @@ "StaInfo": { "properties": { "apAssociated": { - "allOf": [ - { - "$ref": "#/components/schemas/ApAssociated" - }, - { - "description": "Information about the Access Point that this Client Station is associated to." - }, - { - "x-etsi-mec-cardinality": "0..1" - }, - { - "x-etsi-mec-origin-type": "ApAssociated" - } - ] + "$ref": "#/components/schemas/ApAssociated" }, "beaconReport": { - "allOf": [ - { - "$ref": "#/components/schemas/BeaconReport" - }, - { - "description": "Beacon Report as defined in Wi-Fi Agile Multiband Specification [9]." - }, - { - "x-etsi-mec-cardinality": "0..1" - }, - { - "x-etsi-mec-origin-type": "BeaconReport" - } - ] + "$ref": "#/components/schemas/BeaconReport" }, "channel": { - "type": "integer", - "format": "uint32", "description": "Channel currently used by the station.", + "format": "int32", + "type": "integer", "x-etsi-mec-cardinality": "0..1", "x-etsi-mec-origin-type": "Uint32" }, "rssi": { - "allOf": [ - { - "$ref": "#/components/schemas/Rssi" - }, - { - "description": "Receive Signal Strength Indicator." - }, - { - "x-etsi-mec-cardinality": "0..1" - }, - { - "x-etsi-mec-origin-type": "Rssi" - } - ] + "$ref": "#/components/schemas/Rssi" }, "staDataRate": { - "allOf": [ - { - "$ref": "#/components/schemas/StaDataRate" - }, - { - "description": "Station Data Rate as defined in IEEE 802.11-2016 [8]." - }, - { - "x-etsi-mec-cardinality": "0..1" - }, - { - "x-etsi-mec-origin-type": "StaDataRate" - } - ] + "$ref": "#/components/schemas/StaDataRate" }, "staId": { - "allOf": [ - { - "$ref": "#/components/schemas/StaIdentity" - }, - { - "description": "0 to N identifiers to uniquely specify the station whose information is exposed within this data type." - }, - { - "x-etsi-mec-cardinality": "1" - }, - { - "x-etsi-mec-origin-type": "StaIdentity" - } - ] + "$ref": "#/components/schemas/StaIdentity" }, "staStatistics": { - "allOf": [ - { - "$ref": "#/components/schemas/StaStatistics" - }, - { - "description": "Statistics as defined in IEEE 802.11-2016 [8] for the client station collected over measurement duration." - }, - { - "x-etsi-mec-cardinality": "0..1" - }, - { - "x-etsi-mec-origin-type": "StaStatistics" - } - ] + "$ref": "#/components/schemas/StaStatistics" }, "timeStamp": { - "allOf": [ - { - "$ref": "#/components/schemas/TimeStamp" - }, - { - "description": "Time stamp." - }, - { - "x-etsi-mec-cardinality": "0..1" - }, - { - "x-etsi-mec-origin-type": "TimeStamp" - } - ] + "$ref": "#/components/schemas/TimeStamp" } }, "required": [ @@ -2533,20 +2162,10 @@ "x-etsi-mec-origin-type": "UInt16" }, "statisticsGroupData": { - "allOf": [ - { - "$ref": "#/components/schemas/StatisticsGroupData" - }, - { - "description": "Statistics Group Data as defined in Annex C of IEEE 802.112016  [8]." - }, - { - "x-etsi-mec-cardinality": "1" - }, - { - "x-etsi-mec-origin-type": "not specified" - } - ] + "$ref": "#/components/schemas/StatisticsGroupData", + "description": "Statistics Group Data as defined in Annex C of IEEE 802.112016 [8].", + "x-etsi-mec-cardinality": "1", + "x-etsi-mec-origin-type": "not specified" } }, "required": [ @@ -2566,26 +2185,10 @@ "x-etsi-mec-origin-type": "Integer" }, "staId": { - "allOf": [ - { - "$ref": "#/components/schemas/StaIdentity" - }, - { - "description": "Identifier to uniquely specify the station whose information is exposed within this data type." - }, - { - "x-etsi-mec-cardinality": "1" - }, - { - "x-etsi-mec-origin-type": "StaIdentity" - } - ] + "$ref": "#/components/schemas/StaIdentity" }, "triggerCondition": { - "type": "integer", - "description": "As per Figure 9-161 of IEEE 802.11. This bitmap defines what are the metrics returned by the STA Statistics Report.", - "x-etsi-mec-cardinality": "1", - "x-etsi-mec-origin-type": "16bits bitmap" + "type": "integer" }, "triggerTimeout": { "description": "The Trigger Timeout field contains a value in units of 100 TUs during which a measuring STA does not generate further triggered STA Statistics Reports after a trigger condition has been met.", @@ -2594,10 +2197,7 @@ "x-etsi-mec-origin-type": "Integer" }, "triggeredReport": { - "type": "boolean", - "description": "Yes, use triggered report.", - "x-etsi-mec-cardinality": "1", - "x-etsi-mec-origin-type": "Bool" + "type": "boolean" } }, "required": [ @@ -2613,331 +2213,331 @@ "StatisticsGroupData": { "properties": { "dot11AMPDUDelimiterCRCErrorCount": { - "format": "uint32", + "format": "int32", "type": "integer", "x-etsi-mec-cardinality": "0..1", "x-etsi-mec-origin-type": "Uint32" }, "dot11AMPDUReceivedCount": { - "format": "uint32", + "format": "int32", "type": "integer", "x-etsi-mec-cardinality": "0..1", "x-etsi-mec-origin-type": "Uint32" }, "dot11AMSDUAckFailureCount": { - "format": "uint32", + "format": "int32", "type": "integer", "x-etsi-mec-cardinality": "0..1", "x-etsi-mec-origin-type": "Uint32" }, "dot11AckFailureCount": { - "format": "uint32", + "format": "int32", "type": "integer", "x-etsi-mec-cardinality": "0..1", "x-etsi-mec-origin-type": "Uint32" }, "dot11BeamformingFrameCount": { - "format": "uint32", + "format": "int32", "type": "integer", "x-etsi-mec-cardinality": "0..1", "x-etsi-mec-origin-type": "Uint32" }, "dot11ChannelWidthSwitchCount": { - "format": "uint32", + "format": "int32", "type": "integer", "x-etsi-mec-cardinality": "0..1", "x-etsi-mec-origin-type": "Uint32" }, "dot11DualCTSFailureCount": { - "format": "uint32", + "format": "int32", "type": "integer", "x-etsi-mec-cardinality": "0..1", "x-etsi-mec-origin-type": "Uint32" }, "dot11DualCTSSuccessCount": { - "format": "uint32", + "format": "int32", "type": "integer", "x-etsi-mec-cardinality": "0..1", "x-etsi-mec-origin-type": "Uint32" }, "dot11ExplicitBARFailureCount": { - "format": "uint32", + "format": "int32", "type": "integer", "x-etsi-mec-cardinality": "0..1", "x-etsi-mec-origin-type": "Uint32" }, "dot11FCSErrorCount": { - "format": "uint32", + "format": "int32", "type": "integer", "x-etsi-mec-cardinality": "0..1", "x-etsi-mec-origin-type": "Uint32" }, "dot11FailedAMSDUCount": { - "format": "uint32", + "format": "int32", "type": "integer", "x-etsi-mec-cardinality": "0..1", "x-etsi-mec-origin-type": "Uint32" }, "dot11FailedCount": { - "format": "uint32", + "format": "int32", "type": "integer", "x-etsi-mec-cardinality": "0..1", "x-etsi-mec-origin-type": "Uint32" }, "dot11FortyMHzFrameReceivedCount": { - "format": "uint32", + "format": "int32", "type": "integer", "x-etsi-mec-cardinality": "0..1", "x-etsi-mec-origin-type": "Uint32" }, "dot11FortyMHzFrameTransmittedCount": { - "format": "uint32", + "format": "int32", "type": "integer", "x-etsi-mec-cardinality": "0..1", "x-etsi-mec-origin-type": "Uint32" }, "dot11FrameDuplicateCount": { - "format": "uint32", + "format": "int32", "type": "integer", "x-etsi-mec-cardinality": "0..1", "x-etsi-mec-origin-type": "Uint32" }, "dot11GrantedRDGUnusedCount": { - "format": "uint32", + "format": "int32", "type": "integer", "x-etsi-mec-cardinality": "0..1", "x-etsi-mec-origin-type": "Uint32" }, "dot11GrantedRDGUsedCount": { - "format": "uint32", + "format": "int32", "type": "integer", "x-etsi-mec-cardinality": "0..1", "x-etsi-mec-origin-type": "Uint32" }, "dot11GroupReceivedFrameCount": { - "format": "uint32", + "format": "int32", "type": "integer", "x-etsi-mec-cardinality": "0..1", "x-etsi-mec-origin-type": "Uint32" }, "dot11GroupTransmittedFrameCount": { - "format": "uint32", + "format": "int32", "type": "integer", "x-etsi-mec-cardinality": "0..1", "x-etsi-mec-origin-type": "Uint32" }, "dot11ImplicitBARFailureCount": { - "format": "uint32", + "format": "int32", "type": "integer", "x-etsi-mec-cardinality": "0..1", "x-etsi-mec-origin-type": "Uint32" }, "dot11MPDUInReceivedAMPDUCount": { - "format": "uint32", + "format": "int32", "type": "integer", "x-etsi-mec-cardinality": "0..1", "x-etsi-mec-origin-type": "Uint32" }, "dot11MultipleRetryAMSDUCount": { - "format": "uint32", + "format": "int32", "type": "integer", "x-etsi-mec-cardinality": "0..1", "x-etsi-mec-origin-type": "Uint32" }, "dot11MultipleRetryCount": { - "format": "uint32", + "format": "int32", "type": "integer", "x-etsi-mec-cardinality": "0..1", "x-etsi-mec-origin-type": "Uint32" }, "dot11PSMPUTTGrantDuration": { - "format": "uint32", + "format": "int32", "type": "integer", "x-etsi-mec-cardinality": "0..1", "x-etsi-mec-origin-type": "Uint32" }, "dot11PSMPUTTUsedDuration": { - "format": "uint32", + "format": "int32", "type": "integer", "x-etsi-mec-cardinality": "0..1", "x-etsi-mec-origin-type": "Uint32" }, "dot11QosAckFailureCount": { - "format": "uint32", + "format": "int32", "type": "integer", "x-etsi-mec-cardinality": "0..1", "x-etsi-mec-origin-type": "Uint32" }, "dot11QosDiscardedFrameCount": { - "format": "uint32", + "format": "int32", "type": "integer", "x-etsi-mec-cardinality": "0..1", "x-etsi-mec-origin-type": "Uint32" }, "dot11QosFailedCount": { - "format": "uint32", + "format": "int32", "type": "integer", "x-etsi-mec-cardinality": "0..1", "x-etsi-mec-origin-type": "Uint32" }, "dot11QosFrameDuplicateCount": { - "format": "uint32", + "format": "int32", "type": "integer", "x-etsi-mec-cardinality": "0..1", "x-etsi-mec-origin-type": "Uint32" }, "dot11QosMPDUsReceivedCount": { - "format": "uint32", + "format": "int32", "type": "integer", "x-etsi-mec-cardinality": "0..1", "x-etsi-mec-origin-type": "Uint32" }, "dot11QosMultipleRetryCount": { - "format": "uint32", + "format": "int32", "type": "integer", "x-etsi-mec-cardinality": "0..1", "x-etsi-mec-origin-type": "Uint32" }, "dot11QosRTSFailureCount": { - "format": "uint32", + "format": "int32", "type": "integer", "x-etsi-mec-cardinality": "0..1", "x-etsi-mec-origin-type": "Uint32" }, "dot11QosRTSSuccessCount": { - "format": "uint32", + "format": "int32", "type": "integer", "x-etsi-mec-cardinality": "0..1", "x-etsi-mec-origin-type": "Uint32" }, "dot11QosReceivedFragmentCount": { - "format": "uint32", + "format": "int32", "type": "integer", "x-etsi-mec-cardinality": "0..1", "x-etsi-mec-origin-type": "Uint32" }, "dot11QosRetriesReceivedCount": { - "format": "uint32", + "format": "int32", "type": "integer", "x-etsi-mec-cardinality": "0..1", "x-etsi-mec-origin-type": "Uint32" }, "dot11QosRetryCount": { - "format": "uint32", + "format": "int32", "type": "integer", "x-etsi-mec-cardinality": "0..1", "x-etsi-mec-origin-type": "Uint32" }, "dot11QosTransmittedFragmentCount": { - "format": "uint32", + "format": "int32", "type": "integer", "x-etsi-mec-cardinality": "0..1", "x-etsi-mec-origin-type": "Uint32" }, "dot11QosTransmittedFrameCount": { - "format": "uint32", + "format": "int32", "type": "integer", "x-etsi-mec-cardinality": "0..1", "x-etsi-mec-origin-type": "Uint32" }, "dot11RSNAStatsBIPMICErrors": { - "format": "uint32", + "format": "int32", "type": "integer", "x-etsi-mec-cardinality": "0..1", "x-etsi-mec-origin-type": "Uint32" }, "dot11RSNAStatsCCMPDecryptErrors": { - "format": "uint32", + "format": "int32", "type": "integer", "x-etsi-mec-cardinality": "0..1", "x-etsi-mec-origin-type": "Uint32" }, "dot11RSNAStatsCCMPReplays": { - "format": "uint32", + "format": "int32", "type": "integer", "x-etsi-mec-cardinality": "0..1", "x-etsi-mec-origin-type": "Uint32" }, "dot11RSNAStatsCMACReplays": { - "format": "uint32", + "format": "int32", "type": "integer", "x-etsi-mec-cardinality": "0..1", "x-etsi-mec-origin-type": "Uint32" }, "dot11RSNAStatsRobustMgmtCCMPReplays": { - "format": "uint32", + "format": "int32", "type": "integer", "x-etsi-mec-cardinality": "0..1", "x-etsi-mec-origin-type": "Uint32" }, "dot11RSNAStatsTKIPICVErrors": { - "format": "uint32", + "format": "int32", "type": "integer", "x-etsi-mec-cardinality": "0..1", "x-etsi-mec-origin-type": "Uint32" }, "dot11RSNAStatsTKIPReplays": { - "format": "uint32", + "format": "int32", "type": "integer", "x-etsi-mec-cardinality": "0..1", "x-etsi-mec-origin-type": "Uint32" }, "dot11RTSFailureCount": { - "format": "uint32", + "format": "int32", "type": "integer", "x-etsi-mec-cardinality": "0..1", "x-etsi-mec-origin-type": "Uint32" }, "dot11RTSLSIGFailureCount": { - "format": "uint32", + "format": "int32", "type": "integer", "x-etsi-mec-cardinality": "0..1", "x-etsi-mec-origin-type": "Uint32" }, "dot11RTSLSIGSuccessCount": { - "format": "uint32", + "format": "int32", "type": "integer", "x-etsi-mec-cardinality": "0..1", "x-etsi-mec-origin-type": "Uint32" }, "dot11RTSSuccessCount": { - "format": "uint32", + "format": "int32", "type": "integer", "x-etsi-mec-cardinality": "0..1", "x-etsi-mec-origin-type": "Uint32" }, "dot11ReceivedAMSDUCount": { - "format": "uint32", + "format": "int32", "type": "integer", "x-etsi-mec-cardinality": "0..1", "x-etsi-mec-origin-type": "Uint32" }, "dot11ReceivedFragmentCount": { - "format": "uint32", + "format": "int32", "type": "integer", "x-etsi-mec-cardinality": "0..1", "x-etsi-mec-origin-type": "Uint32" }, "dot11ReceivedOctetsInAMPDUCount": { - "format": "uint64", + "format": "int64", "type": "integer", "x-etsi-mec-cardinality": "0..1", "x-etsi-mec-origin-type": "Uint64" }, "dot11ReceivedOctetsInAMSDUCount": { - "format": "uint64", + "format": "int64", "type": "integer", "x-etsi-mec-cardinality": "0..1", "x-etsi-mec-origin-type": "Uint64" }, "dot11RetryAMSDUCount": { - "format": "uint32", + "format": "int32", "type": "integer", "x-etsi-mec-cardinality": "0..1", "x-etsi-mec-origin-type": "Uint32" }, "dot11RetryCount": { - "format": "uint32", + "format": "int32", "type": "integer", "x-etsi-mec-cardinality": "0..1", "x-etsi-mec-origin-type": "Uint32" @@ -2978,91 +2578,91 @@ "x-etsi-mec-origin-type": "Uint8" }, "dot11STBCCTSFailureCount": { - "format": "uint32", + "format": "int32", "type": "integer", "x-etsi-mec-cardinality": "0..1", "x-etsi-mec-origin-type": "Uint32" }, "dot11STBCCTSSuccessCount": { - "format": "uint32", + "format": "int32", "type": "integer", "x-etsi-mec-cardinality": "0..1", "x-etsi-mec-origin-type": "Uint32" }, "dot11TransmittedAMPDUCount": { - "format": "uint32", + "format": "int32", "type": "integer", "x-etsi-mec-cardinality": "0..1", "x-etsi-mec-origin-type": "Uint32" }, "dot11TransmittedAMSDUCount": { - "format": "uint32", + "format": "int32", "type": "integer", "x-etsi-mec-cardinality": "0..1", "x-etsi-mec-origin-type": "Uint32" }, "dot11TransmittedFragmentCount": { - "format": "uint32", + "format": "int32", "type": "integer", "x-etsi-mec-cardinality": "0..1", "x-etsi-mec-origin-type": "Uint32" }, "dot11TransmittedFrameCount": { - "format": "uint32", + "format": "int32", "type": "integer", "x-etsi-mec-cardinality": "0..1", "x-etsi-mec-origin-type": "Uint32" }, "dot11TransmittedFramesInGrantedRDGCount": { - "format": "uint32", + "format": "int32", "type": "integer", "x-etsi-mec-cardinality": "0..1", "x-etsi-mec-origin-type": "Uint32" }, "dot11TransmittedMPDUsInAMPDUCount": { - "format": "uint32", + "format": "int32", "type": "integer", "x-etsi-mec-cardinality": "0..1", "x-etsi-mec-origin-type": "Uint32" }, "dot11TransmittedOctetsInAMPDUCount": { - "format": "uint64", + "format": "int64", "type": "integer", "x-etsi-mec-cardinality": "0..1", "x-etsi-mec-origin-type": "Uint64" }, "dot11TransmittedOctetsInAMSDUCount": { - "format": "uint64", + "format": "int64", "type": "integer", "x-etsi-mec-cardinality": "0..1", "x-etsi-mec-origin-type": "Uint32" }, "dot11TransmittedOctetsInGrantedRDGCount": { - "format": "uint32", + "format": "int32", "type": "integer", "x-etsi-mec-cardinality": "0..1", "x-etsi-mec-origin-type": "Uint32" }, "dot11TwentyMHzFrameReceivedCount": { - "format": "uint32", + "format": "int32", "type": "integer", "x-etsi-mec-cardinality": "0..1", "x-etsi-mec-origin-type": "Uint32" }, "dot11TwentyMHzFrameTransmittedCount": { - "format": "uint32", + "format": "int32", "type": "integer", "x-etsi-mec-cardinality": "0..1", "x-etsi-mec-origin-type": "Uint32" }, "dot11nonSTBCCTSFailureCount": { - "format": "uint32", + "format": "int32", "type": "integer", "x-etsi-mec-cardinality": "0..1", "x-etsi-mec-origin-type": "Uint32" }, "dot11nonSTBCCTSSuccessCount": { - "format": "uint32", + "format": "int32", "type": "integer", "x-etsi-mec-cardinality": "0..1", "x-etsi-mec-origin-type": "Uint32" @@ -3076,20 +2676,7 @@ "description": "Hyperlink related to the resource. This shall be only included in the HTTP responses and in HTTP PUT requests.", "properties": { "self": { - "allOf": [ - { - "$ref": "#/components/schemas/LinkType" - }, - { - "description": "URI referring to a resource" - }, - { - "x-etsi-mec-cardinality": 1 - }, - { - "x-etsi-mec-origin-type": "LinkType" - } - ] + "$ref": "#/components/schemas/LinkType" } }, "type": "object", @@ -3121,16 +2708,16 @@ "TimeStamp": { "properties": { "nanoSeconds": { - "type": "integer", - "format": "uint32", "description": "The nanoseconds part of the time. Time is defined as Unix-time since January 1, 1970, 00:00:00 UTC.", + "format": "int32", + "type": "integer", "x-etsi-mec-cardinality": "1", "x-etsi-mec-origin-type": "Uint32" }, "seconds": { - "type": "integer", - "format": "uint32", "description": "The seconds part of the time. Time is defined as Unixtime since January 1, 1970, 00:00:00 UTC.", + "format": "int32", + "type": "integer", "x-etsi-mec-cardinality": "1", "x-etsi-mec-origin-type": "Uint32" } @@ -3145,15 +2732,16 @@ "VhtCapabilities": { "properties": { "vhtCapInfo": { - "type": "integer", - "format": "uint32", "description": "VHT capabilities Info as defined in IEEE 802.11-2016 [8].", + "format": "int32", + "type": "integer", "x-etsi-mec-cardinality": "1", "x-etsi-mec-origin-type": "UInt32" }, "vhtMcsNss": { - "type": "integer", "description": "Supported VHT-MCS and NSS Set as defined in IEEE 802.11-2016 [8].", + "format": "int64", + "type": "integer", "x-etsi-mec-cardinality": "1", "x-etsi-mec-origin-type": "UInt64" } @@ -3168,39 +2756,43 @@ "WanMetrics": { "properties": { "downlinkLoad": { - "type": "integer", "description": "1-octet positive integer representing the current percentage loading of the downlink WAN connection, scaled linearly with 255 representing 100 %, as measured over an interval the duration of which is reported in Load Measurement Duration. In cases where the downlink load is unknown to the AP, the value is set to zero.", + "format": "int32", + "type": "integer", "x-etsi-mec-cardinality": "1", "x-etsi-mec-origin-type": "UInt8" }, "downlinkSpeed": { - "type": "integer", - "format": "uint32", "description": "4-octet positive integer whose value is an estimate of the WAN Backhaul link current downlink speed in kilobits per second.", + "format": "int32", + "type": "integer", "x-etsi-mec-cardinality": "1", "x-etsi-mec-origin-type": "Uint32" }, "lmd": { - "type": "integer", "description": "The LMD (Load Measurement Duration) field is a 2-octet positive integer representing the duration over which the Downlink Load and Uplink Load have been measured, in tenths of a second. When the actual load measurement duration is greater than the maximum value, the maximum value will be reported. The value of the LMD field is set to 0 when neither the uplink nor downlink load can be computed. When the uplink and downlink loads are computed over different intervals, the maximum interval is reported.", + "format": "int32", + "type": "integer", "x-etsi-mec-cardinality": "1", "x-etsi-mec-origin-type": "Uint16" }, "uplinkLoad": { "description": "1-octet positive integer representing the current percentage loading of the uplink WAN connection, scaled linearly with 255 representing 100 %, as measured over an interval, the duration of which is reported in Load Measurement Duration. In cases where the uplink load is unknown to the AP, the value is set to zero.", + "format": "int32", "type": "integer", "x-etsi-mec-cardinality": "1", "x-etsi-mec-origin-type": "Uint8" }, "uplinkSpeed": { - "type": "integer", - "format": "uint32", "description": "4-octet positive integer whose value is an estimate of the WAN Backhaul link's current uplink speed in kilobits per second.", + "format": "int32", + "type": "integer", "x-etsi-mec-cardinality": "1", "x-etsi-mec-origin-type": "UInt32" }, "wanInfo": { "description": "Info about WAN link status, link symmetricity and capacity currently used.", + "format": "int32", "type": "integer", "x-etsi-mec-cardinality": "1", "x-etsi-mec-origin-type": "Uint8" @@ -3220,84 +2812,19 @@ "WlanCapabilities": { "properties": { "dmg": { - "allOf": [ - { - "$ref": "#/components/schemas/DmgCapabilities" - }, - { - "description": "Information about Access Point DMG capabilities as defined in IEEE 802.11-2016 [8]." - }, - { - "x-etsi-mec-cardinality": "0..1" - }, - { - "x-etsi-mec-origin-type": "DmgCapabilities" - } - ] + "$ref": "#/components/schemas/DmgCapabilities" }, "edmg": { - "allOf": [ - { - "$ref": "#/components/schemas/EdmgCapabilities" - }, - { - "description": "Information about Access Point EDMG capabilities as defined in draft IEEE P802.11/D4.0 [i.11]." - }, - { - "x-etsi-mec-cardinality": "0..1" - }, - { - "x-etsi-mec-origin-type": "EdmgCapabilities" - } - ] + "$ref": "#/components/schemas/EdmgCapabilities" }, "he": { - "allOf": [ - { - "$ref": "#/components/schemas/HeCapabilities" - }, - { - "description": "Information about Access Point HE capabilities as defined in FFS." - }, - { - "x-etsi-mec-cardinality": "0..1" - }, - { - "x-etsi-mec-origin-type": "HeCapabilities" - } - ] + "$ref": "#/components/schemas/HeCapabilities" }, "ht": { - "allOf": [ - { - "$ref": "#/components/schemas/HtCapabilities" - }, - { - "description": "Information about Access Point HT capabilities as defined in IEEE 802.11-2016 [8]." - }, - { - "x-etsi-mec-cardinality": "0..1" - }, - { - "x-etsi-mec-origin-type": "HtCapabilities" - } - ] + "$ref": "#/components/schemas/HtCapabilities" }, "vht": { - "allOf": [ - { - "$ref": "#/components/schemas/VhtCapabilities" - }, - { - "description": "Information about Access Point VHT capabilities as defined in IEEE 802.11-2016 [8]." - }, - { - "x-etsi-mec-cardinality": "0..1" - }, - { - "x-etsi-mec-origin-type": "VhtCapabilities" - } - ] + "$ref": "#/components/schemas/VhtCapabilities" } }, "type": "object", diff --git a/WlanInformationApi.yaml b/WlanInformationApi.yaml index 672748a..c88074b 100644 --- a/WlanInformationApi.yaml +++ b/WlanInformationApi.yaml @@ -1,2342 +1,2238 @@ -openapi: 3.0.0 -info: - title: ETSI GS MEC 028 - WLAN Access Information API - version: 2.1.1 - description: The ETSI MEC ISG MEC028 WLAN Access Information API described using OpenAPI - license: - name: BSD-3-Clause - url: 'https://forge.etsi.org/legal-matters' -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' -servers: - - url: 'https://{apiRoot}/wai/v2' -paths: - /queries/ap/ap_information: - get: - tags: - - '' - summary: 'Retrieve information on existing Access Points' - description: 'Queries information about existing WLAN Access Points' - operationId: apInfoGET - parameters: - - $ref: '#/components/parameters/Query.Filter' - - $ref: '#/components/parameters/Query.AllFields' - - $ref: '#/components/parameters/Query.Fields' - - $ref: '#/components/parameters/Query.ExcludeFields' - - $ref: '#/components/parameters/Query.ExcludeDefault' - responses: - '200': - description: Successful response to ap_info request - content: - application/json: - schema: - type: object - properties: - apInfo: - type: array - items: - $ref: '#/components/schemas/ApInfo' - '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': - $ref: '#/components/responses/429' - /queries/sta/sta_information: - get: - tags: - - '' - summary: 'Retrieve information on existing Stations' - description: 'Queries information about existing WLAN stations' - operationId: staInfoGET - parameters: - - $ref: '#/components/parameters/Query.Filter' - - $ref: '#/components/parameters/Query.AllFields' - - $ref: '#/components/parameters/Query.Fields' - - $ref: '#/components/parameters/Query.ExcludeFields' - - $ref: '#/components/parameters/Query.ExcludeDefault' - responses: - '200': - description: Successful response to sta_info request - content: - application/json: - schema: - type: object - properties: - staInfo: - type: array - items: - $ref: '#/components/schemas/StaInfo' - '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': - $ref: '#/components/responses/429' - /subscriptions/: - get: - tags: - - '' - summary: 'Retrieve information on subscriptions for notifications' - description: 'Queries information on subscriptions for notifications' - operationId: subscriptionLinkList_subscriptionsGET - parameters: - - $ref: '#/components/parameters/Query.SubscriptionType' - responses: - '200': - description: 'Response body contains the list of links to requestors subscriptions.' - content: - application/json: - schema: - type: object - required: - - subscriptionLinkList - properties: - subscriptionLinkList: - $ref: '#/components/schemas/SubscriptionLinkList' - example: - subscriptionLinkList: - _links: - self: - href: 'http://meAppServer.example.com/wai/v2/subscriptions' - subscription: - - _links: - self: - href: 'http://meAppServer.example.com/wai/v2/subscriptions/sub123' - callbackReference: 'http://my.callback.com/wai/assocStaSubscription/some-id' - subscriptionType: AssocStaSubscription - '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': - $ref: '#/components/responses/429' - post: - tags: - - '' - summary: 'Create a new subscription' - description: 'Creates a new subscription to WLAN Access Information notifications' - operationId: subscriptionsPOST - requestBody: - description: Subscription to be created - required: true - content: - application/json: - schema: - type: object - properties: - notificationSubscription: - oneOf: - - $ref: '#/components/schemas/AssocStaSubscription' - - $ref: '#/components/schemas/StaDataRateSubscription' - discriminator: - propertyName: subscriptionType - example: - notificationSubscription: - subscriptionType: AssocStaSubscription - callbackReference: 'http://meAppClient.example.com/wai/v2/notifications/1' - expiryDeadline: - seconds: 1977836800 - nanoSeconds: 0 - apId: - macId: 005C0A0A0A0A - ssid: 'myNetworkSsid' - ipAddress: 10.10.100.1 - responses: - '201': - description: Successful subscription response - content: - application/json: - schema: - type: object - properties: - notificationSubscription: - oneOf: - - $ref: '#/components/schemas/AssocStaSubscription' - - $ref: '#/components/schemas/StaDataRateSubscription' - discriminator: - propertyName: subscriptionType - example: - notificationSubscription: - subscriptionType: AssocStaSubscription - callbackReference: 'http://meAppClient.example.com/wai/v2/notifications/1' - _links: - self: - href: 'http://meAppServer.example.com/wai/v2/subscriptions/sub123' - expiryDeadline: - seconds: 1977836800 - nanoSeconds: 0 - apId: - macId: 005C0A0A0A0A - ssid: 'myNetworkSsid' - ipAddress: 10.10.100.1 - '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': - $ref: '#/components/responses/415' - '422': - $ref: '#/components/responses/422' - '429': - $ref: '#/components/responses/429' - callbacks: - notification: - '{$request.body#/callbackReference}': - post: - summary: 'Callback POST used to send a notification' - description: 'Notification from WAIS, content based on subscription type' - operationId: notificationPOST - requestBody: - description: Subscription notification - required: true - content: - application/json: - schema: - type: object - properties: - notification: - oneOf: - - $ref: '#/components/schemas/AssocStaNotification' - - $ref: '#/components/schemas/StaDataRateNotification' - discriminator: - propertyName: notificationType - example: - notification: - notificationType: AssocStaNotification - timeStamp: - seconds: 1977836800 - nanoseconds: 0 - apId: - macId: 005C0A0A0A0A - ssid: 'myNetworkSsid' - ipAddress: 10.10.100.1 - staId: - macId: 005C01111111 - ssid: - - 'myNetworkSsid' - - 'myOtherNetworkSsid' - aid: '1122' - ipAddress: 10.10.1.255 - responses: - '204': - $ref: '#/components/responses/204' - '/subscriptions/{subscriptionId}': - get: - tags: - - '' - summary: 'Retrieve information on current specific subscription' - description: 'Queries information about an existing subscription, identified by its self-referring URI returned on creation (initial POST)' - operationId: subscriptionsGET - parameters: - - $ref: '#/components/parameters/Path.subscrId' - responses: - '200': - description: Subscription information regarding subscription notifications - content: - application/json: - schema: - type: object - required: - - notificationSubscription - properties: - notificationSubscription: - oneOf: - - $ref: '#/components/schemas/AssocStaSubscription' - - $ref: '#/components/schemas/StaDataRateSubscription' - discriminator: - propertyName: subscriptionType - example: - notificationSubscription: - subscriptionType: AssocStaSubscription - callbackReference: 'http://meAppClient.example.com/wai/v2/notifications/1' - _links: - self: - href: 'http://meAppServer.example.com/wai/v2/subscriptions/sub123' - expiryDeadline: - seconds: 1977836800 - nanoSeconds: 0 - apId: - macId: 005C0A0A0A0A - ssid: 'myNetworkSsid' - ipAddress: 10.10.100.1 - '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': - $ref: '#/components/responses/429' - put: - tags: - - '' - summary: 'Modify an existing subscription' - description: 'Updates an existing subscription, identified by its self-referring URI returned on creation (initial POST)' - operationId: subscriptionsPUT - requestBody: - description: Subscription to be modified - required: true - content: - application/json: - schema: - type: object - properties: - notificationSubscription: - oneOf: - - $ref: '#/components/schemas/AssocStaSubscription' - - $ref: '#/components/schemas/StaDataRateSubscription' - discriminator: - propertyName: subscriptionType - example: - notificationSubscription: - subscriptionType: AssocStaSubscription - callbackReference: 'http://meAppClient.example.com/wai/v2/notifications/1' - _links: - self: - href: 'http://meAppServer.example.com/wai/v2/subscriptions/sub123' - expiryDeadline: - seconds: 1977836800 - nanoSeconds: 0 - apId: - macId: 005C0A0A0A0A - ssid: 'myNetworkSsid' - ipAddress: 10.10.100.1 - parameters: - - $ref: '#/components/parameters/Path.subscrId' - responses: - '200': - description: Successful subscription modification - content: - application/json: - schema: - type: object - properties: - subscription: - oneOf: - - $ref: '#/components/schemas/AssocStaSubscription' - - $ref: '#/components/schemas/StaDataRateSubscription' - discriminator: - propertyName: subscriptionType - example: - subscription: - _links: - self: - href: 'http://[hostIP]/sbox-xyz123/wai/v2/subscriptions/sub123' - callbackReference: 'http://my.callback.com/wai/some-id' - apId: - macId: 005C0A0A0A0A - '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: - - '' - summary: 'Cancel an existing subscription' - description: 'Cancels an existing subscription, identified by its self-referring URI returned on creation (initial POST)' - operationId: subscriptionsDELETE - parameters: - - $ref: '#/components/parameters/Path.subscrId' - 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/json: - schema: - type: object - properties: - problemDetails: - $ref: '#/components/schemas/ProblemDetails' - 401: - description: 'Unauthorized : used when the client did not submit credentials.' - content: - application/json: - schema: - type: object - properties: - problemDetails: - $ref: '#/components/schemas/ProblemDetails' - 403: - description: 'Forbidden : operation is not allowed given the current status of the resource.' - content: - application/json: - schema: - type: object - required: - - problemDetails - properties: - problemDetails: - $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/json: - schema: - type: object - properties: - problemDetails: - $ref: '#/components/schemas/ProblemDetails' - 406: - description: 'Not Acceptable : used to indicate that the server cannot provide the any of the content formats supported by the client.' - content: - application/json: - schema: - type: object - properties: - problemDetails: - $ref: '#/components/schemas/ProblemDetails' - 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' - content: - application/json: - schema: - type: object - properties: - problemDetails: - $ref: '#/components/schemas/ProblemDetails' - 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/json: - schema: - type: object - properties: - problemDetails: - $ref: '#/components/schemas/ProblemDetails' - 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.' - content: - application/json: - schema: - type: object - properties: - problemDetails: - $ref: '#/components/schemas/ProblemDetails' - example: - application/problem+json: - ProblemDetails: - 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 - 429: - description: 'Too Many Requests : used when a rate limiter has triggered.' - content: - application/json: - schema: - type: object - properties: - problemDetails: - $ref: '#/components/schemas/ProblemDetails' - parameters: - Path.subscrId: - name: subscriptionId - in: path - description: 'Subscription Id, specifically the "self" returned in the subscription request' - required: true - schema: - type: string - format: uri - 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 - 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 - 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 - 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: - type: string - Query.ExcludeDefault: - name: exclude_default - in: query - description: 'Indicates to exclude the following complex attributes from the response. See clause 6.18 of ETSI GS MEC 009 for details. - The following attributes shall be excluded from the structure in the response body if this parameter is provided, or none of the parameters - "all_fields", "fields", "exclude_fields", "exclude_default" are provided: Not applicable' - required: false - schema: - type: array - items: - type: string - Query.SubscriptionType: - name: subscription_type - in: query - description: 'Filter on a specific subscription type. Permitted values: assoc_sta, sta_data_rate.' - required: false - schema: - type: string - schemas: - ApAssociated: - properties: - assocId: - description: Unique number which identifies a particular association between - the station and Access Point. - type: string - x-etsi-mec-cardinality: 0..1 - x-etsi-mec-origin-type: string - ipAddress: - description: IPv4 or IPv6 address allocated for the Access Point. - items: - type: string - minItems: 0 - type: array - x-etsi-mec-cardinality: 0..N - x-etsi-mec-origin-type: string - macId: - description: Unique identifier assigned to the Access Point (as network - interface controller) for communications at the data link layer of a network - segment. - type: string - x-etsi-mec-cardinality: '1' - x-etsi-mec-origin-type: string - ssid: - description: Service Set Identifier to identify logical networks. - items: - type: string - minItems: 0 - type: array - x-etsi-mec-cardinality: 0..N - x-etsi-mec-origin-type: String - required: - - macId - type: object - x-etsi-ref: 6.5.12 - ApIdentity: - properties: - ipAddress: - description: IPv4 or IPv6 address allocated for the Access Point. - items: - type: string - minItems: 0 - type: array - x-etsi-mec-cardinality: 0..N - x-etsi-mec-origin-type: String - macId: - description: Unique Identifier assigned to an Access Point (as network interface - controller) for communications at the data link layer of a network segment. - type: string - x-etsi-mec-cardinality: '1' - x-etsi-mec-origin-type: String - ssid: - description: Service Set Identifier to identify logical networks including - Basic Service Set and Extended Service Set. - items: - type: string - minItems: 0 - type: array - x-etsi-mec-cardinality: 0..N - x-etsi-mec-origin-type: String - required: - - macId - type: object - x-etsi-ref: 6.5.3 - ApInfo: - properties: - apId: - allOf: - - $ref: '#/components/schemas/ApIdentity' - - description: Identifier(s) to uniquely specify the Access Point whose information is exposed within this data type. - - x-etsi-mec-cardinality: '1' - - x-etsi-mec-origin-type: ApIdentity - apLocation: - allOf: - - $ref: '#/components/schemas/ApLocation' - - description: The location on the Access Point. - - x-etsi-mec-cardinality: 0..1 - - x-etsi-mec-origin-type: ApLocation - apNeighbor: - allOf: - - $ref: '#/components/schemas/NeighborReport' - - description: Information about neighbor Access Points. - - x-etsi-mec-cardinality: 0..1 - - x-etsi-mec-origin-type: NeighborReport - bssLoad: - allOf: - - $ref: '#/components/schemas/BssLoad' - - description: "BSS Load attribute contains information on the current STA\ - \ population and traffic levels in the BSS as defined in IEEE\_802.11-2016\ - \ [8]." - - x-etsi-mec-cardinality: 0..1 - - x-etsi-mec-origin-type: BssLoad - channel: - type: integer - format: uint32 - description: Channel configured for the Access Point. - x-etsi-mec-cardinality: 0..1 - x-etsi-mec-origin-type: Uint32 - extBssLoad: - allOf: - - $ref: '#/components/schemas/ExtBssLoad' - - description: 'Extended BSS Load attribute contains more detailed information - on the current STA population and traffic levels in the BSS as per ETSI - GS MEC 002 [i.4].' - - x-etsi-mec-cardinality: 0..1 - - x-etsi-mec-origin-type: ExtBssLoad - timeStamp: - allOf: - - $ref: '#/components/schemas/TimeStamp' - - description: Time stamp. - - x-etsi-mec-cardinality: 0..1 - - x-etsi-mec-origin-type: TimeStamp - wanMetrics: - allOf: - - $ref: '#/components/schemas/WanMetrics' - - description: "WAN Metrics element provides information about the WAN link\ - \ connecting an IEEE 802.11 Access Node and the Internet. Transmission\ - \ characteristics such as the speed of the WAN connection to the Internet\ - \ are included in Hotspot\_2.0 Technical Specification v1.0.0 [i.3]." - - x-etsi-mec-cardinality: 0..1 - - x-etsi-mec-origin-type: WanMetrics - wlanCap: - allOf: - - $ref: '#/components/schemas/WlanCapabilities' - - description: WLAN capabilities of Access Point. - - x-etsi-mec-cardinality: 0..1 - - x-etsi-mec-origin-type: WlanCapabilities - required: - - apId - type: object - x-etsi-ref: 6.2.2 - ApLocation: - properties: - civicLocation: - allOf: - - $ref: '#/components/schemas/CivicLocation' - - description: Civic Location of the AP as described in IETF RFC 4776 [7]. - - x-etsi-mec-cardinality: 0..1 - - x-etsi-mec-origin-type: CivicLocation - geolocation: - allOf: - - $ref: '#/components/schemas/GeoLocation' - - description: Geospatial Location of the AP as defined in IEEE 802.11-2016 [8]. - - x-etsi-mec-cardinality: 0..1 - - x-etsi-mec-origin-type: GeoLocation - type: object - x-etsi-ref: 6.5.9 - AssocStaNotification: - properties: - apId: - allOf: - - $ref: '#/components/schemas/ApIdentity' - - description: Identifier(s) to uniquely specify the Access Point to which the client stations are associated. - - x-etsi-mec-cardinality: '1' - - x-etsi-mec-origin-type: ApIdentity - notificationType: - description: Shall be set to "AssocStaNotification". - type: string - x-etsi-mec-cardinality: '1' - x-etsi-mec-origin-type: String - staId: - description: Identifier(s) to uniquely specify the client station(s) associated. - items: - $ref: '#/components/schemas/StaIdentity' - minItems: 0 - type: array - x-etsi-mec-cardinality: 0..N - x-etsi-mec-origin-type: StaIdentity - timeStamp: - allOf: - - $ref: '#/components/schemas/TimeStamp' - - description: Time stamp. - - x-etsi-mec-cardinality: 0..1 - - x-etsi-mec-origin-type: TimeStamp - required: - - notificationType - - apId - type: object - x-etsi-ref: 6.4.2 - AssocStaSubscription: - properties: - _links: - description: Hyperlink related to the resource. This shall be only included - in the HTTP responses and in HTTP PUT requests. - properties: - self: - allOf: - - $ref: '#/components/schemas/LinkType' - - description: URI referring to a resource - - x-etsi-mec-cardinality: 1 - - x-etsi-mec-origin-type: LinkType - type: object - x-etsi-mec-cardinality: 0..1 - x-etsi-mec-origin-type: Structure (inlined) - apId: - allOf: - - $ref: '#/components/schemas/ApIdentity' - - description: Identifier(s) to uniquely specify the target Access Point - for the subscription - - x-etsi-mec-cardinality: '1' - - x-etsi-mec-origin-type: ApIdentity - callbackReference: - description: URI selected by the service consumer to receive notifications - on the subscribed WLAN information. This shall be included both in the - request and in response. - format: uri - type: string - x-etsi-mec-cardinality: '1' - x-etsi-mec-origin-type: URI - expiryDeadline: - allOf: - - $ref: '#/components/schemas/TimeStamp' - - description: The expiration time of the subscription determined by the - WLAN Access Information Service. - - x-etsi-mec-cardinality: 0..1 - - x-etsi-mec-origin-type: TimeStamp - subscriptionType: - description: Shall be set to "AssocStaSubscription". - type: string - x-etsi-mec-cardinality: '1' - x-etsi-mec-origin-type: String - required: - - subscriptionType - - callbackReference - - apId - type: object - x-etsi-ref: 6.3.2 - AssociatedStations: - properties: - assocId: - description: Unique number which identifies a particular association between - an Access Point and a station. - type: string - x-etsi-mec-cardinality: 0..1 - x-etsi-mec-origin-type: string - ipAddress: - description: IPv4 or IPv6 address allocated for the station associated with - the Access Point. - items: - type: string - minItems: 0 - type: array - x-etsi-mec-cardinality: 0..N - x-etsi-mec-origin-type: string - macId: - description: Unique identifier assigned to a station (as network interface - controller) for communications at the data link layer of a network segment. - type: string - x-etsi-mec-cardinality: '1' - x-etsi-mec-origin-type: string - required: - - macId - type: object - x-etsi-ref: 6.5.5 - BeaconReport: - properties: - bssId: - description: The BSSID field indicates the BSSID of the BSS(s) for which - a beacon report has been received. - items: - type: string - minItems: 1 - type: array - x-etsi-mec-cardinality: 1..N - x-etsi-mec-origin-type: String - channelId: - description: Channel number where the beacon was received. - type: integer - x-etsi-mec-cardinality: '1' - x-etsi-mec-origin-type: Integer - measurementId: - description: Measurement ID of the Measurement configuration applied to - this Beacon Report. - type: string - x-etsi-mec-cardinality: '1' - x-etsi-mec-origin-type: String - reportingCondition: - description: As in table T9-89 of IEEE 802.11-2012 [8]. - type: integer - x-etsi-mec-cardinality: '1' - x-etsi-mec-origin-type: Integer - ssId: - description: (Optional) The SSID subelement indicates the ESS(s) or IBSS(s) - for which a beacon report is received. - items: - type: string - minItems: 1 - type: array - x-etsi-mec-cardinality: 1..N - x-etsi-mec-origin-type: String - staId: - allOf: - - $ref: '#/components/schemas/StaIdentity' - - description: Identifier to uniquely specify the station whose information is exposed within this data type. - - x-etsi-mec-cardinality: '1' - - x-etsi-mec-origin-type: StaIdentity - required: - - staId - - measurementId - - channelId - - bssId - - ssId - - reportingCondition - type: object - x-etsi-ref: 6.5.27 - BeaconRequestConfig: - properties: - bssId: - description: The BSSID field indicates the BSSID of the BSS(s) for which - a beacon report is requested. When requesting beacon reports for all BSSs - on the channel, the BSSID field contains the wildcard BSSID. - items: - type: string - minItems: 1 - type: array - x-etsi-mec-cardinality: 1..N - x-etsi-mec-origin-type: String - channelId: - description: Channel number to scan. A Channel Number of 0 indicates a request - to make iterative measurements for all supported channels in the Operating - Class where the measurement is permitted on the channel and the channel - is valid for the current regulatory domain. A Channel Number of 255 indicates - a request to make iterative measurements for all supported channels in - the current Operating Class listed in the latest AP Channel Report received - from the serving AP. - type: integer - x-etsi-mec-cardinality: '1' - x-etsi-mec-origin-type: Integer - measurementMode: - description: '0 for passive. - - 1 for active. - - 2 for beacon table.' - type: integer - x-etsi-mec-cardinality: '1' - x-etsi-mec-origin-type: Integer - reportingCondition: - description: As in table T9-89 of IEEE 802.11-2012 [8]. - type: integer - x-etsi-mec-cardinality: '1' - x-etsi-mec-origin-type: Integer - ssId: - description: (Optional) The SSID subelement indicates the ESS(s) or IBSS(s) - for which a beacon report is requested. - items: - type: string - minItems: 1 - type: array - x-etsi-mec-cardinality: 1..N - x-etsi-mec-origin-type: String - staId: - allOf: - - $ref: '#/components/schemas/StaIdentity' - - description: Identifier to uniquely specify the station whose information is exposed within this data type. - - x-etsi-mec-cardinality: '1' - - x-etsi-mec-origin-type: StaIdentity - required: - - staId - - channelId - - measurementMode - - bssId - - ssId - - reportingCondition - type: object - x-etsi-ref: 6.5.25 - BssLoad: - properties: - availAdmCap: - type: integer - description: Available Admission Capacity that specifies the remaining amount - of medium time available via explicit admission control, in units of 32 - s/s. - x-etsi-mec-cardinality: '1' - x-etsi-mec-origin-type: Uint16 - channelUtilization: - type: integer - description: "The percentage of time, linearly scaled with 255 representing\ - \ 100\_%, that the AP sensed the medium was busy, as indicated by either\ - \ the physical or virtual Carrier Sense (CS) mechanism." - x-etsi-mec-cardinality: '1' - x-etsi-mec-origin-type: UInt8 - staCount: - type: integer - description: An unsigned integer that indicates the total number of STAs - currently associated with this BSS. - x-etsi-mec-cardinality: '1' - x-etsi-mec-origin-type: UInt16 - required: - - staCount - - channelUtilization - - availAdmCap - type: object - x-etsi-ref: 6.5.7 - ChannelLoadConfig: - properties: - apId: - allOf: - - $ref: '#/components/schemas/ApIdentity' - - description: Identifier(s) to uniquely specify the target Access Point - - x-etsi-mec-cardinality: '1' - - x-etsi-mec-origin-type: ApIdentity - cChannelId: - description: Channel number which load is reported - type: integer - x-etsi-mec-cardinality: '1' - x-etsi-mec-origin-type: Integer - channelLoad: - description: Channel load as per IEEE 802.11-2012 [8], section 11.11.9.3 - type: integer - x-etsi-mec-cardinality: '1' - x-etsi-mec-origin-type: Integer - required: - - apId - - cChannelId - - channelLoad - type: object - x-etsi-ref: 6.5.24 - CivicLocation: - properties: - ca0: - description: Language - type: string - x-etsi-mec-cardinality: 0..1 - x-etsi-mec-origin-type: String - ca1: - description: 'National subdivisions (state, canton, region,province, prefecture) ' - type: string - x-etsi-mec-cardinality: 0..1 - x-etsi-mec-origin-type: String - ca128: - description: Script - type: string - x-etsi-mec-cardinality: 0..1 - x-etsi-mec-origin-type: String - ca16: - description: Leading street direction - type: string - x-etsi-mec-cardinality: 0..1 - x-etsi-mec-origin-type: String - ca17: - description: Trailing street suffix - type: string - x-etsi-mec-cardinality: 0..1 - x-etsi-mec-origin-type: String - ca18: - description: Street suffix or type - type: string - x-etsi-mec-cardinality: 0..1 - x-etsi-mec-origin-type: String - ca19: - description: House number - type: string - x-etsi-mec-cardinality: 0..1 - x-etsi-mec-origin-type: String - ca2: - description: County, parish, gun (JP), district (IN) - type: string - x-etsi-mec-cardinality: 0..1 - x-etsi-mec-origin-type: String - ca20: - description: House number suffix - type: string - x-etsi-mec-cardinality: 0..1 - x-etsi-mec-origin-type: String - ca21: - description: Landmark of vanity address - type: string - x-etsi-mec-cardinality: 0..1 - x-etsi-mec-origin-type: String - ca22: - description: Additional location information - type: string - x-etsi-mec-cardinality: 0..1 - x-etsi-mec-origin-type: String - ca23: - description: Name (residence and office occupant) - type: string - x-etsi-mec-cardinality: 0..1 - x-etsi-mec-origin-type: String - ca24: - description: Postal/zip code - type: string - x-etsi-mec-cardinality: 0..1 - x-etsi-mec-origin-type: String - ca25: - description: Building (structure) - type: string - x-etsi-mec-cardinality: 0..1 - x-etsi-mec-origin-type: String - ca26: - description: Unit (apartment/suite) - type: string - x-etsi-mec-cardinality: 0..1 - x-etsi-mec-origin-type: String - ca27: - description: Floor - type: string - x-etsi-mec-cardinality: 0..1 - x-etsi-mec-origin-type: String - ca28: - description: Room - type: string - x-etsi-mec-cardinality: 0..1 - x-etsi-mec-origin-type: String - ca29: - description: Type of place - type: string - x-etsi-mec-cardinality: 0..1 - x-etsi-mec-origin-type: String - ca3: - description: City, township, shi (JP) - type: string - x-etsi-mec-cardinality: 0..1 - x-etsi-mec-origin-type: String - ca30: - description: Postal community name - type: string - x-etsi-mec-cardinality: 0..1 - x-etsi-mec-origin-type: String - ca31: - description: Post office box - type: string - x-etsi-mec-cardinality: 0..1 - x-etsi-mec-origin-type: String - ca32: - description: Additional code - type: string - x-etsi-mec-cardinality: 0..1 - x-etsi-mec-origin-type: String - ca33: - description: Seat (desk.cubicle, workstation) - type: string - x-etsi-mec-cardinality: 0..1 - x-etsi-mec-origin-type: String - ca34: - description: Primary road name - type: string - x-etsi-mec-cardinality: 0..1 - x-etsi-mec-origin-type: String - ca35: - description: Road section - type: string - x-etsi-mec-cardinality: 0..1 - x-etsi-mec-origin-type: String - ca36: - description: Branch road name - type: string - x-etsi-mec-cardinality: 0..1 - x-etsi-mec-origin-type: String - ca37: - description: Sub-branch road name - type: string - x-etsi-mec-cardinality: 0..1 - x-etsi-mec-origin-type: String - ca38: - description: Street name pre-modifier - type: string - x-etsi-mec-cardinality: 0..1 - x-etsi-mec-origin-type: String - ca39: - description: Street name post-modifier - type: string - x-etsi-mec-cardinality: 0..1 - x-etsi-mec-origin-type: String - ca4: - description: City division, borough, city district, ward, chou (JP) - type: string - x-etsi-mec-cardinality: 0..1 - x-etsi-mec-origin-type: String - ca5: - description: Neighborhood, block - type: string - x-etsi-mec-cardinality: 0..1 - x-etsi-mec-origin-type: String - ca6: - description: 'Group of streets below the neighborhood level ' - type: string - x-etsi-mec-cardinality: 0..1 - x-etsi-mec-origin-type: String - country: - description: The two-letter ISO 3166 [i.9] country code in capital ASCII - letters, e.g. DE or US, as per ISO 3166 [i.9] - type: string - x-etsi-mec-cardinality: '1' - x-etsi-mec-origin-type: String - required: - - country - type: object - x-etsi-ref: 6.5.20 - DmgCapabilities: - properties: - ExtScMcsCap: - description: Extended SC MCS capabilities as defined in draft IEEE P802.11/D4.0 - [i.11] - type: integer - x-etsi-mec-cardinality: '1' - x-etsi-mec-origin-type: Uint8 - dmgApOrPcpCapInfo: - type: integer - description: DMG AP or PCP capabilities information as defined in draft - IEEE P802.11/D4.0 [i.11] - x-etsi-mec-cardinality: '1' - x-etsi-mec-origin-type: Uint16 - dmgStaBeamTrackTimeLimit: - type: integer - description: DMG station beam tracking time limit as defined in draft IEEE - P802.11/D4.0 [i.11] - x-etsi-mec-cardinality: '1' - x-etsi-mec-origin-type: Uint16 - dmgStaCapInfo: - type: integer - description: DMG station capabilities information as defined in draft IEEE - P802.11/D4.0 [i.11] - x-etsi-mec-cardinality: '1' - x-etsi-mec-origin-type: Uint64 - maxNrBasicAmsduSubframes: - description: Number of basic A-MSDU subframes in A-MSDU as defined in draft - IEEE P802.11/D4.0 [i.11] - type: integer - x-etsi-mec-cardinality: '1' - x-etsi-mec-origin-type: Uint8 - maxNrShortAmsduSubframes: - description: Number of short A-MSDU subframes in A-MSDU as defined in draft - IEEE P802.11/D4.0 [i.11] - type: integer - x-etsi-mec-cardinality: '1' - x-etsi-mec-origin-type: Uint8 - sarCap: - description: SAR capabilities as defined in draft IEEE P802.11/D4.0 [i.11] - type: integer - x-etsi-mec-cardinality: '1' - x-etsi-mec-origin-type: Uint8 - tddCap: - type: integer - description: TDD capabilities as defined in draft IEEE P802.11/D4.0 [i.11] - x-etsi-mec-cardinality: '1' - x-etsi-mec-origin-type: Uint16 - required: - - dmgStaCapInfo - - dmgApOrPcpCapInfo - - dmgStaBeamTrackTimeLimit - - ExtScMcsCap - - maxNrBasicAmsduSubframes - - maxNrShortAmsduSubframes - - tddCap - - sarCap - type: object - x-etsi-ref: 6.5.17 - EdmgCapabilities: - properties: - ampduParameters: - description: A-MPDU parameters as defined in draft IEEE P802.11/D4.0 [i.11] - type: integer - x-etsi-mec-cardinality: '1' - x-etsi-mec-origin-type: Uint8 - reserved: - description: '' - type: integer - x-etsi-mec-cardinality: 0..1 - x-etsi-mec-origin-type: Uint8 - supportedMcs: - type: integer - format: uint32 - description: Supported MCS as defined in draft IEEE P802.11/D4.0 [i.11] - x-etsi-mec-cardinality: '1' - x-etsi-mec-origin-type: Uint32 - trnParameters: - type: integer - description: Training parameters as defined in draft IEEE P802.11/D4.0 [i.11] - x-etsi-mec-cardinality: '1' - x-etsi-mec-origin-type: Uint16 - required: - - ampduParameters - - trnParameters - - supportedMcs - type: object - x-etsi-ref: 6.5.18 - ExtBssLoad: - properties: - muMimoStaCount: - type: integer - description: Indicates the total number of STAs currently associated with - this BSS that have a 1 in the MU Beamformee Capable field of their VHT - Capabilities element. - x-etsi-mec-cardinality: '1' - x-etsi-mec-origin-type: UInt16 - obsSec20MhzUtil: - description: Observable loading on each of the secondary 20 MHz channel. - type: integer - x-etsi-mec-cardinality: '1' - x-etsi-mec-origin-type: Uint8 - obsSec40MhzUtil: - description: Observable loading on each of the secondary 40 MHz channel. - type: integer - x-etsi-mec-cardinality: '1' - x-etsi-mec-origin-type: Uint8 - obsSec80MhzUtil: - description: Observable loading on each of the secondary 80 MHz channel. - type: integer - x-etsi-mec-cardinality: '1' - x-etsi-mec-origin-type: Uint8 - spatStreamUnderUtil: - type: integer - description: "The percentage of time, linearly scaled with 255 representing\ - \ 100\_%, that the AP has underutilized spatial domain resources for given\ - \ busy time of the medium." - x-etsi-mec-cardinality: '1' - x-etsi-mec-origin-type: UInt8 - required: - - muMimoStaCount - - spatStreamUnderUtil - - obsSec20MhzUtil - - obsSec40MhzUtil - - obsSec80MhzUtil - type: object - x-etsi-ref: 6.5.8 - GeoLocation: - properties: - altitude: - type: integer - format: uint32 - description: "The altitude value of location as defined in IETF RFC\_6225\ - \ [6]" - x-etsi-mec-cardinality: 0..1 - x-etsi-mec-origin-type: Uint32 - altitudeType: - description: The type description for altitude information e.g. floors or - meters as defined in IETF RFC 6225 [6] - type: integer - x-etsi-mec-cardinality: 0..1 - x-etsi-mec-origin-type: Uint8 - altitudeUncertainty: - description: The uncertainty for altitude information as defined in IETF - RFC 6225 [6] - type: integer - x-etsi-mec-cardinality: 0..1 - x-etsi-mec-origin-type: Uint8 - datum: - description: The datum value to express how coordinates are organized and - related to real world as defined in IETF RFC 6225 [6] - type: integer - x-etsi-mec-cardinality: '1' - x-etsi-mec-origin-type: Uint8 - lat: - type: integer - description: "The latitude value of location as defined in IETF RFC\_6225\ - \ [6]" - x-etsi-mec-cardinality: '1' - x-etsi-mec-origin-type: Uint64 - latUncertainty: - description: The uncertainty for Latitude information as defined in IETF - RFC 6225 [6] - type: integer - x-etsi-mec-cardinality: '1' - x-etsi-mec-origin-type: Uint8 - long: - type: integer - description: "The longitude value of location as defined in IETF RFC\_6225\ - \ [6]" - x-etsi-mec-cardinality: '1' - x-etsi-mec-origin-type: Uint64 - longUncertainty: - description: The uncertainty for Longitude information as defined in IETF - RFC 6225 [6] - type: integer - x-etsi-mec-cardinality: '1' - x-etsi-mec-origin-type: Uint8 - required: - - latUncertainty - - lat - - longUncertainty - - long - - datum - type: object - x-etsi-ref: 6.5.19 - HeCapabilities: - properties: - heMacCapInfo: - description: MAC capabilities of an Access Point. - type: integer - x-etsi-mec-cardinality: '1' - x-etsi-mec-origin-type: Uint8 - hePhyCapinfo: - description: PHY capabilities of an Access Point. - type: integer - x-etsi-mec-cardinality: '1' - x-etsi-mec-origin-type: Uint8 - ppeThresholds: - description: PPE Threshold determines the nominal packet padding value for - a HE PPDU. - type: integer - x-etsi-mec-cardinality: 0..1 - x-etsi-mec-origin-type: not defined - supportedHeMcsNssSet: - description: Supported MCS and NSS Set. - type: integer - x-etsi-mec-cardinality: '1' - x-etsi-mec-origin-type: Uint8 - required: - - heMacCapInfo - - hePhyCapinfo - - supportedHeMcsNssSet - type: object - x-etsi-ref: 6.5.16 - HtCapabilities: - properties: - ampduParameters: - type: integer - description: A-MPDU parameters as defined in IEEE 802.11-2016 [8]. - x-etsi-mec-cardinality: '1' - x-etsi-mec-origin-type: UInt8 - aselCap: - type: integer - description: ASEL capabilities as defined in IEEE 802.11-2016 [8]. - x-etsi-mec-cardinality: '1' - x-etsi-mec-origin-type: UInt8 - htCapabilityInfo: - type: integer - description: HT Capability Information as defined in IEEE 802.11-2016 [8]. - x-etsi-mec-cardinality: '1' - x-etsi-mec-origin-type: UInt16 - htExtendedCap: - type: integer - description: Extended HT Capabilities as defined in IEEE 802.11-2016 [8]. - x-etsi-mec-cardinality: '1' - x-etsi-mec-origin-type: UInt16 - supportedMcsSet: - type: integer - format: uint64 - description: Supported MCS set as defined in IEEE 802.11-2016 [8]. - x-etsi-mec-cardinality: '1' - x-etsi-mec-origin-type: Uint128 - txBeamFormCap: - type: integer - format: uint32 - description: Transmit Beamforming Capabilities as defined in IEEE 802.11-2016 - [8]. - x-etsi-mec-cardinality: '1' - x-etsi-mec-origin-type: UInt32 - required: - - htCapabilityInfo - - ampduParameters - - supportedMcsSet - - htExtendedCap - - txBeamFormCap - - aselCap - type: object - x-etsi-ref: 6.5.14 - LinkType: - properties: - href: - description: URI referring to a resource - type: string - x-etsi-mec-cardinality: '1' - x-etsi-mec-origin-type: String - required: - - href - type: object - x-etsi-ref: 6.5.23 - MeasurementConfig: - properties: - beaconRequest: - allOf: - - $ref: '#/components/schemas/BeaconRequestConfig' - - description: Configuration related to Beacon Request. - - x-etsi-mec-cardinality: 0..1 - - x-etsi-mec-origin-type: BeaconRequestConfig - channelLoad: - allOf: - - $ref: '#/components/schemas/ChannelLoadConfig' - - description: Configuration related to the Channel Load. - - x-etsi-mec-cardinality: 0..1 - - x-etsi-mec-origin-type: ChannelLoadConfig - measurementDuration: - description: Duration of the measurement, shall be lower than Maximum Measurement - Duration in TU as defined in section 11.11.4 of IEEE 802.11 [8]. - type: integer - x-etsi-mec-cardinality: '1' - x-etsi-mec-origin-type: Integer - measurementId: - description: Identifier of this measurement configuration. - type: string - x-etsi-mec-cardinality: '1' - x-etsi-mec-origin-type: String - randomnInterval: - description: "Random interval to be used for starting the measurement. In\ - \ units of TU as specifed in section\_11.11.3 of IEEE 802.11 [8]." - type: integer - x-etsi-mec-cardinality: '1' - x-etsi-mec-origin-type: Integer - staStatistics: - allOf: - - $ref: '#/components/schemas/StaStatisticsConfig' - - description: Configuration related to the statistics provided by STAs. - - x-etsi-mec-cardinality: 0..1 - - x-etsi-mec-origin-type: StaStatisticsConfig - required: - - measurementId - - measurementDuration - - randomnInterval - type: object - x-etsi-notes: "NOTE:\tThis element enables the configuration of the channelLoad,\ - \ beaconRequest and staStatistics in a single resource data type, although\ - \ only one of each measurement. Multiple measurement configurations of each\ - \ kind are not allowed." - x-etsi-ref: 6.2.4 - NeighborReport: - properties: - bssid: - description: BSS Id of the Access Point that is being reported. - type: string - x-etsi-mec-cardinality: '1' - x-etsi-mec-origin-type: String - bssidInfo: - description: Additional information related to Access Point that is being - reported such as AP reachability, security, key scope, Mobility Domain, - HT/VHT capability and Fine Time Measurements. - format: uint32 - type: integer - x-etsi-mec-cardinality: '1' - x-etsi-mec-origin-type: UInt32 - channel: - description: The channel currently used by this Access Point. - type: integer - x-etsi-mec-cardinality: '1' - x-etsi-mec-origin-type: Uint8 - operatingClass: - description: The channel set of the AP indicated by this BSSID. - type: integer - x-etsi-mec-cardinality: '1' - x-etsi-mec-origin-type: Uint8 - phyType: - description: PHY type of the AP indicated by this BSSID. It is an integer - value coded according to the value of the dot11PHYType. - type: integer - x-etsi-mec-cardinality: '1' - x-etsi-mec-origin-type: Uint8 - required: - - bssid - - bssidInfo - - operatingClass - - channel - - phyType - type: object - x-etsi-ref: 6.5.10 - ProblemDetails: - properties: - detail: - description: A human-readable explanation specific to this occurrence of - the problem - type: string - x-etsi-mec-cardinality: 0..1 - x-etsi-mec-origin-type: String - instance: - description: A URI reference that identifies the specific occurrence of - the problem - format: uri - type: string - x-etsi-mec-cardinality: 0..1 - x-etsi-mec-origin-type: URI - status: - description: The HTTP status code for this occurrence of the problem - format: uint32 - type: integer - x-etsi-mec-cardinality: 0..1 - x-etsi-mec-origin-type: Uint32 - title: - description: A short, human-readable summary of the problem type - type: string - x-etsi-mec-cardinality: 0..1 - x-etsi-mec-origin-type: String - type: - description: A URI reference according to IETF RFC 3986 that identifies - the problem type - format: uri - type: string - x-etsi-mec-cardinality: 0..1 - x-etsi-mec-origin-type: URI - type: object - Rssi: - properties: - rssi: - description: The Received Signal Strength Indicator from a station - type: integer - x-etsi-mec-cardinality: '1' - x-etsi-mec-origin-type: Uint8 - required: - - rssi - type: object - x-etsi-ref: 6.5.21 - StaDataRate: - properties: - staId: - allOf: - - $ref: '#/components/schemas/StaIdentity' - - description: Identifier(s) to uniquely specify the client station(s) associated. - - x-etsi-mec-cardinality: 0..1 - - x-etsi-mec-origin-type: StaIdentity - staLastDataDownlinkRate: - description: The data transmit rate in kbps that was most recently used - for transmission of data PPDUs from the access point to the station. - format: uint32 - type: integer - x-etsi-mec-cardinality: 0..1 - x-etsi-mec-origin-type: Uint32 - staLastDataUplinkRate: - description: The data transmit rate in Kbps that was most recently used - for transmission of data PPDUs from the associated station to the access - point. - format: uint32 - type: integer - x-etsi-mec-cardinality: 0..1 - x-etsi-mec-origin-type: Uint32 - type: object - x-etsi-ref: 6.5.22 - StaDataRateNotification: - properties: - notificationType: - description: Shall be set to "StaDataRateNotification". - type: string - x-etsi-mec-cardinality: '1' - x-etsi-mec-origin-type: String - staDataRate: - description: Data rates of a client station. - items: - $ref: '#/components/schemas/StaDataRate' - minItems: 0 - type: array - x-etsi-mec-cardinality: 0..N - x-etsi-mec-origin-type: StaDataRate - timeStamp: - allOf: - - $ref: '#/components/schemas/TimeStamp' - - description: Time stamp. - - x-etsi-mec-cardinality: 0..1 - - x-etsi-mec-origin-type: TimeStamp - required: - - notificationType - type: object - x-etsi-ref: 6.4.3 - StaDataRateSubscription: - properties: - _links: - description: Hyperlink related to the resource. This shall be only included - in the HTTP responses and in HTTP PUT requests. - properties: - self: - allOf: - - $ref: '#/components/schemas/LinkType' - - description: URI referring to a resource - - x-etsi-mec-cardinality: 1 - - x-etsi-mec-origin-type: LinkType - type: object - x-etsi-mec-cardinality: 0..1 - x-etsi-mec-origin-type: Structure (inlined) - callbackReference: - description: URI selected by the service consumer to receive notifications - on the subscribed WLAN Access Information Service. This shall be included - both in the request and in response. - format: uri - type: string - x-etsi-mec-cardinality: '1' - x-etsi-mec-origin-type: URI - expiryDeadline: - allOf: - - $ref: '#/components/schemas/TimeStamp' - - description: The expiration time of the subscription determined by the - WLAN Access Information Service. - - x-etsi-mec-cardinality: 0..1 - - x-etsi-mec-origin-type: TimeStamp - staId: - description: Identifier(s) to uniquely specify the target client station(s) - for the subscription - items: - $ref: '#/components/schemas/StaIdentity' - minItems: 1 - type: array - x-etsi-mec-cardinality: 1..N - x-etsi-mec-origin-type: StaIdentity - subscriptionType: - description: Shall be set to "StaDataRateSubscription". - type: string - x-etsi-mec-cardinality: '1' - x-etsi-mec-origin-type: String - required: - - subscriptionType - - callbackReference - - staId - type: object - x-etsi-ref: 6.3.3 - StaIdentity: - properties: - aid: - description: 'Number which identifies a particular association between a - station and an Access Point ' - type: string - x-etsi-mec-cardinality: 0..1 - x-etsi-mec-origin-type: String - ipAddress: - description: IPv4 or IPv6 address allocated for the station. - items: - type: string - minItems: 0 - type: array - x-etsi-mec-cardinality: 0..N - x-etsi-mec-origin-type: String - macId: - description: Unique identifier assigned to station (as network interface - controller) for communications at the data link layer of a network segment. - type: string - x-etsi-mec-cardinality: '1' - x-etsi-mec-origin-type: String - ssid: - description: Service Set Identifier to identify logical networks. - items: - type: string - minItems: 0 - type: array - x-etsi-mec-cardinality: 0..N - x-etsi-mec-origin-type: String - required: - - macId - type: object - x-etsi-ref: 6.5.11 - StaInfo: - properties: - apAssociated: - allOf: - - $ref: '#/components/schemas/ApAssociated' - - description: Information about the Access Point that this Client Station is associated to. - - x-etsi-mec-cardinality: 0..1 - - x-etsi-mec-origin-type: ApAssociated - beaconReport: - allOf: - - $ref: '#/components/schemas/BeaconReport' - - description: Beacon Report as defined in Wi-Fi Agile Multiband Specification [9]. - - x-etsi-mec-cardinality: 0..1 - - x-etsi-mec-origin-type: BeaconReport - channel: - type: integer - format: uint32 - description: Channel currently used by the station. - x-etsi-mec-cardinality: 0..1 - x-etsi-mec-origin-type: Uint32 - rssi: - allOf: - - $ref: '#/components/schemas/Rssi' - - description: Receive Signal Strength Indicator. - - x-etsi-mec-cardinality: 0..1 - - x-etsi-mec-origin-type: Rssi - staDataRate: - allOf: - - $ref: '#/components/schemas/StaDataRate' - - description: Station Data Rate as defined in IEEE 802.11-2016 [8]. - - x-etsi-mec-cardinality: 0..1 - - x-etsi-mec-origin-type: StaDataRate - staId: - allOf: - - $ref: '#/components/schemas/StaIdentity' - - description: 0 to N identifiers to uniquely specify the station whose information is exposed within this data type. - - x-etsi-mec-cardinality: '1' - - x-etsi-mec-origin-type: StaIdentity - staStatistics: - allOf: - - $ref: '#/components/schemas/StaStatistics' - - description: Statistics as defined in IEEE 802.11-2016 [8] for the client station collected over measurement duration. - - x-etsi-mec-cardinality: 0..1 - - x-etsi-mec-origin-type: StaStatistics - timeStamp: - allOf: - - $ref: '#/components/schemas/TimeStamp' - - description: Time stamp. - - x-etsi-mec-cardinality: 0..1 - - x-etsi-mec-origin-type: TimeStamp - required: - - staId - type: object - x-etsi-ref: 6.2.3 - StaStatistics: - properties: - groupIdentity: - description: Indicates the requested statistics group describing the Statistics - Group Data according to table 9-114 of IEEE 802.11-2016 [8]. - type: integer - x-etsi-mec-cardinality: '1' - x-etsi-mec-origin-type: UInt8 - md: - description: Measurement Duration. - type: integer - x-etsi-mec-cardinality: '1' - x-etsi-mec-origin-type: UInt16 - statisticsGroupData: - allOf: - - $ref: '#/components/schemas/StatisticsGroupData' - - description: "Statistics Group Data as defined in Annex C of IEEE 802.112016\_\ [8]." - - x-etsi-mec-cardinality: '1' - - x-etsi-mec-origin-type: not specified - required: - - md - - groupIdentity - - statisticsGroupData - type: object - x-etsi-ref: 6.5.13 - StaStatisticsConfig: - properties: - groupIdentity: - description: As per table T 9-114 of IEEE 802.11-2012 [8]. - type: integer - x-etsi-mec-cardinality: '1' - x-etsi-mec-origin-type: Integer - staId: - allOf: - - $ref: '#/components/schemas/StaIdentity' - - description: Identifier to uniquely specify the station whose information is exposed within this data type. - - x-etsi-mec-cardinality: '1' - - x-etsi-mec-origin-type: StaIdentity - triggerCondition: - type: integer - description: As per Figure 9-161 of IEEE 802.11. This bitmap defines what - are the metrics returned by the STA Statistics Report. - x-etsi-mec-cardinality: '1' - x-etsi-mec-origin-type: 16bits bitmap - triggerTimeout: - description: The Trigger Timeout field contains a value in units of 100 - TUs during which a measuring STA does not generate further triggered STA - Statistics Reports after a trigger condition has been met. - type: integer - x-etsi-mec-cardinality: '1' - x-etsi-mec-origin-type: Integer - triggeredReport: - type: boolean - description: Yes, use triggered report. - x-etsi-mec-cardinality: '1' - x-etsi-mec-origin-type: Bool - required: - - staId - - groupIdentity - - triggeredReport - - triggerTimeout - - triggerCondition - type: object - x-etsi-ref: 6.5.26 - StatisticsGroupData: - properties: - dot11AMPDUDelimiterCRCErrorCount: - format: uint32 - type: integer - x-etsi-mec-cardinality: 0..1 - x-etsi-mec-origin-type: Uint32 - dot11AMPDUReceivedCount: - format: uint32 - type: integer - x-etsi-mec-cardinality: 0..1 - x-etsi-mec-origin-type: Uint32 - dot11AMSDUAckFailureCount: - format: uint32 - type: integer - x-etsi-mec-cardinality: 0..1 - x-etsi-mec-origin-type: Uint32 - dot11AckFailureCount: - format: uint32 - type: integer - x-etsi-mec-cardinality: 0..1 - x-etsi-mec-origin-type: Uint32 - dot11BeamformingFrameCount: - format: uint32 - type: integer - x-etsi-mec-cardinality: 0..1 - x-etsi-mec-origin-type: Uint32 - dot11ChannelWidthSwitchCount: - format: uint32 - type: integer - x-etsi-mec-cardinality: 0..1 - x-etsi-mec-origin-type: Uint32 - dot11DualCTSFailureCount: - format: uint32 - type: integer - x-etsi-mec-cardinality: 0..1 - x-etsi-mec-origin-type: Uint32 - dot11DualCTSSuccessCount: - format: uint32 - type: integer - x-etsi-mec-cardinality: 0..1 - x-etsi-mec-origin-type: Uint32 - dot11ExplicitBARFailureCount: - format: uint32 - type: integer - x-etsi-mec-cardinality: 0..1 - x-etsi-mec-origin-type: Uint32 - dot11FCSErrorCount: - format: uint32 - type: integer - x-etsi-mec-cardinality: 0..1 - x-etsi-mec-origin-type: Uint32 - dot11FailedAMSDUCount: - format: uint32 - type: integer - x-etsi-mec-cardinality: 0..1 - x-etsi-mec-origin-type: Uint32 - dot11FailedCount: - format: uint32 - type: integer - x-etsi-mec-cardinality: 0..1 - x-etsi-mec-origin-type: Uint32 - dot11FortyMHzFrameReceivedCount: - format: uint32 - type: integer - x-etsi-mec-cardinality: 0..1 - x-etsi-mec-origin-type: Uint32 - dot11FortyMHzFrameTransmittedCount: - format: uint32 - type: integer - x-etsi-mec-cardinality: 0..1 - x-etsi-mec-origin-type: Uint32 - dot11FrameDuplicateCount: - format: uint32 - type: integer - x-etsi-mec-cardinality: 0..1 - x-etsi-mec-origin-type: Uint32 - dot11GrantedRDGUnusedCount: - format: uint32 - type: integer - x-etsi-mec-cardinality: 0..1 - x-etsi-mec-origin-type: Uint32 - dot11GrantedRDGUsedCount: - format: uint32 - type: integer - x-etsi-mec-cardinality: 0..1 - x-etsi-mec-origin-type: Uint32 - dot11GroupReceivedFrameCount: - format: uint32 - type: integer - x-etsi-mec-cardinality: 0..1 - x-etsi-mec-origin-type: Uint32 - dot11GroupTransmittedFrameCount: - format: uint32 - type: integer - x-etsi-mec-cardinality: 0..1 - x-etsi-mec-origin-type: Uint32 - dot11ImplicitBARFailureCount: - format: uint32 - type: integer - x-etsi-mec-cardinality: 0..1 - x-etsi-mec-origin-type: Uint32 - dot11MPDUInReceivedAMPDUCount: - format: uint32 - type: integer - x-etsi-mec-cardinality: 0..1 - x-etsi-mec-origin-type: Uint32 - dot11MultipleRetryAMSDUCount: - format: uint32 - type: integer - x-etsi-mec-cardinality: 0..1 - x-etsi-mec-origin-type: Uint32 - dot11MultipleRetryCount: - format: uint32 - type: integer - x-etsi-mec-cardinality: 0..1 - x-etsi-mec-origin-type: Uint32 - dot11PSMPUTTGrantDuration: - format: uint32 - type: integer - x-etsi-mec-cardinality: 0..1 - x-etsi-mec-origin-type: Uint32 - dot11PSMPUTTUsedDuration: - format: uint32 - type: integer - x-etsi-mec-cardinality: 0..1 - x-etsi-mec-origin-type: Uint32 - dot11QosAckFailureCount: - format: uint32 - type: integer - x-etsi-mec-cardinality: 0..1 - x-etsi-mec-origin-type: Uint32 - dot11QosDiscardedFrameCount: - format: uint32 - type: integer - x-etsi-mec-cardinality: 0..1 - x-etsi-mec-origin-type: Uint32 - dot11QosFailedCount: - format: uint32 - type: integer - x-etsi-mec-cardinality: 0..1 - x-etsi-mec-origin-type: Uint32 - dot11QosFrameDuplicateCount: - format: uint32 - type: integer - x-etsi-mec-cardinality: 0..1 - x-etsi-mec-origin-type: Uint32 - dot11QosMPDUsReceivedCount: - format: uint32 - type: integer - x-etsi-mec-cardinality: 0..1 - x-etsi-mec-origin-type: Uint32 - dot11QosMultipleRetryCount: - format: uint32 - type: integer - x-etsi-mec-cardinality: 0..1 - x-etsi-mec-origin-type: Uint32 - dot11QosRTSFailureCount: - format: uint32 - type: integer - x-etsi-mec-cardinality: 0..1 - x-etsi-mec-origin-type: Uint32 - dot11QosRTSSuccessCount: - format: uint32 - type: integer - x-etsi-mec-cardinality: 0..1 - x-etsi-mec-origin-type: Uint32 - dot11QosReceivedFragmentCount: - format: uint32 - type: integer - x-etsi-mec-cardinality: 0..1 - x-etsi-mec-origin-type: Uint32 - dot11QosRetriesReceivedCount: - format: uint32 - type: integer - x-etsi-mec-cardinality: 0..1 - x-etsi-mec-origin-type: Uint32 - dot11QosRetryCount: - format: uint32 - type: integer - x-etsi-mec-cardinality: 0..1 - x-etsi-mec-origin-type: Uint32 - dot11QosTransmittedFragmentCount: - format: uint32 - type: integer - x-etsi-mec-cardinality: 0..1 - x-etsi-mec-origin-type: Uint32 - dot11QosTransmittedFrameCount: - format: uint32 - type: integer - x-etsi-mec-cardinality: 0..1 - x-etsi-mec-origin-type: Uint32 - dot11RSNAStatsBIPMICErrors: - format: uint32 - type: integer - x-etsi-mec-cardinality: 0..1 - x-etsi-mec-origin-type: Uint32 - dot11RSNAStatsCCMPDecryptErrors: - format: uint32 - type: integer - x-etsi-mec-cardinality: 0..1 - x-etsi-mec-origin-type: Uint32 - dot11RSNAStatsCCMPReplays: - format: uint32 - type: integer - x-etsi-mec-cardinality: 0..1 - x-etsi-mec-origin-type: Uint32 - dot11RSNAStatsCMACReplays: - format: uint32 - type: integer - x-etsi-mec-cardinality: 0..1 - x-etsi-mec-origin-type: Uint32 - dot11RSNAStatsRobustMgmtCCMPReplays: - format: uint32 - type: integer - x-etsi-mec-cardinality: 0..1 - x-etsi-mec-origin-type: Uint32 - dot11RSNAStatsTKIPICVErrors: - format: uint32 - type: integer - x-etsi-mec-cardinality: 0..1 - x-etsi-mec-origin-type: Uint32 - dot11RSNAStatsTKIPReplays: - format: uint32 - type: integer - x-etsi-mec-cardinality: 0..1 - x-etsi-mec-origin-type: Uint32 - dot11RTSFailureCount: - format: uint32 - type: integer - x-etsi-mec-cardinality: 0..1 - x-etsi-mec-origin-type: Uint32 - dot11RTSLSIGFailureCount: - format: uint32 - type: integer - x-etsi-mec-cardinality: 0..1 - x-etsi-mec-origin-type: Uint32 - dot11RTSLSIGSuccessCount: - format: uint32 - type: integer - x-etsi-mec-cardinality: 0..1 - x-etsi-mec-origin-type: Uint32 - dot11RTSSuccessCount: - format: uint32 - type: integer - x-etsi-mec-cardinality: 0..1 - x-etsi-mec-origin-type: Uint32 - dot11ReceivedAMSDUCount: - format: uint32 - type: integer - x-etsi-mec-cardinality: 0..1 - x-etsi-mec-origin-type: Uint32 - dot11ReceivedFragmentCount: - format: uint32 - type: integer - x-etsi-mec-cardinality: 0..1 - x-etsi-mec-origin-type: Uint32 - dot11ReceivedOctetsInAMPDUCount: - format: uint64 - type: integer - x-etsi-mec-cardinality: 0..1 - x-etsi-mec-origin-type: Uint64 - dot11ReceivedOctetsInAMSDUCount: - format: uint64 - type: integer - x-etsi-mec-cardinality: 0..1 - x-etsi-mec-origin-type: Uint64 - dot11RetryAMSDUCount: - format: uint32 - type: integer - x-etsi-mec-cardinality: 0..1 - x-etsi-mec-origin-type: Uint32 - dot11RetryCount: - format: uint32 - type: integer - x-etsi-mec-cardinality: 0..1 - x-etsi-mec-origin-type: Uint32 - dot11STAStatisticsAPAverageAccessDelay: - type: integer - x-etsi-mec-cardinality: 0..1 - x-etsi-mec-origin-type: Uint8 - dot11STAStatisticsAverageAccessDelayBackGround: - type: integer - x-etsi-mec-cardinality: 0..1 - x-etsi-mec-origin-type: Uint8 - dot11STAStatisticsAverageAccessDelayBestEffort: - type: integer - x-etsi-mec-cardinality: 0..1 - x-etsi-mec-origin-type: Uint8 - dot11STAStatisticsAverageAccessDelayVideo: - type: integer - x-etsi-mec-cardinality: 0..1 - x-etsi-mec-origin-type: Uint8 - dot11STAStatisticsAverageAccessDelayVoice: - type: integer - x-etsi-mec-cardinality: 0..1 - x-etsi-mec-origin-type: Uint8 - dot11STAStatisticsChannelUtilization: - type: integer - x-etsi-mec-cardinality: 0..1 - x-etsi-mec-origin-type: Uint8 - dot11STAStatisticsStationCount: - type: integer - x-etsi-mec-cardinality: 0..1 - x-etsi-mec-origin-type: Uint8 - dot11STBCCTSFailureCount: - format: uint32 - type: integer - x-etsi-mec-cardinality: 0..1 - x-etsi-mec-origin-type: Uint32 - dot11STBCCTSSuccessCount: - format: uint32 - type: integer - x-etsi-mec-cardinality: 0..1 - x-etsi-mec-origin-type: Uint32 - dot11TransmittedAMPDUCount: - format: uint32 - type: integer - x-etsi-mec-cardinality: 0..1 - x-etsi-mec-origin-type: Uint32 - dot11TransmittedAMSDUCount: - format: uint32 - type: integer - x-etsi-mec-cardinality: 0..1 - x-etsi-mec-origin-type: Uint32 - dot11TransmittedFragmentCount: - format: uint32 - type: integer - x-etsi-mec-cardinality: 0..1 - x-etsi-mec-origin-type: Uint32 - dot11TransmittedFrameCount: - format: uint32 - type: integer - x-etsi-mec-cardinality: 0..1 - x-etsi-mec-origin-type: Uint32 - dot11TransmittedFramesInGrantedRDGCount: - format: uint32 - type: integer - x-etsi-mec-cardinality: 0..1 - x-etsi-mec-origin-type: Uint32 - dot11TransmittedMPDUsInAMPDUCount: - format: uint32 - type: integer - x-etsi-mec-cardinality: 0..1 - x-etsi-mec-origin-type: Uint32 - dot11TransmittedOctetsInAMPDUCount: - format: uint64 - type: integer - x-etsi-mec-cardinality: 0..1 - x-etsi-mec-origin-type: Uint64 - dot11TransmittedOctetsInAMSDUCount: - format: uint64 - type: integer - x-etsi-mec-cardinality: 0..1 - x-etsi-mec-origin-type: Uint32 - dot11TransmittedOctetsInGrantedRDGCount: - format: uint32 - type: integer - x-etsi-mec-cardinality: 0..1 - x-etsi-mec-origin-type: Uint32 - dot11TwentyMHzFrameReceivedCount: - format: uint32 - type: integer - x-etsi-mec-cardinality: 0..1 - x-etsi-mec-origin-type: Uint32 - dot11TwentyMHzFrameTransmittedCount: - format: uint32 - type: integer - x-etsi-mec-cardinality: 0..1 - x-etsi-mec-origin-type: Uint32 - dot11nonSTBCCTSFailureCount: - format: uint32 - type: integer - x-etsi-mec-cardinality: 0..1 - x-etsi-mec-origin-type: Uint32 - dot11nonSTBCCTSSuccessCount: - format: uint32 - type: integer - x-etsi-mec-cardinality: 0..1 - x-etsi-mec-origin-type: Uint32 - type: object - SubscriptionLinkList: - properties: - _links: - description: Hyperlink related to the resource. This shall be only included - in the HTTP responses and in HTTP PUT requests. - properties: - self: - allOf: - - $ref: '#/components/schemas/LinkType' - - description: URI referring to a resource - - x-etsi-mec-cardinality: 1 - - x-etsi-mec-origin-type: LinkType - type: object - x-etsi-mec-cardinality: 0..1 - x-etsi-mec-origin-type: Structure (inlined) - assocStaSubscription: - items: - $ref: '#/components/schemas/AssocStaSubscription' - type: array - x-etsi-mec-cardinality: 0..N - x-etsi-mec-origin-type: AssocStaSubscription - staDataRateSubscription: - items: - $ref: '#/components/schemas/StaDataRateSubscription' - type: array - x-etsi-mec-cardinality: 0..N - x-etsi-mec-origin-type: StaDataRateSubscription - required: - - _links - type: object - TimeStamp: - properties: - nanoSeconds: - type: integer - format: uint32 - description: The nanoseconds part of the time. Time is defined as Unix-time - since January 1, 1970, 00:00:00 UTC. - x-etsi-mec-cardinality: '1' - x-etsi-mec-origin-type: Uint32 - seconds: - type: integer - format: uint32 - description: The seconds part of the time. Time is defined as Unixtime since - January 1, 1970, 00:00:00 UTC. - x-etsi-mec-cardinality: '1' - x-etsi-mec-origin-type: Uint32 - required: - - seconds - - nanoSeconds - type: object - x-etsi-ref: 6.5.2 - VhtCapabilities: - properties: - vhtCapInfo: - type: integer - format: uint32 - description: VHT capabilities Info as defined in IEEE 802.11-2016 [8]. - x-etsi-mec-cardinality: '1' - x-etsi-mec-origin-type: UInt32 - vhtMcsNss: - type: integer - description: Supported VHT-MCS and NSS Set as defined in IEEE 802.11-2016 - [8]. - x-etsi-mec-cardinality: '1' - x-etsi-mec-origin-type: UInt64 - required: - - vhtCapInfo - - vhtMcsNss - type: object - x-etsi-ref: 6.5.15 - WanMetrics: - properties: - downlinkLoad: - type: integer - description: 1-octet positive integer representing the current percentage - loading of the downlink WAN connection, scaled linearly with 255 representing - 100 %, as measured over an interval the duration of which is reported - in Load Measurement Duration. In cases where the downlink load is unknown - to the AP, the value is set to zero. - x-etsi-mec-cardinality: '1' - x-etsi-mec-origin-type: UInt8 - downlinkSpeed: - type: integer - format: uint32 - description: 4-octet positive integer whose value is an estimate of the - WAN Backhaul link current downlink speed in kilobits per second. - x-etsi-mec-cardinality: '1' - x-etsi-mec-origin-type: Uint32 - lmd: - type: integer - description: The LMD (Load Measurement Duration) field is a 2-octet positive - integer representing the duration over which the Downlink Load and Uplink - Load have been measured, in tenths of a second. When the actual load measurement - duration is greater than the maximum value, the maximum value will be - reported. The value of the LMD field is set to 0 when neither the uplink - nor downlink load can be computed. When the uplink and downlink loads - are computed over different intervals, the maximum interval is reported. - x-etsi-mec-cardinality: '1' - x-etsi-mec-origin-type: Uint16 - uplinkLoad: - description: 1-octet positive integer representing the current percentage - loading of the uplink WAN connection, scaled linearly with 255 representing - 100 %, as measured over an interval, the duration of which is reported - in Load Measurement Duration. In cases where the uplink load is unknown - to the AP, the value is set to zero. - type: integer - x-etsi-mec-cardinality: '1' - x-etsi-mec-origin-type: Uint8 - uplinkSpeed: - type: integer - format: uint32 - description: 4-octet positive integer whose value is an estimate of the - WAN Backhaul link's current uplink speed in kilobits per second. - x-etsi-mec-cardinality: '1' - x-etsi-mec-origin-type: UInt32 - wanInfo: - description: Info about WAN link status, link symmetricity and capacity - currently used. - type: integer - x-etsi-mec-cardinality: '1' - x-etsi-mec-origin-type: Uint8 - required: - - wanInfo - - downlinkSpeed - - uplinkSpeed - - downlinkLoad - - uplinkLoad - - lmd - type: object - x-etsi-ref: 6.5.6 - WlanCapabilities: - properties: - dmg: - allOf: - - $ref: '#/components/schemas/DmgCapabilities' - - description: Information about Access Point DMG capabilities as defined in IEEE 802.11-2016 [8]. - - x-etsi-mec-cardinality: 0..1 - - x-etsi-mec-origin-type: DmgCapabilities - edmg: - allOf: - - $ref: '#/components/schemas/EdmgCapabilities' - - description: Information about Access Point EDMG capabilities as defined in draft IEEE P802.11/D4.0 [i.11]. - - x-etsi-mec-cardinality: 0..1 - - x-etsi-mec-origin-type: EdmgCapabilities - he: - allOf: - - $ref: '#/components/schemas/HeCapabilities' - - description: Information about Access Point HE capabilities as defined in FFS. - - x-etsi-mec-cardinality: 0..1 - - x-etsi-mec-origin-type: HeCapabilities - ht: - allOf: - - $ref: '#/components/schemas/HtCapabilities' - - description: "Information about Access Point HT capabilities as defined\ - \ in IEEE\_802.11-2016 [8]." - - x-etsi-mec-cardinality: 0..1 - - x-etsi-mec-origin-type: HtCapabilities - vht: - allOf: - - $ref: '#/components/schemas/VhtCapabilities' - - description: Information about Access Point VHT capabilities as defined in IEEE 802.11-2016 [8]. - - x-etsi-mec-cardinality: 0..1 - - x-etsi-mec-origin-type: VhtCapabilities - type: object - x-etsi-ref: 6.5.4 +openapi: 3.0.0 +info: + contact: + url: https://forge.etsi.org/rep/mec/gs028-wai-api + title: ETSI GS MEC 028 - WLAN Access Information API + version: 2.1.1 + description: The ETSI MEC ISG MEC028 WLAN Access Information API described using OpenAPI + license: + name: BSD-3-Clause + url: 'https://forge.etsi.org/legal-matters' +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' +servers: + - url: 'https://localhost/wai/v2' +tags: +- name: "wai" +paths: + /queries/ap/ap_information: + get: + tags: + - 'wai' + summary: 'Retrieve information on existing Access Points' + description: 'Queries information about existing WLAN Access Points' + operationId: apInfoGET + parameters: + - $ref: '#/components/parameters/Query.Filter' + - $ref: '#/components/parameters/Query.AllFields' + - $ref: '#/components/parameters/Query.Fields' + - $ref: '#/components/parameters/Query.ExcludeFields' + - $ref: '#/components/parameters/Query.ExcludeDefault' + responses: + '200': + description: Successful response to ap_info request + content: + application/json: + schema: + type: object + properties: + apInfo: + type: array + items: + $ref: '#/components/schemas/ApInfo' + '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': + $ref: '#/components/responses/429' + /queries/sta/sta_information: + get: + tags: + - 'wai' + summary: 'Retrieve information on existing Stations' + description: 'Queries information about existing WLAN stations' + operationId: staInfoGET + parameters: + - $ref: '#/components/parameters/Query.Filter' + - $ref: '#/components/parameters/Query.AllFields' + - $ref: '#/components/parameters/Query.Fields' + - $ref: '#/components/parameters/Query.ExcludeFields' + - $ref: '#/components/parameters/Query.ExcludeDefault' + responses: + '200': + description: Successful response to sta_info request + content: + application/json: + schema: + type: object + properties: + staInfo: + type: array + items: + $ref: '#/components/schemas/StaInfo' + '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': + $ref: '#/components/responses/429' + /subscriptions: + get: + tags: + - 'wai' + summary: 'Retrieve information on subscriptions for notifications' + description: 'Queries information on subscriptions for notifications' + operationId: subscriptionLinkList_subscriptionsGET + parameters: + - $ref: '#/components/parameters/Query.SubscriptionType' + responses: + '200': + description: 'Response body contains the list of links to requestors subscriptions.' + content: + application/json: + schema: + type: object + required: + - subscriptionLinkList + properties: + subscriptionLinkList: + $ref: '#/components/schemas/SubscriptionLinkList' + example: + subscriptionLinkList: + _links: + self: + href: 'http://meAppServer.example.com/wai/v2/subscriptions' + subscription: + - _links: + self: + href: 'http://meAppServer.example.com/wai/v2/subscriptions/sub123' + callbackReference: 'http://my.callback.com/wai/assocStaSubscription/some-id' + subscriptionType: AssocStaSubscription + '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': + $ref: '#/components/responses/429' + post: + tags: + - 'wai' + summary: 'Create a new subscription' + description: 'Creates a new subscription to WLAN Access Information notifications' + operationId: subscriptionsPOST + requestBody: + description: Subscription to be created + required: true + content: + application/json: + schema: + type: object + properties: + notificationSubscription: + oneOf: + - $ref: '#/components/schemas/AssocStaSubscription' + - $ref: '#/components/schemas/StaDataRateSubscription' + discriminator: + propertyName: subscriptionType + example: + notificationSubscription: + subscriptionType: AssocStaSubscription + callbackReference: 'http://meAppClient.example.com/wai/v2/notifications/1' + expiryDeadline: + seconds: 1977836800 + nanoSeconds: 0 + apId: + macId: 005C0A0A0A0A + ssid: 'myNetworkSsid' + ipAddress: 10.10.100.1 + responses: + '201': + description: Successful subscription response + content: + application/json: + schema: + type: object + properties: + notificationSubscription: + oneOf: + - $ref: '#/components/schemas/AssocStaSubscription' + - $ref: '#/components/schemas/StaDataRateSubscription' + discriminator: + propertyName: subscriptionType + example: + notificationSubscription: + subscriptionType: AssocStaSubscription + callbackReference: 'http://meAppClient.example.com/wai/v2/notifications/1' + _links: + self: + href: 'http://meAppServer.example.com/wai/v2/subscriptions/sub123' + expiryDeadline: + seconds: 1977836800 + nanoSeconds: 0 + apId: + macId: 005C0A0A0A0A + ssid: 'myNetworkSsid' + ipAddress: 10.10.100.1 + '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': + $ref: '#/components/responses/415' + '422': + $ref: '#/components/responses/422' + '429': + $ref: '#/components/responses/429' + callbacks: + notification: + '{$request.body#/callbackReference}': + post: + summary: 'Callback POST used to send a notification' + description: 'Notification from WAIS, content based on subscription type' + operationId: notificationPOST + requestBody: + description: Subscription notification + required: true + content: + application/json: + schema: + type: object + properties: + notification: + oneOf: + - $ref: '#/components/schemas/AssocStaNotification' + - $ref: '#/components/schemas/StaDataRateNotification' + discriminator: + propertyName: notificationType + example: + notification: + notificationType: AssocStaNotification + timeStamp: + seconds: 1977836800 + nanoseconds: 0 + apId: + macId: 005C0A0A0A0A + ssid: 'myNetworkSsid' + ipAddress: 10.10.100.1 + staId: + macId: 005C01111111 + ssid: + - 'myNetworkSsid' + - 'myOtherNetworkSsid' + aid: '1122' + ipAddress: 10.10.1.255 + responses: + '204': + $ref: '#/components/responses/204' + '/subscriptions/{subscriptionId}': + get: + tags: + - 'wai' + summary: 'Retrieve information on current specific subscription' + description: 'Queries information about an existing subscription, identified by its self-referring URI returned on creation (initial POST)' + operationId: subscriptionsGET + parameters: + - $ref: '#/components/parameters/Path.subscrId' + responses: + '200': + description: Subscription information regarding subscription notifications + content: + application/json: + schema: + type: object + required: + - notificationSubscription + properties: + notificationSubscription: + oneOf: + - $ref: '#/components/schemas/AssocStaSubscription' + - $ref: '#/components/schemas/StaDataRateSubscription' + discriminator: + propertyName: subscriptionType + example: + notificationSubscription: + subscriptionType: AssocStaSubscription + callbackReference: 'http://meAppClient.example.com/wai/v2/notifications/1' + _links: + self: + href: 'http://meAppServer.example.com/wai/v2/subscriptions/sub123' + expiryDeadline: + seconds: 1977836800 + nanoSeconds: 0 + apId: + macId: 005C0A0A0A0A + ssid: 'myNetworkSsid' + ipAddress: 10.10.100.1 + '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': + $ref: '#/components/responses/429' + put: + tags: + - 'wai' + summary: 'Modify an existing subscription' + description: 'Updates an existing subscription, identified by its self-referring URI returned on creation (initial POST)' + operationId: subscriptionsPUT + requestBody: + description: Subscription to be modified + required: true + content: + application/json: + schema: + type: object + properties: + notificationSubscription: + oneOf: + - $ref: '#/components/schemas/AssocStaSubscription' + - $ref: '#/components/schemas/StaDataRateSubscription' + discriminator: + propertyName: subscriptionType + example: + notificationSubscription: + subscriptionType: AssocStaSubscription + callbackReference: 'http://meAppClient.example.com/wai/v2/notifications/1' + _links: + self: + href: 'http://meAppServer.example.com/wai/v2/subscriptions/sub123' + expiryDeadline: + seconds: 1977836800 + nanoSeconds: 0 + apId: + macId: 005C0A0A0A0A + ssid: 'myNetworkSsid' + ipAddress: 10.10.100.1 + parameters: + - $ref: '#/components/parameters/Path.subscrId' + responses: + '200': + description: Successful subscription modification + content: + application/json: + schema: + type: object + properties: + subscription: + oneOf: + - $ref: '#/components/schemas/AssocStaSubscription' + - $ref: '#/components/schemas/StaDataRateSubscription' + discriminator: + propertyName: subscriptionType + example: + subscription: + _links: + self: + href: 'http://[hostIP]/sbox-xyz123/wai/v2/subscriptions/sub123' + callbackReference: 'http://my.callback.com/wai/some-id' + apId: + macId: 005C0A0A0A0A + '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 an existing subscription' + description: 'Cancels an existing subscription, identified by its self-referring URI returned on creation (initial POST)' + operationId: subscriptionsDELETE + parameters: + - $ref: '#/components/parameters/Path.subscrId' + 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/json: + schema: + type: object + properties: + problemDetails: + $ref: '#/components/schemas/ProblemDetails' + 401: + description: 'Unauthorized : used when the client did not submit credentials.' + content: + application/json: + schema: + type: object + properties: + problemDetails: + $ref: '#/components/schemas/ProblemDetails' + 403: + description: 'Forbidden : operation is not allowed given the current status of the resource.' + content: + application/json: + schema: + type: object + required: + - problemDetails + properties: + problemDetails: + $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/json: + schema: + type: object + properties: + problemDetails: + $ref: '#/components/schemas/ProblemDetails' + 406: + description: 'Not Acceptable : used to indicate that the server cannot provide the any of the content formats supported by the client.' + content: + application/json: + schema: + type: object + properties: + problemDetails: + $ref: '#/components/schemas/ProblemDetails' + 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' + content: + application/json: + schema: + type: object + properties: + problemDetails: + $ref: '#/components/schemas/ProblemDetails' + 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/json: + schema: + type: object + properties: + problemDetails: + $ref: '#/components/schemas/ProblemDetails' + 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.' + content: + application/json: + schema: + type: object + properties: + problemDetails: + $ref: '#/components/schemas/ProblemDetails' + example: + application/problem+json: + ProblemDetails: + 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 + 429: + description: 'Too Many Requests : used when a rate limiter has triggered.' + content: + application/json: + schema: + type: object + properties: + problemDetails: + $ref: '#/components/schemas/ProblemDetails' + parameters: + Path.subscrId: + name: subscriptionId + in: path + description: 'Subscription Id, specifically the "self" returned in the subscription request' + required: true + schema: + type: string + format: uri + 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 + 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 + 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 + 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: + type: string + Query.ExcludeDefault: + name: exclude_default + in: query + description: 'Indicates to exclude the following complex attributes from the response. See clause 6.18 of ETSI GS MEC 009 for details. + The following attributes shall be excluded from the structure in the response body if this parameter is provided, or none of the parameters + "all_fields", "fields", "exclude_fields", "exclude_default" are provided: Not applicable' + required: false + schema: + type: array + items: + type: string + Query.SubscriptionType: + name: subscription_type + in: query + description: 'Filter on a specific subscription type. Permitted values: assoc_sta, sta_data_rate.' + required: false + schema: + type: string + schemas: + ApAssociated: + properties: + assocId: + description: Unique number which identifies a particular association between the station and Access Point. + type: string + x-etsi-mec-cardinality: 0..1 + x-etsi-mec-origin-type: string + ipAddress: + description: IPv4 or IPv6 address allocated for the Access Point. + items: + type: string + minItems: 0 + type: array + x-etsi-mec-cardinality: 0..N + x-etsi-mec-origin-type: string + macId: + description: Unique identifier assigned to the Access Point (as network interface controller) for communications at the data link layer of a network segment. + type: string + x-etsi-mec-cardinality: '1' + x-etsi-mec-origin-type: string + ssid: + description: Service Set Identifier to identify logical networks. + items: + type: string + minItems: 0 + type: array + x-etsi-mec-cardinality: 0..N + x-etsi-mec-origin-type: String + required: + - macId + type: object + x-etsi-ref: 6.5.12 + ApIdentity: + properties: + ipAddress: + description: IPv4 or IPv6 address allocated for the Access Point. + items: + type: string + minItems: 0 + type: array + x-etsi-mec-cardinality: 0..N + x-etsi-mec-origin-type: String + macId: + description: Unique Identifier assigned to an Access Point (as network interface controller) for communications at the data link layer of a network segment. + type: string + x-etsi-mec-cardinality: '1' + x-etsi-mec-origin-type: String + ssid: + description: Service Set Identifier to identify logical networks including Basic Service Set and Extended Service Set. + items: + type: string + minItems: 0 + type: array + x-etsi-mec-cardinality: 0..N + x-etsi-mec-origin-type: String + required: + - macId + type: object + x-etsi-ref: 6.5.3 + ApInfo: + properties: + apId: + # description': Identifier(s) to uniquely specify the Access Point whose information is exposed within this data type. + # x-etsi-mec-cardinality': '1' + # x-etsi-mec-origin-type': ApIdentity + $ref: '#/components/schemas/ApIdentity' + apLocation: + # description': The location on the Access Point. + # x-etsi-mec-cardinality': 0..1 + # x-etsi-mec-origin-type': ApLocation + $ref: '#/components/schemas/ApLocation' + apNeighbor: + # description': Information about neighbor Access Points. + # x-etsi-mec-cardinality': 0..1 + # x-etsi-mec-origin-type': NeighborReport + $ref: '#/components/schemas/NeighborReport' + bssLoad: + # description': BSS Load attribute contains information on the current STA population and traffic levels in the BSS as defined in IEEE 802.11-2016 [8]. + # x-etsi-mec-cardinality': 0..1 + # x-etsi-mec-origin-type': BssLoad + $ref: '#/components/schemas/BssLoad' + channel: + description: Channel configured for the Access Point. + format: int32 + type: integer + x-etsi-mec-cardinality: 0..1 + x-etsi-mec-origin-type: Uint32 + extBssLoad: + # description': Extended BSS Load attribute contains more detailed information on the current STA population and traffic levels in the BSS as per ETSI GS MEC 002 [i.4]. + # x-etsi-mec-cardinality': 0..1 + # x-etsi-mec-origin-type': ExtBssLoad + $ref: '#/components/schemas/ExtBssLoad' + timeStamp: + # description': Time stamp. + # x-etsi-mec-cardinality': 0..1 + # x-etsi-mec-origin-type': TimeStamp + $ref: '#/components/schemas/TimeStamp' + wanMetrics: + # description': WAN Metrics element provides information about the WAN link connecting an IEEE 802.11 Access Node and the Internet. Transmission characteristics such as the speed of the WAN connection to the Internet are included in Hotspot 2.0 Technical Specification v1.0.0 [i.3]. + # x-etsi-mec-cardinality': 0..1 + # x-etsi-mec-origin-type': WanMetrics + $ref: '#/components/schemas/WanMetrics' + wlanCap: + # description': WLAN capabilities of Access Point. + # x-etsi-mec-cardinality': 0..1 + # x-etsi-mec-origin-type': WlanCapabilities + $ref: '#/components/schemas/WlanCapabilities' + required: + - apId + type: object + x-etsi-ref: 6.2.2 + ApLocation: + properties: + civicLocation: + # description': Civic Location of the AP as described in IETF RFC 4776 [7]. + # x-etsi-mec-cardinality': 0..1 + # x-etsi-mec-origin-type': CivicLocation + $ref: '#/components/schemas/CivicLocation' + geolocation: + # description': Geospatial Location of the AP as defined in IEEE 802.11-2016 [8]. + # x-etsi-mec-cardinality': 0..1 + # x-etsi-mec-origin-type': GeoLocation + $ref: '#/components/schemas/GeoLocation' + type: object + x-etsi-ref: 6.5.9 + AssocStaNotification: + properties: + apId: + # description': Identifier(s) to uniquely specify the Access Point to which the client stations are associated. + # x-etsi-mec-cardinality': '1' + # x-etsi-mec-origin-type': ApIdentity + $ref: '#/components/schemas/ApIdentity' + notificationType: + description: Shall be set to "AssocStaNotification". + type: string + x-etsi-mec-cardinality: '1' + x-etsi-mec-origin-type: String + staId: + description: Identifier(s) to uniquely specify the client station(s) associated. + items: + $ref: '#/components/schemas/StaIdentity' + minItems: 0 + type: array + x-etsi-mec-cardinality: 0..N + x-etsi-mec-origin-type: StaIdentity + timeStamp: + # description': Time stamp. + # x-etsi-mec-cardinality': 0..1 + # x-etsi-mec-origin-type': TimeStamp + $ref: '#/components/schemas/TimeStamp' + required: + - notificationType + - apId + type: object + x-etsi-ref: 6.4.2 + AssocStaSubscription: + properties: + _links: + description: Hyperlink related to the resource. This shall be only included in the HTTP responses and in HTTP PUT requests. + properties: + self: + # description': Self referring URI. The URI shall be unique within the WLAN information API as it acts as an ID for the subscription. + # x-etsi-mec-cardinality': '1' + # x-etsi-mec-origin-type': LinkType + $ref: '#/components/schemas/LinkType' + required: + - self + type: object + x-etsi-mec-cardinality: 0..1 + x-etsi-mec-origin-type: Structure (inlined) + apId: + # description': Identifier(s) to uniquely specify the target Access Point for the subscription + # x-etsi-mec-cardinality': '1' + # x-etsi-mec-origin-type': ApIdentity + $ref: '#/components/schemas/ApIdentity' + callbackReference: + description: URI selected by the service consumer to receive notifications on the subscribed WLAN information. This shall be included both in the request and in response. + format: uri + type: string + x-etsi-mec-cardinality: '1' + x-etsi-mec-origin-type: URI + expiryDeadline: + # description': The expiration time of the subscription determined by the WLAN Access Information Service. + # x-etsi-mec-cardinality': 0..1 + # x-etsi-mec-origin-type': TimeStamp + $ref: '#/components/schemas/TimeStamp' + subscriptionType: + description: Shall be set to "AssocStaSubscription". + type: string + x-etsi-mec-cardinality: '1' + x-etsi-mec-origin-type: String + required: + - subscriptionType + - callbackReference + - apId + type: object + x-etsi-ref: 6.3.2 + AssociatedStations: + properties: + assocId: + description: Unique number which identifies a particular association between an Access Point and a station. + type: string + x-etsi-mec-cardinality: 0..1 + x-etsi-mec-origin-type: string + ipAddress: + description: IPv4 or IPv6 address allocated for the station associated with the Access Point. + items: + type: string + minItems: 0 + type: array + x-etsi-mec-cardinality: 0..N + x-etsi-mec-origin-type: string + macId: + description: Unique identifier assigned to a station (as network interface controller) for communications at the data link layer of a network segment. + type: string + x-etsi-mec-cardinality: '1' + x-etsi-mec-origin-type: string + required: + - macId + type: object + x-etsi-ref: 6.5.5 + BeaconReport: + properties: + bssId: + description: The BSSID field indicates the BSSID of the BSS(s) for which a beacon report has been received. + items: + type: string + minItems: 1 + type: array + x-etsi-mec-cardinality: 1..N + x-etsi-mec-origin-type: String + channelId: + description: Channel number where the beacon was received. + type: integer + x-etsi-mec-cardinality: '1' + x-etsi-mec-origin-type: Integer + measurementId: + description: Measurement ID of the Measurement configuration applied to this Beacon Report. + type: string + x-etsi-mec-cardinality: '1' + x-etsi-mec-origin-type: String + reportingCondition: + description: As in table T9-89 of IEEE 802.11-2012 [8]. + type: integer + x-etsi-mec-cardinality: '1' + x-etsi-mec-origin-type: Integer + ssId: + description: (Optional) The SSID subelement indicates the ESS(s) or IBSS(s) for which a beacon report is received. + items: + type: string + minItems: 1 + type: array + x-etsi-mec-cardinality: 1..N + x-etsi-mec-origin-type: String + staId: + # description': Identifier to uniquely specify the station whose information is exposed within this data type. + # x-etsi-mec-cardinality': '1' + # x-etsi-mec-origin-type': StaIdentity + $ref: '#/components/schemas/StaIdentity' + required: + - staId + - measurementId + - channelId + - bssId + - ssId + - reportingCondition + type: object + x-etsi-ref: 6.5.27 + BeaconRequestConfig: + properties: + bssId: + description: The BSSID field indicates the BSSID of the BSS(s) for which a beacon report is requested. When requesting beacon reports for all BSSs on the channel, the BSSID field contains the wildcard BSSID. + items: + type: string + minItems: 1 + type: array + x-etsi-mec-cardinality: 1..N + x-etsi-mec-origin-type: String + channelId: + description: Channel number to scan. A Channel Number of 0 indicates a request to make iterative measurements for all supported channels in the Operating Class where the measurement is permitted on the channel and the channel is valid for the current regulatory domain. A Channel Number of 255 indicates a request to make iterative measurements for all supported channels in the current Operating Class listed in the latest AP Channel Report received from the serving AP. + type: integer + x-etsi-mec-cardinality: '1' + x-etsi-mec-origin-type: Integer + measurementMode: + description: '0 for passive. + + 1 for active. + + 2 for beacon table.' + type: integer + x-etsi-mec-cardinality: '1' + x-etsi-mec-origin-type: Integer + reportingCondition: + description: As in table T9-89 of IEEE 802.11-2012 [8]. + type: integer + x-etsi-mec-cardinality: '1' + x-etsi-mec-origin-type: Integer + ssId: + description: (Optional) The SSID subelement indicates the ESS(s) or IBSS(s) for which a beacon report is requested. + items: + type: string + minItems: 1 + type: array + x-etsi-mec-cardinality: 1..N + x-etsi-mec-origin-type: String + staId: + # description': Identifier to uniquely specify the station whose information is exposed within this data type. + # x-etsi-mec-cardinality': '1' + # x-etsi-mec-origin-type': StaIdentity + $ref: '#/components/schemas/StaIdentity' + required: + - staId + - channelId + - measurementMode + - bssId + - ssId + - reportingCondition + type: object + x-etsi-ref: 6.5.25 + BssLoad: + properties: + availAdmCap: + description: Available Admission Capacity that specifies the remaining amount of medium time available via explicit admission control, in units of 32 s/s. + format: int32 + type: integer + x-etsi-mec-cardinality: '1' + x-etsi-mec-origin-type: Uint16 + channelUtilization: + description: "The percentage of time, linearly scaled with 255 representing 100\_%, that the AP sensed the medium was busy, as indicated by either the physical or virtual Carrier Sense (CS) mechanism." + format: int32 + type: integer + x-etsi-mec-cardinality: '1' + x-etsi-mec-origin-type: UInt8 + staCount: + description: An unsigned integer that indicates the total number of STAs currently associated with this BSS. + format: int32 + type: integer + x-etsi-mec-cardinality: '1' + x-etsi-mec-origin-type: UInt16 + required: + - staCount + - channelUtilization + - availAdmCap + type: object + x-etsi-ref: 6.5.7 + ChannelLoadConfig: + properties: + apId: + # description': Identifier(s) to uniquely specify the target Access Point + # x-etsi-mec-cardinality': '1' + # x-etsi-mec-origin-type': ApIdentity + $ref: '#/components/schemas/ApIdentity' + cChannelId: + description: Channel number which load is reported + type: integer + x-etsi-mec-cardinality: '1' + x-etsi-mec-origin-type: Integer + channelLoad: + description: Channel load as per IEEE 802.11-2012 [8], section 11.11.9.3 + type: integer + x-etsi-mec-cardinality: '1' + x-etsi-mec-origin-type: Integer + required: + - apId + - cChannelId + - channelLoad + type: object + x-etsi-ref: 6.5.24 + CivicLocation: + properties: + ca0: + description: Language + type: string + x-etsi-mec-cardinality: 0..1 + x-etsi-mec-origin-type: String + ca1: + description: 'National subdivisions (state, canton, region,province, prefecture) ' + type: string + x-etsi-mec-cardinality: 0..1 + x-etsi-mec-origin-type: String + ca128: + description: Script + type: string + x-etsi-mec-cardinality: 0..1 + x-etsi-mec-origin-type: String + ca16: + description: Leading street direction + type: string + x-etsi-mec-cardinality: 0..1 + x-etsi-mec-origin-type: String + ca17: + description: Trailing street suffix + type: string + x-etsi-mec-cardinality: 0..1 + x-etsi-mec-origin-type: String + ca18: + description: Street suffix or type + type: string + x-etsi-mec-cardinality: 0..1 + x-etsi-mec-origin-type: String + ca19: + description: House number + type: string + x-etsi-mec-cardinality: 0..1 + x-etsi-mec-origin-type: String + ca2: + description: County, parish, gun (JP), district (IN) + type: string + x-etsi-mec-cardinality: 0..1 + x-etsi-mec-origin-type: String + ca20: + description: House number suffix + type: string + x-etsi-mec-cardinality: 0..1 + x-etsi-mec-origin-type: String + ca21: + description: Landmark of vanity address + type: string + x-etsi-mec-cardinality: 0..1 + x-etsi-mec-origin-type: String + ca22: + description: Additional location information + type: string + x-etsi-mec-cardinality: 0..1 + x-etsi-mec-origin-type: String + ca23: + description: Name (residence and office occupant) + type: string + x-etsi-mec-cardinality: 0..1 + x-etsi-mec-origin-type: String + ca24: + description: Postal/zip code + type: string + x-etsi-mec-cardinality: 0..1 + x-etsi-mec-origin-type: String + ca25: + description: Building (structure) + type: string + x-etsi-mec-cardinality: 0..1 + x-etsi-mec-origin-type: String + ca26: + description: Unit (apartment/suite) + type: string + x-etsi-mec-cardinality: 0..1 + x-etsi-mec-origin-type: String + ca27: + description: Floor + type: string + x-etsi-mec-cardinality: 0..1 + x-etsi-mec-origin-type: String + ca28: + description: Room + type: string + x-etsi-mec-cardinality: 0..1 + x-etsi-mec-origin-type: String + ca29: + description: Type of place + type: string + x-etsi-mec-cardinality: 0..1 + x-etsi-mec-origin-type: String + ca3: + description: City, township, shi (JP) + type: string + x-etsi-mec-cardinality: 0..1 + x-etsi-mec-origin-type: String + ca30: + description: Postal community name + type: string + x-etsi-mec-cardinality: 0..1 + x-etsi-mec-origin-type: String + ca31: + description: Post office box + type: string + x-etsi-mec-cardinality: 0..1 + x-etsi-mec-origin-type: String + ca32: + description: Additional code + type: string + x-etsi-mec-cardinality: 0..1 + x-etsi-mec-origin-type: String + ca33: + description: Seat (desk.cubicle, workstation) + type: string + x-etsi-mec-cardinality: 0..1 + x-etsi-mec-origin-type: String + ca34: + description: Primary road name + type: string + x-etsi-mec-cardinality: 0..1 + x-etsi-mec-origin-type: String + ca35: + description: Road section + type: string + x-etsi-mec-cardinality: 0..1 + x-etsi-mec-origin-type: String + ca36: + description: Branch road name + type: string + x-etsi-mec-cardinality: 0..1 + x-etsi-mec-origin-type: String + ca37: + description: Sub-branch road name + type: string + x-etsi-mec-cardinality: 0..1 + x-etsi-mec-origin-type: String + ca38: + description: Street name pre-modifier + type: string + x-etsi-mec-cardinality: 0..1 + x-etsi-mec-origin-type: String + ca39: + description: Street name post-modifier + type: string + x-etsi-mec-cardinality: 0..1 + x-etsi-mec-origin-type: String + ca4: + description: City division, borough, city district, ward, chou (JP) + type: string + x-etsi-mec-cardinality: 0..1 + x-etsi-mec-origin-type: String + ca5: + description: Neighborhood, block + type: string + x-etsi-mec-cardinality: 0..1 + x-etsi-mec-origin-type: String + ca6: + description: 'Group of streets below the neighborhood level ' + type: string + x-etsi-mec-cardinality: 0..1 + x-etsi-mec-origin-type: String + country: + description: The two-letter ISO 3166 [i.9] country code in capital ASCII letters, e.g. DE or US, as per ISO 3166 [i.9] + type: string + x-etsi-mec-cardinality: '1' + x-etsi-mec-origin-type: String + required: + - country + type: object + x-etsi-ref: 6.5.20 + DmgCapabilities: + properties: + ExtScMcsCap: + description: Extended SC MCS capabilities as defined in draft IEEE P802.11/D4.0 [i.11] + format: int32 + type: integer + x-etsi-mec-cardinality: '1' + x-etsi-mec-origin-type: Uint8 + dmgApOrPcpCapInfo: + description: DMG AP or PCP capabilities information as defined in draft IEEE P802.11/D4.0 [i.11] + format: int32 + type: integer + x-etsi-mec-cardinality: '1' + x-etsi-mec-origin-type: Uint16 + dmgStaBeamTrackTimeLimit: + description: DMG station beam tracking time limit as defined in draft IEEE P802.11/D4.0 [i.11] + format: int32 + type: integer + x-etsi-mec-cardinality: '1' + x-etsi-mec-origin-type: Uint16 + dmgStaCapInfo: + description: DMG station capabilities information as defined in draft IEEE P802.11/D4.0 [i.11] + format: int64 + type: integer + x-etsi-mec-cardinality: '1' + x-etsi-mec-origin-type: Uint64 + maxNrBasicAmsduSubframes: + description: Number of basic A-MSDU subframes in A-MSDU as defined in draft IEEE P802.11/D4.0 [i.11] + format: int32 + type: integer + x-etsi-mec-cardinality: '1' + x-etsi-mec-origin-type: Uint8 + maxNrShortAmsduSubframes: + description: Number of short A-MSDU subframes in A-MSDU as defined in draft IEEE P802.11/D4.0 [i.11] + format: int32 + type: integer + x-etsi-mec-cardinality: '1' + x-etsi-mec-origin-type: Uint8 + sarCap: + description: SAR capabilities as defined in draft IEEE P802.11/D4.0 [i.11] + format: int32 + type: integer + x-etsi-mec-cardinality: '1' + x-etsi-mec-origin-type: Uint8 + tddCap: + description: TDD capabilities as defined in draft IEEE P802.11/D4.0 [i.11] + format: int32 + type: integer + x-etsi-mec-cardinality: '1' + x-etsi-mec-origin-type: Uint16 + required: + - dmgStaCapInfo + - dmgApOrPcpCapInfo + - dmgStaBeamTrackTimeLimit + - ExtScMcsCap + - maxNrBasicAmsduSubframes + - maxNrShortAmsduSubframes + - tddCap + - sarCap + type: object + x-etsi-ref: 6.5.17 + EdmgCapabilities: + properties: + ampduParameters: + description: A-MPDU parameters as defined in draft IEEE P802.11/D4.0 [i.11] + format: Uint8 + type: integer + x-etsi-mec-cardinality: '1' + x-etsi-mec-origin-type: Uint8 + reserved: + description: '' + format: int32 + type: integer + x-etsi-mec-cardinality: 0..1 + x-etsi-mec-origin-type: Uint8 + supportedMcs: + description: Supported MCS as defined in draft IEEE P802.11/D4.0 [i.11] + format: int32 + type: integer + x-etsi-mec-cardinality: '1' + x-etsi-mec-origin-type: Uint32 + trnParameters: + description: Training parameters as defined in draft IEEE P802.11/D4.0 [i.11] + format: int32 + type: integer + x-etsi-mec-cardinality: '1' + x-etsi-mec-origin-type: Uint16 + required: + - ampduParameters + - trnParameters + - supportedMcs + type: object + x-etsi-ref: 6.5.18 + ExtBssLoad: + properties: + muMimoStaCount: + description: Indicates the total number of STAs currently associated with this BSS that have a 1 in the MU Beamformee Capable field of their VHT Capabilities element. + format: int32 + type: integer + x-etsi-mec-cardinality: '1' + x-etsi-mec-origin-type: UInt16 + obsSec20MhzUtil: + description: Observable loading on each of the secondary 20 MHz channel. + format: int32 + type: integer + x-etsi-mec-cardinality: '1' + x-etsi-mec-origin-type: Uint8 + obsSec40MhzUtil: + description: Observable loading on each of the secondary 40 MHz channel. + format: int32 + type: integer + x-etsi-mec-cardinality: '1' + x-etsi-mec-origin-type: Uint8 + obsSec80MhzUtil: + description: Observable loading on each of the secondary 80 MHz channel. + format: int32 + type: integer + x-etsi-mec-cardinality: '1' + x-etsi-mec-origin-type: Uint8 + spatStreamUnderUtil: + description: "The percentage of time, linearly scaled with 255 representing 100\_%, that the AP has underutilized spatial domain resources for given busy time of the medium." + format: int32 + type: integer + x-etsi-mec-cardinality: '1' + x-etsi-mec-origin-type: UInt8 + required: + - muMimoStaCount + - spatStreamUnderUtil + - obsSec20MhzUtil + - obsSec40MhzUtil + - obsSec80MhzUtil + type: object + x-etsi-ref: 6.5.8 + GeoLocation: + properties: + altitude: + description: "The altitude value of location as defined in IETF RFC\_6225 [6]" + format: int32 + type: integer + x-etsi-mec-cardinality: 0..1 + x-etsi-mec-origin-type: Uint32 + altitudeType: + description: The type description for altitude information e.g. floors or meters as defined in IETF RFC 6225 [6] + format: int32 + type: integer + x-etsi-mec-cardinality: 0..1 + x-etsi-mec-origin-type: Uint8 + altitudeUncertainty: + description: The uncertainty for altitude information as defined in IETF RFC 6225 [6] + format: int32 + type: integer + x-etsi-mec-cardinality: 0..1 + x-etsi-mec-origin-type: Uint8 + datum: + description: The datum value to express how coordinates are organized and related to real world as defined in IETF RFC 6225 [6] + format: int32 + type: integer + x-etsi-mec-cardinality: '1' + x-etsi-mec-origin-type: Uint8 + lat: + description: "The latitude value of location as defined in IETF RFC\_6225 [6]" + format: int64 + type: integer + x-etsi-mec-cardinality: '1' + x-etsi-mec-origin-type: Uint64 + latUncertainty: + description: The uncertainty for Latitude information as defined in IETF RFC 6225 [6] + format: int32 + type: integer + x-etsi-mec-cardinality: '1' + x-etsi-mec-origin-type: Uint8 + long: + description: "The longitude value of location as defined in IETF RFC\_6225 [6]" + format: int64 + type: integer + x-etsi-mec-cardinality: '1' + x-etsi-mec-origin-type: Uint64 + longUncertainty: + description: The uncertainty for Longitude information as defined in IETF RFC 6225 [6] + format: int32 + type: integer + x-etsi-mec-cardinality: '1' + x-etsi-mec-origin-type: Uint8 + required: + - latUncertainty + - lat + - longUncertainty + - long + - datum + type: object + x-etsi-ref: 6.5.19 + HeCapabilities: + properties: + heMacCapInfo: + description: MAC capabilities of an Access Point. + type: integer + x-etsi-mec-cardinality: '1' + x-etsi-mec-origin-type: Uint8 + hePhyCapinfo: + description: PHY capabilities of an Access Point. + type: integer + x-etsi-mec-cardinality: '1' + x-etsi-mec-origin-type: Uint8 + ppeThresholds: + description: PPE Threshold determines the nominal packet padding value for a HE PPDU. + type: integer + x-etsi-mec-cardinality: 0..1 + x-etsi-mec-origin-type: not defined + supportedHeMcsNssSet: + description: Supported MCS and NSS Set. + type: integer + x-etsi-mec-cardinality: '1' + x-etsi-mec-origin-type: Uint8 + required: + - heMacCapInfo + - hePhyCapinfo + - supportedHeMcsNssSet + type: object + x-etsi-ref: 6.5.16 + HtCapabilities: + properties: + ampduParameters: + description: A-MPDU parameters as defined in IEEE 802.11-2016 [8]. + format: int32 + type: integer + x-etsi-mec-cardinality: '1' + x-etsi-mec-origin-type: UInt8 + aselCap: + description: ASEL capabilities as defined in IEEE 802.11-2016 [8]. + format: int32 + type: integer + x-etsi-mec-cardinality: '1' + x-etsi-mec-origin-type: UInt8 + htCapabilityInfo: + description: HT Capability Information as defined in IEEE 802.11-2016 [8]. + format: int32 + type: integer + x-etsi-mec-cardinality: '1' + x-etsi-mec-origin-type: UInt16 + htExtendedCap: + description: Extended HT Capabilities as defined in IEEE 802.11-2016 [8]. + format: int32 + type: integer + x-etsi-mec-cardinality: '1' + x-etsi-mec-origin-type: UInt16 + supportedMcsSet: + description: Supported MCS set as defined in IEEE 802.11-2016 [8]. + format: int64 + type: integer + x-etsi-mec-cardinality: '1' + x-etsi-mec-origin-type: Uint128 + txBeamFormCap: + description: Transmit Beamforming Capabilities as defined in IEEE 802.11-2016 [8]. + format: int32 + type: integer + x-etsi-mec-cardinality: '1' + x-etsi-mec-origin-type: UInt32 + required: + - htCapabilityInfo + - ampduParameters + - supportedMcsSet + - htExtendedCap + - txBeamFormCap + - aselCap + type: object + x-etsi-ref: 6.5.14 + LinkType: + properties: + href: + description: URI referring to a resource + type: string + x-etsi-mec-cardinality: '1' + x-etsi-mec-origin-type: String + required: + - href + type: object + x-etsi-ref: 6.5.23 + MeasurementConfig: + properties: + beaconRequest: + # description': Configuration related to Beacon Request. + # x-etsi-mec-cardinality': 0..1 + # x-etsi-mec-origin-type': BeaconRequestConfig + $ref: '#/components/schemas/BeaconRequestConfig' + channelLoad: + # description': Configuration related to the Channel Load. + # x-etsi-mec-cardinality': 0..1 + # x-etsi-mec-origin-type': ChannelLoadConfig + $ref: '#/components/schemas/ChannelLoadConfig' + measurementDuration: + description: Duration of the measurement, shall be lower than Maximum Measurement Duration in TU as defined in section 11.11.4 of IEEE 802.11 [8]. + type: integer + x-etsi-mec-cardinality: '1' + x-etsi-mec-origin-type: Integer + measurementId: + description: Identifier of this measurement configuration. + type: string + x-etsi-mec-cardinality: '1' + x-etsi-mec-origin-type: String + randomnInterval: + description: "Random interval to be used for starting the measurement. In units of TU as specifed in section\_11.11.3 of IEEE 802.11 [8]." + type: integer + x-etsi-mec-cardinality: '1' + x-etsi-mec-origin-type: Integer + staStatistics: + # description': Configuration related to the statistics provided by STAs. + # x-etsi-mec-cardinality': 0..1 + # x-etsi-mec-origin-type': StaStatisticsConfig + $ref: '#/components/schemas/StaStatisticsConfig' + required: + - measurementId + - measurementDuration + - randomnInterval + type: object + x-etsi-notes: "NOTE:\tThis element enables the configuration of the channelLoad, beaconRequest and staStatistics in a single resource data type, although only one of each measurement. Multiple measurement configurations of each kind are not allowed." + x-etsi-ref: 6.2.4 + NeighborReport: + properties: + bssid: + description: BSS Id of the Access Point that is being reported. + type: string + x-etsi-mec-cardinality: '1' + x-etsi-mec-origin-type: String + bssidInfo: + description: Additional information related to Access Point that is being reported such as AP reachability, security, key scope, Mobility Domain, HT/VHT capability and Fine Time Measurements. + format: int32 + type: integer + x-etsi-mec-cardinality: '1' + x-etsi-mec-origin-type: UInt32 + channel: + description: The channel currently used by this Access Point. + type: integer + x-etsi-mec-cardinality: '1' + x-etsi-mec-origin-type: Uint8 + operatingClass: + description: The channel set of the AP indicated by this BSSID. + type: integer + x-etsi-mec-cardinality: '1' + x-etsi-mec-origin-type: Uint8 + phyType: + description: PHY type of the AP indicated by this BSSID. It is an integer value coded according to the value of the dot11PHYType. + type: integer + x-etsi-mec-cardinality: '1' + x-etsi-mec-origin-type: Uint8 + required: + - bssid + - bssidInfo + - operatingClass + - channel + - phyType + type: object + x-etsi-ref: 6.5.10 + ProblemDetails: + properties: + detail: + description: A human-readable explanation specific to this occurrence of the problem + type: string + x-etsi-mec-cardinality: 0..1 + x-etsi-mec-origin-type: String + instance: + description: A URI reference that identifies the specific occurrence of the problem + format: uri + type: string + x-etsi-mec-cardinality: 0..1 + x-etsi-mec-origin-type: URI + status: + description: The HTTP status code for this occurrence of the problem + format: int32 + type: integer + x-etsi-mec-cardinality: 0..1 + x-etsi-mec-origin-type: Uint32 + title: + description: A short, human-readable summary of the problem type + type: string + x-etsi-mec-cardinality: 0..1 + x-etsi-mec-origin-type: String + type: + description: A URI reference according to IETF RFC 3986 that identifies the problem type + format: uri + type: string + x-etsi-mec-cardinality: 0..1 + x-etsi-mec-origin-type: URI + type: object + Rssi: + properties: + rssi: + description: The Received Signal Strength Indicator from a station + format: int32 + type: integer + x-etsi-mec-cardinality: '1' + x-etsi-mec-origin-type: Uint8 + required: + - rssi + type: object + x-etsi-ref: 6.5.21 + StaDataRate: + properties: + staId: + # description': Identifier(s) to uniquely specify the client station(s) associated. + # x-etsi-mec-cardinality': 0..1 + # x-etsi-mec-origin-type': StaIdentity + $ref: '#/components/schemas/StaIdentity' + staLastDataDownlinkRate: + description: The data transmit rate in kbps that was most recently used for transmission of data PPDUs from the access point to the station. + format: int32 + type: integer + x-etsi-mec-cardinality: 0..1 + x-etsi-mec-origin-type: Uint32 + staLastDataUplinkRate: + description: The data transmit rate in Kbps that was most recently used for transmission of data PPDUs from the associated station to the access point. + format: int32 + type: integer + x-etsi-mec-cardinality: 0..1 + x-etsi-mec-origin-type: Uint32 + type: object + x-etsi-ref: 6.5.22 + StaDataRateNotification: + properties: + notificationType: + description: Shall be set to "StaDataRateNotification". + type: string + x-etsi-mec-cardinality: '1' + x-etsi-mec-origin-type: String + staDataRate: + description: Data rates of a client station. + items: + $ref: '#/components/schemas/StaDataRate' + minItems: 0 + type: array + x-etsi-mec-cardinality: 0..N + x-etsi-mec-origin-type: StaDataRate + timeStamp: + # description': Time stamp. + # x-etsi-mec-cardinality': 0..1 + # x-etsi-mec-origin-type': TimeStamp + $ref: '#/components/schemas/TimeStamp' + required: + - notificationType + type: object + x-etsi-ref: 6.4.3 + StaDataRateSubscription: + properties: + _links: + description: Hyperlink related to the resource. This shall be only included in the HTTP responses and in HTTP PUT requests. + properties: + self: + # description': Self referring URI. The URI shall be unique within the WLAN Access Information API as it acts as an ID for the subscription. + # x-etsi-mec-cardinality': '1' + # x-etsi-mec-origin-type': LinkType + $ref: '#/components/schemas/LinkType' + required: + - self + type: object + x-etsi-mec-cardinality: 0..1 + x-etsi-mec-origin-type: Structure (inlined) + callbackReference: + description: URI selected by the service consumer to receive notifications on the subscribed WLAN Access Information Service. This shall be included both in the request and in response. + format: uri + type: string + x-etsi-mec-cardinality: '1' + x-etsi-mec-origin-type: URI + expiryDeadline: + # description': The expiration time of the subscription determined by the WLAN Access Information Service. + # x-etsi-mec-cardinality': 0..1 + # x-etsi-mec-origin-type': TimeStamp + $ref: '#/components/schemas/TimeStamp' + staId: + description: Identifier(s) to uniquely specify the target client station(s) for the subscription + items: + $ref: '#/components/schemas/StaIdentity' + minItems: 1 + type: array + x-etsi-mec-cardinality: 1..N + x-etsi-mec-origin-type: StaIdentity + subscriptionType: + description: Shall be set to "StaDataRateSubscription". + type: string + x-etsi-mec-cardinality: '1' + x-etsi-mec-origin-type: String + required: + - subscriptionType + - callbackReference + - staId + type: object + x-etsi-ref: 6.3.3 + StaIdentity: + properties: + aid: + description: 'Number which identifies a particular association between a station and an Access Point ' + type: string + x-etsi-mec-cardinality: 0..1 + x-etsi-mec-origin-type: String + ipAddress: + description: IPv4 or IPv6 address allocated for the station. + items: + type: string + minItems: 0 + type: array + x-etsi-mec-cardinality: 0..N + x-etsi-mec-origin-type: String + macId: + description: Unique identifier assigned to station (as network interface controller) for communications at the data link layer of a network segment. + type: string + x-etsi-mec-cardinality: '1' + x-etsi-mec-origin-type: String + ssid: + description: Service Set Identifier to identify logical networks. + items: + type: string + minItems: 0 + type: array + x-etsi-mec-cardinality: 0..N + x-etsi-mec-origin-type: String + required: + - macId + type: object + x-etsi-ref: 6.5.11 + StaInfo: + properties: + apAssociated: + # description': Information about the Access Point that this Client Station is associated to. + # x-etsi-mec-cardinality': 0..1 + # x-etsi-mec-origin-type': ApAssociated + $ref: '#/components/schemas/ApAssociated' + beaconReport: + # description': Beacon Report as defined in Wi-Fi Agile Multiband Specification [9]. + # x-etsi-mec-cardinality': 0..1 + # x-etsi-mec-origin-type': BeaconReport + $ref: '#/components/schemas/BeaconReport' + channel: + description: Channel currently used by the station. + format: int32 + type: integer + x-etsi-mec-cardinality: 0..1 + x-etsi-mec-origin-type: Uint32 + rssi: + # description': Receive Signal Strength Indicator. + # x-etsi-mec-cardinality': 0..1 + # x-etsi-mec-origin-type': Rssi + $ref: '#/components/schemas/Rssi' + staDataRate: + # description': Station Data Rate as defined in IEEE 802.11-2016 [8]. + # x-etsi-mec-cardinality': 0..1 + # x-etsi-mec-origin-type': StaDataRate + $ref: '#/components/schemas/StaDataRate' + staId: + # description': 0 to N identifiers to uniquely specify the station whose information is exposed within this data type. + # x-etsi-mec-cardinality': '1' + # x-etsi-mec-origin-type': StaIdentity + $ref: '#/components/schemas/StaIdentity' + staStatistics: + # description': Statistics as defined in IEEE 802.11-2016 [8] for the client station collected over measurement duration. + # x-etsi-mec-cardinality': 0..1 + # x-etsi-mec-origin-type': StaStatistics + $ref: '#/components/schemas/StaStatistics' + timeStamp: + # description': Time stamp. + # x-etsi-mec-cardinality': 0..1 + # x-etsi-mec-origin-type': TimeStamp + $ref: '#/components/schemas/TimeStamp' + required: + - staId + type: object + x-etsi-ref: 6.2.3 + StaStatistics: + properties: + groupIdentity: + description: Indicates the requested statistics group describing the Statistics Group Data according to table 9-114 of IEEE 802.11-2016 [8]. + type: integer + x-etsi-mec-cardinality: '1' + x-etsi-mec-origin-type: UInt8 + md: + description: Measurement Duration. + type: integer + x-etsi-mec-cardinality: '1' + x-etsi-mec-origin-type: UInt16 + statisticsGroupData: + $ref: '#/components/schemas/StatisticsGroupData' + description: "Statistics Group Data as defined in Annex C of IEEE 802.112016\_[8]." + x-etsi-mec-cardinality: '1' + x-etsi-mec-origin-type: not specified + required: + - md + - groupIdentity + - statisticsGroupData + type: object + x-etsi-ref: 6.5.13 + StaStatisticsConfig: + properties: + groupIdentity: + description: As per table T 9-114 of IEEE 802.11-2012 [8]. + type: integer + x-etsi-mec-cardinality: '1' + x-etsi-mec-origin-type: Integer + staId: + # description': Identifier to uniquely specify the station whose information is exposed within this data type. + # x-etsi-mec-cardinality': '1' + # x-etsi-mec-origin-type': StaIdentity + $ref: '#/components/schemas/StaIdentity' + triggerCondition: + # description': As per Figure 9-161 of IEEE 802.11. This bitmap defines what are the metrics returned by the STA Statistics Report. + # x-etsi-mec-cardinality': '1' + # x-etsi-mec-origin-type': 16bits bitmap + type: integer + triggerTimeout: + description: The Trigger Timeout field contains a value in units of 100 TUs during which a measuring STA does not generate further triggered STA Statistics Reports after a trigger condition has been met. + type: integer + x-etsi-mec-cardinality: '1' + x-etsi-mec-origin-type: Integer + triggeredReport: + # description': Yes, use triggered report. + # x-etsi-mec-cardinality': '1' + # x-etsi-mec-origin-type': Bool + type: boolean + required: + - staId + - groupIdentity + - triggeredReport + - triggerTimeout + - triggerCondition + type: object + x-etsi-ref: 6.5.26 + StatisticsGroupData: + properties: + dot11AMPDUDelimiterCRCErrorCount: + format: int32 + type: integer + x-etsi-mec-cardinality: 0..1 + x-etsi-mec-origin-type: Uint32 + dot11AMPDUReceivedCount: + format: int32 + type: integer + x-etsi-mec-cardinality: 0..1 + x-etsi-mec-origin-type: Uint32 + dot11AMSDUAckFailureCount: + format: int32 + type: integer + x-etsi-mec-cardinality: 0..1 + x-etsi-mec-origin-type: Uint32 + dot11AckFailureCount: + format: int32 + type: integer + x-etsi-mec-cardinality: 0..1 + x-etsi-mec-origin-type: Uint32 + dot11BeamformingFrameCount: + format: int32 + type: integer + x-etsi-mec-cardinality: 0..1 + x-etsi-mec-origin-type: Uint32 + dot11ChannelWidthSwitchCount: + format: int32 + type: integer + x-etsi-mec-cardinality: 0..1 + x-etsi-mec-origin-type: Uint32 + dot11DualCTSFailureCount: + format: int32 + type: integer + x-etsi-mec-cardinality: 0..1 + x-etsi-mec-origin-type: Uint32 + dot11DualCTSSuccessCount: + format: int32 + type: integer + x-etsi-mec-cardinality: 0..1 + x-etsi-mec-origin-type: Uint32 + dot11ExplicitBARFailureCount: + format: int32 + type: integer + x-etsi-mec-cardinality: 0..1 + x-etsi-mec-origin-type: Uint32 + dot11FCSErrorCount: + format: int32 + type: integer + x-etsi-mec-cardinality: 0..1 + x-etsi-mec-origin-type: Uint32 + dot11FailedAMSDUCount: + format: int32 + type: integer + x-etsi-mec-cardinality: 0..1 + x-etsi-mec-origin-type: Uint32 + dot11FailedCount: + format: int32 + type: integer + x-etsi-mec-cardinality: 0..1 + x-etsi-mec-origin-type: Uint32 + dot11FortyMHzFrameReceivedCount: + format: int32 + type: integer + x-etsi-mec-cardinality: 0..1 + x-etsi-mec-origin-type: Uint32 + dot11FortyMHzFrameTransmittedCount: + format: int32 + type: integer + x-etsi-mec-cardinality: 0..1 + x-etsi-mec-origin-type: Uint32 + dot11FrameDuplicateCount: + format: int32 + type: integer + x-etsi-mec-cardinality: 0..1 + x-etsi-mec-origin-type: Uint32 + dot11GrantedRDGUnusedCount: + format: int32 + type: integer + x-etsi-mec-cardinality: 0..1 + x-etsi-mec-origin-type: Uint32 + dot11GrantedRDGUsedCount: + format: int32 + type: integer + x-etsi-mec-cardinality: 0..1 + x-etsi-mec-origin-type: Uint32 + dot11GroupReceivedFrameCount: + format: int32 + type: integer + x-etsi-mec-cardinality: 0..1 + x-etsi-mec-origin-type: Uint32 + dot11GroupTransmittedFrameCount: + format: int32 + type: integer + x-etsi-mec-cardinality: 0..1 + x-etsi-mec-origin-type: Uint32 + dot11ImplicitBARFailureCount: + format: int32 + type: integer + x-etsi-mec-cardinality: 0..1 + x-etsi-mec-origin-type: Uint32 + dot11MPDUInReceivedAMPDUCount: + format: int32 + type: integer + x-etsi-mec-cardinality: 0..1 + x-etsi-mec-origin-type: Uint32 + dot11MultipleRetryAMSDUCount: + format: int32 + type: integer + x-etsi-mec-cardinality: 0..1 + x-etsi-mec-origin-type: Uint32 + dot11MultipleRetryCount: + format: int32 + type: integer + x-etsi-mec-cardinality: 0..1 + x-etsi-mec-origin-type: Uint32 + dot11PSMPUTTGrantDuration: + format: int32 + type: integer + x-etsi-mec-cardinality: 0..1 + x-etsi-mec-origin-type: Uint32 + dot11PSMPUTTUsedDuration: + format: int32 + type: integer + x-etsi-mec-cardinality: 0..1 + x-etsi-mec-origin-type: Uint32 + dot11QosAckFailureCount: + format: int32 + type: integer + x-etsi-mec-cardinality: 0..1 + x-etsi-mec-origin-type: Uint32 + dot11QosDiscardedFrameCount: + format: int32 + type: integer + x-etsi-mec-cardinality: 0..1 + x-etsi-mec-origin-type: Uint32 + dot11QosFailedCount: + format: int32 + type: integer + x-etsi-mec-cardinality: 0..1 + x-etsi-mec-origin-type: Uint32 + dot11QosFrameDuplicateCount: + format: int32 + type: integer + x-etsi-mec-cardinality: 0..1 + x-etsi-mec-origin-type: Uint32 + dot11QosMPDUsReceivedCount: + format: int32 + type: integer + x-etsi-mec-cardinality: 0..1 + x-etsi-mec-origin-type: Uint32 + dot11QosMultipleRetryCount: + format: int32 + type: integer + x-etsi-mec-cardinality: 0..1 + x-etsi-mec-origin-type: Uint32 + dot11QosRTSFailureCount: + format: int32 + type: integer + x-etsi-mec-cardinality: 0..1 + x-etsi-mec-origin-type: Uint32 + dot11QosRTSSuccessCount: + format: int32 + type: integer + x-etsi-mec-cardinality: 0..1 + x-etsi-mec-origin-type: Uint32 + dot11QosReceivedFragmentCount: + format: int32 + type: integer + x-etsi-mec-cardinality: 0..1 + x-etsi-mec-origin-type: Uint32 + dot11QosRetriesReceivedCount: + format: int32 + type: integer + x-etsi-mec-cardinality: 0..1 + x-etsi-mec-origin-type: Uint32 + dot11QosRetryCount: + format: int32 + type: integer + x-etsi-mec-cardinality: 0..1 + x-etsi-mec-origin-type: Uint32 + dot11QosTransmittedFragmentCount: + format: int32 + type: integer + x-etsi-mec-cardinality: 0..1 + x-etsi-mec-origin-type: Uint32 + dot11QosTransmittedFrameCount: + format: int32 + type: integer + x-etsi-mec-cardinality: 0..1 + x-etsi-mec-origin-type: Uint32 + dot11RSNAStatsBIPMICErrors: + format: int32 + type: integer + x-etsi-mec-cardinality: 0..1 + x-etsi-mec-origin-type: Uint32 + dot11RSNAStatsCCMPDecryptErrors: + format: int32 + type: integer + x-etsi-mec-cardinality: 0..1 + x-etsi-mec-origin-type: Uint32 + dot11RSNAStatsCCMPReplays: + format: int32 + type: integer + x-etsi-mec-cardinality: 0..1 + x-etsi-mec-origin-type: Uint32 + dot11RSNAStatsCMACReplays: + format: int32 + type: integer + x-etsi-mec-cardinality: 0..1 + x-etsi-mec-origin-type: Uint32 + dot11RSNAStatsRobustMgmtCCMPReplays: + format: int32 + type: integer + x-etsi-mec-cardinality: 0..1 + x-etsi-mec-origin-type: Uint32 + dot11RSNAStatsTKIPICVErrors: + format: int32 + type: integer + x-etsi-mec-cardinality: 0..1 + x-etsi-mec-origin-type: Uint32 + dot11RSNAStatsTKIPReplays: + format: int32 + type: integer + x-etsi-mec-cardinality: 0..1 + x-etsi-mec-origin-type: Uint32 + dot11RTSFailureCount: + format: int32 + type: integer + x-etsi-mec-cardinality: 0..1 + x-etsi-mec-origin-type: Uint32 + dot11RTSLSIGFailureCount: + format: int32 + type: integer + x-etsi-mec-cardinality: 0..1 + x-etsi-mec-origin-type: Uint32 + dot11RTSLSIGSuccessCount: + format: int32 + type: integer + x-etsi-mec-cardinality: 0..1 + x-etsi-mec-origin-type: Uint32 + dot11RTSSuccessCount: + format: int32 + type: integer + x-etsi-mec-cardinality: 0..1 + x-etsi-mec-origin-type: Uint32 + dot11ReceivedAMSDUCount: + format: int32 + type: integer + x-etsi-mec-cardinality: 0..1 + x-etsi-mec-origin-type: Uint32 + dot11ReceivedFragmentCount: + format: int32 + type: integer + x-etsi-mec-cardinality: 0..1 + x-etsi-mec-origin-type: Uint32 + dot11ReceivedOctetsInAMPDUCount: + format: int64 + type: integer + x-etsi-mec-cardinality: 0..1 + x-etsi-mec-origin-type: Uint64 + dot11ReceivedOctetsInAMSDUCount: + format: int64 + type: integer + x-etsi-mec-cardinality: 0..1 + x-etsi-mec-origin-type: Uint64 + dot11RetryAMSDUCount: + format: int32 + type: integer + x-etsi-mec-cardinality: 0..1 + x-etsi-mec-origin-type: Uint32 + dot11RetryCount: + format: int32 + type: integer + x-etsi-mec-cardinality: 0..1 + x-etsi-mec-origin-type: Uint32 + dot11STAStatisticsAPAverageAccessDelay: + type: integer + x-etsi-mec-cardinality: 0..1 + x-etsi-mec-origin-type: Uint8 + dot11STAStatisticsAverageAccessDelayBackGround: + type: integer + x-etsi-mec-cardinality: 0..1 + x-etsi-mec-origin-type: Uint8 + dot11STAStatisticsAverageAccessDelayBestEffort: + type: integer + x-etsi-mec-cardinality: 0..1 + x-etsi-mec-origin-type: Uint8 + dot11STAStatisticsAverageAccessDelayVideo: + type: integer + x-etsi-mec-cardinality: 0..1 + x-etsi-mec-origin-type: Uint8 + dot11STAStatisticsAverageAccessDelayVoice: + type: integer + x-etsi-mec-cardinality: 0..1 + x-etsi-mec-origin-type: Uint8 + dot11STAStatisticsChannelUtilization: + type: integer + x-etsi-mec-cardinality: 0..1 + x-etsi-mec-origin-type: Uint8 + dot11STAStatisticsStationCount: + type: integer + x-etsi-mec-cardinality: 0..1 + x-etsi-mec-origin-type: Uint8 + dot11STBCCTSFailureCount: + format: int32 + type: integer + x-etsi-mec-cardinality: 0..1 + x-etsi-mec-origin-type: Uint32 + dot11STBCCTSSuccessCount: + format: int32 + type: integer + x-etsi-mec-cardinality: 0..1 + x-etsi-mec-origin-type: Uint32 + dot11TransmittedAMPDUCount: + format: int32 + type: integer + x-etsi-mec-cardinality: 0..1 + x-etsi-mec-origin-type: Uint32 + dot11TransmittedAMSDUCount: + format: int32 + type: integer + x-etsi-mec-cardinality: 0..1 + x-etsi-mec-origin-type: Uint32 + dot11TransmittedFragmentCount: + format: int32 + type: integer + x-etsi-mec-cardinality: 0..1 + x-etsi-mec-origin-type: Uint32 + dot11TransmittedFrameCount: + format: int32 + type: integer + x-etsi-mec-cardinality: 0..1 + x-etsi-mec-origin-type: Uint32 + dot11TransmittedFramesInGrantedRDGCount: + format: int32 + type: integer + x-etsi-mec-cardinality: 0..1 + x-etsi-mec-origin-type: Uint32 + dot11TransmittedMPDUsInAMPDUCount: + format: int32 + type: integer + x-etsi-mec-cardinality: 0..1 + x-etsi-mec-origin-type: Uint32 + dot11TransmittedOctetsInAMPDUCount: + format: int64 + type: integer + x-etsi-mec-cardinality: 0..1 + x-etsi-mec-origin-type: Uint64 + dot11TransmittedOctetsInAMSDUCount: + format: int64 + type: integer + x-etsi-mec-cardinality: 0..1 + x-etsi-mec-origin-type: Uint32 + dot11TransmittedOctetsInGrantedRDGCount: + format: int32 + type: integer + x-etsi-mec-cardinality: 0..1 + x-etsi-mec-origin-type: Uint32 + dot11TwentyMHzFrameReceivedCount: + format: int32 + type: integer + x-etsi-mec-cardinality: 0..1 + x-etsi-mec-origin-type: Uint32 + dot11TwentyMHzFrameTransmittedCount: + format: int32 + type: integer + x-etsi-mec-cardinality: 0..1 + x-etsi-mec-origin-type: Uint32 + dot11nonSTBCCTSFailureCount: + format: int32 + type: integer + x-etsi-mec-cardinality: 0..1 + x-etsi-mec-origin-type: Uint32 + dot11nonSTBCCTSSuccessCount: + format: int32 + type: integer + x-etsi-mec-cardinality: 0..1 + x-etsi-mec-origin-type: Uint32 + type: object + SubscriptionLinkList: + properties: + _links: + description: Hyperlink related to the resource. This shall be only included in the HTTP responses and in HTTP PUT requests. + properties: + self: + $ref: '#/components/schemas/LinkType' + type: object + x-etsi-mec-cardinality: 0..1 + x-etsi-mec-origin-type: Structure (inlined) + assocStaSubscription: + items: + $ref: '#/components/schemas/AssocStaSubscription' + type: array + x-etsi-mec-cardinality: 0..N + x-etsi-mec-origin-type: AssocStaSubscription + staDataRateSubscription: + items: + $ref: '#/components/schemas/StaDataRateSubscription' + type: array + x-etsi-mec-cardinality: 0..N + x-etsi-mec-origin-type: StaDataRateSubscription + required: + - _links + type: object + TimeStamp: + properties: + nanoSeconds: + description: The nanoseconds part of the time. Time is defined as Unix-time since January 1, 1970, 00:00:00 UTC. + format: int32 + type: integer + x-etsi-mec-cardinality: '1' + x-etsi-mec-origin-type: Uint32 + seconds: + description: The seconds part of the time. Time is defined as Unixtime since January 1, 1970, 00:00:00 UTC. + format: int32 + type: integer + x-etsi-mec-cardinality: '1' + x-etsi-mec-origin-type: Uint32 + required: + - seconds + - nanoSeconds + type: object + x-etsi-ref: 6.5.2 + VhtCapabilities: + properties: + vhtCapInfo: + description: VHT capabilities Info as defined in IEEE 802.11-2016 [8]. + format: int32 + type: integer + x-etsi-mec-cardinality: '1' + x-etsi-mec-origin-type: UInt32 + vhtMcsNss: + description: Supported VHT-MCS and NSS Set as defined in IEEE 802.11-2016 [8]. + format: int64 + type: integer + x-etsi-mec-cardinality: '1' + x-etsi-mec-origin-type: UInt64 + required: + - vhtCapInfo + - vhtMcsNss + type: object + x-etsi-ref: 6.5.15 + WanMetrics: + properties: + downlinkLoad: + description: 1-octet positive integer representing the current percentage loading of the downlink WAN connection, scaled linearly with 255 representing 100 %, as measured over an interval the duration of which is reported in Load Measurement Duration. In cases where the downlink load is unknown to the AP, the value is set to zero. + format: int32 + type: integer + x-etsi-mec-cardinality: '1' + x-etsi-mec-origin-type: UInt8 + downlinkSpeed: + description: 4-octet positive integer whose value is an estimate of the WAN Backhaul link current downlink speed in kilobits per second. + format: int32 + type: integer + x-etsi-mec-cardinality: '1' + x-etsi-mec-origin-type: Uint32 + lmd: + description: The LMD (Load Measurement Duration) field is a 2-octet positive integer representing the duration over which the Downlink Load and Uplink Load have been measured, in tenths of a second. When the actual load measurement duration is greater than the maximum value, the maximum value will be reported. The value of the LMD field is set to 0 when neither the uplink nor downlink load can be computed. When the uplink and downlink loads are computed over different intervals, the maximum interval is reported. + format: int32 + type: integer + x-etsi-mec-cardinality: '1' + x-etsi-mec-origin-type: Uint16 + uplinkLoad: + description: 1-octet positive integer representing the current percentage loading of the uplink WAN connection, scaled linearly with 255 representing 100 %, as measured over an interval, the duration of which is reported in Load Measurement Duration. In cases where the uplink load is unknown to the AP, the value is set to zero. + format: int32 + type: integer + x-etsi-mec-cardinality: '1' + x-etsi-mec-origin-type: Uint8 + uplinkSpeed: + description: 4-octet positive integer whose value is an estimate of the WAN Backhaul link's current uplink speed in kilobits per second. + format: int32 + type: integer + x-etsi-mec-cardinality: '1' + x-etsi-mec-origin-type: UInt32 + wanInfo: + description: Info about WAN link status, link symmetricity and capacity currently used. + format: int32 + type: integer + x-etsi-mec-cardinality: '1' + x-etsi-mec-origin-type: Uint8 + required: + - wanInfo + - downlinkSpeed + - uplinkSpeed + - downlinkLoad + - uplinkLoad + - lmd + type: object + x-etsi-ref: 6.5.6 + WlanCapabilities: + properties: + dmg: + # description': Information about Access Point DMG capabilities as defined in IEEE 802.11-2016 [8]. + # x-etsi-mec-cardinality': 0..1 + # x-etsi-mec-origin-type': DmgCapabilities + $ref: '#/components/schemas/DmgCapabilities' + edmg: + # description': Information about Access Point EDMG capabilities as defined in draft IEEE P802.11/D4.0 [i.11]. + # x-etsi-mec-cardinality': 0..1 + # x-etsi-mec-origin-type': EdmgCapabilities + $ref: '#/components/schemas/EdmgCapabilities' + he: + # description': Information about Access Point HE capabilities as defined in FFS. + # x-etsi-mec-cardinality': 0..1 + # x-etsi-mec-origin-type': HeCapabilities + $ref: '#/components/schemas/HeCapabilities' + ht: + # description': Information about Access Point HT capabilities as defined in IEEE 802.11-2016 [8]. + # x-etsi-mec-cardinality': 0..1 + # x-etsi-mec-origin-type': HtCapabilities + $ref: '#/components/schemas/HtCapabilities' + vht: + # description': Information about Access Point VHT capabilities as defined in IEEE 802.11-2016 [8]. + # x-etsi-mec-cardinality': 0..1 + # x-etsi-mec-origin-type': VhtCapabilities + $ref: '#/components/schemas/VhtCapabilities' + type: object + x-etsi-ref: 6.5.4 -- GitLab From 75b88ba6dccfb64d6c1813a1c2339f9b30a9ccdc Mon Sep 17 00:00:00 2001 From: Michel Roy Date: Thu, 12 Nov 2020 21:00:55 -0500 Subject: [PATCH 4/8] implicit naming --- WlanInformationApi.yaml | 4924 +++++++++++++++++++++------------------ 1 file changed, 2686 insertions(+), 2238 deletions(-) diff --git a/WlanInformationApi.yaml b/WlanInformationApi.yaml index c88074b..c082656 100644 --- a/WlanInformationApi.yaml +++ b/WlanInformationApi.yaml @@ -1,2238 +1,2686 @@ -openapi: 3.0.0 -info: - contact: - url: https://forge.etsi.org/rep/mec/gs028-wai-api - title: ETSI GS MEC 028 - WLAN Access Information API - version: 2.1.1 - description: The ETSI MEC ISG MEC028 WLAN Access Information API described using OpenAPI - license: - name: BSD-3-Clause - url: 'https://forge.etsi.org/legal-matters' -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' -servers: - - url: 'https://localhost/wai/v2' -tags: -- name: "wai" -paths: - /queries/ap/ap_information: - get: - tags: - - 'wai' - summary: 'Retrieve information on existing Access Points' - description: 'Queries information about existing WLAN Access Points' - operationId: apInfoGET - parameters: - - $ref: '#/components/parameters/Query.Filter' - - $ref: '#/components/parameters/Query.AllFields' - - $ref: '#/components/parameters/Query.Fields' - - $ref: '#/components/parameters/Query.ExcludeFields' - - $ref: '#/components/parameters/Query.ExcludeDefault' - responses: - '200': - description: Successful response to ap_info request - content: - application/json: - schema: - type: object - properties: - apInfo: - type: array - items: - $ref: '#/components/schemas/ApInfo' - '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': - $ref: '#/components/responses/429' - /queries/sta/sta_information: - get: - tags: - - 'wai' - summary: 'Retrieve information on existing Stations' - description: 'Queries information about existing WLAN stations' - operationId: staInfoGET - parameters: - - $ref: '#/components/parameters/Query.Filter' - - $ref: '#/components/parameters/Query.AllFields' - - $ref: '#/components/parameters/Query.Fields' - - $ref: '#/components/parameters/Query.ExcludeFields' - - $ref: '#/components/parameters/Query.ExcludeDefault' - responses: - '200': - description: Successful response to sta_info request - content: - application/json: - schema: - type: object - properties: - staInfo: - type: array - items: - $ref: '#/components/schemas/StaInfo' - '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': - $ref: '#/components/responses/429' - /subscriptions: - get: - tags: - - 'wai' - summary: 'Retrieve information on subscriptions for notifications' - description: 'Queries information on subscriptions for notifications' - operationId: subscriptionLinkList_subscriptionsGET - parameters: - - $ref: '#/components/parameters/Query.SubscriptionType' - responses: - '200': - description: 'Response body contains the list of links to requestors subscriptions.' - content: - application/json: - schema: - type: object - required: - - subscriptionLinkList - properties: - subscriptionLinkList: - $ref: '#/components/schemas/SubscriptionLinkList' - example: - subscriptionLinkList: - _links: - self: - href: 'http://meAppServer.example.com/wai/v2/subscriptions' - subscription: - - _links: - self: - href: 'http://meAppServer.example.com/wai/v2/subscriptions/sub123' - callbackReference: 'http://my.callback.com/wai/assocStaSubscription/some-id' - subscriptionType: AssocStaSubscription - '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': - $ref: '#/components/responses/429' - post: - tags: - - 'wai' - summary: 'Create a new subscription' - description: 'Creates a new subscription to WLAN Access Information notifications' - operationId: subscriptionsPOST - requestBody: - description: Subscription to be created - required: true - content: - application/json: - schema: - type: object - properties: - notificationSubscription: - oneOf: - - $ref: '#/components/schemas/AssocStaSubscription' - - $ref: '#/components/schemas/StaDataRateSubscription' - discriminator: - propertyName: subscriptionType - example: - notificationSubscription: - subscriptionType: AssocStaSubscription - callbackReference: 'http://meAppClient.example.com/wai/v2/notifications/1' - expiryDeadline: - seconds: 1977836800 - nanoSeconds: 0 - apId: - macId: 005C0A0A0A0A - ssid: 'myNetworkSsid' - ipAddress: 10.10.100.1 - responses: - '201': - description: Successful subscription response - content: - application/json: - schema: - type: object - properties: - notificationSubscription: - oneOf: - - $ref: '#/components/schemas/AssocStaSubscription' - - $ref: '#/components/schemas/StaDataRateSubscription' - discriminator: - propertyName: subscriptionType - example: - notificationSubscription: - subscriptionType: AssocStaSubscription - callbackReference: 'http://meAppClient.example.com/wai/v2/notifications/1' - _links: - self: - href: 'http://meAppServer.example.com/wai/v2/subscriptions/sub123' - expiryDeadline: - seconds: 1977836800 - nanoSeconds: 0 - apId: - macId: 005C0A0A0A0A - ssid: 'myNetworkSsid' - ipAddress: 10.10.100.1 - '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': - $ref: '#/components/responses/415' - '422': - $ref: '#/components/responses/422' - '429': - $ref: '#/components/responses/429' - callbacks: - notification: - '{$request.body#/callbackReference}': - post: - summary: 'Callback POST used to send a notification' - description: 'Notification from WAIS, content based on subscription type' - operationId: notificationPOST - requestBody: - description: Subscription notification - required: true - content: - application/json: - schema: - type: object - properties: - notification: - oneOf: - - $ref: '#/components/schemas/AssocStaNotification' - - $ref: '#/components/schemas/StaDataRateNotification' - discriminator: - propertyName: notificationType - example: - notification: - notificationType: AssocStaNotification - timeStamp: - seconds: 1977836800 - nanoseconds: 0 - apId: - macId: 005C0A0A0A0A - ssid: 'myNetworkSsid' - ipAddress: 10.10.100.1 - staId: - macId: 005C01111111 - ssid: - - 'myNetworkSsid' - - 'myOtherNetworkSsid' - aid: '1122' - ipAddress: 10.10.1.255 - responses: - '204': - $ref: '#/components/responses/204' - '/subscriptions/{subscriptionId}': - get: - tags: - - 'wai' - summary: 'Retrieve information on current specific subscription' - description: 'Queries information about an existing subscription, identified by its self-referring URI returned on creation (initial POST)' - operationId: subscriptionsGET - parameters: - - $ref: '#/components/parameters/Path.subscrId' - responses: - '200': - description: Subscription information regarding subscription notifications - content: - application/json: - schema: - type: object - required: - - notificationSubscription - properties: - notificationSubscription: - oneOf: - - $ref: '#/components/schemas/AssocStaSubscription' - - $ref: '#/components/schemas/StaDataRateSubscription' - discriminator: - propertyName: subscriptionType - example: - notificationSubscription: - subscriptionType: AssocStaSubscription - callbackReference: 'http://meAppClient.example.com/wai/v2/notifications/1' - _links: - self: - href: 'http://meAppServer.example.com/wai/v2/subscriptions/sub123' - expiryDeadline: - seconds: 1977836800 - nanoSeconds: 0 - apId: - macId: 005C0A0A0A0A - ssid: 'myNetworkSsid' - ipAddress: 10.10.100.1 - '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': - $ref: '#/components/responses/429' - put: - tags: - - 'wai' - summary: 'Modify an existing subscription' - description: 'Updates an existing subscription, identified by its self-referring URI returned on creation (initial POST)' - operationId: subscriptionsPUT - requestBody: - description: Subscription to be modified - required: true - content: - application/json: - schema: - type: object - properties: - notificationSubscription: - oneOf: - - $ref: '#/components/schemas/AssocStaSubscription' - - $ref: '#/components/schemas/StaDataRateSubscription' - discriminator: - propertyName: subscriptionType - example: - notificationSubscription: - subscriptionType: AssocStaSubscription - callbackReference: 'http://meAppClient.example.com/wai/v2/notifications/1' - _links: - self: - href: 'http://meAppServer.example.com/wai/v2/subscriptions/sub123' - expiryDeadline: - seconds: 1977836800 - nanoSeconds: 0 - apId: - macId: 005C0A0A0A0A - ssid: 'myNetworkSsid' - ipAddress: 10.10.100.1 - parameters: - - $ref: '#/components/parameters/Path.subscrId' - responses: - '200': - description: Successful subscription modification - content: - application/json: - schema: - type: object - properties: - subscription: - oneOf: - - $ref: '#/components/schemas/AssocStaSubscription' - - $ref: '#/components/schemas/StaDataRateSubscription' - discriminator: - propertyName: subscriptionType - example: - subscription: - _links: - self: - href: 'http://[hostIP]/sbox-xyz123/wai/v2/subscriptions/sub123' - callbackReference: 'http://my.callback.com/wai/some-id' - apId: - macId: 005C0A0A0A0A - '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 an existing subscription' - description: 'Cancels an existing subscription, identified by its self-referring URI returned on creation (initial POST)' - operationId: subscriptionsDELETE - parameters: - - $ref: '#/components/parameters/Path.subscrId' - 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/json: - schema: - type: object - properties: - problemDetails: - $ref: '#/components/schemas/ProblemDetails' - 401: - description: 'Unauthorized : used when the client did not submit credentials.' - content: - application/json: - schema: - type: object - properties: - problemDetails: - $ref: '#/components/schemas/ProblemDetails' - 403: - description: 'Forbidden : operation is not allowed given the current status of the resource.' - content: - application/json: - schema: - type: object - required: - - problemDetails - properties: - problemDetails: - $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/json: - schema: - type: object - properties: - problemDetails: - $ref: '#/components/schemas/ProblemDetails' - 406: - description: 'Not Acceptable : used to indicate that the server cannot provide the any of the content formats supported by the client.' - content: - application/json: - schema: - type: object - properties: - problemDetails: - $ref: '#/components/schemas/ProblemDetails' - 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' - content: - application/json: - schema: - type: object - properties: - problemDetails: - $ref: '#/components/schemas/ProblemDetails' - 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/json: - schema: - type: object - properties: - problemDetails: - $ref: '#/components/schemas/ProblemDetails' - 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.' - content: - application/json: - schema: - type: object - properties: - problemDetails: - $ref: '#/components/schemas/ProblemDetails' - example: - application/problem+json: - ProblemDetails: - 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 - 429: - description: 'Too Many Requests : used when a rate limiter has triggered.' - content: - application/json: - schema: - type: object - properties: - problemDetails: - $ref: '#/components/schemas/ProblemDetails' - parameters: - Path.subscrId: - name: subscriptionId - in: path - description: 'Subscription Id, specifically the "self" returned in the subscription request' - required: true - schema: - type: string - format: uri - 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 - 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 - 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 - 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: - type: string - Query.ExcludeDefault: - name: exclude_default - in: query - description: 'Indicates to exclude the following complex attributes from the response. See clause 6.18 of ETSI GS MEC 009 for details. - The following attributes shall be excluded from the structure in the response body if this parameter is provided, or none of the parameters - "all_fields", "fields", "exclude_fields", "exclude_default" are provided: Not applicable' - required: false - schema: - type: array - items: - type: string - Query.SubscriptionType: - name: subscription_type - in: query - description: 'Filter on a specific subscription type. Permitted values: assoc_sta, sta_data_rate.' - required: false - schema: - type: string - schemas: - ApAssociated: - properties: - assocId: - description: Unique number which identifies a particular association between the station and Access Point. - type: string - x-etsi-mec-cardinality: 0..1 - x-etsi-mec-origin-type: string - ipAddress: - description: IPv4 or IPv6 address allocated for the Access Point. - items: - type: string - minItems: 0 - type: array - x-etsi-mec-cardinality: 0..N - x-etsi-mec-origin-type: string - macId: - description: Unique identifier assigned to the Access Point (as network interface controller) for communications at the data link layer of a network segment. - type: string - x-etsi-mec-cardinality: '1' - x-etsi-mec-origin-type: string - ssid: - description: Service Set Identifier to identify logical networks. - items: - type: string - minItems: 0 - type: array - x-etsi-mec-cardinality: 0..N - x-etsi-mec-origin-type: String - required: - - macId - type: object - x-etsi-ref: 6.5.12 - ApIdentity: - properties: - ipAddress: - description: IPv4 or IPv6 address allocated for the Access Point. - items: - type: string - minItems: 0 - type: array - x-etsi-mec-cardinality: 0..N - x-etsi-mec-origin-type: String - macId: - description: Unique Identifier assigned to an Access Point (as network interface controller) for communications at the data link layer of a network segment. - type: string - x-etsi-mec-cardinality: '1' - x-etsi-mec-origin-type: String - ssid: - description: Service Set Identifier to identify logical networks including Basic Service Set and Extended Service Set. - items: - type: string - minItems: 0 - type: array - x-etsi-mec-cardinality: 0..N - x-etsi-mec-origin-type: String - required: - - macId - type: object - x-etsi-ref: 6.5.3 - ApInfo: - properties: - apId: - # description': Identifier(s) to uniquely specify the Access Point whose information is exposed within this data type. - # x-etsi-mec-cardinality': '1' - # x-etsi-mec-origin-type': ApIdentity - $ref: '#/components/schemas/ApIdentity' - apLocation: - # description': The location on the Access Point. - # x-etsi-mec-cardinality': 0..1 - # x-etsi-mec-origin-type': ApLocation - $ref: '#/components/schemas/ApLocation' - apNeighbor: - # description': Information about neighbor Access Points. - # x-etsi-mec-cardinality': 0..1 - # x-etsi-mec-origin-type': NeighborReport - $ref: '#/components/schemas/NeighborReport' - bssLoad: - # description': BSS Load attribute contains information on the current STA population and traffic levels in the BSS as defined in IEEE 802.11-2016 [8]. - # x-etsi-mec-cardinality': 0..1 - # x-etsi-mec-origin-type': BssLoad - $ref: '#/components/schemas/BssLoad' - channel: - description: Channel configured for the Access Point. - format: int32 - type: integer - x-etsi-mec-cardinality: 0..1 - x-etsi-mec-origin-type: Uint32 - extBssLoad: - # description': Extended BSS Load attribute contains more detailed information on the current STA population and traffic levels in the BSS as per ETSI GS MEC 002 [i.4]. - # x-etsi-mec-cardinality': 0..1 - # x-etsi-mec-origin-type': ExtBssLoad - $ref: '#/components/schemas/ExtBssLoad' - timeStamp: - # description': Time stamp. - # x-etsi-mec-cardinality': 0..1 - # x-etsi-mec-origin-type': TimeStamp - $ref: '#/components/schemas/TimeStamp' - wanMetrics: - # description': WAN Metrics element provides information about the WAN link connecting an IEEE 802.11 Access Node and the Internet. Transmission characteristics such as the speed of the WAN connection to the Internet are included in Hotspot 2.0 Technical Specification v1.0.0 [i.3]. - # x-etsi-mec-cardinality': 0..1 - # x-etsi-mec-origin-type': WanMetrics - $ref: '#/components/schemas/WanMetrics' - wlanCap: - # description': WLAN capabilities of Access Point. - # x-etsi-mec-cardinality': 0..1 - # x-etsi-mec-origin-type': WlanCapabilities - $ref: '#/components/schemas/WlanCapabilities' - required: - - apId - type: object - x-etsi-ref: 6.2.2 - ApLocation: - properties: - civicLocation: - # description': Civic Location of the AP as described in IETF RFC 4776 [7]. - # x-etsi-mec-cardinality': 0..1 - # x-etsi-mec-origin-type': CivicLocation - $ref: '#/components/schemas/CivicLocation' - geolocation: - # description': Geospatial Location of the AP as defined in IEEE 802.11-2016 [8]. - # x-etsi-mec-cardinality': 0..1 - # x-etsi-mec-origin-type': GeoLocation - $ref: '#/components/schemas/GeoLocation' - type: object - x-etsi-ref: 6.5.9 - AssocStaNotification: - properties: - apId: - # description': Identifier(s) to uniquely specify the Access Point to which the client stations are associated. - # x-etsi-mec-cardinality': '1' - # x-etsi-mec-origin-type': ApIdentity - $ref: '#/components/schemas/ApIdentity' - notificationType: - description: Shall be set to "AssocStaNotification". - type: string - x-etsi-mec-cardinality: '1' - x-etsi-mec-origin-type: String - staId: - description: Identifier(s) to uniquely specify the client station(s) associated. - items: - $ref: '#/components/schemas/StaIdentity' - minItems: 0 - type: array - x-etsi-mec-cardinality: 0..N - x-etsi-mec-origin-type: StaIdentity - timeStamp: - # description': Time stamp. - # x-etsi-mec-cardinality': 0..1 - # x-etsi-mec-origin-type': TimeStamp - $ref: '#/components/schemas/TimeStamp' - required: - - notificationType - - apId - type: object - x-etsi-ref: 6.4.2 - AssocStaSubscription: - properties: - _links: - description: Hyperlink related to the resource. This shall be only included in the HTTP responses and in HTTP PUT requests. - properties: - self: - # description': Self referring URI. The URI shall be unique within the WLAN information API as it acts as an ID for the subscription. - # x-etsi-mec-cardinality': '1' - # x-etsi-mec-origin-type': LinkType - $ref: '#/components/schemas/LinkType' - required: - - self - type: object - x-etsi-mec-cardinality: 0..1 - x-etsi-mec-origin-type: Structure (inlined) - apId: - # description': Identifier(s) to uniquely specify the target Access Point for the subscription - # x-etsi-mec-cardinality': '1' - # x-etsi-mec-origin-type': ApIdentity - $ref: '#/components/schemas/ApIdentity' - callbackReference: - description: URI selected by the service consumer to receive notifications on the subscribed WLAN information. This shall be included both in the request and in response. - format: uri - type: string - x-etsi-mec-cardinality: '1' - x-etsi-mec-origin-type: URI - expiryDeadline: - # description': The expiration time of the subscription determined by the WLAN Access Information Service. - # x-etsi-mec-cardinality': 0..1 - # x-etsi-mec-origin-type': TimeStamp - $ref: '#/components/schemas/TimeStamp' - subscriptionType: - description: Shall be set to "AssocStaSubscription". - type: string - x-etsi-mec-cardinality: '1' - x-etsi-mec-origin-type: String - required: - - subscriptionType - - callbackReference - - apId - type: object - x-etsi-ref: 6.3.2 - AssociatedStations: - properties: - assocId: - description: Unique number which identifies a particular association between an Access Point and a station. - type: string - x-etsi-mec-cardinality: 0..1 - x-etsi-mec-origin-type: string - ipAddress: - description: IPv4 or IPv6 address allocated for the station associated with the Access Point. - items: - type: string - minItems: 0 - type: array - x-etsi-mec-cardinality: 0..N - x-etsi-mec-origin-type: string - macId: - description: Unique identifier assigned to a station (as network interface controller) for communications at the data link layer of a network segment. - type: string - x-etsi-mec-cardinality: '1' - x-etsi-mec-origin-type: string - required: - - macId - type: object - x-etsi-ref: 6.5.5 - BeaconReport: - properties: - bssId: - description: The BSSID field indicates the BSSID of the BSS(s) for which a beacon report has been received. - items: - type: string - minItems: 1 - type: array - x-etsi-mec-cardinality: 1..N - x-etsi-mec-origin-type: String - channelId: - description: Channel number where the beacon was received. - type: integer - x-etsi-mec-cardinality: '1' - x-etsi-mec-origin-type: Integer - measurementId: - description: Measurement ID of the Measurement configuration applied to this Beacon Report. - type: string - x-etsi-mec-cardinality: '1' - x-etsi-mec-origin-type: String - reportingCondition: - description: As in table T9-89 of IEEE 802.11-2012 [8]. - type: integer - x-etsi-mec-cardinality: '1' - x-etsi-mec-origin-type: Integer - ssId: - description: (Optional) The SSID subelement indicates the ESS(s) or IBSS(s) for which a beacon report is received. - items: - type: string - minItems: 1 - type: array - x-etsi-mec-cardinality: 1..N - x-etsi-mec-origin-type: String - staId: - # description': Identifier to uniquely specify the station whose information is exposed within this data type. - # x-etsi-mec-cardinality': '1' - # x-etsi-mec-origin-type': StaIdentity - $ref: '#/components/schemas/StaIdentity' - required: - - staId - - measurementId - - channelId - - bssId - - ssId - - reportingCondition - type: object - x-etsi-ref: 6.5.27 - BeaconRequestConfig: - properties: - bssId: - description: The BSSID field indicates the BSSID of the BSS(s) for which a beacon report is requested. When requesting beacon reports for all BSSs on the channel, the BSSID field contains the wildcard BSSID. - items: - type: string - minItems: 1 - type: array - x-etsi-mec-cardinality: 1..N - x-etsi-mec-origin-type: String - channelId: - description: Channel number to scan. A Channel Number of 0 indicates a request to make iterative measurements for all supported channels in the Operating Class where the measurement is permitted on the channel and the channel is valid for the current regulatory domain. A Channel Number of 255 indicates a request to make iterative measurements for all supported channels in the current Operating Class listed in the latest AP Channel Report received from the serving AP. - type: integer - x-etsi-mec-cardinality: '1' - x-etsi-mec-origin-type: Integer - measurementMode: - description: '0 for passive. - - 1 for active. - - 2 for beacon table.' - type: integer - x-etsi-mec-cardinality: '1' - x-etsi-mec-origin-type: Integer - reportingCondition: - description: As in table T9-89 of IEEE 802.11-2012 [8]. - type: integer - x-etsi-mec-cardinality: '1' - x-etsi-mec-origin-type: Integer - ssId: - description: (Optional) The SSID subelement indicates the ESS(s) or IBSS(s) for which a beacon report is requested. - items: - type: string - minItems: 1 - type: array - x-etsi-mec-cardinality: 1..N - x-etsi-mec-origin-type: String - staId: - # description': Identifier to uniquely specify the station whose information is exposed within this data type. - # x-etsi-mec-cardinality': '1' - # x-etsi-mec-origin-type': StaIdentity - $ref: '#/components/schemas/StaIdentity' - required: - - staId - - channelId - - measurementMode - - bssId - - ssId - - reportingCondition - type: object - x-etsi-ref: 6.5.25 - BssLoad: - properties: - availAdmCap: - description: Available Admission Capacity that specifies the remaining amount of medium time available via explicit admission control, in units of 32 s/s. - format: int32 - type: integer - x-etsi-mec-cardinality: '1' - x-etsi-mec-origin-type: Uint16 - channelUtilization: - description: "The percentage of time, linearly scaled with 255 representing 100\_%, that the AP sensed the medium was busy, as indicated by either the physical or virtual Carrier Sense (CS) mechanism." - format: int32 - type: integer - x-etsi-mec-cardinality: '1' - x-etsi-mec-origin-type: UInt8 - staCount: - description: An unsigned integer that indicates the total number of STAs currently associated with this BSS. - format: int32 - type: integer - x-etsi-mec-cardinality: '1' - x-etsi-mec-origin-type: UInt16 - required: - - staCount - - channelUtilization - - availAdmCap - type: object - x-etsi-ref: 6.5.7 - ChannelLoadConfig: - properties: - apId: - # description': Identifier(s) to uniquely specify the target Access Point - # x-etsi-mec-cardinality': '1' - # x-etsi-mec-origin-type': ApIdentity - $ref: '#/components/schemas/ApIdentity' - cChannelId: - description: Channel number which load is reported - type: integer - x-etsi-mec-cardinality: '1' - x-etsi-mec-origin-type: Integer - channelLoad: - description: Channel load as per IEEE 802.11-2012 [8], section 11.11.9.3 - type: integer - x-etsi-mec-cardinality: '1' - x-etsi-mec-origin-type: Integer - required: - - apId - - cChannelId - - channelLoad - type: object - x-etsi-ref: 6.5.24 - CivicLocation: - properties: - ca0: - description: Language - type: string - x-etsi-mec-cardinality: 0..1 - x-etsi-mec-origin-type: String - ca1: - description: 'National subdivisions (state, canton, region,province, prefecture) ' - type: string - x-etsi-mec-cardinality: 0..1 - x-etsi-mec-origin-type: String - ca128: - description: Script - type: string - x-etsi-mec-cardinality: 0..1 - x-etsi-mec-origin-type: String - ca16: - description: Leading street direction - type: string - x-etsi-mec-cardinality: 0..1 - x-etsi-mec-origin-type: String - ca17: - description: Trailing street suffix - type: string - x-etsi-mec-cardinality: 0..1 - x-etsi-mec-origin-type: String - ca18: - description: Street suffix or type - type: string - x-etsi-mec-cardinality: 0..1 - x-etsi-mec-origin-type: String - ca19: - description: House number - type: string - x-etsi-mec-cardinality: 0..1 - x-etsi-mec-origin-type: String - ca2: - description: County, parish, gun (JP), district (IN) - type: string - x-etsi-mec-cardinality: 0..1 - x-etsi-mec-origin-type: String - ca20: - description: House number suffix - type: string - x-etsi-mec-cardinality: 0..1 - x-etsi-mec-origin-type: String - ca21: - description: Landmark of vanity address - type: string - x-etsi-mec-cardinality: 0..1 - x-etsi-mec-origin-type: String - ca22: - description: Additional location information - type: string - x-etsi-mec-cardinality: 0..1 - x-etsi-mec-origin-type: String - ca23: - description: Name (residence and office occupant) - type: string - x-etsi-mec-cardinality: 0..1 - x-etsi-mec-origin-type: String - ca24: - description: Postal/zip code - type: string - x-etsi-mec-cardinality: 0..1 - x-etsi-mec-origin-type: String - ca25: - description: Building (structure) - type: string - x-etsi-mec-cardinality: 0..1 - x-etsi-mec-origin-type: String - ca26: - description: Unit (apartment/suite) - type: string - x-etsi-mec-cardinality: 0..1 - x-etsi-mec-origin-type: String - ca27: - description: Floor - type: string - x-etsi-mec-cardinality: 0..1 - x-etsi-mec-origin-type: String - ca28: - description: Room - type: string - x-etsi-mec-cardinality: 0..1 - x-etsi-mec-origin-type: String - ca29: - description: Type of place - type: string - x-etsi-mec-cardinality: 0..1 - x-etsi-mec-origin-type: String - ca3: - description: City, township, shi (JP) - type: string - x-etsi-mec-cardinality: 0..1 - x-etsi-mec-origin-type: String - ca30: - description: Postal community name - type: string - x-etsi-mec-cardinality: 0..1 - x-etsi-mec-origin-type: String - ca31: - description: Post office box - type: string - x-etsi-mec-cardinality: 0..1 - x-etsi-mec-origin-type: String - ca32: - description: Additional code - type: string - x-etsi-mec-cardinality: 0..1 - x-etsi-mec-origin-type: String - ca33: - description: Seat (desk.cubicle, workstation) - type: string - x-etsi-mec-cardinality: 0..1 - x-etsi-mec-origin-type: String - ca34: - description: Primary road name - type: string - x-etsi-mec-cardinality: 0..1 - x-etsi-mec-origin-type: String - ca35: - description: Road section - type: string - x-etsi-mec-cardinality: 0..1 - x-etsi-mec-origin-type: String - ca36: - description: Branch road name - type: string - x-etsi-mec-cardinality: 0..1 - x-etsi-mec-origin-type: String - ca37: - description: Sub-branch road name - type: string - x-etsi-mec-cardinality: 0..1 - x-etsi-mec-origin-type: String - ca38: - description: Street name pre-modifier - type: string - x-etsi-mec-cardinality: 0..1 - x-etsi-mec-origin-type: String - ca39: - description: Street name post-modifier - type: string - x-etsi-mec-cardinality: 0..1 - x-etsi-mec-origin-type: String - ca4: - description: City division, borough, city district, ward, chou (JP) - type: string - x-etsi-mec-cardinality: 0..1 - x-etsi-mec-origin-type: String - ca5: - description: Neighborhood, block - type: string - x-etsi-mec-cardinality: 0..1 - x-etsi-mec-origin-type: String - ca6: - description: 'Group of streets below the neighborhood level ' - type: string - x-etsi-mec-cardinality: 0..1 - x-etsi-mec-origin-type: String - country: - description: The two-letter ISO 3166 [i.9] country code in capital ASCII letters, e.g. DE or US, as per ISO 3166 [i.9] - type: string - x-etsi-mec-cardinality: '1' - x-etsi-mec-origin-type: String - required: - - country - type: object - x-etsi-ref: 6.5.20 - DmgCapabilities: - properties: - ExtScMcsCap: - description: Extended SC MCS capabilities as defined in draft IEEE P802.11/D4.0 [i.11] - format: int32 - type: integer - x-etsi-mec-cardinality: '1' - x-etsi-mec-origin-type: Uint8 - dmgApOrPcpCapInfo: - description: DMG AP or PCP capabilities information as defined in draft IEEE P802.11/D4.0 [i.11] - format: int32 - type: integer - x-etsi-mec-cardinality: '1' - x-etsi-mec-origin-type: Uint16 - dmgStaBeamTrackTimeLimit: - description: DMG station beam tracking time limit as defined in draft IEEE P802.11/D4.0 [i.11] - format: int32 - type: integer - x-etsi-mec-cardinality: '1' - x-etsi-mec-origin-type: Uint16 - dmgStaCapInfo: - description: DMG station capabilities information as defined in draft IEEE P802.11/D4.0 [i.11] - format: int64 - type: integer - x-etsi-mec-cardinality: '1' - x-etsi-mec-origin-type: Uint64 - maxNrBasicAmsduSubframes: - description: Number of basic A-MSDU subframes in A-MSDU as defined in draft IEEE P802.11/D4.0 [i.11] - format: int32 - type: integer - x-etsi-mec-cardinality: '1' - x-etsi-mec-origin-type: Uint8 - maxNrShortAmsduSubframes: - description: Number of short A-MSDU subframes in A-MSDU as defined in draft IEEE P802.11/D4.0 [i.11] - format: int32 - type: integer - x-etsi-mec-cardinality: '1' - x-etsi-mec-origin-type: Uint8 - sarCap: - description: SAR capabilities as defined in draft IEEE P802.11/D4.0 [i.11] - format: int32 - type: integer - x-etsi-mec-cardinality: '1' - x-etsi-mec-origin-type: Uint8 - tddCap: - description: TDD capabilities as defined in draft IEEE P802.11/D4.0 [i.11] - format: int32 - type: integer - x-etsi-mec-cardinality: '1' - x-etsi-mec-origin-type: Uint16 - required: - - dmgStaCapInfo - - dmgApOrPcpCapInfo - - dmgStaBeamTrackTimeLimit - - ExtScMcsCap - - maxNrBasicAmsduSubframes - - maxNrShortAmsduSubframes - - tddCap - - sarCap - type: object - x-etsi-ref: 6.5.17 - EdmgCapabilities: - properties: - ampduParameters: - description: A-MPDU parameters as defined in draft IEEE P802.11/D4.0 [i.11] - format: Uint8 - type: integer - x-etsi-mec-cardinality: '1' - x-etsi-mec-origin-type: Uint8 - reserved: - description: '' - format: int32 - type: integer - x-etsi-mec-cardinality: 0..1 - x-etsi-mec-origin-type: Uint8 - supportedMcs: - description: Supported MCS as defined in draft IEEE P802.11/D4.0 [i.11] - format: int32 - type: integer - x-etsi-mec-cardinality: '1' - x-etsi-mec-origin-type: Uint32 - trnParameters: - description: Training parameters as defined in draft IEEE P802.11/D4.0 [i.11] - format: int32 - type: integer - x-etsi-mec-cardinality: '1' - x-etsi-mec-origin-type: Uint16 - required: - - ampduParameters - - trnParameters - - supportedMcs - type: object - x-etsi-ref: 6.5.18 - ExtBssLoad: - properties: - muMimoStaCount: - description: Indicates the total number of STAs currently associated with this BSS that have a 1 in the MU Beamformee Capable field of their VHT Capabilities element. - format: int32 - type: integer - x-etsi-mec-cardinality: '1' - x-etsi-mec-origin-type: UInt16 - obsSec20MhzUtil: - description: Observable loading on each of the secondary 20 MHz channel. - format: int32 - type: integer - x-etsi-mec-cardinality: '1' - x-etsi-mec-origin-type: Uint8 - obsSec40MhzUtil: - description: Observable loading on each of the secondary 40 MHz channel. - format: int32 - type: integer - x-etsi-mec-cardinality: '1' - x-etsi-mec-origin-type: Uint8 - obsSec80MhzUtil: - description: Observable loading on each of the secondary 80 MHz channel. - format: int32 - type: integer - x-etsi-mec-cardinality: '1' - x-etsi-mec-origin-type: Uint8 - spatStreamUnderUtil: - description: "The percentage of time, linearly scaled with 255 representing 100\_%, that the AP has underutilized spatial domain resources for given busy time of the medium." - format: int32 - type: integer - x-etsi-mec-cardinality: '1' - x-etsi-mec-origin-type: UInt8 - required: - - muMimoStaCount - - spatStreamUnderUtil - - obsSec20MhzUtil - - obsSec40MhzUtil - - obsSec80MhzUtil - type: object - x-etsi-ref: 6.5.8 - GeoLocation: - properties: - altitude: - description: "The altitude value of location as defined in IETF RFC\_6225 [6]" - format: int32 - type: integer - x-etsi-mec-cardinality: 0..1 - x-etsi-mec-origin-type: Uint32 - altitudeType: - description: The type description for altitude information e.g. floors or meters as defined in IETF RFC 6225 [6] - format: int32 - type: integer - x-etsi-mec-cardinality: 0..1 - x-etsi-mec-origin-type: Uint8 - altitudeUncertainty: - description: The uncertainty for altitude information as defined in IETF RFC 6225 [6] - format: int32 - type: integer - x-etsi-mec-cardinality: 0..1 - x-etsi-mec-origin-type: Uint8 - datum: - description: The datum value to express how coordinates are organized and related to real world as defined in IETF RFC 6225 [6] - format: int32 - type: integer - x-etsi-mec-cardinality: '1' - x-etsi-mec-origin-type: Uint8 - lat: - description: "The latitude value of location as defined in IETF RFC\_6225 [6]" - format: int64 - type: integer - x-etsi-mec-cardinality: '1' - x-etsi-mec-origin-type: Uint64 - latUncertainty: - description: The uncertainty for Latitude information as defined in IETF RFC 6225 [6] - format: int32 - type: integer - x-etsi-mec-cardinality: '1' - x-etsi-mec-origin-type: Uint8 - long: - description: "The longitude value of location as defined in IETF RFC\_6225 [6]" - format: int64 - type: integer - x-etsi-mec-cardinality: '1' - x-etsi-mec-origin-type: Uint64 - longUncertainty: - description: The uncertainty for Longitude information as defined in IETF RFC 6225 [6] - format: int32 - type: integer - x-etsi-mec-cardinality: '1' - x-etsi-mec-origin-type: Uint8 - required: - - latUncertainty - - lat - - longUncertainty - - long - - datum - type: object - x-etsi-ref: 6.5.19 - HeCapabilities: - properties: - heMacCapInfo: - description: MAC capabilities of an Access Point. - type: integer - x-etsi-mec-cardinality: '1' - x-etsi-mec-origin-type: Uint8 - hePhyCapinfo: - description: PHY capabilities of an Access Point. - type: integer - x-etsi-mec-cardinality: '1' - x-etsi-mec-origin-type: Uint8 - ppeThresholds: - description: PPE Threshold determines the nominal packet padding value for a HE PPDU. - type: integer - x-etsi-mec-cardinality: 0..1 - x-etsi-mec-origin-type: not defined - supportedHeMcsNssSet: - description: Supported MCS and NSS Set. - type: integer - x-etsi-mec-cardinality: '1' - x-etsi-mec-origin-type: Uint8 - required: - - heMacCapInfo - - hePhyCapinfo - - supportedHeMcsNssSet - type: object - x-etsi-ref: 6.5.16 - HtCapabilities: - properties: - ampduParameters: - description: A-MPDU parameters as defined in IEEE 802.11-2016 [8]. - format: int32 - type: integer - x-etsi-mec-cardinality: '1' - x-etsi-mec-origin-type: UInt8 - aselCap: - description: ASEL capabilities as defined in IEEE 802.11-2016 [8]. - format: int32 - type: integer - x-etsi-mec-cardinality: '1' - x-etsi-mec-origin-type: UInt8 - htCapabilityInfo: - description: HT Capability Information as defined in IEEE 802.11-2016 [8]. - format: int32 - type: integer - x-etsi-mec-cardinality: '1' - x-etsi-mec-origin-type: UInt16 - htExtendedCap: - description: Extended HT Capabilities as defined in IEEE 802.11-2016 [8]. - format: int32 - type: integer - x-etsi-mec-cardinality: '1' - x-etsi-mec-origin-type: UInt16 - supportedMcsSet: - description: Supported MCS set as defined in IEEE 802.11-2016 [8]. - format: int64 - type: integer - x-etsi-mec-cardinality: '1' - x-etsi-mec-origin-type: Uint128 - txBeamFormCap: - description: Transmit Beamforming Capabilities as defined in IEEE 802.11-2016 [8]. - format: int32 - type: integer - x-etsi-mec-cardinality: '1' - x-etsi-mec-origin-type: UInt32 - required: - - htCapabilityInfo - - ampduParameters - - supportedMcsSet - - htExtendedCap - - txBeamFormCap - - aselCap - type: object - x-etsi-ref: 6.5.14 - LinkType: - properties: - href: - description: URI referring to a resource - type: string - x-etsi-mec-cardinality: '1' - x-etsi-mec-origin-type: String - required: - - href - type: object - x-etsi-ref: 6.5.23 - MeasurementConfig: - properties: - beaconRequest: - # description': Configuration related to Beacon Request. - # x-etsi-mec-cardinality': 0..1 - # x-etsi-mec-origin-type': BeaconRequestConfig - $ref: '#/components/schemas/BeaconRequestConfig' - channelLoad: - # description': Configuration related to the Channel Load. - # x-etsi-mec-cardinality': 0..1 - # x-etsi-mec-origin-type': ChannelLoadConfig - $ref: '#/components/schemas/ChannelLoadConfig' - measurementDuration: - description: Duration of the measurement, shall be lower than Maximum Measurement Duration in TU as defined in section 11.11.4 of IEEE 802.11 [8]. - type: integer - x-etsi-mec-cardinality: '1' - x-etsi-mec-origin-type: Integer - measurementId: - description: Identifier of this measurement configuration. - type: string - x-etsi-mec-cardinality: '1' - x-etsi-mec-origin-type: String - randomnInterval: - description: "Random interval to be used for starting the measurement. In units of TU as specifed in section\_11.11.3 of IEEE 802.11 [8]." - type: integer - x-etsi-mec-cardinality: '1' - x-etsi-mec-origin-type: Integer - staStatistics: - # description': Configuration related to the statistics provided by STAs. - # x-etsi-mec-cardinality': 0..1 - # x-etsi-mec-origin-type': StaStatisticsConfig - $ref: '#/components/schemas/StaStatisticsConfig' - required: - - measurementId - - measurementDuration - - randomnInterval - type: object - x-etsi-notes: "NOTE:\tThis element enables the configuration of the channelLoad, beaconRequest and staStatistics in a single resource data type, although only one of each measurement. Multiple measurement configurations of each kind are not allowed." - x-etsi-ref: 6.2.4 - NeighborReport: - properties: - bssid: - description: BSS Id of the Access Point that is being reported. - type: string - x-etsi-mec-cardinality: '1' - x-etsi-mec-origin-type: String - bssidInfo: - description: Additional information related to Access Point that is being reported such as AP reachability, security, key scope, Mobility Domain, HT/VHT capability and Fine Time Measurements. - format: int32 - type: integer - x-etsi-mec-cardinality: '1' - x-etsi-mec-origin-type: UInt32 - channel: - description: The channel currently used by this Access Point. - type: integer - x-etsi-mec-cardinality: '1' - x-etsi-mec-origin-type: Uint8 - operatingClass: - description: The channel set of the AP indicated by this BSSID. - type: integer - x-etsi-mec-cardinality: '1' - x-etsi-mec-origin-type: Uint8 - phyType: - description: PHY type of the AP indicated by this BSSID. It is an integer value coded according to the value of the dot11PHYType. - type: integer - x-etsi-mec-cardinality: '1' - x-etsi-mec-origin-type: Uint8 - required: - - bssid - - bssidInfo - - operatingClass - - channel - - phyType - type: object - x-etsi-ref: 6.5.10 - ProblemDetails: - properties: - detail: - description: A human-readable explanation specific to this occurrence of the problem - type: string - x-etsi-mec-cardinality: 0..1 - x-etsi-mec-origin-type: String - instance: - description: A URI reference that identifies the specific occurrence of the problem - format: uri - type: string - x-etsi-mec-cardinality: 0..1 - x-etsi-mec-origin-type: URI - status: - description: The HTTP status code for this occurrence of the problem - format: int32 - type: integer - x-etsi-mec-cardinality: 0..1 - x-etsi-mec-origin-type: Uint32 - title: - description: A short, human-readable summary of the problem type - type: string - x-etsi-mec-cardinality: 0..1 - x-etsi-mec-origin-type: String - type: - description: A URI reference according to IETF RFC 3986 that identifies the problem type - format: uri - type: string - x-etsi-mec-cardinality: 0..1 - x-etsi-mec-origin-type: URI - type: object - Rssi: - properties: - rssi: - description: The Received Signal Strength Indicator from a station - format: int32 - type: integer - x-etsi-mec-cardinality: '1' - x-etsi-mec-origin-type: Uint8 - required: - - rssi - type: object - x-etsi-ref: 6.5.21 - StaDataRate: - properties: - staId: - # description': Identifier(s) to uniquely specify the client station(s) associated. - # x-etsi-mec-cardinality': 0..1 - # x-etsi-mec-origin-type': StaIdentity - $ref: '#/components/schemas/StaIdentity' - staLastDataDownlinkRate: - description: The data transmit rate in kbps that was most recently used for transmission of data PPDUs from the access point to the station. - format: int32 - type: integer - x-etsi-mec-cardinality: 0..1 - x-etsi-mec-origin-type: Uint32 - staLastDataUplinkRate: - description: The data transmit rate in Kbps that was most recently used for transmission of data PPDUs from the associated station to the access point. - format: int32 - type: integer - x-etsi-mec-cardinality: 0..1 - x-etsi-mec-origin-type: Uint32 - type: object - x-etsi-ref: 6.5.22 - StaDataRateNotification: - properties: - notificationType: - description: Shall be set to "StaDataRateNotification". - type: string - x-etsi-mec-cardinality: '1' - x-etsi-mec-origin-type: String - staDataRate: - description: Data rates of a client station. - items: - $ref: '#/components/schemas/StaDataRate' - minItems: 0 - type: array - x-etsi-mec-cardinality: 0..N - x-etsi-mec-origin-type: StaDataRate - timeStamp: - # description': Time stamp. - # x-etsi-mec-cardinality': 0..1 - # x-etsi-mec-origin-type': TimeStamp - $ref: '#/components/schemas/TimeStamp' - required: - - notificationType - type: object - x-etsi-ref: 6.4.3 - StaDataRateSubscription: - properties: - _links: - description: Hyperlink related to the resource. This shall be only included in the HTTP responses and in HTTP PUT requests. - properties: - self: - # description': Self referring URI. The URI shall be unique within the WLAN Access Information API as it acts as an ID for the subscription. - # x-etsi-mec-cardinality': '1' - # x-etsi-mec-origin-type': LinkType - $ref: '#/components/schemas/LinkType' - required: - - self - type: object - x-etsi-mec-cardinality: 0..1 - x-etsi-mec-origin-type: Structure (inlined) - callbackReference: - description: URI selected by the service consumer to receive notifications on the subscribed WLAN Access Information Service. This shall be included both in the request and in response. - format: uri - type: string - x-etsi-mec-cardinality: '1' - x-etsi-mec-origin-type: URI - expiryDeadline: - # description': The expiration time of the subscription determined by the WLAN Access Information Service. - # x-etsi-mec-cardinality': 0..1 - # x-etsi-mec-origin-type': TimeStamp - $ref: '#/components/schemas/TimeStamp' - staId: - description: Identifier(s) to uniquely specify the target client station(s) for the subscription - items: - $ref: '#/components/schemas/StaIdentity' - minItems: 1 - type: array - x-etsi-mec-cardinality: 1..N - x-etsi-mec-origin-type: StaIdentity - subscriptionType: - description: Shall be set to "StaDataRateSubscription". - type: string - x-etsi-mec-cardinality: '1' - x-etsi-mec-origin-type: String - required: - - subscriptionType - - callbackReference - - staId - type: object - x-etsi-ref: 6.3.3 - StaIdentity: - properties: - aid: - description: 'Number which identifies a particular association between a station and an Access Point ' - type: string - x-etsi-mec-cardinality: 0..1 - x-etsi-mec-origin-type: String - ipAddress: - description: IPv4 or IPv6 address allocated for the station. - items: - type: string - minItems: 0 - type: array - x-etsi-mec-cardinality: 0..N - x-etsi-mec-origin-type: String - macId: - description: Unique identifier assigned to station (as network interface controller) for communications at the data link layer of a network segment. - type: string - x-etsi-mec-cardinality: '1' - x-etsi-mec-origin-type: String - ssid: - description: Service Set Identifier to identify logical networks. - items: - type: string - minItems: 0 - type: array - x-etsi-mec-cardinality: 0..N - x-etsi-mec-origin-type: String - required: - - macId - type: object - x-etsi-ref: 6.5.11 - StaInfo: - properties: - apAssociated: - # description': Information about the Access Point that this Client Station is associated to. - # x-etsi-mec-cardinality': 0..1 - # x-etsi-mec-origin-type': ApAssociated - $ref: '#/components/schemas/ApAssociated' - beaconReport: - # description': Beacon Report as defined in Wi-Fi Agile Multiband Specification [9]. - # x-etsi-mec-cardinality': 0..1 - # x-etsi-mec-origin-type': BeaconReport - $ref: '#/components/schemas/BeaconReport' - channel: - description: Channel currently used by the station. - format: int32 - type: integer - x-etsi-mec-cardinality: 0..1 - x-etsi-mec-origin-type: Uint32 - rssi: - # description': Receive Signal Strength Indicator. - # x-etsi-mec-cardinality': 0..1 - # x-etsi-mec-origin-type': Rssi - $ref: '#/components/schemas/Rssi' - staDataRate: - # description': Station Data Rate as defined in IEEE 802.11-2016 [8]. - # x-etsi-mec-cardinality': 0..1 - # x-etsi-mec-origin-type': StaDataRate - $ref: '#/components/schemas/StaDataRate' - staId: - # description': 0 to N identifiers to uniquely specify the station whose information is exposed within this data type. - # x-etsi-mec-cardinality': '1' - # x-etsi-mec-origin-type': StaIdentity - $ref: '#/components/schemas/StaIdentity' - staStatistics: - # description': Statistics as defined in IEEE 802.11-2016 [8] for the client station collected over measurement duration. - # x-etsi-mec-cardinality': 0..1 - # x-etsi-mec-origin-type': StaStatistics - $ref: '#/components/schemas/StaStatistics' - timeStamp: - # description': Time stamp. - # x-etsi-mec-cardinality': 0..1 - # x-etsi-mec-origin-type': TimeStamp - $ref: '#/components/schemas/TimeStamp' - required: - - staId - type: object - x-etsi-ref: 6.2.3 - StaStatistics: - properties: - groupIdentity: - description: Indicates the requested statistics group describing the Statistics Group Data according to table 9-114 of IEEE 802.11-2016 [8]. - type: integer - x-etsi-mec-cardinality: '1' - x-etsi-mec-origin-type: UInt8 - md: - description: Measurement Duration. - type: integer - x-etsi-mec-cardinality: '1' - x-etsi-mec-origin-type: UInt16 - statisticsGroupData: - $ref: '#/components/schemas/StatisticsGroupData' - description: "Statistics Group Data as defined in Annex C of IEEE 802.112016\_[8]." - x-etsi-mec-cardinality: '1' - x-etsi-mec-origin-type: not specified - required: - - md - - groupIdentity - - statisticsGroupData - type: object - x-etsi-ref: 6.5.13 - StaStatisticsConfig: - properties: - groupIdentity: - description: As per table T 9-114 of IEEE 802.11-2012 [8]. - type: integer - x-etsi-mec-cardinality: '1' - x-etsi-mec-origin-type: Integer - staId: - # description': Identifier to uniquely specify the station whose information is exposed within this data type. - # x-etsi-mec-cardinality': '1' - # x-etsi-mec-origin-type': StaIdentity - $ref: '#/components/schemas/StaIdentity' - triggerCondition: - # description': As per Figure 9-161 of IEEE 802.11. This bitmap defines what are the metrics returned by the STA Statistics Report. - # x-etsi-mec-cardinality': '1' - # x-etsi-mec-origin-type': 16bits bitmap - type: integer - triggerTimeout: - description: The Trigger Timeout field contains a value in units of 100 TUs during which a measuring STA does not generate further triggered STA Statistics Reports after a trigger condition has been met. - type: integer - x-etsi-mec-cardinality: '1' - x-etsi-mec-origin-type: Integer - triggeredReport: - # description': Yes, use triggered report. - # x-etsi-mec-cardinality': '1' - # x-etsi-mec-origin-type': Bool - type: boolean - required: - - staId - - groupIdentity - - triggeredReport - - triggerTimeout - - triggerCondition - type: object - x-etsi-ref: 6.5.26 - StatisticsGroupData: - properties: - dot11AMPDUDelimiterCRCErrorCount: - format: int32 - type: integer - x-etsi-mec-cardinality: 0..1 - x-etsi-mec-origin-type: Uint32 - dot11AMPDUReceivedCount: - format: int32 - type: integer - x-etsi-mec-cardinality: 0..1 - x-etsi-mec-origin-type: Uint32 - dot11AMSDUAckFailureCount: - format: int32 - type: integer - x-etsi-mec-cardinality: 0..1 - x-etsi-mec-origin-type: Uint32 - dot11AckFailureCount: - format: int32 - type: integer - x-etsi-mec-cardinality: 0..1 - x-etsi-mec-origin-type: Uint32 - dot11BeamformingFrameCount: - format: int32 - type: integer - x-etsi-mec-cardinality: 0..1 - x-etsi-mec-origin-type: Uint32 - dot11ChannelWidthSwitchCount: - format: int32 - type: integer - x-etsi-mec-cardinality: 0..1 - x-etsi-mec-origin-type: Uint32 - dot11DualCTSFailureCount: - format: int32 - type: integer - x-etsi-mec-cardinality: 0..1 - x-etsi-mec-origin-type: Uint32 - dot11DualCTSSuccessCount: - format: int32 - type: integer - x-etsi-mec-cardinality: 0..1 - x-etsi-mec-origin-type: Uint32 - dot11ExplicitBARFailureCount: - format: int32 - type: integer - x-etsi-mec-cardinality: 0..1 - x-etsi-mec-origin-type: Uint32 - dot11FCSErrorCount: - format: int32 - type: integer - x-etsi-mec-cardinality: 0..1 - x-etsi-mec-origin-type: Uint32 - dot11FailedAMSDUCount: - format: int32 - type: integer - x-etsi-mec-cardinality: 0..1 - x-etsi-mec-origin-type: Uint32 - dot11FailedCount: - format: int32 - type: integer - x-etsi-mec-cardinality: 0..1 - x-etsi-mec-origin-type: Uint32 - dot11FortyMHzFrameReceivedCount: - format: int32 - type: integer - x-etsi-mec-cardinality: 0..1 - x-etsi-mec-origin-type: Uint32 - dot11FortyMHzFrameTransmittedCount: - format: int32 - type: integer - x-etsi-mec-cardinality: 0..1 - x-etsi-mec-origin-type: Uint32 - dot11FrameDuplicateCount: - format: int32 - type: integer - x-etsi-mec-cardinality: 0..1 - x-etsi-mec-origin-type: Uint32 - dot11GrantedRDGUnusedCount: - format: int32 - type: integer - x-etsi-mec-cardinality: 0..1 - x-etsi-mec-origin-type: Uint32 - dot11GrantedRDGUsedCount: - format: int32 - type: integer - x-etsi-mec-cardinality: 0..1 - x-etsi-mec-origin-type: Uint32 - dot11GroupReceivedFrameCount: - format: int32 - type: integer - x-etsi-mec-cardinality: 0..1 - x-etsi-mec-origin-type: Uint32 - dot11GroupTransmittedFrameCount: - format: int32 - type: integer - x-etsi-mec-cardinality: 0..1 - x-etsi-mec-origin-type: Uint32 - dot11ImplicitBARFailureCount: - format: int32 - type: integer - x-etsi-mec-cardinality: 0..1 - x-etsi-mec-origin-type: Uint32 - dot11MPDUInReceivedAMPDUCount: - format: int32 - type: integer - x-etsi-mec-cardinality: 0..1 - x-etsi-mec-origin-type: Uint32 - dot11MultipleRetryAMSDUCount: - format: int32 - type: integer - x-etsi-mec-cardinality: 0..1 - x-etsi-mec-origin-type: Uint32 - dot11MultipleRetryCount: - format: int32 - type: integer - x-etsi-mec-cardinality: 0..1 - x-etsi-mec-origin-type: Uint32 - dot11PSMPUTTGrantDuration: - format: int32 - type: integer - x-etsi-mec-cardinality: 0..1 - x-etsi-mec-origin-type: Uint32 - dot11PSMPUTTUsedDuration: - format: int32 - type: integer - x-etsi-mec-cardinality: 0..1 - x-etsi-mec-origin-type: Uint32 - dot11QosAckFailureCount: - format: int32 - type: integer - x-etsi-mec-cardinality: 0..1 - x-etsi-mec-origin-type: Uint32 - dot11QosDiscardedFrameCount: - format: int32 - type: integer - x-etsi-mec-cardinality: 0..1 - x-etsi-mec-origin-type: Uint32 - dot11QosFailedCount: - format: int32 - type: integer - x-etsi-mec-cardinality: 0..1 - x-etsi-mec-origin-type: Uint32 - dot11QosFrameDuplicateCount: - format: int32 - type: integer - x-etsi-mec-cardinality: 0..1 - x-etsi-mec-origin-type: Uint32 - dot11QosMPDUsReceivedCount: - format: int32 - type: integer - x-etsi-mec-cardinality: 0..1 - x-etsi-mec-origin-type: Uint32 - dot11QosMultipleRetryCount: - format: int32 - type: integer - x-etsi-mec-cardinality: 0..1 - x-etsi-mec-origin-type: Uint32 - dot11QosRTSFailureCount: - format: int32 - type: integer - x-etsi-mec-cardinality: 0..1 - x-etsi-mec-origin-type: Uint32 - dot11QosRTSSuccessCount: - format: int32 - type: integer - x-etsi-mec-cardinality: 0..1 - x-etsi-mec-origin-type: Uint32 - dot11QosReceivedFragmentCount: - format: int32 - type: integer - x-etsi-mec-cardinality: 0..1 - x-etsi-mec-origin-type: Uint32 - dot11QosRetriesReceivedCount: - format: int32 - type: integer - x-etsi-mec-cardinality: 0..1 - x-etsi-mec-origin-type: Uint32 - dot11QosRetryCount: - format: int32 - type: integer - x-etsi-mec-cardinality: 0..1 - x-etsi-mec-origin-type: Uint32 - dot11QosTransmittedFragmentCount: - format: int32 - type: integer - x-etsi-mec-cardinality: 0..1 - x-etsi-mec-origin-type: Uint32 - dot11QosTransmittedFrameCount: - format: int32 - type: integer - x-etsi-mec-cardinality: 0..1 - x-etsi-mec-origin-type: Uint32 - dot11RSNAStatsBIPMICErrors: - format: int32 - type: integer - x-etsi-mec-cardinality: 0..1 - x-etsi-mec-origin-type: Uint32 - dot11RSNAStatsCCMPDecryptErrors: - format: int32 - type: integer - x-etsi-mec-cardinality: 0..1 - x-etsi-mec-origin-type: Uint32 - dot11RSNAStatsCCMPReplays: - format: int32 - type: integer - x-etsi-mec-cardinality: 0..1 - x-etsi-mec-origin-type: Uint32 - dot11RSNAStatsCMACReplays: - format: int32 - type: integer - x-etsi-mec-cardinality: 0..1 - x-etsi-mec-origin-type: Uint32 - dot11RSNAStatsRobustMgmtCCMPReplays: - format: int32 - type: integer - x-etsi-mec-cardinality: 0..1 - x-etsi-mec-origin-type: Uint32 - dot11RSNAStatsTKIPICVErrors: - format: int32 - type: integer - x-etsi-mec-cardinality: 0..1 - x-etsi-mec-origin-type: Uint32 - dot11RSNAStatsTKIPReplays: - format: int32 - type: integer - x-etsi-mec-cardinality: 0..1 - x-etsi-mec-origin-type: Uint32 - dot11RTSFailureCount: - format: int32 - type: integer - x-etsi-mec-cardinality: 0..1 - x-etsi-mec-origin-type: Uint32 - dot11RTSLSIGFailureCount: - format: int32 - type: integer - x-etsi-mec-cardinality: 0..1 - x-etsi-mec-origin-type: Uint32 - dot11RTSLSIGSuccessCount: - format: int32 - type: integer - x-etsi-mec-cardinality: 0..1 - x-etsi-mec-origin-type: Uint32 - dot11RTSSuccessCount: - format: int32 - type: integer - x-etsi-mec-cardinality: 0..1 - x-etsi-mec-origin-type: Uint32 - dot11ReceivedAMSDUCount: - format: int32 - type: integer - x-etsi-mec-cardinality: 0..1 - x-etsi-mec-origin-type: Uint32 - dot11ReceivedFragmentCount: - format: int32 - type: integer - x-etsi-mec-cardinality: 0..1 - x-etsi-mec-origin-type: Uint32 - dot11ReceivedOctetsInAMPDUCount: - format: int64 - type: integer - x-etsi-mec-cardinality: 0..1 - x-etsi-mec-origin-type: Uint64 - dot11ReceivedOctetsInAMSDUCount: - format: int64 - type: integer - x-etsi-mec-cardinality: 0..1 - x-etsi-mec-origin-type: Uint64 - dot11RetryAMSDUCount: - format: int32 - type: integer - x-etsi-mec-cardinality: 0..1 - x-etsi-mec-origin-type: Uint32 - dot11RetryCount: - format: int32 - type: integer - x-etsi-mec-cardinality: 0..1 - x-etsi-mec-origin-type: Uint32 - dot11STAStatisticsAPAverageAccessDelay: - type: integer - x-etsi-mec-cardinality: 0..1 - x-etsi-mec-origin-type: Uint8 - dot11STAStatisticsAverageAccessDelayBackGround: - type: integer - x-etsi-mec-cardinality: 0..1 - x-etsi-mec-origin-type: Uint8 - dot11STAStatisticsAverageAccessDelayBestEffort: - type: integer - x-etsi-mec-cardinality: 0..1 - x-etsi-mec-origin-type: Uint8 - dot11STAStatisticsAverageAccessDelayVideo: - type: integer - x-etsi-mec-cardinality: 0..1 - x-etsi-mec-origin-type: Uint8 - dot11STAStatisticsAverageAccessDelayVoice: - type: integer - x-etsi-mec-cardinality: 0..1 - x-etsi-mec-origin-type: Uint8 - dot11STAStatisticsChannelUtilization: - type: integer - x-etsi-mec-cardinality: 0..1 - x-etsi-mec-origin-type: Uint8 - dot11STAStatisticsStationCount: - type: integer - x-etsi-mec-cardinality: 0..1 - x-etsi-mec-origin-type: Uint8 - dot11STBCCTSFailureCount: - format: int32 - type: integer - x-etsi-mec-cardinality: 0..1 - x-etsi-mec-origin-type: Uint32 - dot11STBCCTSSuccessCount: - format: int32 - type: integer - x-etsi-mec-cardinality: 0..1 - x-etsi-mec-origin-type: Uint32 - dot11TransmittedAMPDUCount: - format: int32 - type: integer - x-etsi-mec-cardinality: 0..1 - x-etsi-mec-origin-type: Uint32 - dot11TransmittedAMSDUCount: - format: int32 - type: integer - x-etsi-mec-cardinality: 0..1 - x-etsi-mec-origin-type: Uint32 - dot11TransmittedFragmentCount: - format: int32 - type: integer - x-etsi-mec-cardinality: 0..1 - x-etsi-mec-origin-type: Uint32 - dot11TransmittedFrameCount: - format: int32 - type: integer - x-etsi-mec-cardinality: 0..1 - x-etsi-mec-origin-type: Uint32 - dot11TransmittedFramesInGrantedRDGCount: - format: int32 - type: integer - x-etsi-mec-cardinality: 0..1 - x-etsi-mec-origin-type: Uint32 - dot11TransmittedMPDUsInAMPDUCount: - format: int32 - type: integer - x-etsi-mec-cardinality: 0..1 - x-etsi-mec-origin-type: Uint32 - dot11TransmittedOctetsInAMPDUCount: - format: int64 - type: integer - x-etsi-mec-cardinality: 0..1 - x-etsi-mec-origin-type: Uint64 - dot11TransmittedOctetsInAMSDUCount: - format: int64 - type: integer - x-etsi-mec-cardinality: 0..1 - x-etsi-mec-origin-type: Uint32 - dot11TransmittedOctetsInGrantedRDGCount: - format: int32 - type: integer - x-etsi-mec-cardinality: 0..1 - x-etsi-mec-origin-type: Uint32 - dot11TwentyMHzFrameReceivedCount: - format: int32 - type: integer - x-etsi-mec-cardinality: 0..1 - x-etsi-mec-origin-type: Uint32 - dot11TwentyMHzFrameTransmittedCount: - format: int32 - type: integer - x-etsi-mec-cardinality: 0..1 - x-etsi-mec-origin-type: Uint32 - dot11nonSTBCCTSFailureCount: - format: int32 - type: integer - x-etsi-mec-cardinality: 0..1 - x-etsi-mec-origin-type: Uint32 - dot11nonSTBCCTSSuccessCount: - format: int32 - type: integer - x-etsi-mec-cardinality: 0..1 - x-etsi-mec-origin-type: Uint32 - type: object - SubscriptionLinkList: - properties: - _links: - description: Hyperlink related to the resource. This shall be only included in the HTTP responses and in HTTP PUT requests. - properties: - self: - $ref: '#/components/schemas/LinkType' - type: object - x-etsi-mec-cardinality: 0..1 - x-etsi-mec-origin-type: Structure (inlined) - assocStaSubscription: - items: - $ref: '#/components/schemas/AssocStaSubscription' - type: array - x-etsi-mec-cardinality: 0..N - x-etsi-mec-origin-type: AssocStaSubscription - staDataRateSubscription: - items: - $ref: '#/components/schemas/StaDataRateSubscription' - type: array - x-etsi-mec-cardinality: 0..N - x-etsi-mec-origin-type: StaDataRateSubscription - required: - - _links - type: object - TimeStamp: - properties: - nanoSeconds: - description: The nanoseconds part of the time. Time is defined as Unix-time since January 1, 1970, 00:00:00 UTC. - format: int32 - type: integer - x-etsi-mec-cardinality: '1' - x-etsi-mec-origin-type: Uint32 - seconds: - description: The seconds part of the time. Time is defined as Unixtime since January 1, 1970, 00:00:00 UTC. - format: int32 - type: integer - x-etsi-mec-cardinality: '1' - x-etsi-mec-origin-type: Uint32 - required: - - seconds - - nanoSeconds - type: object - x-etsi-ref: 6.5.2 - VhtCapabilities: - properties: - vhtCapInfo: - description: VHT capabilities Info as defined in IEEE 802.11-2016 [8]. - format: int32 - type: integer - x-etsi-mec-cardinality: '1' - x-etsi-mec-origin-type: UInt32 - vhtMcsNss: - description: Supported VHT-MCS and NSS Set as defined in IEEE 802.11-2016 [8]. - format: int64 - type: integer - x-etsi-mec-cardinality: '1' - x-etsi-mec-origin-type: UInt64 - required: - - vhtCapInfo - - vhtMcsNss - type: object - x-etsi-ref: 6.5.15 - WanMetrics: - properties: - downlinkLoad: - description: 1-octet positive integer representing the current percentage loading of the downlink WAN connection, scaled linearly with 255 representing 100 %, as measured over an interval the duration of which is reported in Load Measurement Duration. In cases where the downlink load is unknown to the AP, the value is set to zero. - format: int32 - type: integer - x-etsi-mec-cardinality: '1' - x-etsi-mec-origin-type: UInt8 - downlinkSpeed: - description: 4-octet positive integer whose value is an estimate of the WAN Backhaul link current downlink speed in kilobits per second. - format: int32 - type: integer - x-etsi-mec-cardinality: '1' - x-etsi-mec-origin-type: Uint32 - lmd: - description: The LMD (Load Measurement Duration) field is a 2-octet positive integer representing the duration over which the Downlink Load and Uplink Load have been measured, in tenths of a second. When the actual load measurement duration is greater than the maximum value, the maximum value will be reported. The value of the LMD field is set to 0 when neither the uplink nor downlink load can be computed. When the uplink and downlink loads are computed over different intervals, the maximum interval is reported. - format: int32 - type: integer - x-etsi-mec-cardinality: '1' - x-etsi-mec-origin-type: Uint16 - uplinkLoad: - description: 1-octet positive integer representing the current percentage loading of the uplink WAN connection, scaled linearly with 255 representing 100 %, as measured over an interval, the duration of which is reported in Load Measurement Duration. In cases where the uplink load is unknown to the AP, the value is set to zero. - format: int32 - type: integer - x-etsi-mec-cardinality: '1' - x-etsi-mec-origin-type: Uint8 - uplinkSpeed: - description: 4-octet positive integer whose value is an estimate of the WAN Backhaul link's current uplink speed in kilobits per second. - format: int32 - type: integer - x-etsi-mec-cardinality: '1' - x-etsi-mec-origin-type: UInt32 - wanInfo: - description: Info about WAN link status, link symmetricity and capacity currently used. - format: int32 - type: integer - x-etsi-mec-cardinality: '1' - x-etsi-mec-origin-type: Uint8 - required: - - wanInfo - - downlinkSpeed - - uplinkSpeed - - downlinkLoad - - uplinkLoad - - lmd - type: object - x-etsi-ref: 6.5.6 - WlanCapabilities: - properties: - dmg: - # description': Information about Access Point DMG capabilities as defined in IEEE 802.11-2016 [8]. - # x-etsi-mec-cardinality': 0..1 - # x-etsi-mec-origin-type': DmgCapabilities - $ref: '#/components/schemas/DmgCapabilities' - edmg: - # description': Information about Access Point EDMG capabilities as defined in draft IEEE P802.11/D4.0 [i.11]. - # x-etsi-mec-cardinality': 0..1 - # x-etsi-mec-origin-type': EdmgCapabilities - $ref: '#/components/schemas/EdmgCapabilities' - he: - # description': Information about Access Point HE capabilities as defined in FFS. - # x-etsi-mec-cardinality': 0..1 - # x-etsi-mec-origin-type': HeCapabilities - $ref: '#/components/schemas/HeCapabilities' - ht: - # description': Information about Access Point HT capabilities as defined in IEEE 802.11-2016 [8]. - # x-etsi-mec-cardinality': 0..1 - # x-etsi-mec-origin-type': HtCapabilities - $ref: '#/components/schemas/HtCapabilities' - vht: - # description': Information about Access Point VHT capabilities as defined in IEEE 802.11-2016 [8]. - # x-etsi-mec-cardinality': 0..1 - # x-etsi-mec-origin-type': VhtCapabilities - $ref: '#/components/schemas/VhtCapabilities' - type: object - x-etsi-ref: 6.5.4 +{ + "openapi": "3.0.0", + "info": { + "contact": { + "url": "https://forge.etsi.org/rep/mec/gs028-wai-api" + }, + "title": "ETSI GS MEC 028 - WLAN Access Information API", + "version": "2.1.1", + "description": "The ETSI MEC ISG MEC028 WLAN Access Information API described using OpenAPI", + "license": { + "name": "BSD-3-Clause", + "url": "https://forge.etsi.org/legal-matters" + } + }, + "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" + }, + "servers": [ + { + "url": "https://localhost/wai/v2" + } + ], + "tags": [ + { + "name": "wai" + } + ], + "paths": { + "/queries/ap/ap_information": { + "get": { + "tags": [ + "wai" + ], + "summary": "Retrieve information on existing Access Points", + "description": "Queries information about existing WLAN Access Points", + "operationId": "apInfoGET", + "parameters": [ + { + "$ref": "#/components/parameters/Query.Filter" + }, + { + "$ref": "#/components/parameters/Query.AllFields" + }, + { + "$ref": "#/components/parameters/Query.Fields" + }, + { + "$ref": "#/components/parameters/Query.ExcludeFields" + }, + { + "$ref": "#/components/parameters/Query.ExcludeDefault" + } + ], + "responses": { + "200": { + "description": "Successful response to ap_info request", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/ApInfo" + } + } + } + } + }, + "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": { + "$ref": "#/components/responses/429" + } + } + } + }, + "/queries/sta/sta_information": { + "get": { + "tags": [ + "wai" + ], + "summary": "Retrieve information on existing Stations", + "description": "Queries information about existing WLAN stations", + "operationId": "staInfoGET", + "parameters": [ + { + "$ref": "#/components/parameters/Query.Filter" + }, + { + "$ref": "#/components/parameters/Query.AllFields" + }, + { + "$ref": "#/components/parameters/Query.Fields" + }, + { + "$ref": "#/components/parameters/Query.ExcludeFields" + }, + { + "$ref": "#/components/parameters/Query.ExcludeDefault" + } + ], + "responses": { + "200": { + "description": "Successful response to sta_info request", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/StaInfo" + } + } + } + } + }, + "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": { + "$ref": "#/components/responses/429" + } + } + } + }, + "/subscriptions": { + "get": { + "tags": [ + "wai" + ], + "summary": "Retrieve information on subscriptions for notifications", + "description": "Queries information on subscriptions for notifications", + "operationId": "subscriptionLinkList_subscriptionsGET", + "parameters": [ + { + "$ref": "#/components/parameters/Query.SubscriptionType" + } + ], + "responses": { + "200": { + "description": "Response body contains the list of links to requestors subscriptions.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SubscriptionLinkList" + }, + "example": { + "_links": { + "self": { + "href": "http://meAppServer.example.com/wai/v2/subscriptions" + } + }, + "subscription": [ + { + "_links": { + "self": { + "href": "http://meAppServer.example.com/wai/v2/subscriptions/sub123" + } + }, + "callbackReference": "http://my.callback.com/wai/assocStaSubscription/some-id", + "subscriptionType": "AssocStaSubscription" + } + ] + } + } + } + }, + "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": { + "$ref": "#/components/responses/429" + } + } + }, + "post": { + "tags": [ + "wai" + ], + "summary": "Create a new subscription", + "description": "Creates a new subscription to WLAN Access Information notifications", + "operationId": "subscriptionsPOST", + "requestBody": { + "description": "Subscription to be created", + "required": true, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/InlineSubscription" + }, + "example": { + "subscriptionType": "AssocStaSubscription", + "callbackReference": "http://meAppClient.example.com/wai/v2/notifications/1", + "expiryDeadline": { + "seconds": 1977836800, + "nanoSeconds": 0 + }, + "apId": { + "macId": "005C0A0A0A0A", + "ssid": "myNetworkSsid", + "ipAddress": "10.10.100.1" + } + } + } + } + }, + "responses": { + "201": { + "description": "Successful subscription response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/InlineSubscription" + }, + "example": { + "subscriptionType": "AssocStaSubscription", + "callbackReference": "http://meAppClient.example.com/wai/v2/notifications/1", + "_links": { + "self": { + "href": "http://meAppServer.example.com/wai/v2/subscriptions/sub123" + } + }, + "expiryDeadline": { + "seconds": 1977836800, + "nanoSeconds": 0 + }, + "apId": { + "macId": "005C0A0A0A0A", + "ssid": "myNetworkSsid", + "ipAddress": "10.10.100.1" + } + } + } + } + }, + "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": { + "$ref": "#/components/responses/415" + }, + "422": { + "$ref": "#/components/responses/422" + }, + "429": { + "$ref": "#/components/responses/429" + } + }, + "callbacks": { + "notification": { + "{$request.body#/callbackReference}": { + "post": { + "summary": "Callback POST used to send a notification", + "description": "Notification from WAIS, content based on subscription type", + "operationId": "notificationPOST", + "requestBody": { + "description": "Subscription notification", + "required": true, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/InlineNotification" + }, + "example": { + "notificationType": "AssocStaNotification", + "timeStamp": { + "seconds": 1977836800, + "nanoseconds": 0 + }, + "apId": { + "macId": "005C0A0A0A0A", + "ssid": "myNetworkSsid", + "ipAddress": "10.10.100.1" + }, + "staId": { + "macId": "005C01111111", + "ssid": [ + "myNetworkSsid", + "myOtherNetworkSsid" + ], + "aid": "1122", + "ipAddress": "10.10.1.255" + } + } + } + } + }, + "responses": { + "204": { + "$ref": "#/components/responses/204" + } + } + } + } + } + } + } + }, + "/subscriptions/{subscriptionId}": { + "get": { + "tags": [ + "wai" + ], + "summary": "Retrieve information on current specific subscription", + "description": "Queries information about an existing subscription, identified by its self-referring URI returned on creation (initial POST)", + "operationId": "subscriptionsGET", + "parameters": [ + { + "$ref": "#/components/parameters/Path.subscrId" + } + ], + "responses": { + "200": { + "description": "Subscription information regarding subscription notifications", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/InlineSubscription" + }, + "example": { + "subscriptionType": "AssocStaSubscription", + "callbackReference": "http://meAppClient.example.com/wai/v2/notifications/1", + "_links": { + "self": { + "href": "http://meAppServer.example.com/wai/v2/subscriptions/sub123" + } + }, + "expiryDeadline": { + "seconds": 1977836800, + "nanoSeconds": 0 + }, + "apId": { + "macId": "005C0A0A0A0A", + "ssid": "myNetworkSsid", + "ipAddress": "10.10.100.1" + } + } + } + } + }, + "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": { + "$ref": "#/components/responses/429" + } + } + }, + "put": { + "tags": [ + "wai" + ], + "summary": "Modify an existing subscription", + "description": "Updates an existing subscription, identified by its self-referring URI returned on creation (initial POST)", + "operationId": "subscriptionsPUT", + "requestBody": { + "description": "Subscription to be modified", + "required": true, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/InlineSubscription" + }, + "example": { + "subscriptionType": "AssocStaSubscription", + "callbackReference": "http://meAppClient.example.com/wai/v2/notifications/1", + "_links": { + "self": { + "href": "http://meAppServer.example.com/wai/v2/subscriptions/sub123" + } + }, + "expiryDeadline": { + "seconds": 1977836800, + "nanoSeconds": 0 + }, + "apId": { + "macId": "005C0A0A0A0A", + "ssid": "myNetworkSsid", + "ipAddress": "10.10.100.1" + } + } + } + } + }, + "parameters": [ + { + "$ref": "#/components/parameters/Path.subscrId" + } + ], + "responses": { + "200": { + "description": "Successful subscription modification", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/InlineSubscription" + }, + "example": { + "_links": { + "self": { + "href": "http://[hostIP]/sbox-xyz123/wai/v2/subscriptions/sub123" + } + }, + "callbackReference": "http://my.callback.com/wai/some-id", + "apId": { + "macId": "005C0A0A0A0A" + } + } + } + } + }, + "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 an existing subscription", + "description": "Cancels an existing subscription, identified by its self-referring URI returned on creation (initial POST)", + "operationId": "subscriptionsDELETE", + "parameters": [ + { + "$ref": "#/components/parameters/Path.subscrId" + } + ], + "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" + } + } + } + }, + "406": { + "description": "Not Acceptable : used to indicate that the server cannot provide the any of the content formats supported by the client.", + "content": { + "application/problem+json": { + "schema": { + "$ref": "#/components/schemas/ProblemDetails" + } + } + } + }, + "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", + "content": { + "application/problem+json": { + "schema": { + "$ref": "#/components/schemas/ProblemDetails" + } + } + } + }, + "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" + } + } + } + }, + "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.", + "content": { + "application/problem+json": { + "schema": { + "$ref": "#/components/schemas/ProblemDetails" + }, + "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" + } + } + } + } + }, + "429": { + "description": "Too Many Requests : used when a rate limiter has triggered.", + "content": { + "application/problem+json": { + "schema": { + "$ref": "#/components/schemas/ProblemDetails" + } + } + } + } + }, + "parameters": { + "Path.subscrId": { + "name": "subscriptionId", + "in": "path", + "description": "Subscription Id, specifically the \"self\" returned in the subscription request", + "required": true, + "schema": { + "type": "string", + "format": "uri" + } + }, + "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" + } + }, + "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" + } + }, + "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" + } + } + }, + "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": { + "type": "string" + } + } + }, + "Query.ExcludeDefault": { + "name": "exclude_default", + "in": "query", + "description": "Indicates to exclude the following complex attributes from the response. See clause 6.18 of ETSI GS MEC 009 for details. The following attributes shall be excluded from the structure in the response body if this parameter is provided, or none of the parameters \"all_fields\", \"fields\", \"exclude_fields\", \"exclude_default\" are provided: Not applicable", + "required": false, + "schema": { + "type": "array", + "items": { + "type": "string" + } + } + }, + "Query.SubscriptionType": { + "name": "subscription_type", + "in": "query", + "description": "Filter on a specific subscription type. Permitted values: assoc_sta, sta_data_rate.", + "required": false, + "schema": { + "type": "string" + } + } + }, + "schemas": { + "ApAssociated": { + "properties": { + "assocId": { + "description": "Unique number which identifies a particular association between the station and Access Point.", + "type": "string", + "x-etsi-mec-cardinality": "0..1", + "x-etsi-mec-origin-type": "string" + }, + "ipAddress": { + "description": "IPv4 or IPv6 address allocated for the Access Point.", + "items": { + "type": "string" + }, + "minItems": 0, + "type": "array", + "x-etsi-mec-cardinality": "0..N", + "x-etsi-mec-origin-type": "string" + }, + "macId": { + "description": "Unique identifier assigned to the Access Point (as network interface controller) for communications at the data link layer of a network segment.", + "type": "string", + "x-etsi-mec-cardinality": "1", + "x-etsi-mec-origin-type": "string" + }, + "ssid": { + "description": "Service Set Identifier to identify logical networks.", + "items": { + "type": "string" + }, + "minItems": 0, + "type": "array", + "x-etsi-mec-cardinality": "0..N", + "x-etsi-mec-origin-type": "String" + } + }, + "required": [ + "macId" + ], + "type": "object", + "x-etsi-ref": "6.5.12" + }, + "ApIdentity": { + "properties": { + "ipAddress": { + "description": "IPv4 or IPv6 address allocated for the Access Point.", + "items": { + "type": "string" + }, + "minItems": 0, + "type": "array", + "x-etsi-mec-cardinality": "0..N", + "x-etsi-mec-origin-type": "String" + }, + "macId": { + "description": "Unique Identifier assigned to an Access Point (as network interface controller) for communications at the data link layer of a network segment.", + "type": "string", + "x-etsi-mec-cardinality": "1", + "x-etsi-mec-origin-type": "String" + }, + "ssid": { + "description": "Service Set Identifier to identify logical networks including Basic Service Set and Extended Service Set.", + "items": { + "type": "string" + }, + "minItems": 0, + "type": "array", + "x-etsi-mec-cardinality": "0..N", + "x-etsi-mec-origin-type": "String" + } + }, + "required": [ + "macId" + ], + "type": "object", + "x-etsi-ref": "6.5.3" + }, + "ApInfo": { + "properties": { + "apId": { + "$ref": "#/components/schemas/ApIdentity" + }, + "apLocation": { + "$ref": "#/components/schemas/ApLocation" + }, + "apNeighbor": { + "$ref": "#/components/schemas/NeighborReport" + }, + "bssLoad": { + "$ref": "#/components/schemas/BssLoad" + }, + "channel": { + "description": "Channel configured for the Access Point.", + "format": "int32", + "type": "integer", + "x-etsi-mec-cardinality": "0..1", + "x-etsi-mec-origin-type": "Uint32" + }, + "extBssLoad": { + "$ref": "#/components/schemas/ExtBssLoad" + }, + "timeStamp": { + "$ref": "#/components/schemas/TimeStamp" + }, + "wanMetrics": { + "$ref": "#/components/schemas/WanMetrics" + }, + "wlanCap": { + "$ref": "#/components/schemas/WlanCapabilities" + } + }, + "required": [ + "apId" + ], + "type": "object", + "x-etsi-ref": "6.2.2" + }, + "ApLocation": { + "properties": { + "civicLocation": { + "$ref": "#/components/schemas/CivicLocation" + }, + "geolocation": { + "$ref": "#/components/schemas/GeoLocation" + } + }, + "type": "object", + "x-etsi-ref": "6.5.9" + }, + "AssocStaNotification": { + "properties": { + "apId": { + "$ref": "#/components/schemas/ApIdentity" + }, + "notificationType": { + "description": "Shall be set to \"AssocStaNotification\".", + "type": "string", + "x-etsi-mec-cardinality": "1", + "x-etsi-mec-origin-type": "String" + }, + "staId": { + "description": "Identifier(s) to uniquely specify the client station(s) associated.", + "items": { + "$ref": "#/components/schemas/StaIdentity" + }, + "minItems": 0, + "type": "array", + "x-etsi-mec-cardinality": "0..N", + "x-etsi-mec-origin-type": "StaIdentity" + }, + "timeStamp": { + "$ref": "#/components/schemas/TimeStamp" + } + }, + "required": [ + "notificationType", + "apId" + ], + "type": "object", + "x-etsi-ref": "6.4.2" + }, + "AssocStaSubscription": { + "properties": { + "_links": { + "description": "Hyperlink related to the resource. This shall be only included in the HTTP responses and in HTTP PUT requests.", + "properties": { + "self": { + "$ref": "#/components/schemas/LinkType" + } + }, + "required": [ + "self" + ], + "type": "object", + "x-etsi-mec-cardinality": "0..1", + "x-etsi-mec-origin-type": "Structure (inlined)" + }, + "apId": { + "$ref": "#/components/schemas/ApIdentity" + }, + "callbackReference": { + "description": "URI selected by the service consumer to receive notifications on the subscribed WLAN information. This shall be included both in the request and in response.", + "format": "uri", + "type": "string", + "x-etsi-mec-cardinality": "1", + "x-etsi-mec-origin-type": "URI" + }, + "expiryDeadline": { + "$ref": "#/components/schemas/TimeStamp" + }, + "subscriptionType": { + "description": "Shall be set to \"AssocStaSubscription\".", + "type": "string", + "x-etsi-mec-cardinality": "1", + "x-etsi-mec-origin-type": "String" + } + }, + "required": [ + "subscriptionType", + "callbackReference", + "apId" + ], + "type": "object", + "x-etsi-ref": "6.3.2" + }, + "AssociatedStations": { + "properties": { + "assocId": { + "description": "Unique number which identifies a particular association between an Access Point and a station.", + "type": "string", + "x-etsi-mec-cardinality": "0..1", + "x-etsi-mec-origin-type": "string" + }, + "ipAddress": { + "description": "IPv4 or IPv6 address allocated for the station associated with the Access Point.", + "items": { + "type": "string" + }, + "minItems": 0, + "type": "array", + "x-etsi-mec-cardinality": "0..N", + "x-etsi-mec-origin-type": "string" + }, + "macId": { + "description": "Unique identifier assigned to a station (as network interface controller) for communications at the data link layer of a network segment.", + "type": "string", + "x-etsi-mec-cardinality": "1", + "x-etsi-mec-origin-type": "string" + } + }, + "required": [ + "macId" + ], + "type": "object", + "x-etsi-ref": "6.5.5" + }, + "BeaconReport": { + "properties": { + "bssId": { + "description": "The BSSID field indicates the BSSID of the BSS(s) for which a beacon report has been received.", + "items": { + "type": "string" + }, + "minItems": 1, + "type": "array", + "x-etsi-mec-cardinality": "1..N", + "x-etsi-mec-origin-type": "String" + }, + "channelId": { + "description": "Channel number where the beacon was received.", + "type": "integer", + "x-etsi-mec-cardinality": "1", + "x-etsi-mec-origin-type": "Integer" + }, + "measurementId": { + "description": "Measurement ID of the Measurement configuration applied to this Beacon Report.", + "type": "string", + "x-etsi-mec-cardinality": "1", + "x-etsi-mec-origin-type": "String" + }, + "reportingCondition": { + "description": "As in table T9-89 of IEEE 802.11-2012 [8].", + "type": "integer", + "x-etsi-mec-cardinality": "1", + "x-etsi-mec-origin-type": "Integer" + }, + "ssId": { + "description": "(Optional) The SSID subelement indicates the ESS(s) or IBSS(s) for which a beacon report is received.", + "items": { + "type": "string" + }, + "minItems": 1, + "type": "array", + "x-etsi-mec-cardinality": "1..N", + "x-etsi-mec-origin-type": "String" + }, + "staId": { + "$ref": "#/components/schemas/StaIdentity" + } + }, + "required": [ + "staId", + "measurementId", + "channelId", + "bssId", + "ssId", + "reportingCondition" + ], + "type": "object", + "x-etsi-ref": "6.5.27" + }, + "BeaconRequestConfig": { + "properties": { + "bssId": { + "description": "The BSSID field indicates the BSSID of the BSS(s) for which a beacon report is requested. When requesting beacon reports for all BSSs on the channel, the BSSID field contains the wildcard BSSID.", + "items": { + "type": "string" + }, + "minItems": 1, + "type": "array", + "x-etsi-mec-cardinality": "1..N", + "x-etsi-mec-origin-type": "String" + }, + "channelId": { + "description": "Channel number to scan. A Channel Number of 0 indicates a request to make iterative measurements for all supported channels in the Operating Class where the measurement is permitted on the channel and the channel is valid for the current regulatory domain. A Channel Number of 255 indicates a request to make iterative measurements for all supported channels in the current Operating Class listed in the latest AP Channel Report received from the serving AP.", + "type": "integer", + "x-etsi-mec-cardinality": "1", + "x-etsi-mec-origin-type": "Integer" + }, + "measurementMode": { + "description": "0 for passive.\n1 for active.\n2 for beacon table.", + "type": "integer", + "x-etsi-mec-cardinality": "1", + "x-etsi-mec-origin-type": "Integer" + }, + "reportingCondition": { + "description": "As in table T9-89 of IEEE 802.11-2012 [8].", + "type": "integer", + "x-etsi-mec-cardinality": "1", + "x-etsi-mec-origin-type": "Integer" + }, + "ssId": { + "description": "(Optional) The SSID subelement indicates the ESS(s) or IBSS(s) for which a beacon report is requested.", + "items": { + "type": "string" + }, + "minItems": 1, + "type": "array", + "x-etsi-mec-cardinality": "1..N", + "x-etsi-mec-origin-type": "String" + }, + "staId": { + "$ref": "#/components/schemas/StaIdentity" + } + }, + "required": [ + "staId", + "channelId", + "measurementMode", + "bssId", + "ssId", + "reportingCondition" + ], + "type": "object", + "x-etsi-ref": "6.5.25" + }, + "BssLoad": { + "properties": { + "availAdmCap": { + "description": "Available Admission Capacity that specifies the remaining amount of medium time available via explicit admission control, in units of 32 s/s.", + "format": "int32", + "type": "integer", + "x-etsi-mec-cardinality": "1", + "x-etsi-mec-origin-type": "Uint16" + }, + "channelUtilization": { + "description": "The percentage of time, linearly scaled with 255 representing 100 %, that the AP sensed the medium was busy, as indicated by either the physical or virtual Carrier Sense (CS) mechanism.", + "format": "int32", + "type": "integer", + "x-etsi-mec-cardinality": "1", + "x-etsi-mec-origin-type": "UInt8" + }, + "staCount": { + "description": "An unsigned integer that indicates the total number of STAs currently associated with this BSS.", + "format": "int32", + "type": "integer", + "x-etsi-mec-cardinality": "1", + "x-etsi-mec-origin-type": "UInt16" + } + }, + "required": [ + "staCount", + "channelUtilization", + "availAdmCap" + ], + "type": "object", + "x-etsi-ref": "6.5.7" + }, + "ChannelLoadConfig": { + "properties": { + "apId": { + "$ref": "#/components/schemas/ApIdentity" + }, + "cChannelId": { + "description": "Channel number which load is reported", + "type": "integer", + "x-etsi-mec-cardinality": "1", + "x-etsi-mec-origin-type": "Integer" + }, + "channelLoad": { + "description": "Channel load as per IEEE 802.11-2012 [8], section 11.11.9.3", + "type": "integer", + "x-etsi-mec-cardinality": "1", + "x-etsi-mec-origin-type": "Integer" + } + }, + "required": [ + "apId", + "cChannelId", + "channelLoad" + ], + "type": "object", + "x-etsi-ref": "6.5.24" + }, + "CivicLocation": { + "properties": { + "ca0": { + "description": "Language", + "type": "string", + "x-etsi-mec-cardinality": "0..1", + "x-etsi-mec-origin-type": "String" + }, + "ca1": { + "description": "National subdivisions (state, canton, region,province, prefecture) ", + "type": "string", + "x-etsi-mec-cardinality": "0..1", + "x-etsi-mec-origin-type": "String" + }, + "ca128": { + "description": "Script", + "type": "string", + "x-etsi-mec-cardinality": "0..1", + "x-etsi-mec-origin-type": "String" + }, + "ca16": { + "description": "Leading street direction", + "type": "string", + "x-etsi-mec-cardinality": "0..1", + "x-etsi-mec-origin-type": "String" + }, + "ca17": { + "description": "Trailing street suffix", + "type": "string", + "x-etsi-mec-cardinality": "0..1", + "x-etsi-mec-origin-type": "String" + }, + "ca18": { + "description": "Street suffix or type", + "type": "string", + "x-etsi-mec-cardinality": "0..1", + "x-etsi-mec-origin-type": "String" + }, + "ca19": { + "description": "House number", + "type": "string", + "x-etsi-mec-cardinality": "0..1", + "x-etsi-mec-origin-type": "String" + }, + "ca2": { + "description": "County, parish, gun (JP), district (IN)", + "type": "string", + "x-etsi-mec-cardinality": "0..1", + "x-etsi-mec-origin-type": "String" + }, + "ca20": { + "description": "House number suffix", + "type": "string", + "x-etsi-mec-cardinality": "0..1", + "x-etsi-mec-origin-type": "String" + }, + "ca21": { + "description": "Landmark of vanity address", + "type": "string", + "x-etsi-mec-cardinality": "0..1", + "x-etsi-mec-origin-type": "String" + }, + "ca22": { + "description": "Additional location information", + "type": "string", + "x-etsi-mec-cardinality": "0..1", + "x-etsi-mec-origin-type": "String" + }, + "ca23": { + "description": "Name (residence and office occupant)", + "type": "string", + "x-etsi-mec-cardinality": "0..1", + "x-etsi-mec-origin-type": "String" + }, + "ca24": { + "description": "Postal/zip code", + "type": "string", + "x-etsi-mec-cardinality": "0..1", + "x-etsi-mec-origin-type": "String" + }, + "ca25": { + "description": "Building (structure)", + "type": "string", + "x-etsi-mec-cardinality": "0..1", + "x-etsi-mec-origin-type": "String" + }, + "ca26": { + "description": "Unit (apartment/suite)", + "type": "string", + "x-etsi-mec-cardinality": "0..1", + "x-etsi-mec-origin-type": "String" + }, + "ca27": { + "description": "Floor", + "type": "string", + "x-etsi-mec-cardinality": "0..1", + "x-etsi-mec-origin-type": "String" + }, + "ca28": { + "description": "Room", + "type": "string", + "x-etsi-mec-cardinality": "0..1", + "x-etsi-mec-origin-type": "String" + }, + "ca29": { + "description": "Type of place", + "type": "string", + "x-etsi-mec-cardinality": "0..1", + "x-etsi-mec-origin-type": "String" + }, + "ca3": { + "description": "City, township, shi (JP)", + "type": "string", + "x-etsi-mec-cardinality": "0..1", + "x-etsi-mec-origin-type": "String" + }, + "ca30": { + "description": "Postal community name", + "type": "string", + "x-etsi-mec-cardinality": "0..1", + "x-etsi-mec-origin-type": "String" + }, + "ca31": { + "description": "Post office box", + "type": "string", + "x-etsi-mec-cardinality": "0..1", + "x-etsi-mec-origin-type": "String" + }, + "ca32": { + "description": "Additional code", + "type": "string", + "x-etsi-mec-cardinality": "0..1", + "x-etsi-mec-origin-type": "String" + }, + "ca33": { + "description": "Seat (desk.cubicle, workstation)", + "type": "string", + "x-etsi-mec-cardinality": "0..1", + "x-etsi-mec-origin-type": "String" + }, + "ca34": { + "description": "Primary road name", + "type": "string", + "x-etsi-mec-cardinality": "0..1", + "x-etsi-mec-origin-type": "String" + }, + "ca35": { + "description": "Road section", + "type": "string", + "x-etsi-mec-cardinality": "0..1", + "x-etsi-mec-origin-type": "String" + }, + "ca36": { + "description": "Branch road name", + "type": "string", + "x-etsi-mec-cardinality": "0..1", + "x-etsi-mec-origin-type": "String" + }, + "ca37": { + "description": "Sub-branch road name", + "type": "string", + "x-etsi-mec-cardinality": "0..1", + "x-etsi-mec-origin-type": "String" + }, + "ca38": { + "description": "Street name pre-modifier", + "type": "string", + "x-etsi-mec-cardinality": "0..1", + "x-etsi-mec-origin-type": "String" + }, + "ca39": { + "description": "Street name post-modifier", + "type": "string", + "x-etsi-mec-cardinality": "0..1", + "x-etsi-mec-origin-type": "String" + }, + "ca4": { + "description": "City division, borough, city district, ward, chou (JP)", + "type": "string", + "x-etsi-mec-cardinality": "0..1", + "x-etsi-mec-origin-type": "String" + }, + "ca5": { + "description": "Neighborhood, block", + "type": "string", + "x-etsi-mec-cardinality": "0..1", + "x-etsi-mec-origin-type": "String" + }, + "ca6": { + "description": "Group of streets below the neighborhood level ", + "type": "string", + "x-etsi-mec-cardinality": "0..1", + "x-etsi-mec-origin-type": "String" + }, + "country": { + "description": "The two-letter ISO 3166 [i.9] country code in capital ASCII letters, e.g. DE or US, as per ISO 3166 [i.9]", + "type": "string", + "x-etsi-mec-cardinality": "1", + "x-etsi-mec-origin-type": "String" + } + }, + "required": [ + "country" + ], + "type": "object", + "x-etsi-ref": "6.5.20" + }, + "DmgCapabilities": { + "properties": { + "ExtScMcsCap": { + "description": "Extended SC MCS capabilities as defined in draft IEEE P802.11/D4.0 [i.11]", + "format": "int32", + "type": "integer", + "x-etsi-mec-cardinality": "1", + "x-etsi-mec-origin-type": "Uint8" + }, + "dmgApOrPcpCapInfo": { + "description": "DMG AP or PCP capabilities information as defined in draft IEEE P802.11/D4.0 [i.11]", + "format": "int32", + "type": "integer", + "x-etsi-mec-cardinality": "1", + "x-etsi-mec-origin-type": "Uint16" + }, + "dmgStaBeamTrackTimeLimit": { + "description": "DMG station beam tracking time limit as defined in draft IEEE P802.11/D4.0 [i.11]", + "format": "int32", + "type": "integer", + "x-etsi-mec-cardinality": "1", + "x-etsi-mec-origin-type": "Uint16" + }, + "dmgStaCapInfo": { + "description": "DMG station capabilities information as defined in draft IEEE P802.11/D4.0 [i.11]", + "format": "int64", + "type": "integer", + "x-etsi-mec-cardinality": "1", + "x-etsi-mec-origin-type": "Uint64" + }, + "maxNrBasicAmsduSubframes": { + "description": "Number of basic A-MSDU subframes in A-MSDU as defined in draft IEEE P802.11/D4.0 [i.11]", + "format": "int32", + "type": "integer", + "x-etsi-mec-cardinality": "1", + "x-etsi-mec-origin-type": "Uint8" + }, + "maxNrShortAmsduSubframes": { + "description": "Number of short A-MSDU subframes in A-MSDU as defined in draft IEEE P802.11/D4.0 [i.11]", + "format": "int32", + "type": "integer", + "x-etsi-mec-cardinality": "1", + "x-etsi-mec-origin-type": "Uint8" + }, + "sarCap": { + "description": "SAR capabilities as defined in draft IEEE P802.11/D4.0 [i.11]", + "format": "int32", + "type": "integer", + "x-etsi-mec-cardinality": "1", + "x-etsi-mec-origin-type": "Uint8" + }, + "tddCap": { + "description": "TDD capabilities as defined in draft IEEE P802.11/D4.0 [i.11]", + "format": "int32", + "type": "integer", + "x-etsi-mec-cardinality": "1", + "x-etsi-mec-origin-type": "Uint16" + } + }, + "required": [ + "dmgStaCapInfo", + "dmgApOrPcpCapInfo", + "dmgStaBeamTrackTimeLimit", + "ExtScMcsCap", + "maxNrBasicAmsduSubframes", + "maxNrShortAmsduSubframes", + "tddCap", + "sarCap" + ], + "type": "object", + "x-etsi-ref": "6.5.17" + }, + "EdmgCapabilities": { + "properties": { + "ampduParameters": { + "description": "A-MPDU parameters as defined in draft IEEE P802.11/D4.0 [i.11]", + "format": "Uint8", + "type": "integer", + "x-etsi-mec-cardinality": "1", + "x-etsi-mec-origin-type": "Uint8" + }, + "reserved": { + "description": "", + "format": "int32", + "type": "integer", + "x-etsi-mec-cardinality": "0..1", + "x-etsi-mec-origin-type": "Uint8" + }, + "supportedMcs": { + "description": "Supported MCS as defined in draft IEEE P802.11/D4.0 [i.11]", + "format": "int32", + "type": "integer", + "x-etsi-mec-cardinality": "1", + "x-etsi-mec-origin-type": "Uint32" + }, + "trnParameters": { + "description": "Training parameters as defined in draft IEEE P802.11/D4.0 [i.11]", + "format": "int32", + "type": "integer", + "x-etsi-mec-cardinality": "1", + "x-etsi-mec-origin-type": "Uint16" + } + }, + "required": [ + "ampduParameters", + "trnParameters", + "supportedMcs" + ], + "type": "object", + "x-etsi-ref": "6.5.18" + }, + "ExtBssLoad": { + "properties": { + "muMimoStaCount": { + "description": "Indicates the total number of STAs currently associated with this BSS that have a 1 in the MU Beamformee Capable field of their VHT Capabilities element.", + "format": "int32", + "type": "integer", + "x-etsi-mec-cardinality": "1", + "x-etsi-mec-origin-type": "UInt16" + }, + "obsSec20MhzUtil": { + "description": "Observable loading on each of the secondary 20 MHz channel.", + "format": "int32", + "type": "integer", + "x-etsi-mec-cardinality": "1", + "x-etsi-mec-origin-type": "Uint8" + }, + "obsSec40MhzUtil": { + "description": "Observable loading on each of the secondary 40 MHz channel.", + "format": "int32", + "type": "integer", + "x-etsi-mec-cardinality": "1", + "x-etsi-mec-origin-type": "Uint8" + }, + "obsSec80MhzUtil": { + "description": "Observable loading on each of the secondary 80 MHz channel.", + "format": "int32", + "type": "integer", + "x-etsi-mec-cardinality": "1", + "x-etsi-mec-origin-type": "Uint8" + }, + "spatStreamUnderUtil": { + "description": "The percentage of time, linearly scaled with 255 representing 100 %, that the AP has underutilized spatial domain resources for given busy time of the medium.", + "format": "int32", + "type": "integer", + "x-etsi-mec-cardinality": "1", + "x-etsi-mec-origin-type": "UInt8" + } + }, + "required": [ + "muMimoStaCount", + "spatStreamUnderUtil", + "obsSec20MhzUtil", + "obsSec40MhzUtil", + "obsSec80MhzUtil" + ], + "type": "object", + "x-etsi-ref": "6.5.8" + }, + "GeoLocation": { + "properties": { + "altitude": { + "description": "The altitude value of location as defined in IETF RFC 6225 [6]", + "format": "int32", + "type": "integer", + "x-etsi-mec-cardinality": "0..1", + "x-etsi-mec-origin-type": "Uint32" + }, + "altitudeType": { + "description": "The type description for altitude information e.g. floors or meters as defined in IETF RFC 6225 [6]", + "format": "int32", + "type": "integer", + "x-etsi-mec-cardinality": "0..1", + "x-etsi-mec-origin-type": "Uint8" + }, + "altitudeUncertainty": { + "description": "The uncertainty for altitude information as defined in IETF RFC 6225 [6]", + "format": "int32", + "type": "integer", + "x-etsi-mec-cardinality": "0..1", + "x-etsi-mec-origin-type": "Uint8" + }, + "datum": { + "description": "The datum value to express how coordinates are organized and related to real world as defined in IETF RFC 6225 [6]", + "format": "int32", + "type": "integer", + "x-etsi-mec-cardinality": "1", + "x-etsi-mec-origin-type": "Uint8" + }, + "lat": { + "description": "The latitude value of location as defined in IETF RFC 6225 [6]", + "format": "int64", + "type": "integer", + "x-etsi-mec-cardinality": "1", + "x-etsi-mec-origin-type": "Uint64" + }, + "latUncertainty": { + "description": "The uncertainty for Latitude information as defined in IETF RFC 6225 [6]", + "format": "int32", + "type": "integer", + "x-etsi-mec-cardinality": "1", + "x-etsi-mec-origin-type": "Uint8" + }, + "long": { + "description": "The longitude value of location as defined in IETF RFC 6225 [6]", + "format": "int64", + "type": "integer", + "x-etsi-mec-cardinality": "1", + "x-etsi-mec-origin-type": "Uint64" + }, + "longUncertainty": { + "description": "The uncertainty for Longitude information as defined in IETF RFC 6225 [6]", + "format": "int32", + "type": "integer", + "x-etsi-mec-cardinality": "1", + "x-etsi-mec-origin-type": "Uint8" + } + }, + "required": [ + "latUncertainty", + "lat", + "longUncertainty", + "long", + "datum" + ], + "type": "object", + "x-etsi-ref": "6.5.19" + }, + "HeCapabilities": { + "properties": { + "heMacCapInfo": { + "description": "MAC capabilities of an Access Point.", + "type": "integer", + "x-etsi-mec-cardinality": "1", + "x-etsi-mec-origin-type": "Uint8" + }, + "hePhyCapinfo": { + "description": "PHY capabilities of an Access Point.", + "type": "integer", + "x-etsi-mec-cardinality": "1", + "x-etsi-mec-origin-type": "Uint8" + }, + "ppeThresholds": { + "description": "PPE Threshold determines the nominal packet padding value for a HE PPDU.", + "type": "integer", + "x-etsi-mec-cardinality": "0..1", + "x-etsi-mec-origin-type": "not defined" + }, + "supportedHeMcsNssSet": { + "description": "Supported MCS and NSS Set.", + "type": "integer", + "x-etsi-mec-cardinality": "1", + "x-etsi-mec-origin-type": "Uint8" + } + }, + "required": [ + "heMacCapInfo", + "hePhyCapinfo", + "supportedHeMcsNssSet" + ], + "type": "object", + "x-etsi-ref": "6.5.16" + }, + "HtCapabilities": { + "properties": { + "ampduParameters": { + "description": "A-MPDU parameters as defined in IEEE 802.11-2016 [8].", + "format": "int32", + "type": "integer", + "x-etsi-mec-cardinality": "1", + "x-etsi-mec-origin-type": "UInt8" + }, + "aselCap": { + "description": "ASEL capabilities as defined in IEEE 802.11-2016 [8].", + "format": "int32", + "type": "integer", + "x-etsi-mec-cardinality": "1", + "x-etsi-mec-origin-type": "UInt8" + }, + "htCapabilityInfo": { + "description": "HT Capability Information as defined in IEEE 802.11-2016 [8].", + "format": "int32", + "type": "integer", + "x-etsi-mec-cardinality": "1", + "x-etsi-mec-origin-type": "UInt16" + }, + "htExtendedCap": { + "description": "Extended HT Capabilities as defined in IEEE 802.11-2016 [8].", + "format": "int32", + "type": "integer", + "x-etsi-mec-cardinality": "1", + "x-etsi-mec-origin-type": "UInt16" + }, + "supportedMcsSet": { + "description": "Supported MCS set as defined in IEEE 802.11-2016 [8].", + "format": "int64", + "type": "integer", + "x-etsi-mec-cardinality": "1", + "x-etsi-mec-origin-type": "Uint128" + }, + "txBeamFormCap": { + "description": "Transmit Beamforming Capabilities as defined in IEEE 802.11-2016 [8].", + "format": "int32", + "type": "integer", + "x-etsi-mec-cardinality": "1", + "x-etsi-mec-origin-type": "UInt32" + } + }, + "required": [ + "htCapabilityInfo", + "ampduParameters", + "supportedMcsSet", + "htExtendedCap", + "txBeamFormCap", + "aselCap" + ], + "type": "object", + "x-etsi-ref": "6.5.1" + }, + "InlineNotification": { + "oneOf": [ + { + "$ref": "#/components/schemas/AssocStaNotification" + }, + { + "$ref": "#/components/schemas/StaDataRateNotification" + } + ], + "discriminator": { + "propertyName": "notificationType" + } + }, + "InlineSubscription": { + "oneOf": [ + { + "$ref": "#/components/schemas/AssocStaSubscription" + }, + { + "$ref": "#/components/schemas/StaDataRateSubscription" + } + ], + "discriminator": { + "propertyName": "subscriptionType" + } + }, + "LinkType": { + "properties": { + "href": { + "description": "URI referring to a resource", + "type": "string", + "x-etsi-mec-cardinality": "1", + "x-etsi-mec-origin-type": "String" + } + }, + "required": [ + "href" + ], + "type": "object", + "x-etsi-ref": "6.5.23" + }, + "MeasurementConfig": { + "properties": { + "beaconRequest": { + "$ref": "#/components/schemas/BeaconRequestConfig" + }, + "channelLoad": { + "$ref": "#/components/schemas/ChannelLoadConfig" + }, + "measurementDuration": { + "description": "Duration of the measurement, shall be lower than Maximum Measurement Duration in TU as defined in section 11.11.4 of IEEE 802.11 [8].", + "type": "integer", + "x-etsi-mec-cardinality": "1", + "x-etsi-mec-origin-type": "Integer" + }, + "measurementId": { + "description": "Identifier of this measurement configuration.", + "type": "string", + "x-etsi-mec-cardinality": "1", + "x-etsi-mec-origin-type": "String" + }, + "randomnInterval": { + "description": "Random interval to be used for starting the measurement. In units of TU as specifed in section 11.11.3 of IEEE 802.11 [8].", + "type": "integer", + "x-etsi-mec-cardinality": "1", + "x-etsi-mec-origin-type": "Integer" + }, + "staStatistics": { + "$ref": "#/components/schemas/StaStatisticsConfig" + } + }, + "required": [ + "measurementId", + "measurementDuration", + "randomnInterval" + ], + "type": "object", + "x-etsi-notes": "NOTE:\tThis element enables the configuration of the channelLoad, beaconRequest and staStatistics in a single resource data type, although only one of each measurement. Multiple measurement configurations of each kind are not allowed.", + "x-etsi-ref": "6.2.4" + }, + "NeighborReport": { + "properties": { + "bssid": { + "description": "BSS Id of the Access Point that is being reported.", + "type": "string", + "x-etsi-mec-cardinality": "1", + "x-etsi-mec-origin-type": "String" + }, + "bssidInfo": { + "description": "Additional information related to Access Point that is being reported such as AP reachability, security, key scope, Mobility Domain, HT/VHT capability and Fine Time Measurements.", + "format": "int32", + "type": "integer", + "x-etsi-mec-cardinality": "1", + "x-etsi-mec-origin-type": "UInt32" + }, + "channel": { + "description": "The channel currently used by this Access Point.", + "type": "integer", + "x-etsi-mec-cardinality": "1", + "x-etsi-mec-origin-type": "Uint8" + }, + "operatingClass": { + "description": "The channel set of the AP indicated by this BSSID.", + "type": "integer", + "x-etsi-mec-cardinality": "1", + "x-etsi-mec-origin-type": "Uint8" + }, + "phyType": { + "description": "PHY type of the AP indicated by this BSSID. It is an integer value coded according to the value of the dot11PHYType.", + "type": "integer", + "x-etsi-mec-cardinality": "1", + "x-etsi-mec-origin-type": "Uint8" + } + }, + "required": [ + "bssid", + "bssidInfo", + "operatingClass", + "channel", + "phyType" + ], + "type": "object", + "x-etsi-ref": "6.5.10" + }, + "ProblemDetails": { + "properties": { + "detail": { + "description": "A human-readable explanation specific to this occurrence of the problem", + "type": "string", + "x-etsi-mec-cardinality": "0..1", + "x-etsi-mec-origin-type": "String" + }, + "instance": { + "description": "A URI reference that identifies the specific occurrence of the problem", + "format": "uri", + "type": "string", + "x-etsi-mec-cardinality": "0..1", + "x-etsi-mec-origin-type": "URI" + }, + "status": { + "description": "The HTTP status code for this occurrence of the problem", + "format": "int32", + "type": "integer", + "x-etsi-mec-cardinality": "0..1", + "x-etsi-mec-origin-type": "Uint32" + }, + "title": { + "description": "A short, human-readable summary of the problem type", + "type": "string", + "x-etsi-mec-cardinality": "0..1", + "x-etsi-mec-origin-type": "String" + }, + "type": { + "description": "A URI reference according to IETF RFC 3986 that identifies the problem type", + "format": "uri", + "type": "string", + "x-etsi-mec-cardinality": "0..1", + "x-etsi-mec-origin-type": "URI" + } + }, + "type": "object" + }, + "Rssi": { + "properties": { + "rssi": { + "description": "The Received Signal Strength Indicator from a station", + "format": "int32", + "type": "integer", + "x-etsi-mec-cardinality": "1", + "x-etsi-mec-origin-type": "Uint8" + } + }, + "required": [ + "rssi" + ], + "type": "object", + "x-etsi-ref": "6.5.21" + }, + "StaDataRate": { + "properties": { + "staId": { + "$ref": "#/components/schemas/StaIdentity" + }, + "staLastDataDownlinkRate": { + "description": "The data transmit rate in kbps that was most recently used for transmission of data PPDUs from the access point to the station.", + "format": "int32", + "type": "integer", + "x-etsi-mec-cardinality": "0..1", + "x-etsi-mec-origin-type": "Uint32" + }, + "staLastDataUplinkRate": { + "description": "The data transmit rate in Kbps that was most recently used for transmission of data PPDUs from the associated station to the access point.", + "format": "int32", + "type": "integer", + "x-etsi-mec-cardinality": "0..1", + "x-etsi-mec-origin-type": "Uint32" + } + }, + "type": "object", + "x-etsi-ref": "6.5.22" + }, + "StaDataRateNotification": { + "properties": { + "notificationType": { + "description": "Shall be set to \"StaDataRateNotification\".", + "type": "string", + "x-etsi-mec-cardinality": "1", + "x-etsi-mec-origin-type": "String" + }, + "staDataRate": { + "description": "Data rates of a client station.", + "items": { + "$ref": "#/components/schemas/StaDataRate" + }, + "minItems": 0, + "type": "array", + "x-etsi-mec-cardinality": "0..N", + "x-etsi-mec-origin-type": "StaDataRate" + }, + "timeStamp": { + "$ref": "#/components/schemas/TimeStamp" + } + }, + "required": [ + "notificationType" + ], + "type": "object", + "x-etsi-ref": "6.4.3" + }, + "StaDataRateSubscription": { + "properties": { + "_links": { + "description": "Hyperlink related to the resource. This shall be only included in the HTTP responses and in HTTP PUT requests.", + "properties": { + "self": { + "$ref": "#/components/schemas/LinkType" + } + }, + "required": [ + "self" + ], + "type": "object", + "x-etsi-mec-cardinality": "0..1", + "x-etsi-mec-origin-type": "Structure (inlined)" + }, + "callbackReference": { + "description": "URI selected by the service consumer to receive notifications on the subscribed WLAN Access Information Service. This shall be included both in the request and in response.", + "format": "uri", + "type": "string", + "x-etsi-mec-cardinality": "1", + "x-etsi-mec-origin-type": "URI" + }, + "expiryDeadline": { + "$ref": "#/components/schemas/TimeStamp" + }, + "staId": { + "description": "Identifier(s) to uniquely specify the target client station(s) for the subscription", + "items": { + "$ref": "#/components/schemas/StaIdentity" + }, + "minItems": 1, + "type": "array", + "x-etsi-mec-cardinality": "1..N", + "x-etsi-mec-origin-type": "StaIdentity" + }, + "subscriptionType": { + "description": "Shall be set to \"StaDataRateSubscription\".", + "type": "string", + "x-etsi-mec-cardinality": "1", + "x-etsi-mec-origin-type": "String" + } + }, + "required": [ + "subscriptionType", + "callbackReference", + "staId" + ], + "type": "object", + "x-etsi-ref": "6.3.3" + }, + "StaIdentity": { + "properties": { + "aid": { + "description": "Number which identifies a particular association between a station and an Access Point ", + "type": "string", + "x-etsi-mec-cardinality": "0..1", + "x-etsi-mec-origin-type": "String" + }, + "ipAddress": { + "description": "IPv4 or IPv6 address allocated for the station.", + "items": { + "type": "string" + }, + "minItems": 0, + "type": "array", + "x-etsi-mec-cardinality": "0..N", + "x-etsi-mec-origin-type": "String" + }, + "macId": { + "description": "Unique identifier assigned to station (as network interface controller) for communications at the data link layer of a network segment.", + "type": "string", + "x-etsi-mec-cardinality": "1", + "x-etsi-mec-origin-type": "String" + }, + "ssid": { + "description": "Service Set Identifier to identify logical networks.", + "items": { + "type": "string" + }, + "minItems": 0, + "type": "array", + "x-etsi-mec-cardinality": "0..N", + "x-etsi-mec-origin-type": "String" + } + }, + "required": [ + "macId" + ], + "type": "object", + "x-etsi-ref": "6.5.11" + }, + "StaInfo": { + "properties": { + "apAssociated": { + "$ref": "#/components/schemas/ApAssociated" + }, + "beaconReport": { + "$ref": "#/components/schemas/BeaconReport" + }, + "channel": { + "description": "Channel currently used by the station.", + "format": "int32", + "type": "integer", + "x-etsi-mec-cardinality": "0..1", + "x-etsi-mec-origin-type": "Uint32" + }, + "rssi": { + "$ref": "#/components/schemas/Rssi" + }, + "staDataRate": { + "$ref": "#/components/schemas/StaDataRate" + }, + "staId": { + "$ref": "#/components/schemas/StaIdentity" + }, + "staStatistics": { + "$ref": "#/components/schemas/StaStatistics" + }, + "timeStamp": { + "$ref": "#/components/schemas/TimeStamp" + } + }, + "required": [ + "staId" + ], + "type": "object", + "x-etsi-ref": "6.2.3" + }, + "StaStatistics": { + "properties": { + "groupIdentity": { + "description": "Indicates the requested statistics group describing the Statistics Group Data according to table 9-114 of IEEE 802.11-2016 [8].", + "type": "integer", + "x-etsi-mec-cardinality": "1", + "x-etsi-mec-origin-type": "UInt8" + }, + "md": { + "description": "Measurement Duration.", + "type": "integer", + "x-etsi-mec-cardinality": "1", + "x-etsi-mec-origin-type": "UInt16" + }, + "statisticsGroupData": { + "$ref": "#/components/schemas/StatisticsGroupData", + "description": "Statistics Group Data as defined in Annex C of IEEE 802.112016 [8].", + "x-etsi-mec-cardinality": "1", + "x-etsi-mec-origin-type": "not specified" + } + }, + "required": [ + "md", + "groupIdentity", + "statisticsGroupData" + ], + "type": "object", + "x-etsi-ref": "6.5.13" + }, + "StaStatisticsConfig": { + "properties": { + "groupIdentity": { + "description": "As per table T 9-114 of IEEE 802.11-2012 [8].", + "type": "integer", + "x-etsi-mec-cardinality": "1", + "x-etsi-mec-origin-type": "Integer" + }, + "staId": { + "$ref": "#/components/schemas/StaIdentity" + }, + "triggerCondition": { + "type": "integer" + }, + "triggerTimeout": { + "description": "The Trigger Timeout field contains a value in units of 100 TUs during which a measuring STA does not generate further triggered STA Statistics Reports after a trigger condition has been met.", + "type": "integer", + "x-etsi-mec-cardinality": "1", + "x-etsi-mec-origin-type": "Integer" + }, + "triggeredReport": { + "type": "boolean" + } + }, + "required": [ + "staId", + "groupIdentity", + "triggeredReport", + "triggerTimeout", + "triggerCondition" + ], + "type": "object", + "x-etsi-ref": "6.5.26" + }, + "StatisticsGroupData": { + "properties": { + "dot11AMPDUDelimiterCRCErrorCount": { + "format": "int32", + "type": "integer", + "x-etsi-mec-cardinality": "0..1", + "x-etsi-mec-origin-type": "Uint32" + }, + "dot11AMPDUReceivedCount": { + "format": "int32", + "type": "integer", + "x-etsi-mec-cardinality": "0..1", + "x-etsi-mec-origin-type": "Uint32" + }, + "dot11AMSDUAckFailureCount": { + "format": "int32", + "type": "integer", + "x-etsi-mec-cardinality": "0..1", + "x-etsi-mec-origin-type": "Uint32" + }, + "dot11AckFailureCount": { + "format": "int32", + "type": "integer", + "x-etsi-mec-cardinality": "0..1", + "x-etsi-mec-origin-type": "Uint32" + }, + "dot11BeamformingFrameCount": { + "format": "int32", + "type": "integer", + "x-etsi-mec-cardinality": "0..1", + "x-etsi-mec-origin-type": "Uint32" + }, + "dot11ChannelWidthSwitchCount": { + "format": "int32", + "type": "integer", + "x-etsi-mec-cardinality": "0..1", + "x-etsi-mec-origin-type": "Uint32" + }, + "dot11DualCTSFailureCount": { + "format": "int32", + "type": "integer", + "x-etsi-mec-cardinality": "0..1", + "x-etsi-mec-origin-type": "Uint32" + }, + "dot11DualCTSSuccessCount": { + "format": "int32", + "type": "integer", + "x-etsi-mec-cardinality": "0..1", + "x-etsi-mec-origin-type": "Uint32" + }, + "dot11ExplicitBARFailureCount": { + "format": "int32", + "type": "integer", + "x-etsi-mec-cardinality": "0..1", + "x-etsi-mec-origin-type": "Uint32" + }, + "dot11FCSErrorCount": { + "format": "int32", + "type": "integer", + "x-etsi-mec-cardinality": "0..1", + "x-etsi-mec-origin-type": "Uint32" + }, + "dot11FailedAMSDUCount": { + "format": "int32", + "type": "integer", + "x-etsi-mec-cardinality": "0..1", + "x-etsi-mec-origin-type": "Uint32" + }, + "dot11FailedCount": { + "format": "int32", + "type": "integer", + "x-etsi-mec-cardinality": "0..1", + "x-etsi-mec-origin-type": "Uint32" + }, + "dot11FortyMHzFrameReceivedCount": { + "format": "int32", + "type": "integer", + "x-etsi-mec-cardinality": "0..1", + "x-etsi-mec-origin-type": "Uint32" + }, + "dot11FortyMHzFrameTransmittedCount": { + "format": "int32", + "type": "integer", + "x-etsi-mec-cardinality": "0..1", + "x-etsi-mec-origin-type": "Uint32" + }, + "dot11FrameDuplicateCount": { + "format": "int32", + "type": "integer", + "x-etsi-mec-cardinality": "0..1", + "x-etsi-mec-origin-type": "Uint32" + }, + "dot11GrantedRDGUnusedCount": { + "format": "int32", + "type": "integer", + "x-etsi-mec-cardinality": "0..1", + "x-etsi-mec-origin-type": "Uint32" + }, + "dot11GrantedRDGUsedCount": { + "format": "int32", + "type": "integer", + "x-etsi-mec-cardinality": "0..1", + "x-etsi-mec-origin-type": "Uint32" + }, + "dot11GroupReceivedFrameCount": { + "format": "int32", + "type": "integer", + "x-etsi-mec-cardinality": "0..1", + "x-etsi-mec-origin-type": "Uint32" + }, + "dot11GroupTransmittedFrameCount": { + "format": "int32", + "type": "integer", + "x-etsi-mec-cardinality": "0..1", + "x-etsi-mec-origin-type": "Uint32" + }, + "dot11ImplicitBARFailureCount": { + "format": "int32", + "type": "integer", + "x-etsi-mec-cardinality": "0..1", + "x-etsi-mec-origin-type": "Uint32" + }, + "dot11MPDUInReceivedAMPDUCount": { + "format": "int32", + "type": "integer", + "x-etsi-mec-cardinality": "0..1", + "x-etsi-mec-origin-type": "Uint32" + }, + "dot11MultipleRetryAMSDUCount": { + "format": "int32", + "type": "integer", + "x-etsi-mec-cardinality": "0..1", + "x-etsi-mec-origin-type": "Uint32" + }, + "dot11MultipleRetryCount": { + "format": "int32", + "type": "integer", + "x-etsi-mec-cardinality": "0..1", + "x-etsi-mec-origin-type": "Uint32" + }, + "dot11PSMPUTTGrantDuration": { + "format": "int32", + "type": "integer", + "x-etsi-mec-cardinality": "0..1", + "x-etsi-mec-origin-type": "Uint32" + }, + "dot11PSMPUTTUsedDuration": { + "format": "int32", + "type": "integer", + "x-etsi-mec-cardinality": "0..1", + "x-etsi-mec-origin-type": "Uint32" + }, + "dot11QosAckFailureCount": { + "format": "int32", + "type": "integer", + "x-etsi-mec-cardinality": "0..1", + "x-etsi-mec-origin-type": "Uint32" + }, + "dot11QosDiscardedFrameCount": { + "format": "int32", + "type": "integer", + "x-etsi-mec-cardinality": "0..1", + "x-etsi-mec-origin-type": "Uint32" + }, + "dot11QosFailedCount": { + "format": "int32", + "type": "integer", + "x-etsi-mec-cardinality": "0..1", + "x-etsi-mec-origin-type": "Uint32" + }, + "dot11QosFrameDuplicateCount": { + "format": "int32", + "type": "integer", + "x-etsi-mec-cardinality": "0..1", + "x-etsi-mec-origin-type": "Uint32" + }, + "dot11QosMPDUsReceivedCount": { + "format": "int32", + "type": "integer", + "x-etsi-mec-cardinality": "0..1", + "x-etsi-mec-origin-type": "Uint32" + }, + "dot11QosMultipleRetryCount": { + "format": "int32", + "type": "integer", + "x-etsi-mec-cardinality": "0..1", + "x-etsi-mec-origin-type": "Uint32" + }, + "dot11QosRTSFailureCount": { + "format": "int32", + "type": "integer", + "x-etsi-mec-cardinality": "0..1", + "x-etsi-mec-origin-type": "Uint32" + }, + "dot11QosRTSSuccessCount": { + "format": "int32", + "type": "integer", + "x-etsi-mec-cardinality": "0..1", + "x-etsi-mec-origin-type": "Uint32" + }, + "dot11QosReceivedFragmentCount": { + "format": "int32", + "type": "integer", + "x-etsi-mec-cardinality": "0..1", + "x-etsi-mec-origin-type": "Uint32" + }, + "dot11QosRetriesReceivedCount": { + "format": "int32", + "type": "integer", + "x-etsi-mec-cardinality": "0..1", + "x-etsi-mec-origin-type": "Uint32" + }, + "dot11QosRetryCount": { + "format": "int32", + "type": "integer", + "x-etsi-mec-cardinality": "0..1", + "x-etsi-mec-origin-type": "Uint32" + }, + "dot11QosTransmittedFragmentCount": { + "format": "int32", + "type": "integer", + "x-etsi-mec-cardinality": "0..1", + "x-etsi-mec-origin-type": "Uint32" + }, + "dot11QosTransmittedFrameCount": { + "format": "int32", + "type": "integer", + "x-etsi-mec-cardinality": "0..1", + "x-etsi-mec-origin-type": "Uint32" + }, + "dot11RSNAStatsBIPMICErrors": { + "format": "int32", + "type": "integer", + "x-etsi-mec-cardinality": "0..1", + "x-etsi-mec-origin-type": "Uint32" + }, + "dot11RSNAStatsCCMPDecryptErrors": { + "format": "int32", + "type": "integer", + "x-etsi-mec-cardinality": "0..1", + "x-etsi-mec-origin-type": "Uint32" + }, + "dot11RSNAStatsCCMPReplays": { + "format": "int32", + "type": "integer", + "x-etsi-mec-cardinality": "0..1", + "x-etsi-mec-origin-type": "Uint32" + }, + "dot11RSNAStatsCMACReplays": { + "format": "int32", + "type": "integer", + "x-etsi-mec-cardinality": "0..1", + "x-etsi-mec-origin-type": "Uint32" + }, + "dot11RSNAStatsRobustMgmtCCMPReplays": { + "format": "int32", + "type": "integer", + "x-etsi-mec-cardinality": "0..1", + "x-etsi-mec-origin-type": "Uint32" + }, + "dot11RSNAStatsTKIPICVErrors": { + "format": "int32", + "type": "integer", + "x-etsi-mec-cardinality": "0..1", + "x-etsi-mec-origin-type": "Uint32" + }, + "dot11RSNAStatsTKIPReplays": { + "format": "int32", + "type": "integer", + "x-etsi-mec-cardinality": "0..1", + "x-etsi-mec-origin-type": "Uint32" + }, + "dot11RTSFailureCount": { + "format": "int32", + "type": "integer", + "x-etsi-mec-cardinality": "0..1", + "x-etsi-mec-origin-type": "Uint32" + }, + "dot11RTSLSIGFailureCount": { + "format": "int32", + "type": "integer", + "x-etsi-mec-cardinality": "0..1", + "x-etsi-mec-origin-type": "Uint32" + }, + "dot11RTSLSIGSuccessCount": { + "format": "int32", + "type": "integer", + "x-etsi-mec-cardinality": "0..1", + "x-etsi-mec-origin-type": "Uint32" + }, + "dot11RTSSuccessCount": { + "format": "int32", + "type": "integer", + "x-etsi-mec-cardinality": "0..1", + "x-etsi-mec-origin-type": "Uint32" + }, + "dot11ReceivedAMSDUCount": { + "format": "int32", + "type": "integer", + "x-etsi-mec-cardinality": "0..1", + "x-etsi-mec-origin-type": "Uint32" + }, + "dot11ReceivedFragmentCount": { + "format": "int32", + "type": "integer", + "x-etsi-mec-cardinality": "0..1", + "x-etsi-mec-origin-type": "Uint32" + }, + "dot11ReceivedOctetsInAMPDUCount": { + "format": "int64", + "type": "integer", + "x-etsi-mec-cardinality": "0..1", + "x-etsi-mec-origin-type": "Uint64" + }, + "dot11ReceivedOctetsInAMSDUCount": { + "format": "int64", + "type": "integer", + "x-etsi-mec-cardinality": "0..1", + "x-etsi-mec-origin-type": "Uint64" + }, + "dot11RetryAMSDUCount": { + "format": "int32", + "type": "integer", + "x-etsi-mec-cardinality": "0..1", + "x-etsi-mec-origin-type": "Uint32" + }, + "dot11RetryCount": { + "format": "int32", + "type": "integer", + "x-etsi-mec-cardinality": "0..1", + "x-etsi-mec-origin-type": "Uint32" + }, + "dot11STAStatisticsAPAverageAccessDelay": { + "type": "integer", + "x-etsi-mec-cardinality": "0..1", + "x-etsi-mec-origin-type": "Uint8" + }, + "dot11STAStatisticsAverageAccessDelayBackGround": { + "type": "integer", + "x-etsi-mec-cardinality": "0..1", + "x-etsi-mec-origin-type": "Uint8" + }, + "dot11STAStatisticsAverageAccessDelayBestEffort": { + "type": "integer", + "x-etsi-mec-cardinality": "0..1", + "x-etsi-mec-origin-type": "Uint8" + }, + "dot11STAStatisticsAverageAccessDelayVideo": { + "type": "integer", + "x-etsi-mec-cardinality": "0..1", + "x-etsi-mec-origin-type": "Uint8" + }, + "dot11STAStatisticsAverageAccessDelayVoice": { + "type": "integer", + "x-etsi-mec-cardinality": "0..1", + "x-etsi-mec-origin-type": "Uint8" + }, + "dot11STAStatisticsChannelUtilization": { + "type": "integer", + "x-etsi-mec-cardinality": "0..1", + "x-etsi-mec-origin-type": "Uint8" + }, + "dot11STAStatisticsStationCount": { + "type": "integer", + "x-etsi-mec-cardinality": "0..1", + "x-etsi-mec-origin-type": "Uint8" + }, + "dot11STBCCTSFailureCount": { + "format": "int32", + "type": "integer", + "x-etsi-mec-cardinality": "0..1", + "x-etsi-mec-origin-type": "Uint32" + }, + "dot11STBCCTSSuccessCount": { + "format": "int32", + "type": "integer", + "x-etsi-mec-cardinality": "0..1", + "x-etsi-mec-origin-type": "Uint32" + }, + "dot11TransmittedAMPDUCount": { + "format": "int32", + "type": "integer", + "x-etsi-mec-cardinality": "0..1", + "x-etsi-mec-origin-type": "Uint32" + }, + "dot11TransmittedAMSDUCount": { + "format": "int32", + "type": "integer", + "x-etsi-mec-cardinality": "0..1", + "x-etsi-mec-origin-type": "Uint32" + }, + "dot11TransmittedFragmentCount": { + "format": "int32", + "type": "integer", + "x-etsi-mec-cardinality": "0..1", + "x-etsi-mec-origin-type": "Uint32" + }, + "dot11TransmittedFrameCount": { + "format": "int32", + "type": "integer", + "x-etsi-mec-cardinality": "0..1", + "x-etsi-mec-origin-type": "Uint32" + }, + "dot11TransmittedFramesInGrantedRDGCount": { + "format": "int32", + "type": "integer", + "x-etsi-mec-cardinality": "0..1", + "x-etsi-mec-origin-type": "Uint32" + }, + "dot11TransmittedMPDUsInAMPDUCount": { + "format": "int32", + "type": "integer", + "x-etsi-mec-cardinality": "0..1", + "x-etsi-mec-origin-type": "Uint32" + }, + "dot11TransmittedOctetsInAMPDUCount": { + "format": "int64", + "type": "integer", + "x-etsi-mec-cardinality": "0..1", + "x-etsi-mec-origin-type": "Uint64" + }, + "dot11TransmittedOctetsInAMSDUCount": { + "format": "int64", + "type": "integer", + "x-etsi-mec-cardinality": "0..1", + "x-etsi-mec-origin-type": "Uint32" + }, + "dot11TransmittedOctetsInGrantedRDGCount": { + "format": "int32", + "type": "integer", + "x-etsi-mec-cardinality": "0..1", + "x-etsi-mec-origin-type": "Uint32" + }, + "dot11TwentyMHzFrameReceivedCount": { + "format": "int32", + "type": "integer", + "x-etsi-mec-cardinality": "0..1", + "x-etsi-mec-origin-type": "Uint32" + }, + "dot11TwentyMHzFrameTransmittedCount": { + "format": "int32", + "type": "integer", + "x-etsi-mec-cardinality": "0..1", + "x-etsi-mec-origin-type": "Uint32" + }, + "dot11nonSTBCCTSFailureCount": { + "format": "int32", + "type": "integer", + "x-etsi-mec-cardinality": "0..1", + "x-etsi-mec-origin-type": "Uint32" + }, + "dot11nonSTBCCTSSuccessCount": { + "format": "int32", + "type": "integer", + "x-etsi-mec-cardinality": "0..1", + "x-etsi-mec-origin-type": "Uint32" + } + }, + "type": "object" + }, + "SubscriptionLinkList": { + "properties": { + "_links": { + "description": "Hyperlink related to the resource. This shall be only included in the HTTP responses and in HTTP PUT requests.", + "properties": { + "self": { + "$ref": "#/components/schemas/LinkType" + } + }, + "type": "object", + "x-etsi-mec-cardinality": "0..1", + "x-etsi-mec-origin-type": "Structure (inlined)" + }, + "assocStaSubscription": { + "items": { + "$ref": "#/components/schemas/AssocStaSubscription" + }, + "type": "array", + "x-etsi-mec-cardinality": "0..N", + "x-etsi-mec-origin-type": "AssocStaSubscription" + }, + "staDataRateSubscription": { + "items": { + "$ref": "#/components/schemas/StaDataRateSubscription" + }, + "type": "array", + "x-etsi-mec-cardinality": "0..N", + "x-etsi-mec-origin-type": "StaDataRateSubscription" + } + }, + "required": [ + "_links" + ], + "type": "object" + }, + "TimeStamp": { + "properties": { + "nanoSeconds": { + "description": "The nanoseconds part of the time. Time is defined as Unix-time since January 1, 1970, 00:00:00 UTC.", + "format": "int32", + "type": "integer", + "x-etsi-mec-cardinality": "1", + "x-etsi-mec-origin-type": "Uint32" + }, + "seconds": { + "description": "The seconds part of the time. Time is defined as Unixtime since January 1, 1970, 00:00:00 UTC.", + "format": "int32", + "type": "integer", + "x-etsi-mec-cardinality": "1", + "x-etsi-mec-origin-type": "Uint32" + } + }, + "required": [ + "seconds", + "nanoSeconds" + ], + "type": "object", + "x-etsi-ref": "6.5.2" + }, + "VhtCapabilities": { + "properties": { + "vhtCapInfo": { + "description": "VHT capabilities Info as defined in IEEE 802.11-2016 [8].", + "format": "int32", + "type": "integer", + "x-etsi-mec-cardinality": "1", + "x-etsi-mec-origin-type": "UInt32" + }, + "vhtMcsNss": { + "description": "Supported VHT-MCS and NSS Set as defined in IEEE 802.11-2016 [8].", + "format": "int64", + "type": "integer", + "x-etsi-mec-cardinality": "1", + "x-etsi-mec-origin-type": "UInt64" + } + }, + "required": [ + "vhtCapInfo", + "vhtMcsNss" + ], + "type": "object", + "x-etsi-ref": "6.5.15" + }, + "WanMetrics": { + "properties": { + "downlinkLoad": { + "description": "1-octet positive integer representing the current percentage loading of the downlink WAN connection, scaled linearly with 255 representing 100 %, as measured over an interval the duration of which is reported in Load Measurement Duration. In cases where the downlink load is unknown to the AP, the value is set to zero.", + "format": "int32", + "type": "integer", + "x-etsi-mec-cardinality": "1", + "x-etsi-mec-origin-type": "UInt8" + }, + "downlinkSpeed": { + "description": "4-octet positive integer whose value is an estimate of the WAN Backhaul link current downlink speed in kilobits per second.", + "format": "int32", + "type": "integer", + "x-etsi-mec-cardinality": "1", + "x-etsi-mec-origin-type": "Uint32" + }, + "lmd": { + "description": "The LMD (Load Measurement Duration) field is a 2-octet positive integer representing the duration over which the Downlink Load and Uplink Load have been measured, in tenths of a second. When the actual load measurement duration is greater than the maximum value, the maximum value will be reported. The value of the LMD field is set to 0 when neither the uplink nor downlink load can be computed. When the uplink and downlink loads are computed over different intervals, the maximum interval is reported.", + "format": "int32", + "type": "integer", + "x-etsi-mec-cardinality": "1", + "x-etsi-mec-origin-type": "Uint16" + }, + "uplinkLoad": { + "description": "1-octet positive integer representing the current percentage loading of the uplink WAN connection, scaled linearly with 255 representing 100 %, as measured over an interval, the duration of which is reported in Load Measurement Duration. In cases where the uplink load is unknown to the AP, the value is set to zero.", + "format": "int32", + "type": "integer", + "x-etsi-mec-cardinality": "1", + "x-etsi-mec-origin-type": "Uint8" + }, + "uplinkSpeed": { + "description": "4-octet positive integer whose value is an estimate of the WAN Backhaul link's current uplink speed in kilobits per second.", + "format": "int32", + "type": "integer", + "x-etsi-mec-cardinality": "1", + "x-etsi-mec-origin-type": "UInt32" + }, + "wanInfo": { + "description": "Info about WAN link status, link symmetricity and capacity currently used.", + "format": "int32", + "type": "integer", + "x-etsi-mec-cardinality": "1", + "x-etsi-mec-origin-type": "Uint8" + } + }, + "required": [ + "wanInfo", + "downlinkSpeed", + "uplinkSpeed", + "downlinkLoad", + "uplinkLoad", + "lmd" + ], + "type": "object", + "x-etsi-ref": "6.5.6" + }, + "WlanCapabilities": { + "properties": { + "dmg": { + "$ref": "#/components/schemas/DmgCapabilities" + }, + "edmg": { + "$ref": "#/components/schemas/EdmgCapabilities" + }, + "he": { + "$ref": "#/components/schemas/HeCapabilities" + }, + "ht": { + "$ref": "#/components/schemas/HtCapabilities" + }, + "vht": { + "$ref": "#/components/schemas/VhtCapabilities" + } + }, + "type": "object", + "x-etsi-ref": "6.5.4" + } + } + } +} \ No newline at end of file -- GitLab From bbf3e2a3d39d0f9b8b79f773cc19a2aae3191da8 Mon Sep 17 00:00:00 2001 From: Michel Roy Date: Mon, 16 Nov 2020 08:37:45 -0500 Subject: [PATCH 5/8] fixed issue yaml contains json --- WlanInformationApi.json | 467 ++-- WlanInformationApi.yaml | 4844 +++++++++++++++++---------------------- 2 files changed, 2317 insertions(+), 2994 deletions(-) diff --git a/WlanInformationApi.json b/WlanInformationApi.json index b0e3263..c082656 100644 --- a/WlanInformationApi.json +++ b/WlanInformationApi.json @@ -58,14 +58,9 @@ "content": { "application/json": { "schema": { - "type": "object", - "properties": { - "apInfo": { - "type": "array", - "items": { - "$ref": "#/components/schemas/ApInfo" - } - } + "type": "array", + "items": { + "$ref": "#/components/schemas/ApInfo" } } } @@ -123,14 +118,9 @@ "content": { "application/json": { "schema": { - "type": "object", - "properties": { - "staInfo": { - "type": "array", - "items": { - "$ref": "#/components/schemas/StaInfo" - } - } + "type": "array", + "items": { + "$ref": "#/components/schemas/StaInfo" } } } @@ -176,35 +166,25 @@ "content": { "application/json": { "schema": { - "type": "object", - "required": [ - "subscriptionLinkList" - ], - "properties": { - "subscriptionLinkList": { - "$ref": "#/components/schemas/SubscriptionLinkList" - } - } + "$ref": "#/components/schemas/SubscriptionLinkList" }, "example": { - "subscriptionLinkList": { - "_links": { - "self": { - "href": "http://meAppServer.example.com/wai/v2/subscriptions" - } - }, - "subscription": [ - { - "_links": { - "self": { - "href": "http://meAppServer.example.com/wai/v2/subscriptions/sub123" - } - }, - "callbackReference": "http://my.callback.com/wai/assocStaSubscription/some-id", - "subscriptionType": "AssocStaSubscription" - } - ] - } + "_links": { + "self": { + "href": "http://meAppServer.example.com/wai/v2/subscriptions" + } + }, + "subscription": [ + { + "_links": { + "self": { + "href": "http://meAppServer.example.com/wai/v2/subscriptions/sub123" + } + }, + "callbackReference": "http://my.callback.com/wai/assocStaSubscription/some-id", + "subscriptionType": "AssocStaSubscription" + } + ] } } } @@ -242,36 +222,19 @@ "content": { "application/json": { "schema": { - "type": "object", - "properties": { - "notificationSubscription": { - "oneOf": [ - { - "$ref": "#/components/schemas/AssocStaSubscription" - }, - { - "$ref": "#/components/schemas/StaDataRateSubscription" - } - ], - "discriminator": { - "propertyName": "subscriptionType" - } - } + "$ref": "#/components/schemas/InlineSubscription" + }, + "example": { + "subscriptionType": "AssocStaSubscription", + "callbackReference": "http://meAppClient.example.com/wai/v2/notifications/1", + "expiryDeadline": { + "seconds": 1977836800, + "nanoSeconds": 0 }, - "example": { - "notificationSubscription": { - "subscriptionType": "AssocStaSubscription", - "callbackReference": "http://meAppClient.example.com/wai/v2/notifications/1", - "expiryDeadline": { - "seconds": 1977836800, - "nanoSeconds": 0 - }, - "apId": { - "macId": "005C0A0A0A0A", - "ssid": "myNetworkSsid", - "ipAddress": "10.10.100.1" - } - } + "apId": { + "macId": "005C0A0A0A0A", + "ssid": "myNetworkSsid", + "ipAddress": "10.10.100.1" } } } @@ -283,41 +246,24 @@ "content": { "application/json": { "schema": { - "type": "object", - "properties": { - "notificationSubscription": { - "oneOf": [ - { - "$ref": "#/components/schemas/AssocStaSubscription" - }, - { - "$ref": "#/components/schemas/StaDataRateSubscription" - } - ], - "discriminator": { - "propertyName": "subscriptionType" - } - } - } + "$ref": "#/components/schemas/InlineSubscription" }, "example": { - "notificationSubscription": { - "subscriptionType": "AssocStaSubscription", - "callbackReference": "http://meAppClient.example.com/wai/v2/notifications/1", - "_links": { - "self": { - "href": "http://meAppServer.example.com/wai/v2/subscriptions/sub123" - } - }, - "expiryDeadline": { - "seconds": 1977836800, - "nanoSeconds": 0 - }, - "apId": { - "macId": "005C0A0A0A0A", - "ssid": "myNetworkSsid", - "ipAddress": "10.10.100.1" + "subscriptionType": "AssocStaSubscription", + "callbackReference": "http://meAppClient.example.com/wai/v2/notifications/1", + "_links": { + "self": { + "href": "http://meAppServer.example.com/wai/v2/subscriptions/sub123" } + }, + "expiryDeadline": { + "seconds": 1977836800, + "nanoSeconds": 0 + }, + "apId": { + "macId": "005C0A0A0A0A", + "ssid": "myNetworkSsid", + "ipAddress": "10.10.100.1" } } } @@ -361,44 +307,27 @@ "content": { "application/json": { "schema": { - "type": "object", - "properties": { - "notification": { - "oneOf": [ - { - "$ref": "#/components/schemas/AssocStaNotification" - }, - { - "$ref": "#/components/schemas/StaDataRateNotification" - } - ], - "discriminator": { - "propertyName": "notificationType" - } - } + "$ref": "#/components/schemas/InlineNotification" + }, + "example": { + "notificationType": "AssocStaNotification", + "timeStamp": { + "seconds": 1977836800, + "nanoseconds": 0 + }, + "apId": { + "macId": "005C0A0A0A0A", + "ssid": "myNetworkSsid", + "ipAddress": "10.10.100.1" }, - "example": { - "notification": { - "notificationType": "AssocStaNotification", - "timeStamp": { - "seconds": 1977836800, - "nanoseconds": 0 - }, - "apId": { - "macId": "005C0A0A0A0A", - "ssid": "myNetworkSsid", - "ipAddress": "10.10.100.1" - }, - "staId": { - "macId": "005C01111111", - "ssid": [ - "myNetworkSsid", - "myOtherNetworkSsid" - ], - "aid": "1122", - "ipAddress": "10.10.1.255" - } - } + "staId": { + "macId": "005C01111111", + "ssid": [ + "myNetworkSsid", + "myOtherNetworkSsid" + ], + "aid": "1122", + "ipAddress": "10.10.1.255" } } } @@ -434,44 +363,24 @@ "content": { "application/json": { "schema": { - "type": "object", - "required": [ - "notificationSubscription" - ], - "properties": { - "notificationSubscription": { - "oneOf": [ - { - "$ref": "#/components/schemas/AssocStaSubscription" - }, - { - "$ref": "#/components/schemas/StaDataRateSubscription" - } - ], - "discriminator": { - "propertyName": "subscriptionType" - } - } - } + "$ref": "#/components/schemas/InlineSubscription" }, "example": { - "notificationSubscription": { - "subscriptionType": "AssocStaSubscription", - "callbackReference": "http://meAppClient.example.com/wai/v2/notifications/1", - "_links": { - "self": { - "href": "http://meAppServer.example.com/wai/v2/subscriptions/sub123" - } - }, - "expiryDeadline": { - "seconds": 1977836800, - "nanoSeconds": 0 - }, - "apId": { - "macId": "005C0A0A0A0A", - "ssid": "myNetworkSsid", - "ipAddress": "10.10.100.1" + "subscriptionType": "AssocStaSubscription", + "callbackReference": "http://meAppClient.example.com/wai/v2/notifications/1", + "_links": { + "self": { + "href": "http://meAppServer.example.com/wai/v2/subscriptions/sub123" } + }, + "expiryDeadline": { + "seconds": 1977836800, + "nanoSeconds": 0 + }, + "apId": { + "macId": "005C0A0A0A0A", + "ssid": "myNetworkSsid", + "ipAddress": "10.10.100.1" } } } @@ -510,41 +419,24 @@ "content": { "application/json": { "schema": { - "type": "object", - "properties": { - "notificationSubscription": { - "oneOf": [ - { - "$ref": "#/components/schemas/AssocStaSubscription" - }, - { - "$ref": "#/components/schemas/StaDataRateSubscription" - } - ], - "discriminator": { - "propertyName": "subscriptionType" - } + "$ref": "#/components/schemas/InlineSubscription" + }, + "example": { + "subscriptionType": "AssocStaSubscription", + "callbackReference": "http://meAppClient.example.com/wai/v2/notifications/1", + "_links": { + "self": { + "href": "http://meAppServer.example.com/wai/v2/subscriptions/sub123" } }, - "example": { - "notificationSubscription": { - "subscriptionType": "AssocStaSubscription", - "callbackReference": "http://meAppClient.example.com/wai/v2/notifications/1", - "_links": { - "self": { - "href": "http://meAppServer.example.com/wai/v2/subscriptions/sub123" - } - }, - "expiryDeadline": { - "seconds": 1977836800, - "nanoSeconds": 0 - }, - "apId": { - "macId": "005C0A0A0A0A", - "ssid": "myNetworkSsid", - "ipAddress": "10.10.100.1" - } - } + "expiryDeadline": { + "seconds": 1977836800, + "nanoSeconds": 0 + }, + "apId": { + "macId": "005C0A0A0A0A", + "ssid": "myNetworkSsid", + "ipAddress": "10.10.100.1" } } } @@ -561,34 +453,17 @@ "content": { "application/json": { "schema": { - "type": "object", - "properties": { - "subscription": { - "oneOf": [ - { - "$ref": "#/components/schemas/AssocStaSubscription" - }, - { - "$ref": "#/components/schemas/StaDataRateSubscription" - } - ], - "discriminator": { - "propertyName": "subscriptionType" - } - } - } + "$ref": "#/components/schemas/InlineSubscription" }, "example": { - "subscription": { - "_links": { - "self": { - "href": "http://[hostIP]/sbox-xyz123/wai/v2/subscriptions/sub123" - } - }, - "callbackReference": "http://my.callback.com/wai/some-id", - "apId": { - "macId": "005C0A0A0A0A" + "_links": { + "self": { + "href": "http://[hostIP]/sbox-xyz123/wai/v2/subscriptions/sub123" } + }, + "callbackReference": "http://my.callback.com/wai/some-id", + "apId": { + "macId": "005C0A0A0A0A" } } } @@ -663,14 +538,9 @@ "400": { "description": "Bad Request : used to indicate that incorrect parameters were passed to the request.", "content": { - "application/json": { + "application/problem+json": { "schema": { - "type": "object", - "properties": { - "problemDetails": { - "$ref": "#/components/schemas/ProblemDetails" - } - } + "$ref": "#/components/schemas/ProblemDetails" } } } @@ -678,14 +548,9 @@ "401": { "description": "Unauthorized : used when the client did not submit credentials.", "content": { - "application/json": { + "application/problem+json": { "schema": { - "type": "object", - "properties": { - "problemDetails": { - "$ref": "#/components/schemas/ProblemDetails" - } - } + "$ref": "#/components/schemas/ProblemDetails" } } } @@ -693,17 +558,9 @@ "403": { "description": "Forbidden : operation is not allowed given the current status of the resource.", "content": { - "application/json": { + "application/problem+json": { "schema": { - "type": "object", - "required": [ - "problemDetails" - ], - "properties": { - "problemDetails": { - "$ref": "#/components/schemas/ProblemDetails" - } - } + "$ref": "#/components/schemas/ProblemDetails" } } } @@ -711,14 +568,9 @@ "404": { "description": "Not Found : used when a client provided a URI that cannot be mapped to a valid resource URI.", "content": { - "application/json": { + "application/problem+json": { "schema": { - "type": "object", - "properties": { - "problemDetails": { - "$ref": "#/components/schemas/ProblemDetails" - } - } + "$ref": "#/components/schemas/ProblemDetails" } } } @@ -726,14 +578,9 @@ "406": { "description": "Not Acceptable : used to indicate that the server cannot provide the any of the content formats supported by the client.", "content": { - "application/json": { + "application/problem+json": { "schema": { - "type": "object", - "properties": { - "problemDetails": { - "$ref": "#/components/schemas/ProblemDetails" - } - } + "$ref": "#/components/schemas/ProblemDetails" } } } @@ -741,14 +588,9 @@ "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", "content": { - "application/json": { + "application/problem+json": { "schema": { - "type": "object", - "properties": { - "problemDetails": { - "$ref": "#/components/schemas/ProblemDetails" - } - } + "$ref": "#/components/schemas/ProblemDetails" } } } @@ -756,14 +598,9 @@ "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/json": { + "application/problem+json": { "schema": { - "type": "object", - "properties": { - "problemDetails": { - "$ref": "#/components/schemas/ProblemDetails" - } - } + "$ref": "#/components/schemas/ProblemDetails" } } } @@ -771,24 +608,17 @@ "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.", "content": { - "application/json": { + "application/problem+json": { "schema": { - "type": "object", - "properties": { - "problemDetails": { - "$ref": "#/components/schemas/ProblemDetails" - } - } + "$ref": "#/components/schemas/ProblemDetails" }, "example": { "application/problem+json": { - "ProblemDetails": { - "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" - } + "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" } } } @@ -797,14 +627,9 @@ "429": { "description": "Too Many Requests : used when a rate limiter has triggered.", "content": { - "application/json": { + "application/problem+json": { "schema": { - "type": "object", - "properties": { - "problemDetails": { - "$ref": "#/components/schemas/ProblemDetails" - } - } + "$ref": "#/components/schemas/ProblemDetails" } } } @@ -1813,7 +1638,33 @@ "aselCap" ], "type": "object", - "x-etsi-ref": "6.5.14" + "x-etsi-ref": "6.5.1" + }, + "InlineNotification": { + "oneOf": [ + { + "$ref": "#/components/schemas/AssocStaNotification" + }, + { + "$ref": "#/components/schemas/StaDataRateNotification" + } + ], + "discriminator": { + "propertyName": "notificationType" + } + }, + "InlineSubscription": { + "oneOf": [ + { + "$ref": "#/components/schemas/AssocStaSubscription" + }, + { + "$ref": "#/components/schemas/StaDataRateSubscription" + } + ], + "discriminator": { + "propertyName": "subscriptionType" + } }, "LinkType": { "properties": { diff --git a/WlanInformationApi.yaml b/WlanInformationApi.yaml index c082656..4a8c0e5 100644 --- a/WlanInformationApi.yaml +++ b/WlanInformationApi.yaml @@ -1,2686 +1,2158 @@ -{ - "openapi": "3.0.0", - "info": { - "contact": { - "url": "https://forge.etsi.org/rep/mec/gs028-wai-api" - }, - "title": "ETSI GS MEC 028 - WLAN Access Information API", - "version": "2.1.1", - "description": "The ETSI MEC ISG MEC028 WLAN Access Information API described using OpenAPI", - "license": { - "name": "BSD-3-Clause", - "url": "https://forge.etsi.org/legal-matters" - } - }, - "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" - }, - "servers": [ - { - "url": "https://localhost/wai/v2" - } - ], - "tags": [ - { - "name": "wai" - } - ], - "paths": { - "/queries/ap/ap_information": { - "get": { - "tags": [ - "wai" - ], - "summary": "Retrieve information on existing Access Points", - "description": "Queries information about existing WLAN Access Points", - "operationId": "apInfoGET", - "parameters": [ - { - "$ref": "#/components/parameters/Query.Filter" - }, - { - "$ref": "#/components/parameters/Query.AllFields" - }, - { - "$ref": "#/components/parameters/Query.Fields" - }, - { - "$ref": "#/components/parameters/Query.ExcludeFields" - }, - { - "$ref": "#/components/parameters/Query.ExcludeDefault" - } - ], - "responses": { - "200": { - "description": "Successful response to ap_info request", - "content": { - "application/json": { - "schema": { - "type": "array", - "items": { - "$ref": "#/components/schemas/ApInfo" - } - } - } - } - }, - "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": { - "$ref": "#/components/responses/429" - } - } - } - }, - "/queries/sta/sta_information": { - "get": { - "tags": [ - "wai" - ], - "summary": "Retrieve information on existing Stations", - "description": "Queries information about existing WLAN stations", - "operationId": "staInfoGET", - "parameters": [ - { - "$ref": "#/components/parameters/Query.Filter" - }, - { - "$ref": "#/components/parameters/Query.AllFields" - }, - { - "$ref": "#/components/parameters/Query.Fields" - }, - { - "$ref": "#/components/parameters/Query.ExcludeFields" - }, - { - "$ref": "#/components/parameters/Query.ExcludeDefault" - } - ], - "responses": { - "200": { - "description": "Successful response to sta_info request", - "content": { - "application/json": { - "schema": { - "type": "array", - "items": { - "$ref": "#/components/schemas/StaInfo" - } - } - } - } - }, - "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": { - "$ref": "#/components/responses/429" - } - } - } - }, - "/subscriptions": { - "get": { - "tags": [ - "wai" - ], - "summary": "Retrieve information on subscriptions for notifications", - "description": "Queries information on subscriptions for notifications", - "operationId": "subscriptionLinkList_subscriptionsGET", - "parameters": [ - { - "$ref": "#/components/parameters/Query.SubscriptionType" - } - ], - "responses": { - "200": { - "description": "Response body contains the list of links to requestors subscriptions.", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/SubscriptionLinkList" - }, - "example": { - "_links": { - "self": { - "href": "http://meAppServer.example.com/wai/v2/subscriptions" - } - }, - "subscription": [ - { - "_links": { - "self": { - "href": "http://meAppServer.example.com/wai/v2/subscriptions/sub123" - } - }, - "callbackReference": "http://my.callback.com/wai/assocStaSubscription/some-id", - "subscriptionType": "AssocStaSubscription" - } - ] - } - } - } - }, - "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": { - "$ref": "#/components/responses/429" - } - } - }, - "post": { - "tags": [ - "wai" - ], - "summary": "Create a new subscription", - "description": "Creates a new subscription to WLAN Access Information notifications", - "operationId": "subscriptionsPOST", - "requestBody": { - "description": "Subscription to be created", - "required": true, - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/InlineSubscription" - }, - "example": { - "subscriptionType": "AssocStaSubscription", - "callbackReference": "http://meAppClient.example.com/wai/v2/notifications/1", - "expiryDeadline": { - "seconds": 1977836800, - "nanoSeconds": 0 - }, - "apId": { - "macId": "005C0A0A0A0A", - "ssid": "myNetworkSsid", - "ipAddress": "10.10.100.1" - } - } - } - } - }, - "responses": { - "201": { - "description": "Successful subscription response", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/InlineSubscription" - }, - "example": { - "subscriptionType": "AssocStaSubscription", - "callbackReference": "http://meAppClient.example.com/wai/v2/notifications/1", - "_links": { - "self": { - "href": "http://meAppServer.example.com/wai/v2/subscriptions/sub123" - } - }, - "expiryDeadline": { - "seconds": 1977836800, - "nanoSeconds": 0 - }, - "apId": { - "macId": "005C0A0A0A0A", - "ssid": "myNetworkSsid", - "ipAddress": "10.10.100.1" - } - } - } - } - }, - "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": { - "$ref": "#/components/responses/415" - }, - "422": { - "$ref": "#/components/responses/422" - }, - "429": { - "$ref": "#/components/responses/429" - } - }, - "callbacks": { - "notification": { - "{$request.body#/callbackReference}": { - "post": { - "summary": "Callback POST used to send a notification", - "description": "Notification from WAIS, content based on subscription type", - "operationId": "notificationPOST", - "requestBody": { - "description": "Subscription notification", - "required": true, - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/InlineNotification" - }, - "example": { - "notificationType": "AssocStaNotification", - "timeStamp": { - "seconds": 1977836800, - "nanoseconds": 0 - }, - "apId": { - "macId": "005C0A0A0A0A", - "ssid": "myNetworkSsid", - "ipAddress": "10.10.100.1" - }, - "staId": { - "macId": "005C01111111", - "ssid": [ - "myNetworkSsid", - "myOtherNetworkSsid" - ], - "aid": "1122", - "ipAddress": "10.10.1.255" - } - } - } - } - }, - "responses": { - "204": { - "$ref": "#/components/responses/204" - } - } - } - } - } - } - } - }, - "/subscriptions/{subscriptionId}": { - "get": { - "tags": [ - "wai" - ], - "summary": "Retrieve information on current specific subscription", - "description": "Queries information about an existing subscription, identified by its self-referring URI returned on creation (initial POST)", - "operationId": "subscriptionsGET", - "parameters": [ - { - "$ref": "#/components/parameters/Path.subscrId" - } - ], - "responses": { - "200": { - "description": "Subscription information regarding subscription notifications", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/InlineSubscription" - }, - "example": { - "subscriptionType": "AssocStaSubscription", - "callbackReference": "http://meAppClient.example.com/wai/v2/notifications/1", - "_links": { - "self": { - "href": "http://meAppServer.example.com/wai/v2/subscriptions/sub123" - } - }, - "expiryDeadline": { - "seconds": 1977836800, - "nanoSeconds": 0 - }, - "apId": { - "macId": "005C0A0A0A0A", - "ssid": "myNetworkSsid", - "ipAddress": "10.10.100.1" - } - } - } - } - }, - "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": { - "$ref": "#/components/responses/429" - } - } - }, - "put": { - "tags": [ - "wai" - ], - "summary": "Modify an existing subscription", - "description": "Updates an existing subscription, identified by its self-referring URI returned on creation (initial POST)", - "operationId": "subscriptionsPUT", - "requestBody": { - "description": "Subscription to be modified", - "required": true, - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/InlineSubscription" - }, - "example": { - "subscriptionType": "AssocStaSubscription", - "callbackReference": "http://meAppClient.example.com/wai/v2/notifications/1", - "_links": { - "self": { - "href": "http://meAppServer.example.com/wai/v2/subscriptions/sub123" - } - }, - "expiryDeadline": { - "seconds": 1977836800, - "nanoSeconds": 0 - }, - "apId": { - "macId": "005C0A0A0A0A", - "ssid": "myNetworkSsid", - "ipAddress": "10.10.100.1" - } - } - } - } - }, - "parameters": [ - { - "$ref": "#/components/parameters/Path.subscrId" - } - ], - "responses": { - "200": { - "description": "Successful subscription modification", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/InlineSubscription" - }, - "example": { - "_links": { - "self": { - "href": "http://[hostIP]/sbox-xyz123/wai/v2/subscriptions/sub123" - } - }, - "callbackReference": "http://my.callback.com/wai/some-id", - "apId": { - "macId": "005C0A0A0A0A" - } - } - } - } - }, - "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 an existing subscription", - "description": "Cancels an existing subscription, identified by its self-referring URI returned on creation (initial POST)", - "operationId": "subscriptionsDELETE", - "parameters": [ - { - "$ref": "#/components/parameters/Path.subscrId" - } - ], - "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" - } - } - } - }, - "406": { - "description": "Not Acceptable : used to indicate that the server cannot provide the any of the content formats supported by the client.", - "content": { - "application/problem+json": { - "schema": { - "$ref": "#/components/schemas/ProblemDetails" - } - } - } - }, - "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", - "content": { - "application/problem+json": { - "schema": { - "$ref": "#/components/schemas/ProblemDetails" - } - } - } - }, - "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" - } - } - } - }, - "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.", - "content": { - "application/problem+json": { - "schema": { - "$ref": "#/components/schemas/ProblemDetails" - }, - "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" - } - } - } - } - }, - "429": { - "description": "Too Many Requests : used when a rate limiter has triggered.", - "content": { - "application/problem+json": { - "schema": { - "$ref": "#/components/schemas/ProblemDetails" - } - } - } - } - }, - "parameters": { - "Path.subscrId": { - "name": "subscriptionId", - "in": "path", - "description": "Subscription Id, specifically the \"self\" returned in the subscription request", - "required": true, - "schema": { - "type": "string", - "format": "uri" - } - }, - "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" - } - }, - "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" - } - }, - "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" - } - } - }, - "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": { - "type": "string" - } - } - }, - "Query.ExcludeDefault": { - "name": "exclude_default", - "in": "query", - "description": "Indicates to exclude the following complex attributes from the response. See clause 6.18 of ETSI GS MEC 009 for details. The following attributes shall be excluded from the structure in the response body if this parameter is provided, or none of the parameters \"all_fields\", \"fields\", \"exclude_fields\", \"exclude_default\" are provided: Not applicable", - "required": false, - "schema": { - "type": "array", - "items": { - "type": "string" - } - } - }, - "Query.SubscriptionType": { - "name": "subscription_type", - "in": "query", - "description": "Filter on a specific subscription type. Permitted values: assoc_sta, sta_data_rate.", - "required": false, - "schema": { - "type": "string" - } - } - }, - "schemas": { - "ApAssociated": { - "properties": { - "assocId": { - "description": "Unique number which identifies a particular association between the station and Access Point.", - "type": "string", - "x-etsi-mec-cardinality": "0..1", - "x-etsi-mec-origin-type": "string" - }, - "ipAddress": { - "description": "IPv4 or IPv6 address allocated for the Access Point.", - "items": { - "type": "string" - }, - "minItems": 0, - "type": "array", - "x-etsi-mec-cardinality": "0..N", - "x-etsi-mec-origin-type": "string" - }, - "macId": { - "description": "Unique identifier assigned to the Access Point (as network interface controller) for communications at the data link layer of a network segment.", - "type": "string", - "x-etsi-mec-cardinality": "1", - "x-etsi-mec-origin-type": "string" - }, - "ssid": { - "description": "Service Set Identifier to identify logical networks.", - "items": { - "type": "string" - }, - "minItems": 0, - "type": "array", - "x-etsi-mec-cardinality": "0..N", - "x-etsi-mec-origin-type": "String" - } - }, - "required": [ - "macId" - ], - "type": "object", - "x-etsi-ref": "6.5.12" - }, - "ApIdentity": { - "properties": { - "ipAddress": { - "description": "IPv4 or IPv6 address allocated for the Access Point.", - "items": { - "type": "string" - }, - "minItems": 0, - "type": "array", - "x-etsi-mec-cardinality": "0..N", - "x-etsi-mec-origin-type": "String" - }, - "macId": { - "description": "Unique Identifier assigned to an Access Point (as network interface controller) for communications at the data link layer of a network segment.", - "type": "string", - "x-etsi-mec-cardinality": "1", - "x-etsi-mec-origin-type": "String" - }, - "ssid": { - "description": "Service Set Identifier to identify logical networks including Basic Service Set and Extended Service Set.", - "items": { - "type": "string" - }, - "minItems": 0, - "type": "array", - "x-etsi-mec-cardinality": "0..N", - "x-etsi-mec-origin-type": "String" - } - }, - "required": [ - "macId" - ], - "type": "object", - "x-etsi-ref": "6.5.3" - }, - "ApInfo": { - "properties": { - "apId": { - "$ref": "#/components/schemas/ApIdentity" - }, - "apLocation": { - "$ref": "#/components/schemas/ApLocation" - }, - "apNeighbor": { - "$ref": "#/components/schemas/NeighborReport" - }, - "bssLoad": { - "$ref": "#/components/schemas/BssLoad" - }, - "channel": { - "description": "Channel configured for the Access Point.", - "format": "int32", - "type": "integer", - "x-etsi-mec-cardinality": "0..1", - "x-etsi-mec-origin-type": "Uint32" - }, - "extBssLoad": { - "$ref": "#/components/schemas/ExtBssLoad" - }, - "timeStamp": { - "$ref": "#/components/schemas/TimeStamp" - }, - "wanMetrics": { - "$ref": "#/components/schemas/WanMetrics" - }, - "wlanCap": { - "$ref": "#/components/schemas/WlanCapabilities" - } - }, - "required": [ - "apId" - ], - "type": "object", - "x-etsi-ref": "6.2.2" - }, - "ApLocation": { - "properties": { - "civicLocation": { - "$ref": "#/components/schemas/CivicLocation" - }, - "geolocation": { - "$ref": "#/components/schemas/GeoLocation" - } - }, - "type": "object", - "x-etsi-ref": "6.5.9" - }, - "AssocStaNotification": { - "properties": { - "apId": { - "$ref": "#/components/schemas/ApIdentity" - }, - "notificationType": { - "description": "Shall be set to \"AssocStaNotification\".", - "type": "string", - "x-etsi-mec-cardinality": "1", - "x-etsi-mec-origin-type": "String" - }, - "staId": { - "description": "Identifier(s) to uniquely specify the client station(s) associated.", - "items": { - "$ref": "#/components/schemas/StaIdentity" - }, - "minItems": 0, - "type": "array", - "x-etsi-mec-cardinality": "0..N", - "x-etsi-mec-origin-type": "StaIdentity" - }, - "timeStamp": { - "$ref": "#/components/schemas/TimeStamp" - } - }, - "required": [ - "notificationType", - "apId" - ], - "type": "object", - "x-etsi-ref": "6.4.2" - }, - "AssocStaSubscription": { - "properties": { - "_links": { - "description": "Hyperlink related to the resource. This shall be only included in the HTTP responses and in HTTP PUT requests.", - "properties": { - "self": { - "$ref": "#/components/schemas/LinkType" - } - }, - "required": [ - "self" - ], - "type": "object", - "x-etsi-mec-cardinality": "0..1", - "x-etsi-mec-origin-type": "Structure (inlined)" - }, - "apId": { - "$ref": "#/components/schemas/ApIdentity" - }, - "callbackReference": { - "description": "URI selected by the service consumer to receive notifications on the subscribed WLAN information. This shall be included both in the request and in response.", - "format": "uri", - "type": "string", - "x-etsi-mec-cardinality": "1", - "x-etsi-mec-origin-type": "URI" - }, - "expiryDeadline": { - "$ref": "#/components/schemas/TimeStamp" - }, - "subscriptionType": { - "description": "Shall be set to \"AssocStaSubscription\".", - "type": "string", - "x-etsi-mec-cardinality": "1", - "x-etsi-mec-origin-type": "String" - } - }, - "required": [ - "subscriptionType", - "callbackReference", - "apId" - ], - "type": "object", - "x-etsi-ref": "6.3.2" - }, - "AssociatedStations": { - "properties": { - "assocId": { - "description": "Unique number which identifies a particular association between an Access Point and a station.", - "type": "string", - "x-etsi-mec-cardinality": "0..1", - "x-etsi-mec-origin-type": "string" - }, - "ipAddress": { - "description": "IPv4 or IPv6 address allocated for the station associated with the Access Point.", - "items": { - "type": "string" - }, - "minItems": 0, - "type": "array", - "x-etsi-mec-cardinality": "0..N", - "x-etsi-mec-origin-type": "string" - }, - "macId": { - "description": "Unique identifier assigned to a station (as network interface controller) for communications at the data link layer of a network segment.", - "type": "string", - "x-etsi-mec-cardinality": "1", - "x-etsi-mec-origin-type": "string" - } - }, - "required": [ - "macId" - ], - "type": "object", - "x-etsi-ref": "6.5.5" - }, - "BeaconReport": { - "properties": { - "bssId": { - "description": "The BSSID field indicates the BSSID of the BSS(s) for which a beacon report has been received.", - "items": { - "type": "string" - }, - "minItems": 1, - "type": "array", - "x-etsi-mec-cardinality": "1..N", - "x-etsi-mec-origin-type": "String" - }, - "channelId": { - "description": "Channel number where the beacon was received.", - "type": "integer", - "x-etsi-mec-cardinality": "1", - "x-etsi-mec-origin-type": "Integer" - }, - "measurementId": { - "description": "Measurement ID of the Measurement configuration applied to this Beacon Report.", - "type": "string", - "x-etsi-mec-cardinality": "1", - "x-etsi-mec-origin-type": "String" - }, - "reportingCondition": { - "description": "As in table T9-89 of IEEE 802.11-2012 [8].", - "type": "integer", - "x-etsi-mec-cardinality": "1", - "x-etsi-mec-origin-type": "Integer" - }, - "ssId": { - "description": "(Optional) The SSID subelement indicates the ESS(s) or IBSS(s) for which a beacon report is received.", - "items": { - "type": "string" - }, - "minItems": 1, - "type": "array", - "x-etsi-mec-cardinality": "1..N", - "x-etsi-mec-origin-type": "String" - }, - "staId": { - "$ref": "#/components/schemas/StaIdentity" - } - }, - "required": [ - "staId", - "measurementId", - "channelId", - "bssId", - "ssId", - "reportingCondition" - ], - "type": "object", - "x-etsi-ref": "6.5.27" - }, - "BeaconRequestConfig": { - "properties": { - "bssId": { - "description": "The BSSID field indicates the BSSID of the BSS(s) for which a beacon report is requested. When requesting beacon reports for all BSSs on the channel, the BSSID field contains the wildcard BSSID.", - "items": { - "type": "string" - }, - "minItems": 1, - "type": "array", - "x-etsi-mec-cardinality": "1..N", - "x-etsi-mec-origin-type": "String" - }, - "channelId": { - "description": "Channel number to scan. A Channel Number of 0 indicates a request to make iterative measurements for all supported channels in the Operating Class where the measurement is permitted on the channel and the channel is valid for the current regulatory domain. A Channel Number of 255 indicates a request to make iterative measurements for all supported channels in the current Operating Class listed in the latest AP Channel Report received from the serving AP.", - "type": "integer", - "x-etsi-mec-cardinality": "1", - "x-etsi-mec-origin-type": "Integer" - }, - "measurementMode": { - "description": "0 for passive.\n1 for active.\n2 for beacon table.", - "type": "integer", - "x-etsi-mec-cardinality": "1", - "x-etsi-mec-origin-type": "Integer" - }, - "reportingCondition": { - "description": "As in table T9-89 of IEEE 802.11-2012 [8].", - "type": "integer", - "x-etsi-mec-cardinality": "1", - "x-etsi-mec-origin-type": "Integer" - }, - "ssId": { - "description": "(Optional) The SSID subelement indicates the ESS(s) or IBSS(s) for which a beacon report is requested.", - "items": { - "type": "string" - }, - "minItems": 1, - "type": "array", - "x-etsi-mec-cardinality": "1..N", - "x-etsi-mec-origin-type": "String" - }, - "staId": { - "$ref": "#/components/schemas/StaIdentity" - } - }, - "required": [ - "staId", - "channelId", - "measurementMode", - "bssId", - "ssId", - "reportingCondition" - ], - "type": "object", - "x-etsi-ref": "6.5.25" - }, - "BssLoad": { - "properties": { - "availAdmCap": { - "description": "Available Admission Capacity that specifies the remaining amount of medium time available via explicit admission control, in units of 32 s/s.", - "format": "int32", - "type": "integer", - "x-etsi-mec-cardinality": "1", - "x-etsi-mec-origin-type": "Uint16" - }, - "channelUtilization": { - "description": "The percentage of time, linearly scaled with 255 representing 100 %, that the AP sensed the medium was busy, as indicated by either the physical or virtual Carrier Sense (CS) mechanism.", - "format": "int32", - "type": "integer", - "x-etsi-mec-cardinality": "1", - "x-etsi-mec-origin-type": "UInt8" - }, - "staCount": { - "description": "An unsigned integer that indicates the total number of STAs currently associated with this BSS.", - "format": "int32", - "type": "integer", - "x-etsi-mec-cardinality": "1", - "x-etsi-mec-origin-type": "UInt16" - } - }, - "required": [ - "staCount", - "channelUtilization", - "availAdmCap" - ], - "type": "object", - "x-etsi-ref": "6.5.7" - }, - "ChannelLoadConfig": { - "properties": { - "apId": { - "$ref": "#/components/schemas/ApIdentity" - }, - "cChannelId": { - "description": "Channel number which load is reported", - "type": "integer", - "x-etsi-mec-cardinality": "1", - "x-etsi-mec-origin-type": "Integer" - }, - "channelLoad": { - "description": "Channel load as per IEEE 802.11-2012 [8], section 11.11.9.3", - "type": "integer", - "x-etsi-mec-cardinality": "1", - "x-etsi-mec-origin-type": "Integer" - } - }, - "required": [ - "apId", - "cChannelId", - "channelLoad" - ], - "type": "object", - "x-etsi-ref": "6.5.24" - }, - "CivicLocation": { - "properties": { - "ca0": { - "description": "Language", - "type": "string", - "x-etsi-mec-cardinality": "0..1", - "x-etsi-mec-origin-type": "String" - }, - "ca1": { - "description": "National subdivisions (state, canton, region,province, prefecture) ", - "type": "string", - "x-etsi-mec-cardinality": "0..1", - "x-etsi-mec-origin-type": "String" - }, - "ca128": { - "description": "Script", - "type": "string", - "x-etsi-mec-cardinality": "0..1", - "x-etsi-mec-origin-type": "String" - }, - "ca16": { - "description": "Leading street direction", - "type": "string", - "x-etsi-mec-cardinality": "0..1", - "x-etsi-mec-origin-type": "String" - }, - "ca17": { - "description": "Trailing street suffix", - "type": "string", - "x-etsi-mec-cardinality": "0..1", - "x-etsi-mec-origin-type": "String" - }, - "ca18": { - "description": "Street suffix or type", - "type": "string", - "x-etsi-mec-cardinality": "0..1", - "x-etsi-mec-origin-type": "String" - }, - "ca19": { - "description": "House number", - "type": "string", - "x-etsi-mec-cardinality": "0..1", - "x-etsi-mec-origin-type": "String" - }, - "ca2": { - "description": "County, parish, gun (JP), district (IN)", - "type": "string", - "x-etsi-mec-cardinality": "0..1", - "x-etsi-mec-origin-type": "String" - }, - "ca20": { - "description": "House number suffix", - "type": "string", - "x-etsi-mec-cardinality": "0..1", - "x-etsi-mec-origin-type": "String" - }, - "ca21": { - "description": "Landmark of vanity address", - "type": "string", - "x-etsi-mec-cardinality": "0..1", - "x-etsi-mec-origin-type": "String" - }, - "ca22": { - "description": "Additional location information", - "type": "string", - "x-etsi-mec-cardinality": "0..1", - "x-etsi-mec-origin-type": "String" - }, - "ca23": { - "description": "Name (residence and office occupant)", - "type": "string", - "x-etsi-mec-cardinality": "0..1", - "x-etsi-mec-origin-type": "String" - }, - "ca24": { - "description": "Postal/zip code", - "type": "string", - "x-etsi-mec-cardinality": "0..1", - "x-etsi-mec-origin-type": "String" - }, - "ca25": { - "description": "Building (structure)", - "type": "string", - "x-etsi-mec-cardinality": "0..1", - "x-etsi-mec-origin-type": "String" - }, - "ca26": { - "description": "Unit (apartment/suite)", - "type": "string", - "x-etsi-mec-cardinality": "0..1", - "x-etsi-mec-origin-type": "String" - }, - "ca27": { - "description": "Floor", - "type": "string", - "x-etsi-mec-cardinality": "0..1", - "x-etsi-mec-origin-type": "String" - }, - "ca28": { - "description": "Room", - "type": "string", - "x-etsi-mec-cardinality": "0..1", - "x-etsi-mec-origin-type": "String" - }, - "ca29": { - "description": "Type of place", - "type": "string", - "x-etsi-mec-cardinality": "0..1", - "x-etsi-mec-origin-type": "String" - }, - "ca3": { - "description": "City, township, shi (JP)", - "type": "string", - "x-etsi-mec-cardinality": "0..1", - "x-etsi-mec-origin-type": "String" - }, - "ca30": { - "description": "Postal community name", - "type": "string", - "x-etsi-mec-cardinality": "0..1", - "x-etsi-mec-origin-type": "String" - }, - "ca31": { - "description": "Post office box", - "type": "string", - "x-etsi-mec-cardinality": "0..1", - "x-etsi-mec-origin-type": "String" - }, - "ca32": { - "description": "Additional code", - "type": "string", - "x-etsi-mec-cardinality": "0..1", - "x-etsi-mec-origin-type": "String" - }, - "ca33": { - "description": "Seat (desk.cubicle, workstation)", - "type": "string", - "x-etsi-mec-cardinality": "0..1", - "x-etsi-mec-origin-type": "String" - }, - "ca34": { - "description": "Primary road name", - "type": "string", - "x-etsi-mec-cardinality": "0..1", - "x-etsi-mec-origin-type": "String" - }, - "ca35": { - "description": "Road section", - "type": "string", - "x-etsi-mec-cardinality": "0..1", - "x-etsi-mec-origin-type": "String" - }, - "ca36": { - "description": "Branch road name", - "type": "string", - "x-etsi-mec-cardinality": "0..1", - "x-etsi-mec-origin-type": "String" - }, - "ca37": { - "description": "Sub-branch road name", - "type": "string", - "x-etsi-mec-cardinality": "0..1", - "x-etsi-mec-origin-type": "String" - }, - "ca38": { - "description": "Street name pre-modifier", - "type": "string", - "x-etsi-mec-cardinality": "0..1", - "x-etsi-mec-origin-type": "String" - }, - "ca39": { - "description": "Street name post-modifier", - "type": "string", - "x-etsi-mec-cardinality": "0..1", - "x-etsi-mec-origin-type": "String" - }, - "ca4": { - "description": "City division, borough, city district, ward, chou (JP)", - "type": "string", - "x-etsi-mec-cardinality": "0..1", - "x-etsi-mec-origin-type": "String" - }, - "ca5": { - "description": "Neighborhood, block", - "type": "string", - "x-etsi-mec-cardinality": "0..1", - "x-etsi-mec-origin-type": "String" - }, - "ca6": { - "description": "Group of streets below the neighborhood level ", - "type": "string", - "x-etsi-mec-cardinality": "0..1", - "x-etsi-mec-origin-type": "String" - }, - "country": { - "description": "The two-letter ISO 3166 [i.9] country code in capital ASCII letters, e.g. DE or US, as per ISO 3166 [i.9]", - "type": "string", - "x-etsi-mec-cardinality": "1", - "x-etsi-mec-origin-type": "String" - } - }, - "required": [ - "country" - ], - "type": "object", - "x-etsi-ref": "6.5.20" - }, - "DmgCapabilities": { - "properties": { - "ExtScMcsCap": { - "description": "Extended SC MCS capabilities as defined in draft IEEE P802.11/D4.0 [i.11]", - "format": "int32", - "type": "integer", - "x-etsi-mec-cardinality": "1", - "x-etsi-mec-origin-type": "Uint8" - }, - "dmgApOrPcpCapInfo": { - "description": "DMG AP or PCP capabilities information as defined in draft IEEE P802.11/D4.0 [i.11]", - "format": "int32", - "type": "integer", - "x-etsi-mec-cardinality": "1", - "x-etsi-mec-origin-type": "Uint16" - }, - "dmgStaBeamTrackTimeLimit": { - "description": "DMG station beam tracking time limit as defined in draft IEEE P802.11/D4.0 [i.11]", - "format": "int32", - "type": "integer", - "x-etsi-mec-cardinality": "1", - "x-etsi-mec-origin-type": "Uint16" - }, - "dmgStaCapInfo": { - "description": "DMG station capabilities information as defined in draft IEEE P802.11/D4.0 [i.11]", - "format": "int64", - "type": "integer", - "x-etsi-mec-cardinality": "1", - "x-etsi-mec-origin-type": "Uint64" - }, - "maxNrBasicAmsduSubframes": { - "description": "Number of basic A-MSDU subframes in A-MSDU as defined in draft IEEE P802.11/D4.0 [i.11]", - "format": "int32", - "type": "integer", - "x-etsi-mec-cardinality": "1", - "x-etsi-mec-origin-type": "Uint8" - }, - "maxNrShortAmsduSubframes": { - "description": "Number of short A-MSDU subframes in A-MSDU as defined in draft IEEE P802.11/D4.0 [i.11]", - "format": "int32", - "type": "integer", - "x-etsi-mec-cardinality": "1", - "x-etsi-mec-origin-type": "Uint8" - }, - "sarCap": { - "description": "SAR capabilities as defined in draft IEEE P802.11/D4.0 [i.11]", - "format": "int32", - "type": "integer", - "x-etsi-mec-cardinality": "1", - "x-etsi-mec-origin-type": "Uint8" - }, - "tddCap": { - "description": "TDD capabilities as defined in draft IEEE P802.11/D4.0 [i.11]", - "format": "int32", - "type": "integer", - "x-etsi-mec-cardinality": "1", - "x-etsi-mec-origin-type": "Uint16" - } - }, - "required": [ - "dmgStaCapInfo", - "dmgApOrPcpCapInfo", - "dmgStaBeamTrackTimeLimit", - "ExtScMcsCap", - "maxNrBasicAmsduSubframes", - "maxNrShortAmsduSubframes", - "tddCap", - "sarCap" - ], - "type": "object", - "x-etsi-ref": "6.5.17" - }, - "EdmgCapabilities": { - "properties": { - "ampduParameters": { - "description": "A-MPDU parameters as defined in draft IEEE P802.11/D4.0 [i.11]", - "format": "Uint8", - "type": "integer", - "x-etsi-mec-cardinality": "1", - "x-etsi-mec-origin-type": "Uint8" - }, - "reserved": { - "description": "", - "format": "int32", - "type": "integer", - "x-etsi-mec-cardinality": "0..1", - "x-etsi-mec-origin-type": "Uint8" - }, - "supportedMcs": { - "description": "Supported MCS as defined in draft IEEE P802.11/D4.0 [i.11]", - "format": "int32", - "type": "integer", - "x-etsi-mec-cardinality": "1", - "x-etsi-mec-origin-type": "Uint32" - }, - "trnParameters": { - "description": "Training parameters as defined in draft IEEE P802.11/D4.0 [i.11]", - "format": "int32", - "type": "integer", - "x-etsi-mec-cardinality": "1", - "x-etsi-mec-origin-type": "Uint16" - } - }, - "required": [ - "ampduParameters", - "trnParameters", - "supportedMcs" - ], - "type": "object", - "x-etsi-ref": "6.5.18" - }, - "ExtBssLoad": { - "properties": { - "muMimoStaCount": { - "description": "Indicates the total number of STAs currently associated with this BSS that have a 1 in the MU Beamformee Capable field of their VHT Capabilities element.", - "format": "int32", - "type": "integer", - "x-etsi-mec-cardinality": "1", - "x-etsi-mec-origin-type": "UInt16" - }, - "obsSec20MhzUtil": { - "description": "Observable loading on each of the secondary 20 MHz channel.", - "format": "int32", - "type": "integer", - "x-etsi-mec-cardinality": "1", - "x-etsi-mec-origin-type": "Uint8" - }, - "obsSec40MhzUtil": { - "description": "Observable loading on each of the secondary 40 MHz channel.", - "format": "int32", - "type": "integer", - "x-etsi-mec-cardinality": "1", - "x-etsi-mec-origin-type": "Uint8" - }, - "obsSec80MhzUtil": { - "description": "Observable loading on each of the secondary 80 MHz channel.", - "format": "int32", - "type": "integer", - "x-etsi-mec-cardinality": "1", - "x-etsi-mec-origin-type": "Uint8" - }, - "spatStreamUnderUtil": { - "description": "The percentage of time, linearly scaled with 255 representing 100 %, that the AP has underutilized spatial domain resources for given busy time of the medium.", - "format": "int32", - "type": "integer", - "x-etsi-mec-cardinality": "1", - "x-etsi-mec-origin-type": "UInt8" - } - }, - "required": [ - "muMimoStaCount", - "spatStreamUnderUtil", - "obsSec20MhzUtil", - "obsSec40MhzUtil", - "obsSec80MhzUtil" - ], - "type": "object", - "x-etsi-ref": "6.5.8" - }, - "GeoLocation": { - "properties": { - "altitude": { - "description": "The altitude value of location as defined in IETF RFC 6225 [6]", - "format": "int32", - "type": "integer", - "x-etsi-mec-cardinality": "0..1", - "x-etsi-mec-origin-type": "Uint32" - }, - "altitudeType": { - "description": "The type description for altitude information e.g. floors or meters as defined in IETF RFC 6225 [6]", - "format": "int32", - "type": "integer", - "x-etsi-mec-cardinality": "0..1", - "x-etsi-mec-origin-type": "Uint8" - }, - "altitudeUncertainty": { - "description": "The uncertainty for altitude information as defined in IETF RFC 6225 [6]", - "format": "int32", - "type": "integer", - "x-etsi-mec-cardinality": "0..1", - "x-etsi-mec-origin-type": "Uint8" - }, - "datum": { - "description": "The datum value to express how coordinates are organized and related to real world as defined in IETF RFC 6225 [6]", - "format": "int32", - "type": "integer", - "x-etsi-mec-cardinality": "1", - "x-etsi-mec-origin-type": "Uint8" - }, - "lat": { - "description": "The latitude value of location as defined in IETF RFC 6225 [6]", - "format": "int64", - "type": "integer", - "x-etsi-mec-cardinality": "1", - "x-etsi-mec-origin-type": "Uint64" - }, - "latUncertainty": { - "description": "The uncertainty for Latitude information as defined in IETF RFC 6225 [6]", - "format": "int32", - "type": "integer", - "x-etsi-mec-cardinality": "1", - "x-etsi-mec-origin-type": "Uint8" - }, - "long": { - "description": "The longitude value of location as defined in IETF RFC 6225 [6]", - "format": "int64", - "type": "integer", - "x-etsi-mec-cardinality": "1", - "x-etsi-mec-origin-type": "Uint64" - }, - "longUncertainty": { - "description": "The uncertainty for Longitude information as defined in IETF RFC 6225 [6]", - "format": "int32", - "type": "integer", - "x-etsi-mec-cardinality": "1", - "x-etsi-mec-origin-type": "Uint8" - } - }, - "required": [ - "latUncertainty", - "lat", - "longUncertainty", - "long", - "datum" - ], - "type": "object", - "x-etsi-ref": "6.5.19" - }, - "HeCapabilities": { - "properties": { - "heMacCapInfo": { - "description": "MAC capabilities of an Access Point.", - "type": "integer", - "x-etsi-mec-cardinality": "1", - "x-etsi-mec-origin-type": "Uint8" - }, - "hePhyCapinfo": { - "description": "PHY capabilities of an Access Point.", - "type": "integer", - "x-etsi-mec-cardinality": "1", - "x-etsi-mec-origin-type": "Uint8" - }, - "ppeThresholds": { - "description": "PPE Threshold determines the nominal packet padding value for a HE PPDU.", - "type": "integer", - "x-etsi-mec-cardinality": "0..1", - "x-etsi-mec-origin-type": "not defined" - }, - "supportedHeMcsNssSet": { - "description": "Supported MCS and NSS Set.", - "type": "integer", - "x-etsi-mec-cardinality": "1", - "x-etsi-mec-origin-type": "Uint8" - } - }, - "required": [ - "heMacCapInfo", - "hePhyCapinfo", - "supportedHeMcsNssSet" - ], - "type": "object", - "x-etsi-ref": "6.5.16" - }, - "HtCapabilities": { - "properties": { - "ampduParameters": { - "description": "A-MPDU parameters as defined in IEEE 802.11-2016 [8].", - "format": "int32", - "type": "integer", - "x-etsi-mec-cardinality": "1", - "x-etsi-mec-origin-type": "UInt8" - }, - "aselCap": { - "description": "ASEL capabilities as defined in IEEE 802.11-2016 [8].", - "format": "int32", - "type": "integer", - "x-etsi-mec-cardinality": "1", - "x-etsi-mec-origin-type": "UInt8" - }, - "htCapabilityInfo": { - "description": "HT Capability Information as defined in IEEE 802.11-2016 [8].", - "format": "int32", - "type": "integer", - "x-etsi-mec-cardinality": "1", - "x-etsi-mec-origin-type": "UInt16" - }, - "htExtendedCap": { - "description": "Extended HT Capabilities as defined in IEEE 802.11-2016 [8].", - "format": "int32", - "type": "integer", - "x-etsi-mec-cardinality": "1", - "x-etsi-mec-origin-type": "UInt16" - }, - "supportedMcsSet": { - "description": "Supported MCS set as defined in IEEE 802.11-2016 [8].", - "format": "int64", - "type": "integer", - "x-etsi-mec-cardinality": "1", - "x-etsi-mec-origin-type": "Uint128" - }, - "txBeamFormCap": { - "description": "Transmit Beamforming Capabilities as defined in IEEE 802.11-2016 [8].", - "format": "int32", - "type": "integer", - "x-etsi-mec-cardinality": "1", - "x-etsi-mec-origin-type": "UInt32" - } - }, - "required": [ - "htCapabilityInfo", - "ampduParameters", - "supportedMcsSet", - "htExtendedCap", - "txBeamFormCap", - "aselCap" - ], - "type": "object", - "x-etsi-ref": "6.5.1" - }, - "InlineNotification": { - "oneOf": [ - { - "$ref": "#/components/schemas/AssocStaNotification" - }, - { - "$ref": "#/components/schemas/StaDataRateNotification" - } - ], - "discriminator": { - "propertyName": "notificationType" - } - }, - "InlineSubscription": { - "oneOf": [ - { - "$ref": "#/components/schemas/AssocStaSubscription" - }, - { - "$ref": "#/components/schemas/StaDataRateSubscription" - } - ], - "discriminator": { - "propertyName": "subscriptionType" - } - }, - "LinkType": { - "properties": { - "href": { - "description": "URI referring to a resource", - "type": "string", - "x-etsi-mec-cardinality": "1", - "x-etsi-mec-origin-type": "String" - } - }, - "required": [ - "href" - ], - "type": "object", - "x-etsi-ref": "6.5.23" - }, - "MeasurementConfig": { - "properties": { - "beaconRequest": { - "$ref": "#/components/schemas/BeaconRequestConfig" - }, - "channelLoad": { - "$ref": "#/components/schemas/ChannelLoadConfig" - }, - "measurementDuration": { - "description": "Duration of the measurement, shall be lower than Maximum Measurement Duration in TU as defined in section 11.11.4 of IEEE 802.11 [8].", - "type": "integer", - "x-etsi-mec-cardinality": "1", - "x-etsi-mec-origin-type": "Integer" - }, - "measurementId": { - "description": "Identifier of this measurement configuration.", - "type": "string", - "x-etsi-mec-cardinality": "1", - "x-etsi-mec-origin-type": "String" - }, - "randomnInterval": { - "description": "Random interval to be used for starting the measurement. In units of TU as specifed in section 11.11.3 of IEEE 802.11 [8].", - "type": "integer", - "x-etsi-mec-cardinality": "1", - "x-etsi-mec-origin-type": "Integer" - }, - "staStatistics": { - "$ref": "#/components/schemas/StaStatisticsConfig" - } - }, - "required": [ - "measurementId", - "measurementDuration", - "randomnInterval" - ], - "type": "object", - "x-etsi-notes": "NOTE:\tThis element enables the configuration of the channelLoad, beaconRequest and staStatistics in a single resource data type, although only one of each measurement. Multiple measurement configurations of each kind are not allowed.", - "x-etsi-ref": "6.2.4" - }, - "NeighborReport": { - "properties": { - "bssid": { - "description": "BSS Id of the Access Point that is being reported.", - "type": "string", - "x-etsi-mec-cardinality": "1", - "x-etsi-mec-origin-type": "String" - }, - "bssidInfo": { - "description": "Additional information related to Access Point that is being reported such as AP reachability, security, key scope, Mobility Domain, HT/VHT capability and Fine Time Measurements.", - "format": "int32", - "type": "integer", - "x-etsi-mec-cardinality": "1", - "x-etsi-mec-origin-type": "UInt32" - }, - "channel": { - "description": "The channel currently used by this Access Point.", - "type": "integer", - "x-etsi-mec-cardinality": "1", - "x-etsi-mec-origin-type": "Uint8" - }, - "operatingClass": { - "description": "The channel set of the AP indicated by this BSSID.", - "type": "integer", - "x-etsi-mec-cardinality": "1", - "x-etsi-mec-origin-type": "Uint8" - }, - "phyType": { - "description": "PHY type of the AP indicated by this BSSID. It is an integer value coded according to the value of the dot11PHYType.", - "type": "integer", - "x-etsi-mec-cardinality": "1", - "x-etsi-mec-origin-type": "Uint8" - } - }, - "required": [ - "bssid", - "bssidInfo", - "operatingClass", - "channel", - "phyType" - ], - "type": "object", - "x-etsi-ref": "6.5.10" - }, - "ProblemDetails": { - "properties": { - "detail": { - "description": "A human-readable explanation specific to this occurrence of the problem", - "type": "string", - "x-etsi-mec-cardinality": "0..1", - "x-etsi-mec-origin-type": "String" - }, - "instance": { - "description": "A URI reference that identifies the specific occurrence of the problem", - "format": "uri", - "type": "string", - "x-etsi-mec-cardinality": "0..1", - "x-etsi-mec-origin-type": "URI" - }, - "status": { - "description": "The HTTP status code for this occurrence of the problem", - "format": "int32", - "type": "integer", - "x-etsi-mec-cardinality": "0..1", - "x-etsi-mec-origin-type": "Uint32" - }, - "title": { - "description": "A short, human-readable summary of the problem type", - "type": "string", - "x-etsi-mec-cardinality": "0..1", - "x-etsi-mec-origin-type": "String" - }, - "type": { - "description": "A URI reference according to IETF RFC 3986 that identifies the problem type", - "format": "uri", - "type": "string", - "x-etsi-mec-cardinality": "0..1", - "x-etsi-mec-origin-type": "URI" - } - }, - "type": "object" - }, - "Rssi": { - "properties": { - "rssi": { - "description": "The Received Signal Strength Indicator from a station", - "format": "int32", - "type": "integer", - "x-etsi-mec-cardinality": "1", - "x-etsi-mec-origin-type": "Uint8" - } - }, - "required": [ - "rssi" - ], - "type": "object", - "x-etsi-ref": "6.5.21" - }, - "StaDataRate": { - "properties": { - "staId": { - "$ref": "#/components/schemas/StaIdentity" - }, - "staLastDataDownlinkRate": { - "description": "The data transmit rate in kbps that was most recently used for transmission of data PPDUs from the access point to the station.", - "format": "int32", - "type": "integer", - "x-etsi-mec-cardinality": "0..1", - "x-etsi-mec-origin-type": "Uint32" - }, - "staLastDataUplinkRate": { - "description": "The data transmit rate in Kbps that was most recently used for transmission of data PPDUs from the associated station to the access point.", - "format": "int32", - "type": "integer", - "x-etsi-mec-cardinality": "0..1", - "x-etsi-mec-origin-type": "Uint32" - } - }, - "type": "object", - "x-etsi-ref": "6.5.22" - }, - "StaDataRateNotification": { - "properties": { - "notificationType": { - "description": "Shall be set to \"StaDataRateNotification\".", - "type": "string", - "x-etsi-mec-cardinality": "1", - "x-etsi-mec-origin-type": "String" - }, - "staDataRate": { - "description": "Data rates of a client station.", - "items": { - "$ref": "#/components/schemas/StaDataRate" - }, - "minItems": 0, - "type": "array", - "x-etsi-mec-cardinality": "0..N", - "x-etsi-mec-origin-type": "StaDataRate" - }, - "timeStamp": { - "$ref": "#/components/schemas/TimeStamp" - } - }, - "required": [ - "notificationType" - ], - "type": "object", - "x-etsi-ref": "6.4.3" - }, - "StaDataRateSubscription": { - "properties": { - "_links": { - "description": "Hyperlink related to the resource. This shall be only included in the HTTP responses and in HTTP PUT requests.", - "properties": { - "self": { - "$ref": "#/components/schemas/LinkType" - } - }, - "required": [ - "self" - ], - "type": "object", - "x-etsi-mec-cardinality": "0..1", - "x-etsi-mec-origin-type": "Structure (inlined)" - }, - "callbackReference": { - "description": "URI selected by the service consumer to receive notifications on the subscribed WLAN Access Information Service. This shall be included both in the request and in response.", - "format": "uri", - "type": "string", - "x-etsi-mec-cardinality": "1", - "x-etsi-mec-origin-type": "URI" - }, - "expiryDeadline": { - "$ref": "#/components/schemas/TimeStamp" - }, - "staId": { - "description": "Identifier(s) to uniquely specify the target client station(s) for the subscription", - "items": { - "$ref": "#/components/schemas/StaIdentity" - }, - "minItems": 1, - "type": "array", - "x-etsi-mec-cardinality": "1..N", - "x-etsi-mec-origin-type": "StaIdentity" - }, - "subscriptionType": { - "description": "Shall be set to \"StaDataRateSubscription\".", - "type": "string", - "x-etsi-mec-cardinality": "1", - "x-etsi-mec-origin-type": "String" - } - }, - "required": [ - "subscriptionType", - "callbackReference", - "staId" - ], - "type": "object", - "x-etsi-ref": "6.3.3" - }, - "StaIdentity": { - "properties": { - "aid": { - "description": "Number which identifies a particular association between a station and an Access Point ", - "type": "string", - "x-etsi-mec-cardinality": "0..1", - "x-etsi-mec-origin-type": "String" - }, - "ipAddress": { - "description": "IPv4 or IPv6 address allocated for the station.", - "items": { - "type": "string" - }, - "minItems": 0, - "type": "array", - "x-etsi-mec-cardinality": "0..N", - "x-etsi-mec-origin-type": "String" - }, - "macId": { - "description": "Unique identifier assigned to station (as network interface controller) for communications at the data link layer of a network segment.", - "type": "string", - "x-etsi-mec-cardinality": "1", - "x-etsi-mec-origin-type": "String" - }, - "ssid": { - "description": "Service Set Identifier to identify logical networks.", - "items": { - "type": "string" - }, - "minItems": 0, - "type": "array", - "x-etsi-mec-cardinality": "0..N", - "x-etsi-mec-origin-type": "String" - } - }, - "required": [ - "macId" - ], - "type": "object", - "x-etsi-ref": "6.5.11" - }, - "StaInfo": { - "properties": { - "apAssociated": { - "$ref": "#/components/schemas/ApAssociated" - }, - "beaconReport": { - "$ref": "#/components/schemas/BeaconReport" - }, - "channel": { - "description": "Channel currently used by the station.", - "format": "int32", - "type": "integer", - "x-etsi-mec-cardinality": "0..1", - "x-etsi-mec-origin-type": "Uint32" - }, - "rssi": { - "$ref": "#/components/schemas/Rssi" - }, - "staDataRate": { - "$ref": "#/components/schemas/StaDataRate" - }, - "staId": { - "$ref": "#/components/schemas/StaIdentity" - }, - "staStatistics": { - "$ref": "#/components/schemas/StaStatistics" - }, - "timeStamp": { - "$ref": "#/components/schemas/TimeStamp" - } - }, - "required": [ - "staId" - ], - "type": "object", - "x-etsi-ref": "6.2.3" - }, - "StaStatistics": { - "properties": { - "groupIdentity": { - "description": "Indicates the requested statistics group describing the Statistics Group Data according to table 9-114 of IEEE 802.11-2016 [8].", - "type": "integer", - "x-etsi-mec-cardinality": "1", - "x-etsi-mec-origin-type": "UInt8" - }, - "md": { - "description": "Measurement Duration.", - "type": "integer", - "x-etsi-mec-cardinality": "1", - "x-etsi-mec-origin-type": "UInt16" - }, - "statisticsGroupData": { - "$ref": "#/components/schemas/StatisticsGroupData", - "description": "Statistics Group Data as defined in Annex C of IEEE 802.112016 [8].", - "x-etsi-mec-cardinality": "1", - "x-etsi-mec-origin-type": "not specified" - } - }, - "required": [ - "md", - "groupIdentity", - "statisticsGroupData" - ], - "type": "object", - "x-etsi-ref": "6.5.13" - }, - "StaStatisticsConfig": { - "properties": { - "groupIdentity": { - "description": "As per table T 9-114 of IEEE 802.11-2012 [8].", - "type": "integer", - "x-etsi-mec-cardinality": "1", - "x-etsi-mec-origin-type": "Integer" - }, - "staId": { - "$ref": "#/components/schemas/StaIdentity" - }, - "triggerCondition": { - "type": "integer" - }, - "triggerTimeout": { - "description": "The Trigger Timeout field contains a value in units of 100 TUs during which a measuring STA does not generate further triggered STA Statistics Reports after a trigger condition has been met.", - "type": "integer", - "x-etsi-mec-cardinality": "1", - "x-etsi-mec-origin-type": "Integer" - }, - "triggeredReport": { - "type": "boolean" - } - }, - "required": [ - "staId", - "groupIdentity", - "triggeredReport", - "triggerTimeout", - "triggerCondition" - ], - "type": "object", - "x-etsi-ref": "6.5.26" - }, - "StatisticsGroupData": { - "properties": { - "dot11AMPDUDelimiterCRCErrorCount": { - "format": "int32", - "type": "integer", - "x-etsi-mec-cardinality": "0..1", - "x-etsi-mec-origin-type": "Uint32" - }, - "dot11AMPDUReceivedCount": { - "format": "int32", - "type": "integer", - "x-etsi-mec-cardinality": "0..1", - "x-etsi-mec-origin-type": "Uint32" - }, - "dot11AMSDUAckFailureCount": { - "format": "int32", - "type": "integer", - "x-etsi-mec-cardinality": "0..1", - "x-etsi-mec-origin-type": "Uint32" - }, - "dot11AckFailureCount": { - "format": "int32", - "type": "integer", - "x-etsi-mec-cardinality": "0..1", - "x-etsi-mec-origin-type": "Uint32" - }, - "dot11BeamformingFrameCount": { - "format": "int32", - "type": "integer", - "x-etsi-mec-cardinality": "0..1", - "x-etsi-mec-origin-type": "Uint32" - }, - "dot11ChannelWidthSwitchCount": { - "format": "int32", - "type": "integer", - "x-etsi-mec-cardinality": "0..1", - "x-etsi-mec-origin-type": "Uint32" - }, - "dot11DualCTSFailureCount": { - "format": "int32", - "type": "integer", - "x-etsi-mec-cardinality": "0..1", - "x-etsi-mec-origin-type": "Uint32" - }, - "dot11DualCTSSuccessCount": { - "format": "int32", - "type": "integer", - "x-etsi-mec-cardinality": "0..1", - "x-etsi-mec-origin-type": "Uint32" - }, - "dot11ExplicitBARFailureCount": { - "format": "int32", - "type": "integer", - "x-etsi-mec-cardinality": "0..1", - "x-etsi-mec-origin-type": "Uint32" - }, - "dot11FCSErrorCount": { - "format": "int32", - "type": "integer", - "x-etsi-mec-cardinality": "0..1", - "x-etsi-mec-origin-type": "Uint32" - }, - "dot11FailedAMSDUCount": { - "format": "int32", - "type": "integer", - "x-etsi-mec-cardinality": "0..1", - "x-etsi-mec-origin-type": "Uint32" - }, - "dot11FailedCount": { - "format": "int32", - "type": "integer", - "x-etsi-mec-cardinality": "0..1", - "x-etsi-mec-origin-type": "Uint32" - }, - "dot11FortyMHzFrameReceivedCount": { - "format": "int32", - "type": "integer", - "x-etsi-mec-cardinality": "0..1", - "x-etsi-mec-origin-type": "Uint32" - }, - "dot11FortyMHzFrameTransmittedCount": { - "format": "int32", - "type": "integer", - "x-etsi-mec-cardinality": "0..1", - "x-etsi-mec-origin-type": "Uint32" - }, - "dot11FrameDuplicateCount": { - "format": "int32", - "type": "integer", - "x-etsi-mec-cardinality": "0..1", - "x-etsi-mec-origin-type": "Uint32" - }, - "dot11GrantedRDGUnusedCount": { - "format": "int32", - "type": "integer", - "x-etsi-mec-cardinality": "0..1", - "x-etsi-mec-origin-type": "Uint32" - }, - "dot11GrantedRDGUsedCount": { - "format": "int32", - "type": "integer", - "x-etsi-mec-cardinality": "0..1", - "x-etsi-mec-origin-type": "Uint32" - }, - "dot11GroupReceivedFrameCount": { - "format": "int32", - "type": "integer", - "x-etsi-mec-cardinality": "0..1", - "x-etsi-mec-origin-type": "Uint32" - }, - "dot11GroupTransmittedFrameCount": { - "format": "int32", - "type": "integer", - "x-etsi-mec-cardinality": "0..1", - "x-etsi-mec-origin-type": "Uint32" - }, - "dot11ImplicitBARFailureCount": { - "format": "int32", - "type": "integer", - "x-etsi-mec-cardinality": "0..1", - "x-etsi-mec-origin-type": "Uint32" - }, - "dot11MPDUInReceivedAMPDUCount": { - "format": "int32", - "type": "integer", - "x-etsi-mec-cardinality": "0..1", - "x-etsi-mec-origin-type": "Uint32" - }, - "dot11MultipleRetryAMSDUCount": { - "format": "int32", - "type": "integer", - "x-etsi-mec-cardinality": "0..1", - "x-etsi-mec-origin-type": "Uint32" - }, - "dot11MultipleRetryCount": { - "format": "int32", - "type": "integer", - "x-etsi-mec-cardinality": "0..1", - "x-etsi-mec-origin-type": "Uint32" - }, - "dot11PSMPUTTGrantDuration": { - "format": "int32", - "type": "integer", - "x-etsi-mec-cardinality": "0..1", - "x-etsi-mec-origin-type": "Uint32" - }, - "dot11PSMPUTTUsedDuration": { - "format": "int32", - "type": "integer", - "x-etsi-mec-cardinality": "0..1", - "x-etsi-mec-origin-type": "Uint32" - }, - "dot11QosAckFailureCount": { - "format": "int32", - "type": "integer", - "x-etsi-mec-cardinality": "0..1", - "x-etsi-mec-origin-type": "Uint32" - }, - "dot11QosDiscardedFrameCount": { - "format": "int32", - "type": "integer", - "x-etsi-mec-cardinality": "0..1", - "x-etsi-mec-origin-type": "Uint32" - }, - "dot11QosFailedCount": { - "format": "int32", - "type": "integer", - "x-etsi-mec-cardinality": "0..1", - "x-etsi-mec-origin-type": "Uint32" - }, - "dot11QosFrameDuplicateCount": { - "format": "int32", - "type": "integer", - "x-etsi-mec-cardinality": "0..1", - "x-etsi-mec-origin-type": "Uint32" - }, - "dot11QosMPDUsReceivedCount": { - "format": "int32", - "type": "integer", - "x-etsi-mec-cardinality": "0..1", - "x-etsi-mec-origin-type": "Uint32" - }, - "dot11QosMultipleRetryCount": { - "format": "int32", - "type": "integer", - "x-etsi-mec-cardinality": "0..1", - "x-etsi-mec-origin-type": "Uint32" - }, - "dot11QosRTSFailureCount": { - "format": "int32", - "type": "integer", - "x-etsi-mec-cardinality": "0..1", - "x-etsi-mec-origin-type": "Uint32" - }, - "dot11QosRTSSuccessCount": { - "format": "int32", - "type": "integer", - "x-etsi-mec-cardinality": "0..1", - "x-etsi-mec-origin-type": "Uint32" - }, - "dot11QosReceivedFragmentCount": { - "format": "int32", - "type": "integer", - "x-etsi-mec-cardinality": "0..1", - "x-etsi-mec-origin-type": "Uint32" - }, - "dot11QosRetriesReceivedCount": { - "format": "int32", - "type": "integer", - "x-etsi-mec-cardinality": "0..1", - "x-etsi-mec-origin-type": "Uint32" - }, - "dot11QosRetryCount": { - "format": "int32", - "type": "integer", - "x-etsi-mec-cardinality": "0..1", - "x-etsi-mec-origin-type": "Uint32" - }, - "dot11QosTransmittedFragmentCount": { - "format": "int32", - "type": "integer", - "x-etsi-mec-cardinality": "0..1", - "x-etsi-mec-origin-type": "Uint32" - }, - "dot11QosTransmittedFrameCount": { - "format": "int32", - "type": "integer", - "x-etsi-mec-cardinality": "0..1", - "x-etsi-mec-origin-type": "Uint32" - }, - "dot11RSNAStatsBIPMICErrors": { - "format": "int32", - "type": "integer", - "x-etsi-mec-cardinality": "0..1", - "x-etsi-mec-origin-type": "Uint32" - }, - "dot11RSNAStatsCCMPDecryptErrors": { - "format": "int32", - "type": "integer", - "x-etsi-mec-cardinality": "0..1", - "x-etsi-mec-origin-type": "Uint32" - }, - "dot11RSNAStatsCCMPReplays": { - "format": "int32", - "type": "integer", - "x-etsi-mec-cardinality": "0..1", - "x-etsi-mec-origin-type": "Uint32" - }, - "dot11RSNAStatsCMACReplays": { - "format": "int32", - "type": "integer", - "x-etsi-mec-cardinality": "0..1", - "x-etsi-mec-origin-type": "Uint32" - }, - "dot11RSNAStatsRobustMgmtCCMPReplays": { - "format": "int32", - "type": "integer", - "x-etsi-mec-cardinality": "0..1", - "x-etsi-mec-origin-type": "Uint32" - }, - "dot11RSNAStatsTKIPICVErrors": { - "format": "int32", - "type": "integer", - "x-etsi-mec-cardinality": "0..1", - "x-etsi-mec-origin-type": "Uint32" - }, - "dot11RSNAStatsTKIPReplays": { - "format": "int32", - "type": "integer", - "x-etsi-mec-cardinality": "0..1", - "x-etsi-mec-origin-type": "Uint32" - }, - "dot11RTSFailureCount": { - "format": "int32", - "type": "integer", - "x-etsi-mec-cardinality": "0..1", - "x-etsi-mec-origin-type": "Uint32" - }, - "dot11RTSLSIGFailureCount": { - "format": "int32", - "type": "integer", - "x-etsi-mec-cardinality": "0..1", - "x-etsi-mec-origin-type": "Uint32" - }, - "dot11RTSLSIGSuccessCount": { - "format": "int32", - "type": "integer", - "x-etsi-mec-cardinality": "0..1", - "x-etsi-mec-origin-type": "Uint32" - }, - "dot11RTSSuccessCount": { - "format": "int32", - "type": "integer", - "x-etsi-mec-cardinality": "0..1", - "x-etsi-mec-origin-type": "Uint32" - }, - "dot11ReceivedAMSDUCount": { - "format": "int32", - "type": "integer", - "x-etsi-mec-cardinality": "0..1", - "x-etsi-mec-origin-type": "Uint32" - }, - "dot11ReceivedFragmentCount": { - "format": "int32", - "type": "integer", - "x-etsi-mec-cardinality": "0..1", - "x-etsi-mec-origin-type": "Uint32" - }, - "dot11ReceivedOctetsInAMPDUCount": { - "format": "int64", - "type": "integer", - "x-etsi-mec-cardinality": "0..1", - "x-etsi-mec-origin-type": "Uint64" - }, - "dot11ReceivedOctetsInAMSDUCount": { - "format": "int64", - "type": "integer", - "x-etsi-mec-cardinality": "0..1", - "x-etsi-mec-origin-type": "Uint64" - }, - "dot11RetryAMSDUCount": { - "format": "int32", - "type": "integer", - "x-etsi-mec-cardinality": "0..1", - "x-etsi-mec-origin-type": "Uint32" - }, - "dot11RetryCount": { - "format": "int32", - "type": "integer", - "x-etsi-mec-cardinality": "0..1", - "x-etsi-mec-origin-type": "Uint32" - }, - "dot11STAStatisticsAPAverageAccessDelay": { - "type": "integer", - "x-etsi-mec-cardinality": "0..1", - "x-etsi-mec-origin-type": "Uint8" - }, - "dot11STAStatisticsAverageAccessDelayBackGround": { - "type": "integer", - "x-etsi-mec-cardinality": "0..1", - "x-etsi-mec-origin-type": "Uint8" - }, - "dot11STAStatisticsAverageAccessDelayBestEffort": { - "type": "integer", - "x-etsi-mec-cardinality": "0..1", - "x-etsi-mec-origin-type": "Uint8" - }, - "dot11STAStatisticsAverageAccessDelayVideo": { - "type": "integer", - "x-etsi-mec-cardinality": "0..1", - "x-etsi-mec-origin-type": "Uint8" - }, - "dot11STAStatisticsAverageAccessDelayVoice": { - "type": "integer", - "x-etsi-mec-cardinality": "0..1", - "x-etsi-mec-origin-type": "Uint8" - }, - "dot11STAStatisticsChannelUtilization": { - "type": "integer", - "x-etsi-mec-cardinality": "0..1", - "x-etsi-mec-origin-type": "Uint8" - }, - "dot11STAStatisticsStationCount": { - "type": "integer", - "x-etsi-mec-cardinality": "0..1", - "x-etsi-mec-origin-type": "Uint8" - }, - "dot11STBCCTSFailureCount": { - "format": "int32", - "type": "integer", - "x-etsi-mec-cardinality": "0..1", - "x-etsi-mec-origin-type": "Uint32" - }, - "dot11STBCCTSSuccessCount": { - "format": "int32", - "type": "integer", - "x-etsi-mec-cardinality": "0..1", - "x-etsi-mec-origin-type": "Uint32" - }, - "dot11TransmittedAMPDUCount": { - "format": "int32", - "type": "integer", - "x-etsi-mec-cardinality": "0..1", - "x-etsi-mec-origin-type": "Uint32" - }, - "dot11TransmittedAMSDUCount": { - "format": "int32", - "type": "integer", - "x-etsi-mec-cardinality": "0..1", - "x-etsi-mec-origin-type": "Uint32" - }, - "dot11TransmittedFragmentCount": { - "format": "int32", - "type": "integer", - "x-etsi-mec-cardinality": "0..1", - "x-etsi-mec-origin-type": "Uint32" - }, - "dot11TransmittedFrameCount": { - "format": "int32", - "type": "integer", - "x-etsi-mec-cardinality": "0..1", - "x-etsi-mec-origin-type": "Uint32" - }, - "dot11TransmittedFramesInGrantedRDGCount": { - "format": "int32", - "type": "integer", - "x-etsi-mec-cardinality": "0..1", - "x-etsi-mec-origin-type": "Uint32" - }, - "dot11TransmittedMPDUsInAMPDUCount": { - "format": "int32", - "type": "integer", - "x-etsi-mec-cardinality": "0..1", - "x-etsi-mec-origin-type": "Uint32" - }, - "dot11TransmittedOctetsInAMPDUCount": { - "format": "int64", - "type": "integer", - "x-etsi-mec-cardinality": "0..1", - "x-etsi-mec-origin-type": "Uint64" - }, - "dot11TransmittedOctetsInAMSDUCount": { - "format": "int64", - "type": "integer", - "x-etsi-mec-cardinality": "0..1", - "x-etsi-mec-origin-type": "Uint32" - }, - "dot11TransmittedOctetsInGrantedRDGCount": { - "format": "int32", - "type": "integer", - "x-etsi-mec-cardinality": "0..1", - "x-etsi-mec-origin-type": "Uint32" - }, - "dot11TwentyMHzFrameReceivedCount": { - "format": "int32", - "type": "integer", - "x-etsi-mec-cardinality": "0..1", - "x-etsi-mec-origin-type": "Uint32" - }, - "dot11TwentyMHzFrameTransmittedCount": { - "format": "int32", - "type": "integer", - "x-etsi-mec-cardinality": "0..1", - "x-etsi-mec-origin-type": "Uint32" - }, - "dot11nonSTBCCTSFailureCount": { - "format": "int32", - "type": "integer", - "x-etsi-mec-cardinality": "0..1", - "x-etsi-mec-origin-type": "Uint32" - }, - "dot11nonSTBCCTSSuccessCount": { - "format": "int32", - "type": "integer", - "x-etsi-mec-cardinality": "0..1", - "x-etsi-mec-origin-type": "Uint32" - } - }, - "type": "object" - }, - "SubscriptionLinkList": { - "properties": { - "_links": { - "description": "Hyperlink related to the resource. This shall be only included in the HTTP responses and in HTTP PUT requests.", - "properties": { - "self": { - "$ref": "#/components/schemas/LinkType" - } - }, - "type": "object", - "x-etsi-mec-cardinality": "0..1", - "x-etsi-mec-origin-type": "Structure (inlined)" - }, - "assocStaSubscription": { - "items": { - "$ref": "#/components/schemas/AssocStaSubscription" - }, - "type": "array", - "x-etsi-mec-cardinality": "0..N", - "x-etsi-mec-origin-type": "AssocStaSubscription" - }, - "staDataRateSubscription": { - "items": { - "$ref": "#/components/schemas/StaDataRateSubscription" - }, - "type": "array", - "x-etsi-mec-cardinality": "0..N", - "x-etsi-mec-origin-type": "StaDataRateSubscription" - } - }, - "required": [ - "_links" - ], - "type": "object" - }, - "TimeStamp": { - "properties": { - "nanoSeconds": { - "description": "The nanoseconds part of the time. Time is defined as Unix-time since January 1, 1970, 00:00:00 UTC.", - "format": "int32", - "type": "integer", - "x-etsi-mec-cardinality": "1", - "x-etsi-mec-origin-type": "Uint32" - }, - "seconds": { - "description": "The seconds part of the time. Time is defined as Unixtime since January 1, 1970, 00:00:00 UTC.", - "format": "int32", - "type": "integer", - "x-etsi-mec-cardinality": "1", - "x-etsi-mec-origin-type": "Uint32" - } - }, - "required": [ - "seconds", - "nanoSeconds" - ], - "type": "object", - "x-etsi-ref": "6.5.2" - }, - "VhtCapabilities": { - "properties": { - "vhtCapInfo": { - "description": "VHT capabilities Info as defined in IEEE 802.11-2016 [8].", - "format": "int32", - "type": "integer", - "x-etsi-mec-cardinality": "1", - "x-etsi-mec-origin-type": "UInt32" - }, - "vhtMcsNss": { - "description": "Supported VHT-MCS and NSS Set as defined in IEEE 802.11-2016 [8].", - "format": "int64", - "type": "integer", - "x-etsi-mec-cardinality": "1", - "x-etsi-mec-origin-type": "UInt64" - } - }, - "required": [ - "vhtCapInfo", - "vhtMcsNss" - ], - "type": "object", - "x-etsi-ref": "6.5.15" - }, - "WanMetrics": { - "properties": { - "downlinkLoad": { - "description": "1-octet positive integer representing the current percentage loading of the downlink WAN connection, scaled linearly with 255 representing 100 %, as measured over an interval the duration of which is reported in Load Measurement Duration. In cases where the downlink load is unknown to the AP, the value is set to zero.", - "format": "int32", - "type": "integer", - "x-etsi-mec-cardinality": "1", - "x-etsi-mec-origin-type": "UInt8" - }, - "downlinkSpeed": { - "description": "4-octet positive integer whose value is an estimate of the WAN Backhaul link current downlink speed in kilobits per second.", - "format": "int32", - "type": "integer", - "x-etsi-mec-cardinality": "1", - "x-etsi-mec-origin-type": "Uint32" - }, - "lmd": { - "description": "The LMD (Load Measurement Duration) field is a 2-octet positive integer representing the duration over which the Downlink Load and Uplink Load have been measured, in tenths of a second. When the actual load measurement duration is greater than the maximum value, the maximum value will be reported. The value of the LMD field is set to 0 when neither the uplink nor downlink load can be computed. When the uplink and downlink loads are computed over different intervals, the maximum interval is reported.", - "format": "int32", - "type": "integer", - "x-etsi-mec-cardinality": "1", - "x-etsi-mec-origin-type": "Uint16" - }, - "uplinkLoad": { - "description": "1-octet positive integer representing the current percentage loading of the uplink WAN connection, scaled linearly with 255 representing 100 %, as measured over an interval, the duration of which is reported in Load Measurement Duration. In cases where the uplink load is unknown to the AP, the value is set to zero.", - "format": "int32", - "type": "integer", - "x-etsi-mec-cardinality": "1", - "x-etsi-mec-origin-type": "Uint8" - }, - "uplinkSpeed": { - "description": "4-octet positive integer whose value is an estimate of the WAN Backhaul link's current uplink speed in kilobits per second.", - "format": "int32", - "type": "integer", - "x-etsi-mec-cardinality": "1", - "x-etsi-mec-origin-type": "UInt32" - }, - "wanInfo": { - "description": "Info about WAN link status, link symmetricity and capacity currently used.", - "format": "int32", - "type": "integer", - "x-etsi-mec-cardinality": "1", - "x-etsi-mec-origin-type": "Uint8" - } - }, - "required": [ - "wanInfo", - "downlinkSpeed", - "uplinkSpeed", - "downlinkLoad", - "uplinkLoad", - "lmd" - ], - "type": "object", - "x-etsi-ref": "6.5.6" - }, - "WlanCapabilities": { - "properties": { - "dmg": { - "$ref": "#/components/schemas/DmgCapabilities" - }, - "edmg": { - "$ref": "#/components/schemas/EdmgCapabilities" - }, - "he": { - "$ref": "#/components/schemas/HeCapabilities" - }, - "ht": { - "$ref": "#/components/schemas/HtCapabilities" - }, - "vht": { - "$ref": "#/components/schemas/VhtCapabilities" - } - }, - "type": "object", - "x-etsi-ref": "6.5.4" - } - } - } -} \ No newline at end of file +openapi: 3.0.0 +info: + contact: + url: https://forge.etsi.org/rep/mec/gs028-wai-api + title: ETSI GS MEC 028 - WLAN Access Information API + version: 2.1.1 + description: The ETSI MEC ISG MEC028 WLAN Access Information API described using OpenAPI + license: + name: BSD-3-Clause + url: 'https://forge.etsi.org/legal-matters' +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' +servers: + - url: 'https://localhost/wai/v2' +tags: +- name: "wai" +paths: + /queries/ap/ap_information: + get: + tags: + - 'wai' + summary: 'Retrieve information on existing Access Points' + description: 'Queries information about existing WLAN Access Points' + operationId: apInfoGET + parameters: + - $ref: '#/components/parameters/Query.Filter' + - $ref: '#/components/parameters/Query.AllFields' + - $ref: '#/components/parameters/Query.Fields' + - $ref: '#/components/parameters/Query.ExcludeFields' + - $ref: '#/components/parameters/Query.ExcludeDefault' + responses: + '200': + description: Successful response to ap_info request + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/ApInfo' + '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': + $ref: '#/components/responses/429' + /queries/sta/sta_information: + get: + tags: + - 'wai' + summary: 'Retrieve information on existing Stations' + description: 'Queries information about existing WLAN stations' + operationId: staInfoGET + parameters: + - $ref: '#/components/parameters/Query.Filter' + - $ref: '#/components/parameters/Query.AllFields' + - $ref: '#/components/parameters/Query.Fields' + - $ref: '#/components/parameters/Query.ExcludeFields' + - $ref: '#/components/parameters/Query.ExcludeDefault' + responses: + '200': + description: Successful response to sta_info request + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/StaInfo' + '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': + $ref: '#/components/responses/429' + /subscriptions: + get: + tags: + - 'wai' + summary: 'Retrieve information on subscriptions for notifications' + description: 'Queries information on subscriptions for notifications' + operationId: subscriptionLinkList_subscriptionsGET + parameters: + - $ref: '#/components/parameters/Query.SubscriptionType' + responses: + '200': + description: 'Response body contains the list of links to requestors subscriptions.' + content: + application/json: + schema: + $ref: '#/components/schemas/SubscriptionLinkList' + example: + _links: + self: + href: 'http://meAppServer.example.com/wai/v2/subscriptions' + subscription: + - _links: + self: + href: 'http://meAppServer.example.com/wai/v2/subscriptions/sub123' + callbackReference: 'http://my.callback.com/wai/assocStaSubscription/some-id' + subscriptionType: AssocStaSubscription + '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': + $ref: '#/components/responses/429' + post: + tags: + - 'wai' + summary: 'Create a new subscription' + description: 'Creates a new subscription to WLAN Access Information notifications' + operationId: subscriptionsPOST + requestBody: + description: Subscription to be created + required: true + content: + application/json: + schema: + $ref: '#/components/schemas/InlineSubscription' + example: + subscriptionType: AssocStaSubscription + callbackReference: 'http://meAppClient.example.com/wai/v2/notifications/1' + expiryDeadline: + seconds: 1977836800 + nanoSeconds: 0 + apId: + macId: 005C0A0A0A0A + ssid: 'myNetworkSsid' + ipAddress: 10.10.100.1 + responses: + '201': + description: Successful subscription response + content: + application/json: + schema: + $ref: '#/components/schemas/InlineSubscription' + example: + subscriptionType: AssocStaSubscription + callbackReference: 'http://meAppClient.example.com/wai/v2/notifications/1' + _links: + self: + href: 'http://meAppServer.example.com/wai/v2/subscriptions/sub123' + expiryDeadline: + seconds: 1977836800 + nanoSeconds: 0 + apId: + macId: 005C0A0A0A0A + ssid: 'myNetworkSsid' + ipAddress: 10.10.100.1 + '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': + $ref: '#/components/responses/415' + '422': + $ref: '#/components/responses/422' + '429': + $ref: '#/components/responses/429' + callbacks: + notification: + '{$request.body#/callbackReference}': + post: + summary: 'Callback POST used to send a notification' + description: 'Notification from WAIS, content based on subscription type' + operationId: notificationPOST + requestBody: + description: Subscription notification + required: true + content: + application/json: + schema: + $ref: '#/components/schemas/InlineNotification' + example: + notificationType: AssocStaNotification + timeStamp: + seconds: 1977836800 + nanoseconds: 0 + apId: + macId: 005C0A0A0A0A + ssid: 'myNetworkSsid' + ipAddress: 10.10.100.1 + staId: + macId: 005C01111111 + ssid: + - 'myNetworkSsid' + - 'myOtherNetworkSsid' + aid: '1122' + ipAddress: 10.10.1.255 + responses: + '204': + $ref: '#/components/responses/204' + '/subscriptions/{subscriptionId}': + get: + tags: + - 'wai' + summary: 'Retrieve information on current specific subscription' + description: 'Queries information about an existing subscription, identified by its self-referring URI returned on creation (initial POST)' + operationId: subscriptionsGET + parameters: + - $ref: '#/components/parameters/Path.subscrId' + responses: + '200': + description: Subscription information regarding subscription notifications + content: + application/json: + schema: + $ref: '#/components/schemas/InlineSubscription' + example: + subscriptionType: AssocStaSubscription + callbackReference: 'http://meAppClient.example.com/wai/v2/notifications/1' + _links: + self: + href: 'http://meAppServer.example.com/wai/v2/subscriptions/sub123' + expiryDeadline: + seconds: 1977836800 + nanoSeconds: 0 + apId: + macId: 005C0A0A0A0A + ssid: 'myNetworkSsid' + ipAddress: 10.10.100.1 + '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': + $ref: '#/components/responses/429' + put: + tags: + - 'wai' + summary: 'Modify an existing subscription' + description: 'Updates an existing subscription, identified by its self-referring URI returned on creation (initial POST)' + operationId: subscriptionsPUT + requestBody: + description: Subscription to be modified + required: true + content: + application/json: + schema: + $ref: '#/components/schemas/InlineSubscription' + example: + subscriptionType: AssocStaSubscription + callbackReference: 'http://meAppClient.example.com/wai/v2/notifications/1' + _links: + self: + href: 'http://meAppServer.example.com/wai/v2/subscriptions/sub123' + expiryDeadline: + seconds: 1977836800 + nanoSeconds: 0 + apId: + macId: 005C0A0A0A0A + ssid: 'myNetworkSsid' + ipAddress: 10.10.100.1 + parameters: + - $ref: '#/components/parameters/Path.subscrId' + responses: + '200': + description: Successful subscription modification + content: + application/json: + schema: + $ref: '#/components/schemas/InlineSubscription' + example: + _links: + self: + href: 'http://[hostIP]/sbox-xyz123/wai/v2/subscriptions/sub123' + callbackReference: 'http://my.callback.com/wai/some-id' + apId: + macId: 005C0A0A0A0A + '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 an existing subscription' + description: 'Cancels an existing subscription, identified by its self-referring URI returned on creation (initial POST)' + operationId: subscriptionsDELETE + parameters: + - $ref: '#/components/parameters/Path.subscrId' + 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' + 406: + description: 'Not Acceptable : used to indicate that the server cannot provide the any of the content formats supported by the client.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/ProblemDetails' + 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' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/ProblemDetails' + 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' + 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.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/ProblemDetails' + 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 + 429: + description: 'Too Many Requests : used when a rate limiter has triggered.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/ProblemDetails' + parameters: + Path.subscrId: + name: subscriptionId + in: path + description: 'Subscription Id, specifically the "self" returned in the subscription request' + required: true + schema: + type: string + format: uri + 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 + 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 + 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 + 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: + type: string + Query.ExcludeDefault: + name: exclude_default + in: query + description: 'Indicates to exclude the following complex attributes from the response. See clause 6.18 of ETSI GS MEC 009 for details. + The following attributes shall be excluded from the structure in the response body if this parameter is provided, or none of the parameters + "all_fields", "fields", "exclude_fields", "exclude_default" are provided: Not applicable' + required: false + schema: + type: array + items: + type: string + Query.SubscriptionType: + name: subscription_type + in: query + description: 'Filter on a specific subscription type. Permitted values: assoc_sta, sta_data_rate.' + required: false + schema: + type: string + schemas: + ApAssociated: + properties: + assocId: + description: Unique number which identifies a particular association between the station and Access Point. + type: string + x-etsi-mec-cardinality: 0..1 + x-etsi-mec-origin-type: string + ipAddress: + description: IPv4 or IPv6 address allocated for the Access Point. + items: + type: string + minItems: 0 + type: array + x-etsi-mec-cardinality: 0..N + x-etsi-mec-origin-type: string + macId: + description: Unique identifier assigned to the Access Point (as network interface controller) for communications at the data link layer of a network segment. + type: string + x-etsi-mec-cardinality: '1' + x-etsi-mec-origin-type: string + ssid: + description: Service Set Identifier to identify logical networks. + items: + type: string + minItems: 0 + type: array + x-etsi-mec-cardinality: 0..N + x-etsi-mec-origin-type: String + required: + - macId + type: object + x-etsi-ref: 6.5.12 + ApIdentity: + properties: + ipAddress: + description: IPv4 or IPv6 address allocated for the Access Point. + items: + type: string + minItems: 0 + type: array + x-etsi-mec-cardinality: 0..N + x-etsi-mec-origin-type: String + macId: + description: Unique Identifier assigned to an Access Point (as network interface controller) for communications at the data link layer of a network segment. + type: string + x-etsi-mec-cardinality: '1' + x-etsi-mec-origin-type: String + ssid: + description: Service Set Identifier to identify logical networks including Basic Service Set and Extended Service Set. + items: + type: string + minItems: 0 + type: array + x-etsi-mec-cardinality: 0..N + x-etsi-mec-origin-type: String + required: + - macId + type: object + x-etsi-ref: 6.5.3 + ApInfo: + properties: + apId: + # description': Identifier(s) to uniquely specify the Access Point whose information is exposed within this data type. + # x-etsi-mec-cardinality': '1' + # x-etsi-mec-origin-type': ApIdentity + $ref: '#/components/schemas/ApIdentity' + apLocation: + # description': The location on the Access Point. + # x-etsi-mec-cardinality': 0..1 + # x-etsi-mec-origin-type': ApLocation + $ref: '#/components/schemas/ApLocation' + apNeighbor: + # description': Information about neighbor Access Points. + # x-etsi-mec-cardinality': 0..1 + # x-etsi-mec-origin-type': NeighborReport + $ref: '#/components/schemas/NeighborReport' + bssLoad: + # description': BSS Load attribute contains information on the current STA population and traffic levels in the BSS as defined in IEEE 802.11-2016 [8]. + # x-etsi-mec-cardinality': 0..1 + # x-etsi-mec-origin-type': BssLoad + $ref: '#/components/schemas/BssLoad' + channel: + description: Channel configured for the Access Point. + format: int32 + type: integer + x-etsi-mec-cardinality: 0..1 + x-etsi-mec-origin-type: Uint32 + extBssLoad: + # description': Extended BSS Load attribute contains more detailed information on the current STA population and traffic levels in the BSS as per ETSI GS MEC 002 [i.4]. + # x-etsi-mec-cardinality': 0..1 + # x-etsi-mec-origin-type': ExtBssLoad + $ref: '#/components/schemas/ExtBssLoad' + timeStamp: + # description': Time stamp. + # x-etsi-mec-cardinality': 0..1 + # x-etsi-mec-origin-type': TimeStamp + $ref: '#/components/schemas/TimeStamp' + wanMetrics: + # description': WAN Metrics element provides information about the WAN link connecting an IEEE 802.11 Access Node and the Internet. Transmission characteristics such as the speed of the WAN connection to the Internet are included in Hotspot 2.0 Technical Specification v1.0.0 [i.3]. + # x-etsi-mec-cardinality': 0..1 + # x-etsi-mec-origin-type': WanMetrics + $ref: '#/components/schemas/WanMetrics' + wlanCap: + # description': WLAN capabilities of Access Point. + # x-etsi-mec-cardinality': 0..1 + # x-etsi-mec-origin-type': WlanCapabilities + $ref: '#/components/schemas/WlanCapabilities' + required: + - apId + type: object + x-etsi-ref: 6.2.2 + ApLocation: + properties: + civicLocation: + # description': Civic Location of the AP as described in IETF RFC 4776 [7]. + # x-etsi-mec-cardinality': 0..1 + # x-etsi-mec-origin-type': CivicLocation + $ref: '#/components/schemas/CivicLocation' + geolocation: + # description': Geospatial Location of the AP as defined in IEEE 802.11-2016 [8]. + # x-etsi-mec-cardinality': 0..1 + # x-etsi-mec-origin-type': GeoLocation + $ref: '#/components/schemas/GeoLocation' + type: object + x-etsi-ref: 6.5.9 + AssocStaNotification: + properties: + apId: + # description': Identifier(s) to uniquely specify the Access Point to which the client stations are associated. + # x-etsi-mec-cardinality': '1' + # x-etsi-mec-origin-type': ApIdentity + $ref: '#/components/schemas/ApIdentity' + notificationType: + description: Shall be set to "AssocStaNotification". + type: string + x-etsi-mec-cardinality: '1' + x-etsi-mec-origin-type: String + staId: + description: Identifier(s) to uniquely specify the client station(s) associated. + items: + $ref: '#/components/schemas/StaIdentity' + minItems: 0 + type: array + x-etsi-mec-cardinality: 0..N + x-etsi-mec-origin-type: StaIdentity + timeStamp: + # description': Time stamp. + # x-etsi-mec-cardinality': 0..1 + # x-etsi-mec-origin-type': TimeStamp + $ref: '#/components/schemas/TimeStamp' + required: + - notificationType + - apId + type: object + x-etsi-ref: 6.4.2 + AssocStaSubscription: + properties: + _links: + description: Hyperlink related to the resource. This shall be only included in the HTTP responses and in HTTP PUT requests. + properties: + self: + # description': Self referring URI. The URI shall be unique within the WLAN information API as it acts as an ID for the subscription. + # x-etsi-mec-cardinality': '1' + # x-etsi-mec-origin-type': LinkType + $ref: '#/components/schemas/LinkType' + required: + - self + type: object + x-etsi-mec-cardinality: 0..1 + x-etsi-mec-origin-type: Structure (inlined) + apId: + # description': Identifier(s) to uniquely specify the target Access Point for the subscription + # x-etsi-mec-cardinality': '1' + # x-etsi-mec-origin-type': ApIdentity + $ref: '#/components/schemas/ApIdentity' + callbackReference: + description: URI selected by the service consumer to receive notifications on the subscribed WLAN information. This shall be included both in the request and in response. + format: uri + type: string + x-etsi-mec-cardinality: '1' + x-etsi-mec-origin-type: URI + expiryDeadline: + # description': The expiration time of the subscription determined by the WLAN Access Information Service. + # x-etsi-mec-cardinality': 0..1 + # x-etsi-mec-origin-type': TimeStamp + $ref: '#/components/schemas/TimeStamp' + subscriptionType: + description: Shall be set to "AssocStaSubscription". + type: string + x-etsi-mec-cardinality: '1' + x-etsi-mec-origin-type: String + required: + - subscriptionType + - callbackReference + - apId + type: object + x-etsi-ref: 6.3.2 + AssociatedStations: + properties: + assocId: + description: Unique number which identifies a particular association between an Access Point and a station. + type: string + x-etsi-mec-cardinality: 0..1 + x-etsi-mec-origin-type: string + ipAddress: + description: IPv4 or IPv6 address allocated for the station associated with the Access Point. + items: + type: string + minItems: 0 + type: array + x-etsi-mec-cardinality: 0..N + x-etsi-mec-origin-type: string + macId: + description: Unique identifier assigned to a station (as network interface controller) for communications at the data link layer of a network segment. + type: string + x-etsi-mec-cardinality: '1' + x-etsi-mec-origin-type: string + required: + - macId + type: object + x-etsi-ref: 6.5.5 + BeaconReport: + properties: + bssId: + description: The BSSID field indicates the BSSID of the BSS(s) for which a beacon report has been received. + items: + type: string + minItems: 1 + type: array + x-etsi-mec-cardinality: 1..N + x-etsi-mec-origin-type: String + channelId: + description: Channel number where the beacon was received. + type: integer + x-etsi-mec-cardinality: '1' + x-etsi-mec-origin-type: Integer + measurementId: + description: Measurement ID of the Measurement configuration applied to this Beacon Report. + type: string + x-etsi-mec-cardinality: '1' + x-etsi-mec-origin-type: String + reportingCondition: + description: As in table T9-89 of IEEE 802.11-2012 [8]. + type: integer + x-etsi-mec-cardinality: '1' + x-etsi-mec-origin-type: Integer + ssId: + description: (Optional) The SSID subelement indicates the ESS(s) or IBSS(s) for which a beacon report is received. + items: + type: string + minItems: 1 + type: array + x-etsi-mec-cardinality: 1..N + x-etsi-mec-origin-type: String + staId: + # description': Identifier to uniquely specify the station whose information is exposed within this data type. + # x-etsi-mec-cardinality': '1' + # x-etsi-mec-origin-type': StaIdentity + $ref: '#/components/schemas/StaIdentity' + required: + - staId + - measurementId + - channelId + - bssId + - ssId + - reportingCondition + type: object + x-etsi-ref: 6.5.27 + BeaconRequestConfig: + properties: + bssId: + description: The BSSID field indicates the BSSID of the BSS(s) for which a beacon report is requested. When requesting beacon reports for all BSSs on the channel, the BSSID field contains the wildcard BSSID. + items: + type: string + minItems: 1 + type: array + x-etsi-mec-cardinality: 1..N + x-etsi-mec-origin-type: String + channelId: + description: Channel number to scan. A Channel Number of 0 indicates a request to make iterative measurements for all supported channels in the Operating Class where the measurement is permitted on the channel and the channel is valid for the current regulatory domain. A Channel Number of 255 indicates a request to make iterative measurements for all supported channels in the current Operating Class listed in the latest AP Channel Report received from the serving AP. + type: integer + x-etsi-mec-cardinality: '1' + x-etsi-mec-origin-type: Integer + measurementMode: + description: '0 for passive. + + 1 for active. + + 2 for beacon table.' + type: integer + x-etsi-mec-cardinality: '1' + x-etsi-mec-origin-type: Integer + reportingCondition: + description: As in table T9-89 of IEEE 802.11-2012 [8]. + type: integer + x-etsi-mec-cardinality: '1' + x-etsi-mec-origin-type: Integer + ssId: + description: (Optional) The SSID subelement indicates the ESS(s) or IBSS(s) for which a beacon report is requested. + items: + type: string + minItems: 1 + type: array + x-etsi-mec-cardinality: 1..N + x-etsi-mec-origin-type: String + staId: + # description': Identifier to uniquely specify the station whose information is exposed within this data type. + # x-etsi-mec-cardinality': '1' + # x-etsi-mec-origin-type': StaIdentity + $ref: '#/components/schemas/StaIdentity' + required: + - staId + - channelId + - measurementMode + - bssId + - ssId + - reportingCondition + type: object + x-etsi-ref: 6.5.25 + BssLoad: + properties: + availAdmCap: + description: Available Admission Capacity that specifies the remaining amount of medium time available via explicit admission control, in units of 32 s/s. + format: int32 + type: integer + x-etsi-mec-cardinality: '1' + x-etsi-mec-origin-type: Uint16 + channelUtilization: + description: "The percentage of time, linearly scaled with 255 representing 100\_%, that the AP sensed the medium was busy, as indicated by either the physical or virtual Carrier Sense (CS) mechanism." + format: int32 + type: integer + x-etsi-mec-cardinality: '1' + x-etsi-mec-origin-type: UInt8 + staCount: + description: An unsigned integer that indicates the total number of STAs currently associated with this BSS. + format: int32 + type: integer + x-etsi-mec-cardinality: '1' + x-etsi-mec-origin-type: UInt16 + required: + - staCount + - channelUtilization + - availAdmCap + type: object + x-etsi-ref: 6.5.7 + ChannelLoadConfig: + properties: + apId: + # description': Identifier(s) to uniquely specify the target Access Point + # x-etsi-mec-cardinality': '1' + # x-etsi-mec-origin-type': ApIdentity + $ref: '#/components/schemas/ApIdentity' + cChannelId: + description: Channel number which load is reported + type: integer + x-etsi-mec-cardinality: '1' + x-etsi-mec-origin-type: Integer + channelLoad: + description: Channel load as per IEEE 802.11-2012 [8], section 11.11.9.3 + type: integer + x-etsi-mec-cardinality: '1' + x-etsi-mec-origin-type: Integer + required: + - apId + - cChannelId + - channelLoad + type: object + x-etsi-ref: 6.5.24 + CivicLocation: + properties: + ca0: + description: Language + type: string + x-etsi-mec-cardinality: 0..1 + x-etsi-mec-origin-type: String + ca1: + description: 'National subdivisions (state, canton, region,province, prefecture) ' + type: string + x-etsi-mec-cardinality: 0..1 + x-etsi-mec-origin-type: String + ca128: + description: Script + type: string + x-etsi-mec-cardinality: 0..1 + x-etsi-mec-origin-type: String + ca16: + description: Leading street direction + type: string + x-etsi-mec-cardinality: 0..1 + x-etsi-mec-origin-type: String + ca17: + description: Trailing street suffix + type: string + x-etsi-mec-cardinality: 0..1 + x-etsi-mec-origin-type: String + ca18: + description: Street suffix or type + type: string + x-etsi-mec-cardinality: 0..1 + x-etsi-mec-origin-type: String + ca19: + description: House number + type: string + x-etsi-mec-cardinality: 0..1 + x-etsi-mec-origin-type: String + ca2: + description: County, parish, gun (JP), district (IN) + type: string + x-etsi-mec-cardinality: 0..1 + x-etsi-mec-origin-type: String + ca20: + description: House number suffix + type: string + x-etsi-mec-cardinality: 0..1 + x-etsi-mec-origin-type: String + ca21: + description: Landmark of vanity address + type: string + x-etsi-mec-cardinality: 0..1 + x-etsi-mec-origin-type: String + ca22: + description: Additional location information + type: string + x-etsi-mec-cardinality: 0..1 + x-etsi-mec-origin-type: String + ca23: + description: Name (residence and office occupant) + type: string + x-etsi-mec-cardinality: 0..1 + x-etsi-mec-origin-type: String + ca24: + description: Postal/zip code + type: string + x-etsi-mec-cardinality: 0..1 + x-etsi-mec-origin-type: String + ca25: + description: Building (structure) + type: string + x-etsi-mec-cardinality: 0..1 + x-etsi-mec-origin-type: String + ca26: + description: Unit (apartment/suite) + type: string + x-etsi-mec-cardinality: 0..1 + x-etsi-mec-origin-type: String + ca27: + description: Floor + type: string + x-etsi-mec-cardinality: 0..1 + x-etsi-mec-origin-type: String + ca28: + description: Room + type: string + x-etsi-mec-cardinality: 0..1 + x-etsi-mec-origin-type: String + ca29: + description: Type of place + type: string + x-etsi-mec-cardinality: 0..1 + x-etsi-mec-origin-type: String + ca3: + description: City, township, shi (JP) + type: string + x-etsi-mec-cardinality: 0..1 + x-etsi-mec-origin-type: String + ca30: + description: Postal community name + type: string + x-etsi-mec-cardinality: 0..1 + x-etsi-mec-origin-type: String + ca31: + description: Post office box + type: string + x-etsi-mec-cardinality: 0..1 + x-etsi-mec-origin-type: String + ca32: + description: Additional code + type: string + x-etsi-mec-cardinality: 0..1 + x-etsi-mec-origin-type: String + ca33: + description: Seat (desk.cubicle, workstation) + type: string + x-etsi-mec-cardinality: 0..1 + x-etsi-mec-origin-type: String + ca34: + description: Primary road name + type: string + x-etsi-mec-cardinality: 0..1 + x-etsi-mec-origin-type: String + ca35: + description: Road section + type: string + x-etsi-mec-cardinality: 0..1 + x-etsi-mec-origin-type: String + ca36: + description: Branch road name + type: string + x-etsi-mec-cardinality: 0..1 + x-etsi-mec-origin-type: String + ca37: + description: Sub-branch road name + type: string + x-etsi-mec-cardinality: 0..1 + x-etsi-mec-origin-type: String + ca38: + description: Street name pre-modifier + type: string + x-etsi-mec-cardinality: 0..1 + x-etsi-mec-origin-type: String + ca39: + description: Street name post-modifier + type: string + x-etsi-mec-cardinality: 0..1 + x-etsi-mec-origin-type: String + ca4: + description: City division, borough, city district, ward, chou (JP) + type: string + x-etsi-mec-cardinality: 0..1 + x-etsi-mec-origin-type: String + ca5: + description: Neighborhood, block + type: string + x-etsi-mec-cardinality: 0..1 + x-etsi-mec-origin-type: String + ca6: + description: 'Group of streets below the neighborhood level ' + type: string + x-etsi-mec-cardinality: 0..1 + x-etsi-mec-origin-type: String + country: + description: The two-letter ISO 3166 [i.9] country code in capital ASCII letters, e.g. DE or US, as per ISO 3166 [i.9] + type: string + x-etsi-mec-cardinality: '1' + x-etsi-mec-origin-type: String + required: + - country + type: object + x-etsi-ref: 6.5.20 + DmgCapabilities: + properties: + ExtScMcsCap: + description: Extended SC MCS capabilities as defined in draft IEEE P802.11/D4.0 [i.11] + format: int32 + type: integer + x-etsi-mec-cardinality: '1' + x-etsi-mec-origin-type: Uint8 + dmgApOrPcpCapInfo: + description: DMG AP or PCP capabilities information as defined in draft IEEE P802.11/D4.0 [i.11] + format: int32 + type: integer + x-etsi-mec-cardinality: '1' + x-etsi-mec-origin-type: Uint16 + dmgStaBeamTrackTimeLimit: + description: DMG station beam tracking time limit as defined in draft IEEE P802.11/D4.0 [i.11] + format: int32 + type: integer + x-etsi-mec-cardinality: '1' + x-etsi-mec-origin-type: Uint16 + dmgStaCapInfo: + description: DMG station capabilities information as defined in draft IEEE P802.11/D4.0 [i.11] + format: int64 + type: integer + x-etsi-mec-cardinality: '1' + x-etsi-mec-origin-type: Uint64 + maxNrBasicAmsduSubframes: + description: Number of basic A-MSDU subframes in A-MSDU as defined in draft IEEE P802.11/D4.0 [i.11] + format: int32 + type: integer + x-etsi-mec-cardinality: '1' + x-etsi-mec-origin-type: Uint8 + maxNrShortAmsduSubframes: + description: Number of short A-MSDU subframes in A-MSDU as defined in draft IEEE P802.11/D4.0 [i.11] + format: int32 + type: integer + x-etsi-mec-cardinality: '1' + x-etsi-mec-origin-type: Uint8 + sarCap: + description: SAR capabilities as defined in draft IEEE P802.11/D4.0 [i.11] + format: int32 + type: integer + x-etsi-mec-cardinality: '1' + x-etsi-mec-origin-type: Uint8 + tddCap: + description: TDD capabilities as defined in draft IEEE P802.11/D4.0 [i.11] + format: int32 + type: integer + x-etsi-mec-cardinality: '1' + x-etsi-mec-origin-type: Uint16 + required: + - dmgStaCapInfo + - dmgApOrPcpCapInfo + - dmgStaBeamTrackTimeLimit + - ExtScMcsCap + - maxNrBasicAmsduSubframes + - maxNrShortAmsduSubframes + - tddCap + - sarCap + type: object + x-etsi-ref: 6.5.17 + EdmgCapabilities: + properties: + ampduParameters: + description: A-MPDU parameters as defined in draft IEEE P802.11/D4.0 [i.11] + format: Uint8 + type: integer + x-etsi-mec-cardinality: '1' + x-etsi-mec-origin-type: Uint8 + reserved: + description: '' + format: int32 + type: integer + x-etsi-mec-cardinality: 0..1 + x-etsi-mec-origin-type: Uint8 + supportedMcs: + description: Supported MCS as defined in draft IEEE P802.11/D4.0 [i.11] + format: int32 + type: integer + x-etsi-mec-cardinality: '1' + x-etsi-mec-origin-type: Uint32 + trnParameters: + description: Training parameters as defined in draft IEEE P802.11/D4.0 [i.11] + format: int32 + type: integer + x-etsi-mec-cardinality: '1' + x-etsi-mec-origin-type: Uint16 + required: + - ampduParameters + - trnParameters + - supportedMcs + type: object + x-etsi-ref: 6.5.18 + ExtBssLoad: + properties: + muMimoStaCount: + description: Indicates the total number of STAs currently associated with this BSS that have a 1 in the MU Beamformee Capable field of their VHT Capabilities element. + format: int32 + type: integer + x-etsi-mec-cardinality: '1' + x-etsi-mec-origin-type: UInt16 + obsSec20MhzUtil: + description: Observable loading on each of the secondary 20 MHz channel. + format: int32 + type: integer + x-etsi-mec-cardinality: '1' + x-etsi-mec-origin-type: Uint8 + obsSec40MhzUtil: + description: Observable loading on each of the secondary 40 MHz channel. + format: int32 + type: integer + x-etsi-mec-cardinality: '1' + x-etsi-mec-origin-type: Uint8 + obsSec80MhzUtil: + description: Observable loading on each of the secondary 80 MHz channel. + format: int32 + type: integer + x-etsi-mec-cardinality: '1' + x-etsi-mec-origin-type: Uint8 + spatStreamUnderUtil: + description: "The percentage of time, linearly scaled with 255 representing 100\_%, that the AP has underutilized spatial domain resources for given busy time of the medium." + format: int32 + type: integer + x-etsi-mec-cardinality: '1' + x-etsi-mec-origin-type: UInt8 + required: + - muMimoStaCount + - spatStreamUnderUtil + - obsSec20MhzUtil + - obsSec40MhzUtil + - obsSec80MhzUtil + type: object + x-etsi-ref: 6.5.8 + GeoLocation: + properties: + altitude: + description: "The altitude value of location as defined in IETF RFC\_6225 [6]" + format: int32 + type: integer + x-etsi-mec-cardinality: 0..1 + x-etsi-mec-origin-type: Uint32 + altitudeType: + description: The type description for altitude information e.g. floors or meters as defined in IETF RFC 6225 [6] + format: int32 + type: integer + x-etsi-mec-cardinality: 0..1 + x-etsi-mec-origin-type: Uint8 + altitudeUncertainty: + description: The uncertainty for altitude information as defined in IETF RFC 6225 [6] + format: int32 + type: integer + x-etsi-mec-cardinality: 0..1 + x-etsi-mec-origin-type: Uint8 + datum: + description: The datum value to express how coordinates are organized and related to real world as defined in IETF RFC 6225 [6] + format: int32 + type: integer + x-etsi-mec-cardinality: '1' + x-etsi-mec-origin-type: Uint8 + lat: + description: "The latitude value of location as defined in IETF RFC\_6225 [6]" + format: int64 + type: integer + x-etsi-mec-cardinality: '1' + x-etsi-mec-origin-type: Uint64 + latUncertainty: + description: The uncertainty for Latitude information as defined in IETF RFC 6225 [6] + format: int32 + type: integer + x-etsi-mec-cardinality: '1' + x-etsi-mec-origin-type: Uint8 + long: + description: "The longitude value of location as defined in IETF RFC\_6225 [6]" + format: int64 + type: integer + x-etsi-mec-cardinality: '1' + x-etsi-mec-origin-type: Uint64 + longUncertainty: + description: The uncertainty for Longitude information as defined in IETF RFC 6225 [6] + format: int32 + type: integer + x-etsi-mec-cardinality: '1' + x-etsi-mec-origin-type: Uint8 + required: + - latUncertainty + - lat + - longUncertainty + - long + - datum + type: object + x-etsi-ref: 6.5.19 + HeCapabilities: + properties: + heMacCapInfo: + description: MAC capabilities of an Access Point. + type: integer + x-etsi-mec-cardinality: '1' + x-etsi-mec-origin-type: Uint8 + hePhyCapinfo: + description: PHY capabilities of an Access Point. + type: integer + x-etsi-mec-cardinality: '1' + x-etsi-mec-origin-type: Uint8 + ppeThresholds: + description: PPE Threshold determines the nominal packet padding value for a HE PPDU. + type: integer + x-etsi-mec-cardinality: 0..1 + x-etsi-mec-origin-type: not defined + supportedHeMcsNssSet: + description: Supported MCS and NSS Set. + type: integer + x-etsi-mec-cardinality: '1' + x-etsi-mec-origin-type: Uint8 + required: + - heMacCapInfo + - hePhyCapinfo + - supportedHeMcsNssSet + type: object + x-etsi-ref: 6.5.16 + HtCapabilities: + properties: + ampduParameters: + description: A-MPDU parameters as defined in IEEE 802.11-2016 [8]. + format: int32 + type: integer + x-etsi-mec-cardinality: '1' + x-etsi-mec-origin-type: UInt8 + aselCap: + description: ASEL capabilities as defined in IEEE 802.11-2016 [8]. + format: int32 + type: integer + x-etsi-mec-cardinality: '1' + x-etsi-mec-origin-type: UInt8 + htCapabilityInfo: + description: HT Capability Information as defined in IEEE 802.11-2016 [8]. + format: int32 + type: integer + x-etsi-mec-cardinality: '1' + x-etsi-mec-origin-type: UInt16 + htExtendedCap: + description: Extended HT Capabilities as defined in IEEE 802.11-2016 [8]. + format: int32 + type: integer + x-etsi-mec-cardinality: '1' + x-etsi-mec-origin-type: UInt16 + supportedMcsSet: + description: Supported MCS set as defined in IEEE 802.11-2016 [8]. + format: int64 + type: integer + x-etsi-mec-cardinality: '1' + x-etsi-mec-origin-type: Uint128 + txBeamFormCap: + description: Transmit Beamforming Capabilities as defined in IEEE 802.11-2016 [8]. + format: int32 + type: integer + x-etsi-mec-cardinality: '1' + x-etsi-mec-origin-type: UInt32 + required: + - htCapabilityInfo + - ampduParameters + - supportedMcsSet + - htExtendedCap + - txBeamFormCap + - aselCap + type: object + x-etsi-ref: 6.5.1 + InlineNotification: + oneOf: + - $ref: '#/components/schemas/AssocStaNotification' + - $ref: '#/components/schemas/StaDataRateNotification' + discriminator: + propertyName: notificationType + InlineSubscription: + oneOf: + - $ref: '#/components/schemas/AssocStaSubscription' + - $ref: '#/components/schemas/StaDataRateSubscription' + discriminator: + propertyName: subscriptionType + LinkType: + properties: + href: + description: URI referring to a resource + type: string + x-etsi-mec-cardinality: '1' + x-etsi-mec-origin-type: String + required: + - href + type: object + x-etsi-ref: 6.5.23 + MeasurementConfig: + properties: + beaconRequest: + # description': Configuration related to Beacon Request. + # x-etsi-mec-cardinality': 0..1 + # x-etsi-mec-origin-type': BeaconRequestConfig + $ref: '#/components/schemas/BeaconRequestConfig' + channelLoad: + # description': Configuration related to the Channel Load. + # x-etsi-mec-cardinality': 0..1 + # x-etsi-mec-origin-type': ChannelLoadConfig + $ref: '#/components/schemas/ChannelLoadConfig' + measurementDuration: + description: Duration of the measurement, shall be lower than Maximum Measurement Duration in TU as defined in section 11.11.4 of IEEE 802.11 [8]. + type: integer + x-etsi-mec-cardinality: '1' + x-etsi-mec-origin-type: Integer + measurementId: + description: Identifier of this measurement configuration. + type: string + x-etsi-mec-cardinality: '1' + x-etsi-mec-origin-type: String + randomnInterval: + description: "Random interval to be used for starting the measurement. In units of TU as specifed in section\_11.11.3 of IEEE 802.11 [8]." + type: integer + x-etsi-mec-cardinality: '1' + x-etsi-mec-origin-type: Integer + staStatistics: + # description': Configuration related to the statistics provided by STAs. + # x-etsi-mec-cardinality': 0..1 + # x-etsi-mec-origin-type': StaStatisticsConfig + $ref: '#/components/schemas/StaStatisticsConfig' + required: + - measurementId + - measurementDuration + - randomnInterval + type: object + x-etsi-notes: "NOTE:\tThis element enables the configuration of the channelLoad, beaconRequest and staStatistics in a single resource data type, although only one of each measurement. Multiple measurement configurations of each kind are not allowed." + x-etsi-ref: 6.2.4 + NeighborReport: + properties: + bssid: + description: BSS Id of the Access Point that is being reported. + type: string + x-etsi-mec-cardinality: '1' + x-etsi-mec-origin-type: String + bssidInfo: + description: Additional information related to Access Point that is being reported such as AP reachability, security, key scope, Mobility Domain, HT/VHT capability and Fine Time Measurements. + format: int32 + type: integer + x-etsi-mec-cardinality: '1' + x-etsi-mec-origin-type: UInt32 + channel: + description: The channel currently used by this Access Point. + type: integer + x-etsi-mec-cardinality: '1' + x-etsi-mec-origin-type: Uint8 + operatingClass: + description: The channel set of the AP indicated by this BSSID. + type: integer + x-etsi-mec-cardinality: '1' + x-etsi-mec-origin-type: Uint8 + phyType: + description: PHY type of the AP indicated by this BSSID. It is an integer value coded according to the value of the dot11PHYType. + type: integer + x-etsi-mec-cardinality: '1' + x-etsi-mec-origin-type: Uint8 + required: + - bssid + - bssidInfo + - operatingClass + - channel + - phyType + type: object + x-etsi-ref: 6.5.10 + ProblemDetails: + properties: + detail: + description: A human-readable explanation specific to this occurrence of the problem + type: string + x-etsi-mec-cardinality: 0..1 + x-etsi-mec-origin-type: String + instance: + description: A URI reference that identifies the specific occurrence of the problem + format: uri + type: string + x-etsi-mec-cardinality: 0..1 + x-etsi-mec-origin-type: URI + status: + description: The HTTP status code for this occurrence of the problem + format: int32 + type: integer + x-etsi-mec-cardinality: 0..1 + x-etsi-mec-origin-type: Uint32 + title: + description: A short, human-readable summary of the problem type + type: string + x-etsi-mec-cardinality: 0..1 + x-etsi-mec-origin-type: String + type: + description: A URI reference according to IETF RFC 3986 that identifies the problem type + format: uri + type: string + x-etsi-mec-cardinality: 0..1 + x-etsi-mec-origin-type: URI + type: object + Rssi: + properties: + rssi: + description: The Received Signal Strength Indicator from a station + format: int32 + type: integer + x-etsi-mec-cardinality: '1' + x-etsi-mec-origin-type: Uint8 + required: + - rssi + type: object + x-etsi-ref: 6.5.21 + StaDataRate: + properties: + staId: + # description': Identifier(s) to uniquely specify the client station(s) associated. + # x-etsi-mec-cardinality': 0..1 + # x-etsi-mec-origin-type': StaIdentity + $ref: '#/components/schemas/StaIdentity' + staLastDataDownlinkRate: + description: The data transmit rate in kbps that was most recently used for transmission of data PPDUs from the access point to the station. + format: int32 + type: integer + x-etsi-mec-cardinality: 0..1 + x-etsi-mec-origin-type: Uint32 + staLastDataUplinkRate: + description: The data transmit rate in Kbps that was most recently used for transmission of data PPDUs from the associated station to the access point. + format: int32 + type: integer + x-etsi-mec-cardinality: 0..1 + x-etsi-mec-origin-type: Uint32 + type: object + x-etsi-ref: 6.5.22 + StaDataRateNotification: + properties: + notificationType: + description: Shall be set to "StaDataRateNotification". + type: string + x-etsi-mec-cardinality: '1' + x-etsi-mec-origin-type: String + staDataRate: + description: Data rates of a client station. + items: + $ref: '#/components/schemas/StaDataRate' + minItems: 0 + type: array + x-etsi-mec-cardinality: 0..N + x-etsi-mec-origin-type: StaDataRate + timeStamp: + # description': Time stamp. + # x-etsi-mec-cardinality': 0..1 + # x-etsi-mec-origin-type': TimeStamp + $ref: '#/components/schemas/TimeStamp' + required: + - notificationType + type: object + x-etsi-ref: 6.4.3 + StaDataRateSubscription: + properties: + _links: + description: Hyperlink related to the resource. This shall be only included in the HTTP responses and in HTTP PUT requests. + properties: + self: + # description': Self referring URI. The URI shall be unique within the WLAN Access Information API as it acts as an ID for the subscription. + # x-etsi-mec-cardinality': '1' + # x-etsi-mec-origin-type': LinkType + $ref: '#/components/schemas/LinkType' + required: + - self + type: object + x-etsi-mec-cardinality: 0..1 + x-etsi-mec-origin-type: Structure (inlined) + callbackReference: + description: URI selected by the service consumer to receive notifications on the subscribed WLAN Access Information Service. This shall be included both in the request and in response. + format: uri + type: string + x-etsi-mec-cardinality: '1' + x-etsi-mec-origin-type: URI + expiryDeadline: + # description': The expiration time of the subscription determined by the WLAN Access Information Service. + # x-etsi-mec-cardinality': 0..1 + # x-etsi-mec-origin-type': TimeStamp + $ref: '#/components/schemas/TimeStamp' + staId: + description: Identifier(s) to uniquely specify the target client station(s) for the subscription + items: + $ref: '#/components/schemas/StaIdentity' + minItems: 1 + type: array + x-etsi-mec-cardinality: 1..N + x-etsi-mec-origin-type: StaIdentity + subscriptionType: + description: Shall be set to "StaDataRateSubscription". + type: string + x-etsi-mec-cardinality: '1' + x-etsi-mec-origin-type: String + required: + - subscriptionType + - callbackReference + - staId + type: object + x-etsi-ref: 6.3.3 + StaIdentity: + properties: + aid: + description: 'Number which identifies a particular association between a station and an Access Point ' + type: string + x-etsi-mec-cardinality: 0..1 + x-etsi-mec-origin-type: String + ipAddress: + description: IPv4 or IPv6 address allocated for the station. + items: + type: string + minItems: 0 + type: array + x-etsi-mec-cardinality: 0..N + x-etsi-mec-origin-type: String + macId: + description: Unique identifier assigned to station (as network interface controller) for communications at the data link layer of a network segment. + type: string + x-etsi-mec-cardinality: '1' + x-etsi-mec-origin-type: String + ssid: + description: Service Set Identifier to identify logical networks. + items: + type: string + minItems: 0 + type: array + x-etsi-mec-cardinality: 0..N + x-etsi-mec-origin-type: String + required: + - macId + type: object + x-etsi-ref: 6.5.11 + StaInfo: + properties: + apAssociated: + # description': Information about the Access Point that this Client Station is associated to. + # x-etsi-mec-cardinality': 0..1 + # x-etsi-mec-origin-type': ApAssociated + $ref: '#/components/schemas/ApAssociated' + beaconReport: + # description': Beacon Report as defined in Wi-Fi Agile Multiband Specification [9]. + # x-etsi-mec-cardinality': 0..1 + # x-etsi-mec-origin-type': BeaconReport + $ref: '#/components/schemas/BeaconReport' + channel: + description: Channel currently used by the station. + format: int32 + type: integer + x-etsi-mec-cardinality: 0..1 + x-etsi-mec-origin-type: Uint32 + rssi: + # description': Receive Signal Strength Indicator. + # x-etsi-mec-cardinality': 0..1 + # x-etsi-mec-origin-type': Rssi + $ref: '#/components/schemas/Rssi' + staDataRate: + # description': Station Data Rate as defined in IEEE 802.11-2016 [8]. + # x-etsi-mec-cardinality': 0..1 + # x-etsi-mec-origin-type': StaDataRate + $ref: '#/components/schemas/StaDataRate' + staId: + # description': 0 to N identifiers to uniquely specify the station whose information is exposed within this data type. + # x-etsi-mec-cardinality': '1' + # x-etsi-mec-origin-type': StaIdentity + $ref: '#/components/schemas/StaIdentity' + staStatistics: + # description': Statistics as defined in IEEE 802.11-2016 [8] for the client station collected over measurement duration. + # x-etsi-mec-cardinality': 0..1 + # x-etsi-mec-origin-type': StaStatistics + $ref: '#/components/schemas/StaStatistics' + timeStamp: + # description': Time stamp. + # x-etsi-mec-cardinality': 0..1 + # x-etsi-mec-origin-type': TimeStamp + $ref: '#/components/schemas/TimeStamp' + required: + - staId + type: object + x-etsi-ref: 6.2.3 + StaStatistics: + properties: + groupIdentity: + description: Indicates the requested statistics group describing the Statistics Group Data according to table 9-114 of IEEE 802.11-2016 [8]. + type: integer + x-etsi-mec-cardinality: '1' + x-etsi-mec-origin-type: UInt8 + md: + description: Measurement Duration. + type: integer + x-etsi-mec-cardinality: '1' + x-etsi-mec-origin-type: UInt16 + statisticsGroupData: + $ref: '#/components/schemas/StatisticsGroupData' + description: "Statistics Group Data as defined in Annex C of IEEE 802.112016\_[8]." + x-etsi-mec-cardinality: '1' + x-etsi-mec-origin-type: not specified + required: + - md + - groupIdentity + - statisticsGroupData + type: object + x-etsi-ref: 6.5.13 + StaStatisticsConfig: + properties: + groupIdentity: + description: As per table T 9-114 of IEEE 802.11-2012 [8]. + type: integer + x-etsi-mec-cardinality: '1' + x-etsi-mec-origin-type: Integer + staId: + # description': Identifier to uniquely specify the station whose information is exposed within this data type. + # x-etsi-mec-cardinality': '1' + # x-etsi-mec-origin-type': StaIdentity + $ref: '#/components/schemas/StaIdentity' + triggerCondition: + # description': As per Figure 9-161 of IEEE 802.11. This bitmap defines what are the metrics returned by the STA Statistics Report. + # x-etsi-mec-cardinality': '1' + # x-etsi-mec-origin-type': 16bits bitmap + type: integer + triggerTimeout: + description: The Trigger Timeout field contains a value in units of 100 TUs during which a measuring STA does not generate further triggered STA Statistics Reports after a trigger condition has been met. + type: integer + x-etsi-mec-cardinality: '1' + x-etsi-mec-origin-type: Integer + triggeredReport: + # description': Yes, use triggered report. + # x-etsi-mec-cardinality': '1' + # x-etsi-mec-origin-type': Bool + type: boolean + required: + - staId + - groupIdentity + - triggeredReport + - triggerTimeout + - triggerCondition + type: object + x-etsi-ref: 6.5.26 + StatisticsGroupData: + properties: + dot11AMPDUDelimiterCRCErrorCount: + format: int32 + type: integer + x-etsi-mec-cardinality: 0..1 + x-etsi-mec-origin-type: Uint32 + dot11AMPDUReceivedCount: + format: int32 + type: integer + x-etsi-mec-cardinality: 0..1 + x-etsi-mec-origin-type: Uint32 + dot11AMSDUAckFailureCount: + format: int32 + type: integer + x-etsi-mec-cardinality: 0..1 + x-etsi-mec-origin-type: Uint32 + dot11AckFailureCount: + format: int32 + type: integer + x-etsi-mec-cardinality: 0..1 + x-etsi-mec-origin-type: Uint32 + dot11BeamformingFrameCount: + format: int32 + type: integer + x-etsi-mec-cardinality: 0..1 + x-etsi-mec-origin-type: Uint32 + dot11ChannelWidthSwitchCount: + format: int32 + type: integer + x-etsi-mec-cardinality: 0..1 + x-etsi-mec-origin-type: Uint32 + dot11DualCTSFailureCount: + format: int32 + type: integer + x-etsi-mec-cardinality: 0..1 + x-etsi-mec-origin-type: Uint32 + dot11DualCTSSuccessCount: + format: int32 + type: integer + x-etsi-mec-cardinality: 0..1 + x-etsi-mec-origin-type: Uint32 + dot11ExplicitBARFailureCount: + format: int32 + type: integer + x-etsi-mec-cardinality: 0..1 + x-etsi-mec-origin-type: Uint32 + dot11FCSErrorCount: + format: int32 + type: integer + x-etsi-mec-cardinality: 0..1 + x-etsi-mec-origin-type: Uint32 + dot11FailedAMSDUCount: + format: int32 + type: integer + x-etsi-mec-cardinality: 0..1 + x-etsi-mec-origin-type: Uint32 + dot11FailedCount: + format: int32 + type: integer + x-etsi-mec-cardinality: 0..1 + x-etsi-mec-origin-type: Uint32 + dot11FortyMHzFrameReceivedCount: + format: int32 + type: integer + x-etsi-mec-cardinality: 0..1 + x-etsi-mec-origin-type: Uint32 + dot11FortyMHzFrameTransmittedCount: + format: int32 + type: integer + x-etsi-mec-cardinality: 0..1 + x-etsi-mec-origin-type: Uint32 + dot11FrameDuplicateCount: + format: int32 + type: integer + x-etsi-mec-cardinality: 0..1 + x-etsi-mec-origin-type: Uint32 + dot11GrantedRDGUnusedCount: + format: int32 + type: integer + x-etsi-mec-cardinality: 0..1 + x-etsi-mec-origin-type: Uint32 + dot11GrantedRDGUsedCount: + format: int32 + type: integer + x-etsi-mec-cardinality: 0..1 + x-etsi-mec-origin-type: Uint32 + dot11GroupReceivedFrameCount: + format: int32 + type: integer + x-etsi-mec-cardinality: 0..1 + x-etsi-mec-origin-type: Uint32 + dot11GroupTransmittedFrameCount: + format: int32 + type: integer + x-etsi-mec-cardinality: 0..1 + x-etsi-mec-origin-type: Uint32 + dot11ImplicitBARFailureCount: + format: int32 + type: integer + x-etsi-mec-cardinality: 0..1 + x-etsi-mec-origin-type: Uint32 + dot11MPDUInReceivedAMPDUCount: + format: int32 + type: integer + x-etsi-mec-cardinality: 0..1 + x-etsi-mec-origin-type: Uint32 + dot11MultipleRetryAMSDUCount: + format: int32 + type: integer + x-etsi-mec-cardinality: 0..1 + x-etsi-mec-origin-type: Uint32 + dot11MultipleRetryCount: + format: int32 + type: integer + x-etsi-mec-cardinality: 0..1 + x-etsi-mec-origin-type: Uint32 + dot11PSMPUTTGrantDuration: + format: int32 + type: integer + x-etsi-mec-cardinality: 0..1 + x-etsi-mec-origin-type: Uint32 + dot11PSMPUTTUsedDuration: + format: int32 + type: integer + x-etsi-mec-cardinality: 0..1 + x-etsi-mec-origin-type: Uint32 + dot11QosAckFailureCount: + format: int32 + type: integer + x-etsi-mec-cardinality: 0..1 + x-etsi-mec-origin-type: Uint32 + dot11QosDiscardedFrameCount: + format: int32 + type: integer + x-etsi-mec-cardinality: 0..1 + x-etsi-mec-origin-type: Uint32 + dot11QosFailedCount: + format: int32 + type: integer + x-etsi-mec-cardinality: 0..1 + x-etsi-mec-origin-type: Uint32 + dot11QosFrameDuplicateCount: + format: int32 + type: integer + x-etsi-mec-cardinality: 0..1 + x-etsi-mec-origin-type: Uint32 + dot11QosMPDUsReceivedCount: + format: int32 + type: integer + x-etsi-mec-cardinality: 0..1 + x-etsi-mec-origin-type: Uint32 + dot11QosMultipleRetryCount: + format: int32 + type: integer + x-etsi-mec-cardinality: 0..1 + x-etsi-mec-origin-type: Uint32 + dot11QosRTSFailureCount: + format: int32 + type: integer + x-etsi-mec-cardinality: 0..1 + x-etsi-mec-origin-type: Uint32 + dot11QosRTSSuccessCount: + format: int32 + type: integer + x-etsi-mec-cardinality: 0..1 + x-etsi-mec-origin-type: Uint32 + dot11QosReceivedFragmentCount: + format: int32 + type: integer + x-etsi-mec-cardinality: 0..1 + x-etsi-mec-origin-type: Uint32 + dot11QosRetriesReceivedCount: + format: int32 + type: integer + x-etsi-mec-cardinality: 0..1 + x-etsi-mec-origin-type: Uint32 + dot11QosRetryCount: + format: int32 + type: integer + x-etsi-mec-cardinality: 0..1 + x-etsi-mec-origin-type: Uint32 + dot11QosTransmittedFragmentCount: + format: int32 + type: integer + x-etsi-mec-cardinality: 0..1 + x-etsi-mec-origin-type: Uint32 + dot11QosTransmittedFrameCount: + format: int32 + type: integer + x-etsi-mec-cardinality: 0..1 + x-etsi-mec-origin-type: Uint32 + dot11RSNAStatsBIPMICErrors: + format: int32 + type: integer + x-etsi-mec-cardinality: 0..1 + x-etsi-mec-origin-type: Uint32 + dot11RSNAStatsCCMPDecryptErrors: + format: int32 + type: integer + x-etsi-mec-cardinality: 0..1 + x-etsi-mec-origin-type: Uint32 + dot11RSNAStatsCCMPReplays: + format: int32 + type: integer + x-etsi-mec-cardinality: 0..1 + x-etsi-mec-origin-type: Uint32 + dot11RSNAStatsCMACReplays: + format: int32 + type: integer + x-etsi-mec-cardinality: 0..1 + x-etsi-mec-origin-type: Uint32 + dot11RSNAStatsRobustMgmtCCMPReplays: + format: int32 + type: integer + x-etsi-mec-cardinality: 0..1 + x-etsi-mec-origin-type: Uint32 + dot11RSNAStatsTKIPICVErrors: + format: int32 + type: integer + x-etsi-mec-cardinality: 0..1 + x-etsi-mec-origin-type: Uint32 + dot11RSNAStatsTKIPReplays: + format: int32 + type: integer + x-etsi-mec-cardinality: 0..1 + x-etsi-mec-origin-type: Uint32 + dot11RTSFailureCount: + format: int32 + type: integer + x-etsi-mec-cardinality: 0..1 + x-etsi-mec-origin-type: Uint32 + dot11RTSLSIGFailureCount: + format: int32 + type: integer + x-etsi-mec-cardinality: 0..1 + x-etsi-mec-origin-type: Uint32 + dot11RTSLSIGSuccessCount: + format: int32 + type: integer + x-etsi-mec-cardinality: 0..1 + x-etsi-mec-origin-type: Uint32 + dot11RTSSuccessCount: + format: int32 + type: integer + x-etsi-mec-cardinality: 0..1 + x-etsi-mec-origin-type: Uint32 + dot11ReceivedAMSDUCount: + format: int32 + type: integer + x-etsi-mec-cardinality: 0..1 + x-etsi-mec-origin-type: Uint32 + dot11ReceivedFragmentCount: + format: int32 + type: integer + x-etsi-mec-cardinality: 0..1 + x-etsi-mec-origin-type: Uint32 + dot11ReceivedOctetsInAMPDUCount: + format: int64 + type: integer + x-etsi-mec-cardinality: 0..1 + x-etsi-mec-origin-type: Uint64 + dot11ReceivedOctetsInAMSDUCount: + format: int64 + type: integer + x-etsi-mec-cardinality: 0..1 + x-etsi-mec-origin-type: Uint64 + dot11RetryAMSDUCount: + format: int32 + type: integer + x-etsi-mec-cardinality: 0..1 + x-etsi-mec-origin-type: Uint32 + dot11RetryCount: + format: int32 + type: integer + x-etsi-mec-cardinality: 0..1 + x-etsi-mec-origin-type: Uint32 + dot11STAStatisticsAPAverageAccessDelay: + type: integer + x-etsi-mec-cardinality: 0..1 + x-etsi-mec-origin-type: Uint8 + dot11STAStatisticsAverageAccessDelayBackGround: + type: integer + x-etsi-mec-cardinality: 0..1 + x-etsi-mec-origin-type: Uint8 + dot11STAStatisticsAverageAccessDelayBestEffort: + type: integer + x-etsi-mec-cardinality: 0..1 + x-etsi-mec-origin-type: Uint8 + dot11STAStatisticsAverageAccessDelayVideo: + type: integer + x-etsi-mec-cardinality: 0..1 + x-etsi-mec-origin-type: Uint8 + dot11STAStatisticsAverageAccessDelayVoice: + type: integer + x-etsi-mec-cardinality: 0..1 + x-etsi-mec-origin-type: Uint8 + dot11STAStatisticsChannelUtilization: + type: integer + x-etsi-mec-cardinality: 0..1 + x-etsi-mec-origin-type: Uint8 + dot11STAStatisticsStationCount: + type: integer + x-etsi-mec-cardinality: 0..1 + x-etsi-mec-origin-type: Uint8 + dot11STBCCTSFailureCount: + format: int32 + type: integer + x-etsi-mec-cardinality: 0..1 + x-etsi-mec-origin-type: Uint32 + dot11STBCCTSSuccessCount: + format: int32 + type: integer + x-etsi-mec-cardinality: 0..1 + x-etsi-mec-origin-type: Uint32 + dot11TransmittedAMPDUCount: + format: int32 + type: integer + x-etsi-mec-cardinality: 0..1 + x-etsi-mec-origin-type: Uint32 + dot11TransmittedAMSDUCount: + format: int32 + type: integer + x-etsi-mec-cardinality: 0..1 + x-etsi-mec-origin-type: Uint32 + dot11TransmittedFragmentCount: + format: int32 + type: integer + x-etsi-mec-cardinality: 0..1 + x-etsi-mec-origin-type: Uint32 + dot11TransmittedFrameCount: + format: int32 + type: integer + x-etsi-mec-cardinality: 0..1 + x-etsi-mec-origin-type: Uint32 + dot11TransmittedFramesInGrantedRDGCount: + format: int32 + type: integer + x-etsi-mec-cardinality: 0..1 + x-etsi-mec-origin-type: Uint32 + dot11TransmittedMPDUsInAMPDUCount: + format: int32 + type: integer + x-etsi-mec-cardinality: 0..1 + x-etsi-mec-origin-type: Uint32 + dot11TransmittedOctetsInAMPDUCount: + format: int64 + type: integer + x-etsi-mec-cardinality: 0..1 + x-etsi-mec-origin-type: Uint64 + dot11TransmittedOctetsInAMSDUCount: + format: int64 + type: integer + x-etsi-mec-cardinality: 0..1 + x-etsi-mec-origin-type: Uint32 + dot11TransmittedOctetsInGrantedRDGCount: + format: int32 + type: integer + x-etsi-mec-cardinality: 0..1 + x-etsi-mec-origin-type: Uint32 + dot11TwentyMHzFrameReceivedCount: + format: int32 + type: integer + x-etsi-mec-cardinality: 0..1 + x-etsi-mec-origin-type: Uint32 + dot11TwentyMHzFrameTransmittedCount: + format: int32 + type: integer + x-etsi-mec-cardinality: 0..1 + x-etsi-mec-origin-type: Uint32 + dot11nonSTBCCTSFailureCount: + format: int32 + type: integer + x-etsi-mec-cardinality: 0..1 + x-etsi-mec-origin-type: Uint32 + dot11nonSTBCCTSSuccessCount: + format: int32 + type: integer + x-etsi-mec-cardinality: 0..1 + x-etsi-mec-origin-type: Uint32 + type: object + SubscriptionLinkList: + properties: + _links: + description: Hyperlink related to the resource. This shall be only included in the HTTP responses and in HTTP PUT requests. + properties: + self: + $ref: '#/components/schemas/LinkType' + type: object + x-etsi-mec-cardinality: 0..1 + x-etsi-mec-origin-type: Structure (inlined) + assocStaSubscription: + items: + $ref: '#/components/schemas/AssocStaSubscription' + type: array + x-etsi-mec-cardinality: 0..N + x-etsi-mec-origin-type: AssocStaSubscription + staDataRateSubscription: + items: + $ref: '#/components/schemas/StaDataRateSubscription' + type: array + x-etsi-mec-cardinality: 0..N + x-etsi-mec-origin-type: StaDataRateSubscription + required: + - _links + type: object + TimeStamp: + properties: + nanoSeconds: + description: The nanoseconds part of the time. Time is defined as Unix-time since January 1, 1970, 00:00:00 UTC. + format: int32 + type: integer + x-etsi-mec-cardinality: '1' + x-etsi-mec-origin-type: Uint32 + seconds: + description: The seconds part of the time. Time is defined as Unixtime since January 1, 1970, 00:00:00 UTC. + format: int32 + type: integer + x-etsi-mec-cardinality: '1' + x-etsi-mec-origin-type: Uint32 + required: + - seconds + - nanoSeconds + type: object + x-etsi-ref: 6.5.2 + VhtCapabilities: + properties: + vhtCapInfo: + description: VHT capabilities Info as defined in IEEE 802.11-2016 [8]. + format: int32 + type: integer + x-etsi-mec-cardinality: '1' + x-etsi-mec-origin-type: UInt32 + vhtMcsNss: + description: Supported VHT-MCS and NSS Set as defined in IEEE 802.11-2016 [8]. + format: int64 + type: integer + x-etsi-mec-cardinality: '1' + x-etsi-mec-origin-type: UInt64 + required: + - vhtCapInfo + - vhtMcsNss + type: object + x-etsi-ref: 6.5.15 + WanMetrics: + properties: + downlinkLoad: + description: 1-octet positive integer representing the current percentage loading of the downlink WAN connection, scaled linearly with 255 representing 100 %, as measured over an interval the duration of which is reported in Load Measurement Duration. In cases where the downlink load is unknown to the AP, the value is set to zero. + format: int32 + type: integer + x-etsi-mec-cardinality: '1' + x-etsi-mec-origin-type: UInt8 + downlinkSpeed: + description: 4-octet positive integer whose value is an estimate of the WAN Backhaul link current downlink speed in kilobits per second. + format: int32 + type: integer + x-etsi-mec-cardinality: '1' + x-etsi-mec-origin-type: Uint32 + lmd: + description: The LMD (Load Measurement Duration) field is a 2-octet positive integer representing the duration over which the Downlink Load and Uplink Load have been measured, in tenths of a second. When the actual load measurement duration is greater than the maximum value, the maximum value will be reported. The value of the LMD field is set to 0 when neither the uplink nor downlink load can be computed. When the uplink and downlink loads are computed over different intervals, the maximum interval is reported. + format: int32 + type: integer + x-etsi-mec-cardinality: '1' + x-etsi-mec-origin-type: Uint16 + uplinkLoad: + description: 1-octet positive integer representing the current percentage loading of the uplink WAN connection, scaled linearly with 255 representing 100 %, as measured over an interval, the duration of which is reported in Load Measurement Duration. In cases where the uplink load is unknown to the AP, the value is set to zero. + format: int32 + type: integer + x-etsi-mec-cardinality: '1' + x-etsi-mec-origin-type: Uint8 + uplinkSpeed: + description: 4-octet positive integer whose value is an estimate of the WAN Backhaul link's current uplink speed in kilobits per second. + format: int32 + type: integer + x-etsi-mec-cardinality: '1' + x-etsi-mec-origin-type: UInt32 + wanInfo: + description: Info about WAN link status, link symmetricity and capacity currently used. + format: int32 + type: integer + x-etsi-mec-cardinality: '1' + x-etsi-mec-origin-type: Uint8 + required: + - wanInfo + - downlinkSpeed + - uplinkSpeed + - downlinkLoad + - uplinkLoad + - lmd + type: object + x-etsi-ref: 6.5.6 + WlanCapabilities: + properties: + dmg: + # description': Information about Access Point DMG capabilities as defined in IEEE 802.11-2016 [8]. + # x-etsi-mec-cardinality': 0..1 + # x-etsi-mec-origin-type': DmgCapabilities + $ref: '#/components/schemas/DmgCapabilities' + edmg: + # description': Information about Access Point EDMG capabilities as defined in draft IEEE P802.11/D4.0 [i.11]. + # x-etsi-mec-cardinality': 0..1 + # x-etsi-mec-origin-type': EdmgCapabilities + $ref: '#/components/schemas/EdmgCapabilities' + he: + # description': Information about Access Point HE capabilities as defined in FFS. + # x-etsi-mec-cardinality': 0..1 + # x-etsi-mec-origin-type': HeCapabilities + $ref: '#/components/schemas/HeCapabilities' + ht: + # description': Information about Access Point HT capabilities as defined in IEEE 802.11-2016 [8]. + # x-etsi-mec-cardinality': 0..1 + # x-etsi-mec-origin-type': HtCapabilities + $ref: '#/components/schemas/HtCapabilities' + vht: + # description': Information about Access Point VHT capabilities as defined in IEEE 802.11-2016 [8]. + # x-etsi-mec-cardinality': 0..1 + # x-etsi-mec-origin-type': VhtCapabilities + $ref: '#/components/schemas/VhtCapabilities' + type: object + x-etsi-ref: 6.5.4 -- GitLab From 93b970be6e8c12ab5827b85641094f5878899571 Mon Sep 17 00:00:00 2001 From: Elian Kraja Date: Wed, 25 Nov 2020 17:09:45 +0100 Subject: [PATCH 6/8] Update README.md --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index beef4df..1d6f88d 100644 --- a/README.md +++ b/README.md @@ -4,7 +4,7 @@ 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/gitlab/mec/gs028-wai-api/raw/stf593/WlanInformationApi.yaml). * [Edit the API online](https://forge.etsi.org/swagger/editor/?url=https://forge.etsi.org/gitlab/mec/gs028-wai-api/raw/stf593/WlanInformationApi.yaml). -- GitLab From d721f21e8b51aecb472c67a74b37733f05b0953a Mon Sep 17 00:00:00 2001 From: piscione Date: Wed, 25 Nov 2020 17:56:37 +0100 Subject: [PATCH 7/8] Added first draft of proto files. --- proto3/models/ap_associated.proto | 30 +++ proto3/models/ap_identity.proto | 27 +++ proto3/models/ap_info.proto | 45 +++++ proto3/models/ap_location.proto | 24 +++ proto3/models/assoc_sta_notification.proto | 31 ++++ proto3/models/assoc_sta_subscription.proto | 33 ++++ .../models/assoc_sta_subscription_links.proto | 21 +++ proto3/models/associated_stations.proto | 27 +++ proto3/models/beacon_report.proto | 36 ++++ proto3/models/beacon_request_config.proto | 36 ++++ proto3/models/bss_load.proto | 27 +++ proto3/models/channel_load_config.proto | 27 +++ proto3/models/civic_location.proto | 117 ++++++++++++ proto3/models/dmg_capabilities.proto | 42 +++++ proto3/models/edmg_capabilities.proto | 29 +++ proto3/models/ext_bss_load.proto | 33 ++++ proto3/models/geo_location.proto | 42 +++++ proto3/models/he_capabilities.proto | 30 +++ proto3/models/ht_capabilities.proto | 36 ++++ proto3/models/inline_notification.proto | 37 ++++ proto3/models/inline_subscription.proto | 39 ++++ proto3/models/link_type.proto | 21 +++ proto3/models/measurement_config.proto | 36 ++++ proto3/models/neighbor_report.proto | 33 ++++ proto3/models/problem_details.proto | 33 ++++ proto3/models/rssi.proto | 21 +++ proto3/models/sta_data_rate.proto | 27 +++ .../models/sta_data_rate_notification.proto | 28 +++ .../models/sta_data_rate_subscription.proto | 34 ++++ proto3/models/sta_identity.proto | 30 +++ proto3/models/sta_info.proto | 42 +++++ proto3/models/sta_statistics.proto | 27 +++ proto3/models/sta_statistics_config.proto | 31 ++++ proto3/models/statistics_group_data.proto | 172 ++++++++++++++++++ proto3/models/subscription_link_list.proto | 27 +++ .../models/subscription_link_list_links.proto | 21 +++ proto3/models/time_stamp.proto | 24 +++ proto3/models/vht_capabilities.proto | 24 +++ proto3/models/wan_metrics.proto | 36 ++++ proto3/models/wlan_capabilities.proto | 33 ++++ proto3/services/wai_service.proto | 106 +++++++++++ 41 files changed, 1575 insertions(+) create mode 100644 proto3/models/ap_associated.proto create mode 100644 proto3/models/ap_identity.proto create mode 100644 proto3/models/ap_info.proto create mode 100644 proto3/models/ap_location.proto create mode 100644 proto3/models/assoc_sta_notification.proto create mode 100644 proto3/models/assoc_sta_subscription.proto create mode 100644 proto3/models/assoc_sta_subscription_links.proto create mode 100644 proto3/models/associated_stations.proto create mode 100644 proto3/models/beacon_report.proto create mode 100644 proto3/models/beacon_request_config.proto create mode 100644 proto3/models/bss_load.proto create mode 100644 proto3/models/channel_load_config.proto create mode 100644 proto3/models/civic_location.proto create mode 100644 proto3/models/dmg_capabilities.proto create mode 100644 proto3/models/edmg_capabilities.proto create mode 100644 proto3/models/ext_bss_load.proto create mode 100644 proto3/models/geo_location.proto create mode 100644 proto3/models/he_capabilities.proto create mode 100644 proto3/models/ht_capabilities.proto create mode 100644 proto3/models/inline_notification.proto create mode 100644 proto3/models/inline_subscription.proto create mode 100644 proto3/models/link_type.proto create mode 100644 proto3/models/measurement_config.proto create mode 100644 proto3/models/neighbor_report.proto create mode 100644 proto3/models/problem_details.proto create mode 100644 proto3/models/rssi.proto create mode 100644 proto3/models/sta_data_rate.proto create mode 100644 proto3/models/sta_data_rate_notification.proto create mode 100644 proto3/models/sta_data_rate_subscription.proto create mode 100644 proto3/models/sta_identity.proto create mode 100644 proto3/models/sta_info.proto create mode 100644 proto3/models/sta_statistics.proto create mode 100644 proto3/models/sta_statistics_config.proto create mode 100644 proto3/models/statistics_group_data.proto create mode 100644 proto3/models/subscription_link_list.proto create mode 100644 proto3/models/subscription_link_list_links.proto create mode 100644 proto3/models/time_stamp.proto create mode 100644 proto3/models/vht_capabilities.proto create mode 100644 proto3/models/wan_metrics.proto create mode 100644 proto3/models/wlan_capabilities.proto create mode 100644 proto3/services/wai_service.proto diff --git a/proto3/models/ap_associated.proto b/proto3/models/ap_associated.proto new file mode 100644 index 0000000..022b389 --- /dev/null +++ b/proto3/models/ap_associated.proto @@ -0,0 +1,30 @@ +/* + ETSI GS MEC 028 - WLAN Access Information API + + The ETSI MEC ISG MEC028 WLAN Access Information API described using OpenAPI + + The version of the OpenAPI document: 2.1.1 + + Generated by OpenAPI Generator: https://openapi-generator.tech +*/ + +syntax = "proto3"; + +package mec028; + + +message ApAssociated { + + // Unique number which identifies a particular association between the station and Access Point. + string assoc_id = 1; + + // IPv4 or IPv6 address allocated for the Access Point. + repeated string ip_address = 2; + + // Unique identifier assigned to the Access Point (as network interface controller) for communications at the data link layer of a network segment. + string mac_id = 3; + + // Service Set Identifier to identify logical networks. + repeated string ssid = 4; + +} diff --git a/proto3/models/ap_identity.proto b/proto3/models/ap_identity.proto new file mode 100644 index 0000000..cb473e1 --- /dev/null +++ b/proto3/models/ap_identity.proto @@ -0,0 +1,27 @@ +/* + ETSI GS MEC 028 - WLAN Access Information API + + The ETSI MEC ISG MEC028 WLAN Access Information API described using OpenAPI + + The version of the OpenAPI document: 2.1.1 + + Generated by OpenAPI Generator: https://openapi-generator.tech +*/ + +syntax = "proto3"; + +package mec028; + + +message ApIdentity { + + // IPv4 or IPv6 address allocated for the Access Point. + repeated string ip_address = 1; + + // Unique Identifier assigned to an Access Point (as network interface controller) for communications at the data link layer of a network segment. + string mac_id = 2; + + // Service Set Identifier to identify logical networks including Basic Service Set and Extended Service Set. + repeated string ssid = 3; + +} diff --git a/proto3/models/ap_info.proto b/proto3/models/ap_info.proto new file mode 100644 index 0000000..320d079 --- /dev/null +++ b/proto3/models/ap_info.proto @@ -0,0 +1,45 @@ +/* + ETSI GS MEC 028 - WLAN Access Information API + + The ETSI MEC ISG MEC028 WLAN Access Information API described using OpenAPI + + The version of the OpenAPI document: 2.1.1 + + Generated by OpenAPI Generator: https://openapi-generator.tech +*/ + +syntax = "proto3"; + +package mec028; + +import public "models/ap_identity.proto"; +import public "models/ap_location.proto"; +import public "models/bss_load.proto"; +import public "models/ext_bss_load.proto"; +import public "models/neighbor_report.proto"; +import public "models/time_stamp.proto"; +import public "models/wan_metrics.proto"; +import public "models/wlan_capabilities.proto"; + +message ApInfo { + + ApIdentity ap_id = 1; + + ApLocation ap_location = 2; + + NeighborReport ap_neighbor = 3; + + BssLoad bss_load = 4; + + // Channel configured for the Access Point. + int32 channel = 5; + + ExtBssLoad ext_bss_load = 6; + + TimeStamp time_stamp = 7; + + WanMetrics wan_metrics = 8; + + WlanCapabilities wlan_cap = 9; + +} diff --git a/proto3/models/ap_location.proto b/proto3/models/ap_location.proto new file mode 100644 index 0000000..65ef291 --- /dev/null +++ b/proto3/models/ap_location.proto @@ -0,0 +1,24 @@ +/* + ETSI GS MEC 028 - WLAN Access Information API + + The ETSI MEC ISG MEC028 WLAN Access Information API described using OpenAPI + + The version of the OpenAPI document: 2.1.1 + + Generated by OpenAPI Generator: https://openapi-generator.tech +*/ + +syntax = "proto3"; + +package mec028; + +import public "models/civic_location.proto"; +import public "models/geo_location.proto"; + +message ApLocation { + + CivicLocation civic_location = 1; + + GeoLocation geolocation = 2; + +} diff --git a/proto3/models/assoc_sta_notification.proto b/proto3/models/assoc_sta_notification.proto new file mode 100644 index 0000000..8349dde --- /dev/null +++ b/proto3/models/assoc_sta_notification.proto @@ -0,0 +1,31 @@ +/* + ETSI GS MEC 028 - WLAN Access Information API + + The ETSI MEC ISG MEC028 WLAN Access Information API described using OpenAPI + + The version of the OpenAPI document: 2.1.1 + + Generated by OpenAPI Generator: https://openapi-generator.tech +*/ + +syntax = "proto3"; + +package mec028; + +import public "models/ap_identity.proto"; +import public "models/sta_identity.proto"; +import public "models/time_stamp.proto"; + +message AssocStaNotification { + + ApIdentity ap_id = 1; + + // Shall be set to \"AssocStaNotification\". + string notification_type = 2; + + // Identifier(s) to uniquely specify the client station(s) associated. + repeated StaIdentity sta_id = 3; + + TimeStamp time_stamp = 4; + +} diff --git a/proto3/models/assoc_sta_subscription.proto b/proto3/models/assoc_sta_subscription.proto new file mode 100644 index 0000000..07a881f --- /dev/null +++ b/proto3/models/assoc_sta_subscription.proto @@ -0,0 +1,33 @@ +/* + ETSI GS MEC 028 - WLAN Access Information API + + The ETSI MEC ISG MEC028 WLAN Access Information API described using OpenAPI + + The version of the OpenAPI document: 2.1.1 + + Generated by OpenAPI Generator: https://openapi-generator.tech +*/ + +syntax = "proto3"; + +package mec028; + +import public "models/ap_identity.proto"; +import public "models/assoc_sta_subscription_links.proto"; +import public "models/time_stamp.proto"; + +message AssocStaSubscription { + + AssocStaSubscriptionLinks underscorelinks = 1; + + ApIdentity ap_id = 2; + + // URI selected by the service consumer to receive notifications on the subscribed WLAN information. This shall be included both in the request and in response. + string callback_reference = 3; + + TimeStamp expiry_deadline = 4; + + // Shall be set to \"AssocStaSubscription\". + string subscription_type = 5; + +} diff --git a/proto3/models/assoc_sta_subscription_links.proto b/proto3/models/assoc_sta_subscription_links.proto new file mode 100644 index 0000000..3a65922 --- /dev/null +++ b/proto3/models/assoc_sta_subscription_links.proto @@ -0,0 +1,21 @@ +/* + ETSI GS MEC 028 - WLAN Access Information API + + The ETSI MEC ISG MEC028 WLAN Access Information API described using OpenAPI + + The version of the OpenAPI document: 2.1.1 + + Generated by OpenAPI Generator: https://openapi-generator.tech +*/ + +syntax = "proto3"; + +package mec028; + +import public "models/link_type.proto"; + +message AssocStaSubscriptionLinks { + + LinkType self = 1; + +} diff --git a/proto3/models/associated_stations.proto b/proto3/models/associated_stations.proto new file mode 100644 index 0000000..5ca0be8 --- /dev/null +++ b/proto3/models/associated_stations.proto @@ -0,0 +1,27 @@ +/* + ETSI GS MEC 028 - WLAN Access Information API + + The ETSI MEC ISG MEC028 WLAN Access Information API described using OpenAPI + + The version of the OpenAPI document: 2.1.1 + + Generated by OpenAPI Generator: https://openapi-generator.tech +*/ + +syntax = "proto3"; + +package mec028; + + +message AssociatedStations { + + // Unique number which identifies a particular association between an Access Point and a station. + string assoc_id = 1; + + // IPv4 or IPv6 address allocated for the station associated with the Access Point. + repeated string ip_address = 2; + + // Unique identifier assigned to a station (as network interface controller) for communications at the data link layer of a network segment. + string mac_id = 3; + +} diff --git a/proto3/models/beacon_report.proto b/proto3/models/beacon_report.proto new file mode 100644 index 0000000..f9dada9 --- /dev/null +++ b/proto3/models/beacon_report.proto @@ -0,0 +1,36 @@ +/* + ETSI GS MEC 028 - WLAN Access Information API + + The ETSI MEC ISG MEC028 WLAN Access Information API described using OpenAPI + + The version of the OpenAPI document: 2.1.1 + + Generated by OpenAPI Generator: https://openapi-generator.tech +*/ + +syntax = "proto3"; + +package mec028; + +import public "models/sta_identity.proto"; + +message BeaconReport { + + // The BSSID field indicates the BSSID of the BSS(s) for which a beacon report has been received. + repeated string bss_id = 1; + + // Channel number where the beacon was received. + int32 channel_id = 2; + + // Measurement ID of the Measurement configuration applied to this Beacon Report. + string measurement_id = 3; + + // As in table T9-89 of IEEE 802.11-2012 [8]. + int32 reporting_condition = 4; + + // (Optional) The SSID subelement indicates the ESS(s) or IBSS(s) for which a beacon report is received. + repeated string ss_id = 5; + + StaIdentity sta_id = 6; + +} diff --git a/proto3/models/beacon_request_config.proto b/proto3/models/beacon_request_config.proto new file mode 100644 index 0000000..352a952 --- /dev/null +++ b/proto3/models/beacon_request_config.proto @@ -0,0 +1,36 @@ +/* + ETSI GS MEC 028 - WLAN Access Information API + + The ETSI MEC ISG MEC028 WLAN Access Information API described using OpenAPI + + The version of the OpenAPI document: 2.1.1 + + Generated by OpenAPI Generator: https://openapi-generator.tech +*/ + +syntax = "proto3"; + +package mec028; + +import public "models/sta_identity.proto"; + +message BeaconRequestConfig { + + // The BSSID field indicates the BSSID of the BSS(s) for which a beacon report is requested. When requesting beacon reports for all BSSs on the channel, the BSSID field contains the wildcard BSSID. + repeated string bss_id = 1; + + // Channel number to scan. A Channel Number of 0 indicates a request to make iterative measurements for all supported channels in the Operating Class where the measurement is permitted on the channel and the channel is valid for the current regulatory domain. A Channel Number of 255 indicates a request to make iterative measurements for all supported channels in the current Operating Class listed in the latest AP Channel Report received from the serving AP. + int32 channel_id = 2; + + // 0 for passive. 1 for active. 2 for beacon table. + int32 measurement_mode = 3; + + // As in table T9-89 of IEEE 802.11-2012 [8]. + int32 reporting_condition = 4; + + // (Optional) The SSID subelement indicates the ESS(s) or IBSS(s) for which a beacon report is requested. + repeated string ss_id = 5; + + StaIdentity sta_id = 6; + +} diff --git a/proto3/models/bss_load.proto b/proto3/models/bss_load.proto new file mode 100644 index 0000000..3633fec --- /dev/null +++ b/proto3/models/bss_load.proto @@ -0,0 +1,27 @@ +/* + ETSI GS MEC 028 - WLAN Access Information API + + The ETSI MEC ISG MEC028 WLAN Access Information API described using OpenAPI + + The version of the OpenAPI document: 2.1.1 + + Generated by OpenAPI Generator: https://openapi-generator.tech +*/ + +syntax = "proto3"; + +package mec028; + + +message BssLoad { + + // Available Admission Capacity that specifies the remaining amount of medium time available via explicit admission control, in units of 32 s/s. + int32 avail_adm_cap = 1; + + // The percentage of time, linearly scaled with 255 representing 100 %, that the AP sensed the medium was busy, as indicated by either the physical or virtual Carrier Sense (CS) mechanism. + int32 channel_utilization = 2; + + // An unsigned integer that indicates the total number of STAs currently associated with this BSS. + int32 sta_count = 3; + +} diff --git a/proto3/models/channel_load_config.proto b/proto3/models/channel_load_config.proto new file mode 100644 index 0000000..5750161 --- /dev/null +++ b/proto3/models/channel_load_config.proto @@ -0,0 +1,27 @@ +/* + ETSI GS MEC 028 - WLAN Access Information API + + The ETSI MEC ISG MEC028 WLAN Access Information API described using OpenAPI + + The version of the OpenAPI document: 2.1.1 + + Generated by OpenAPI Generator: https://openapi-generator.tech +*/ + +syntax = "proto3"; + +package mec028; + +import public "models/ap_identity.proto"; + +message ChannelLoadConfig { + + ApIdentity ap_id = 1; + + // Channel number which load is reported + int32 c_channel_id = 2; + + // Channel load as per IEEE 802.11-2012 [8], section 11.11.9.3 + int32 channel_load = 3; + +} diff --git a/proto3/models/civic_location.proto b/proto3/models/civic_location.proto new file mode 100644 index 0000000..dfd3a8e --- /dev/null +++ b/proto3/models/civic_location.proto @@ -0,0 +1,117 @@ +/* + ETSI GS MEC 028 - WLAN Access Information API + + The ETSI MEC ISG MEC028 WLAN Access Information API described using OpenAPI + + The version of the OpenAPI document: 2.1.1 + + Generated by OpenAPI Generator: https://openapi-generator.tech +*/ + +syntax = "proto3"; + +package mec028; + + +message CivicLocation { + + // Language + string ca0 = 1; + + // National subdivisions (state, canton, region,province, prefecture) + string ca1 = 2; + + // Script + string ca128 = 3; + + // Leading street direction + string ca16 = 4; + + // Trailing street suffix + string ca17 = 5; + + // Street suffix or type + string ca18 = 6; + + // House number + string ca19 = 7; + + // County, parish, gun (JP), district (IN) + string ca2 = 8; + + // House number suffix + string ca20 = 9; + + // Landmark of vanity address + string ca21 = 10; + + // Additional location information + string ca22 = 11; + + // Name (residence and office occupant) + string ca23 = 12; + + // Postal/zip code + string ca24 = 13; + + // Building (structure) + string ca25 = 14; + + // Unit (apartment/suite) + string ca26 = 15; + + // Floor + string ca27 = 16; + + // Room + string ca28 = 17; + + // Type of place + string ca29 = 18; + + // City, township, shi (JP) + string ca3 = 19; + + // Postal community name + string ca30 = 20; + + // Post office box + string ca31 = 21; + + // Additional code + string ca32 = 22; + + // Seat (desk.cubicle, workstation) + string ca33 = 23; + + // Primary road name + string ca34 = 24; + + // Road section + string ca35 = 25; + + // Branch road name + string ca36 = 26; + + // Sub-branch road name + string ca37 = 27; + + // Street name pre-modifier + string ca38 = 28; + + // Street name post-modifier + string ca39 = 29; + + // City division, borough, city district, ward, chou (JP) + string ca4 = 30; + + // Neighborhood, block + string ca5 = 31; + + // Group of streets below the neighborhood level + string ca6 = 32; + + // The two-letter ISO 3166 [i.9] country code in capital ASCII letters, e.g. DE or US, as per ISO 3166 [i.9] + string country = 33; + +} diff --git a/proto3/models/dmg_capabilities.proto b/proto3/models/dmg_capabilities.proto new file mode 100644 index 0000000..9181177 --- /dev/null +++ b/proto3/models/dmg_capabilities.proto @@ -0,0 +1,42 @@ +/* + ETSI GS MEC 028 - WLAN Access Information API + + The ETSI MEC ISG MEC028 WLAN Access Information API described using OpenAPI + + The version of the OpenAPI document: 2.1.1 + + Generated by OpenAPI Generator: https://openapi-generator.tech +*/ + +syntax = "proto3"; + +package mec028; + + +message DmgCapabilities { + + // Extended SC MCS capabilities as defined in draft IEEE P802.11/D4.0 [i.11] + int32 ext_sc_mcs_cap = 1; + + // DMG AP or PCP capabilities information as defined in draft IEEE P802.11/D4.0 [i.11] + int32 dmg_ap_or_pcp_cap_info = 2; + + // DMG station beam tracking time limit as defined in draft IEEE P802.11/D4.0 [i.11] + int32 dmg_sta_beam_track_time_limit = 3; + + // DMG station capabilities information as defined in draft IEEE P802.11/D4.0 [i.11] + int64 dmg_sta_cap_info = 4; + + // Number of basic A-MSDU subframes in A-MSDU as defined in draft IEEE P802.11/D4.0 [i.11] + int32 max_nr_basic_amsdu_subframes = 5; + + // Number of short A-MSDU subframes in A-MSDU as defined in draft IEEE P802.11/D4.0 [i.11] + int32 max_nr_short_amsdu_subframes = 6; + + // SAR capabilities as defined in draft IEEE P802.11/D4.0 [i.11] + int32 sar_cap = 7; + + // TDD capabilities as defined in draft IEEE P802.11/D4.0 [i.11] + int32 tdd_cap = 8; + +} diff --git a/proto3/models/edmg_capabilities.proto b/proto3/models/edmg_capabilities.proto new file mode 100644 index 0000000..996b6bf --- /dev/null +++ b/proto3/models/edmg_capabilities.proto @@ -0,0 +1,29 @@ +/* + ETSI GS MEC 028 - WLAN Access Information API + + The ETSI MEC ISG MEC028 WLAN Access Information API described using OpenAPI + + The version of the OpenAPI document: 2.1.1 + + Generated by OpenAPI Generator: https://openapi-generator.tech +*/ + +syntax = "proto3"; + +package mec028; + + +message EdmgCapabilities { + + // A-MPDU parameters as defined in draft IEEE P802.11/D4.0 [i.11] + int32 ampdu_parameters = 1; + + int32 reserved = 2; + + // Supported MCS as defined in draft IEEE P802.11/D4.0 [i.11] + int32 supported_mcs = 3; + + // Training parameters as defined in draft IEEE P802.11/D4.0 [i.11] + int32 trn_parameters = 4; + +} diff --git a/proto3/models/ext_bss_load.proto b/proto3/models/ext_bss_load.proto new file mode 100644 index 0000000..2307570 --- /dev/null +++ b/proto3/models/ext_bss_load.proto @@ -0,0 +1,33 @@ +/* + ETSI GS MEC 028 - WLAN Access Information API + + The ETSI MEC ISG MEC028 WLAN Access Information API described using OpenAPI + + The version of the OpenAPI document: 2.1.1 + + Generated by OpenAPI Generator: https://openapi-generator.tech +*/ + +syntax = "proto3"; + +package mec028; + + +message ExtBssLoad { + + // Indicates the total number of STAs currently associated with this BSS that have a 1 in the MU Beamformee Capable field of their VHT Capabilities element. + int32 mu_mimo_sta_count = 1; + + // Observable loading on each of the secondary 20 MHz channel. + int32 obs_sec20_mhz_util = 2; + + // Observable loading on each of the secondary 40 MHz channel. + int32 obs_sec40_mhz_util = 3; + + // Observable loading on each of the secondary 80 MHz channel. + int32 obs_sec80_mhz_util = 4; + + // The percentage of time, linearly scaled with 255 representing 100 %, that the AP has underutilized spatial domain resources for given busy time of the medium. + int32 spat_stream_under_util = 5; + +} diff --git a/proto3/models/geo_location.proto b/proto3/models/geo_location.proto new file mode 100644 index 0000000..0e772a2 --- /dev/null +++ b/proto3/models/geo_location.proto @@ -0,0 +1,42 @@ +/* + ETSI GS MEC 028 - WLAN Access Information API + + The ETSI MEC ISG MEC028 WLAN Access Information API described using OpenAPI + + The version of the OpenAPI document: 2.1.1 + + Generated by OpenAPI Generator: https://openapi-generator.tech +*/ + +syntax = "proto3"; + +package mec028; + + +message GeoLocation { + + // The altitude value of location as defined in IETF RFC 6225 [6] + int32 altitude = 1; + + // The type description for altitude information e.g. floors or meters as defined in IETF RFC 6225 [6] + int32 altitude_type = 2; + + // The uncertainty for altitude information as defined in IETF RFC 6225 [6] + int32 altitude_uncertainty = 3; + + // The datum value to express how coordinates are organized and related to real world as defined in IETF RFC 6225 [6] + int32 datum = 4; + + // The latitude value of location as defined in IETF RFC 6225 [6] + int64 lat = 5; + + // The uncertainty for Latitude information as defined in IETF RFC 6225 [6] + int32 lat_uncertainty = 6; + + // The longitude value of location as defined in IETF RFC 6225 [6] + int64 long = 7; + + // The uncertainty for Longitude information as defined in IETF RFC 6225 [6] + int32 long_uncertainty = 8; + +} diff --git a/proto3/models/he_capabilities.proto b/proto3/models/he_capabilities.proto new file mode 100644 index 0000000..5480faf --- /dev/null +++ b/proto3/models/he_capabilities.proto @@ -0,0 +1,30 @@ +/* + ETSI GS MEC 028 - WLAN Access Information API + + The ETSI MEC ISG MEC028 WLAN Access Information API described using OpenAPI + + The version of the OpenAPI document: 2.1.1 + + Generated by OpenAPI Generator: https://openapi-generator.tech +*/ + +syntax = "proto3"; + +package mec028; + + +message HeCapabilities { + + // MAC capabilities of an Access Point. + int32 he_mac_cap_info = 1; + + // PHY capabilities of an Access Point. + int32 he_phy_capinfo = 2; + + // PPE Threshold determines the nominal packet padding value for a HE PPDU. + int32 ppe_thresholds = 3; + + // Supported MCS and NSS Set. + int32 supported_he_mcs_nss_set = 4; + +} diff --git a/proto3/models/ht_capabilities.proto b/proto3/models/ht_capabilities.proto new file mode 100644 index 0000000..3f80b6f --- /dev/null +++ b/proto3/models/ht_capabilities.proto @@ -0,0 +1,36 @@ +/* + ETSI GS MEC 028 - WLAN Access Information API + + The ETSI MEC ISG MEC028 WLAN Access Information API described using OpenAPI + + The version of the OpenAPI document: 2.1.1 + + Generated by OpenAPI Generator: https://openapi-generator.tech +*/ + +syntax = "proto3"; + +package mec028; + + +message HtCapabilities { + + // A-MPDU parameters as defined in IEEE 802.11-2016 [8]. + int32 ampdu_parameters = 1; + + // ASEL capabilities as defined in IEEE 802.11-2016 [8]. + int32 asel_cap = 2; + + // HT Capability Information as defined in IEEE 802.11-2016 [8]. + int32 ht_capability_info = 3; + + // Extended HT Capabilities as defined in IEEE 802.11-2016 [8]. + int32 ht_extended_cap = 4; + + // Supported MCS set as defined in IEEE 802.11-2016 [8]. + int64 supported_mcs_set = 5; + + // Transmit Beamforming Capabilities as defined in IEEE 802.11-2016 [8]. + int32 tx_beam_form_cap = 6; + +} diff --git a/proto3/models/inline_notification.proto b/proto3/models/inline_notification.proto new file mode 100644 index 0000000..3dcac7e --- /dev/null +++ b/proto3/models/inline_notification.proto @@ -0,0 +1,37 @@ +/* + ETSI GS MEC 028 - WLAN Access Information API + + The ETSI MEC ISG MEC028 WLAN Access Information API described using OpenAPI + + The version of the OpenAPI document: 2.1.1 + + Generated by OpenAPI Generator: https://openapi-generator.tech +*/ + +syntax = "proto3"; + +package mec028; + +import public "models/ap_identity.proto"; +import public "models/assoc_sta_notification.proto"; +import public "models/sta_data_rate.proto"; +import public "models/sta_data_rate_notification.proto"; +import public "models/sta_identity.proto"; +import public "models/time_stamp.proto"; + +message InlineNotification { + + ApIdentity ap_id = 1; + + // Shall be set to \"StaDataRateNotification\". + string notification_type = 2; + + // Identifier(s) to uniquely specify the client station(s) associated. + repeated StaIdentity sta_id = 3; + + TimeStamp time_stamp = 4; + + // Data rates of a client station. + repeated StaDataRate sta_data_rate = 5; + +} diff --git a/proto3/models/inline_subscription.proto b/proto3/models/inline_subscription.proto new file mode 100644 index 0000000..28d4405 --- /dev/null +++ b/proto3/models/inline_subscription.proto @@ -0,0 +1,39 @@ +/* + ETSI GS MEC 028 - WLAN Access Information API + + The ETSI MEC ISG MEC028 WLAN Access Information API described using OpenAPI + + The version of the OpenAPI document: 2.1.1 + + Generated by OpenAPI Generator: https://openapi-generator.tech +*/ + +syntax = "proto3"; + +package mec028; + +import public "models/ap_identity.proto"; +import public "models/assoc_sta_subscription.proto"; +import public "models/assoc_sta_subscription_links.proto"; +import public "models/sta_data_rate_subscription.proto"; +import public "models/sta_identity.proto"; +import public "models/time_stamp.proto"; + +message InlineSubscription { + + AssocStaSubscriptionLinks underscorelinks = 1; + + ApIdentity ap_id = 2; + + // URI selected by the service consumer to receive notifications on the subscribed WLAN Access Information Service. This shall be included both in the request and in response. + string callback_reference = 3; + + TimeStamp expiry_deadline = 4; + + // Shall be set to \"StaDataRateSubscription\". + string subscription_type = 5; + + // Identifier(s) to uniquely specify the target client station(s) for the subscription + repeated StaIdentity sta_id = 6; + +} diff --git a/proto3/models/link_type.proto b/proto3/models/link_type.proto new file mode 100644 index 0000000..5257331 --- /dev/null +++ b/proto3/models/link_type.proto @@ -0,0 +1,21 @@ +/* + ETSI GS MEC 028 - WLAN Access Information API + + The ETSI MEC ISG MEC028 WLAN Access Information API described using OpenAPI + + The version of the OpenAPI document: 2.1.1 + + Generated by OpenAPI Generator: https://openapi-generator.tech +*/ + +syntax = "proto3"; + +package mec028; + + +message LinkType { + + // URI referring to a resource + string href = 1; + +} diff --git a/proto3/models/measurement_config.proto b/proto3/models/measurement_config.proto new file mode 100644 index 0000000..48631e0 --- /dev/null +++ b/proto3/models/measurement_config.proto @@ -0,0 +1,36 @@ +/* + ETSI GS MEC 028 - WLAN Access Information API + + The ETSI MEC ISG MEC028 WLAN Access Information API described using OpenAPI + + The version of the OpenAPI document: 2.1.1 + + Generated by OpenAPI Generator: https://openapi-generator.tech +*/ + +syntax = "proto3"; + +package mec028; + +import public "models/beacon_request_config.proto"; +import public "models/channel_load_config.proto"; +import public "models/sta_statistics_config.proto"; + +message MeasurementConfig { + + BeaconRequestConfig beacon_request = 1; + + ChannelLoadConfig channel_load = 2; + + // Duration of the measurement, shall be lower than Maximum Measurement Duration in TU as defined in section 11.11.4 of IEEE 802.11 [8]. + int32 measurement_duration = 3; + + // Identifier of this measurement configuration. + string measurement_id = 4; + + // Random interval to be used for starting the measurement. In units of TU as specifed in section 11.11.3 of IEEE 802.11 [8]. + int32 randomn_interval = 5; + + StaStatisticsConfig sta_statistics = 6; + +} diff --git a/proto3/models/neighbor_report.proto b/proto3/models/neighbor_report.proto new file mode 100644 index 0000000..d2fd87e --- /dev/null +++ b/proto3/models/neighbor_report.proto @@ -0,0 +1,33 @@ +/* + ETSI GS MEC 028 - WLAN Access Information API + + The ETSI MEC ISG MEC028 WLAN Access Information API described using OpenAPI + + The version of the OpenAPI document: 2.1.1 + + Generated by OpenAPI Generator: https://openapi-generator.tech +*/ + +syntax = "proto3"; + +package mec028; + + +message NeighborReport { + + // BSS Id of the Access Point that is being reported. + string bssid = 1; + + // Additional information related to Access Point that is being reported such as AP reachability, security, key scope, Mobility Domain, HT/VHT capability and Fine Time Measurements. + int32 bssid_info = 2; + + // The channel currently used by this Access Point. + int32 channel = 3; + + // The channel set of the AP indicated by this BSSID. + int32 operating_class = 4; + + // PHY type of the AP indicated by this BSSID. It is an integer value coded according to the value of the dot11PHYType. + int32 phy_type = 5; + +} diff --git a/proto3/models/problem_details.proto b/proto3/models/problem_details.proto new file mode 100644 index 0000000..aa2dcb2 --- /dev/null +++ b/proto3/models/problem_details.proto @@ -0,0 +1,33 @@ +/* + ETSI GS MEC 028 - WLAN Access Information API + + The ETSI MEC ISG MEC028 WLAN Access Information API described using OpenAPI + + The version of the OpenAPI document: 2.1.1 + + Generated by OpenAPI Generator: https://openapi-generator.tech +*/ + +syntax = "proto3"; + +package mec028; + + +message ProblemDetails { + + // A human-readable explanation specific to this occurrence of the problem + string detail = 1; + + // A URI reference that identifies the specific occurrence of the problem + string instance = 2; + + // The HTTP status code for this occurrence of the problem + int32 status = 3; + + // A short, human-readable summary of the problem type + string title = 4; + + // A URI reference according to IETF RFC 3986 that identifies the problem type + string type = 5; + +} diff --git a/proto3/models/rssi.proto b/proto3/models/rssi.proto new file mode 100644 index 0000000..f50fb0c --- /dev/null +++ b/proto3/models/rssi.proto @@ -0,0 +1,21 @@ +/* + ETSI GS MEC 028 - WLAN Access Information API + + The ETSI MEC ISG MEC028 WLAN Access Information API described using OpenAPI + + The version of the OpenAPI document: 2.1.1 + + Generated by OpenAPI Generator: https://openapi-generator.tech +*/ + +syntax = "proto3"; + +package mec028; + + +message Rssi { + + // The Received Signal Strength Indicator from a station + int32 rssi = 1; + +} diff --git a/proto3/models/sta_data_rate.proto b/proto3/models/sta_data_rate.proto new file mode 100644 index 0000000..1601203 --- /dev/null +++ b/proto3/models/sta_data_rate.proto @@ -0,0 +1,27 @@ +/* + ETSI GS MEC 028 - WLAN Access Information API + + The ETSI MEC ISG MEC028 WLAN Access Information API described using OpenAPI + + The version of the OpenAPI document: 2.1.1 + + Generated by OpenAPI Generator: https://openapi-generator.tech +*/ + +syntax = "proto3"; + +package mec028; + +import public "models/sta_identity.proto"; + +message StaDataRate { + + StaIdentity sta_id = 1; + + // The data transmit rate in kbps that was most recently used for transmission of data PPDUs from the access point to the station. + int32 sta_last_data_downlink_rate = 2; + + // The data transmit rate in Kbps that was most recently used for transmission of data PPDUs from the associated station to the access point. + int32 sta_last_data_uplink_rate = 3; + +} diff --git a/proto3/models/sta_data_rate_notification.proto b/proto3/models/sta_data_rate_notification.proto new file mode 100644 index 0000000..c545359 --- /dev/null +++ b/proto3/models/sta_data_rate_notification.proto @@ -0,0 +1,28 @@ +/* + ETSI GS MEC 028 - WLAN Access Information API + + The ETSI MEC ISG MEC028 WLAN Access Information API described using OpenAPI + + The version of the OpenAPI document: 2.1.1 + + Generated by OpenAPI Generator: https://openapi-generator.tech +*/ + +syntax = "proto3"; + +package mec028; + +import public "models/sta_data_rate.proto"; +import public "models/time_stamp.proto"; + +message StaDataRateNotification { + + // Shall be set to \"StaDataRateNotification\". + string notification_type = 1; + + // Data rates of a client station. + repeated StaDataRate sta_data_rate = 2; + + TimeStamp time_stamp = 3; + +} diff --git a/proto3/models/sta_data_rate_subscription.proto b/proto3/models/sta_data_rate_subscription.proto new file mode 100644 index 0000000..84b617d --- /dev/null +++ b/proto3/models/sta_data_rate_subscription.proto @@ -0,0 +1,34 @@ +/* + ETSI GS MEC 028 - WLAN Access Information API + + The ETSI MEC ISG MEC028 WLAN Access Information API described using OpenAPI + + The version of the OpenAPI document: 2.1.1 + + Generated by OpenAPI Generator: https://openapi-generator.tech +*/ + +syntax = "proto3"; + +package mec028; + +import public "models/assoc_sta_subscription_links.proto"; +import public "models/sta_identity.proto"; +import public "models/time_stamp.proto"; + +message StaDataRateSubscription { + + AssocStaSubscriptionLinks underscorelinks = 1; + + // URI selected by the service consumer to receive notifications on the subscribed WLAN Access Information Service. This shall be included both in the request and in response. + string callback_reference = 2; + + TimeStamp expiry_deadline = 3; + + // Identifier(s) to uniquely specify the target client station(s) for the subscription + repeated StaIdentity sta_id = 4; + + // Shall be set to \"StaDataRateSubscription\". + string subscription_type = 5; + +} diff --git a/proto3/models/sta_identity.proto b/proto3/models/sta_identity.proto new file mode 100644 index 0000000..d203ea5 --- /dev/null +++ b/proto3/models/sta_identity.proto @@ -0,0 +1,30 @@ +/* + ETSI GS MEC 028 - WLAN Access Information API + + The ETSI MEC ISG MEC028 WLAN Access Information API described using OpenAPI + + The version of the OpenAPI document: 2.1.1 + + Generated by OpenAPI Generator: https://openapi-generator.tech +*/ + +syntax = "proto3"; + +package mec028; + + +message StaIdentity { + + // Number which identifies a particular association between a station and an Access Point + string aid = 1; + + // IPv4 or IPv6 address allocated for the station. + repeated string ip_address = 2; + + // Unique identifier assigned to station (as network interface controller) for communications at the data link layer of a network segment. + string mac_id = 3; + + // Service Set Identifier to identify logical networks. + repeated string ssid = 4; + +} diff --git a/proto3/models/sta_info.proto b/proto3/models/sta_info.proto new file mode 100644 index 0000000..479e12c --- /dev/null +++ b/proto3/models/sta_info.proto @@ -0,0 +1,42 @@ +/* + ETSI GS MEC 028 - WLAN Access Information API + + The ETSI MEC ISG MEC028 WLAN Access Information API described using OpenAPI + + The version of the OpenAPI document: 2.1.1 + + Generated by OpenAPI Generator: https://openapi-generator.tech +*/ + +syntax = "proto3"; + +package mec028; + +import public "models/ap_associated.proto"; +import public "models/beacon_report.proto"; +import public "models/rssi.proto"; +import public "models/sta_data_rate.proto"; +import public "models/sta_identity.proto"; +import public "models/sta_statistics.proto"; +import public "models/time_stamp.proto"; + +message StaInfo { + + ApAssociated ap_associated = 1; + + BeaconReport beacon_report = 2; + + // Channel currently used by the station. + int32 channel = 3; + + Rssi rssi = 4; + + StaDataRate sta_data_rate = 5; + + StaIdentity sta_id = 6; + + StaStatistics sta_statistics = 7; + + TimeStamp time_stamp = 8; + +} diff --git a/proto3/models/sta_statistics.proto b/proto3/models/sta_statistics.proto new file mode 100644 index 0000000..0a29db7 --- /dev/null +++ b/proto3/models/sta_statistics.proto @@ -0,0 +1,27 @@ +/* + ETSI GS MEC 028 - WLAN Access Information API + + The ETSI MEC ISG MEC028 WLAN Access Information API described using OpenAPI + + The version of the OpenAPI document: 2.1.1 + + Generated by OpenAPI Generator: https://openapi-generator.tech +*/ + +syntax = "proto3"; + +package mec028; + +import public "models/statistics_group_data.proto"; + +message StaStatistics { + + // Indicates the requested statistics group describing the Statistics Group Data according to table 9-114 of IEEE 802.11-2016 [8]. + int32 group_identity = 1; + + // Measurement Duration. + int32 md = 2; + + StatisticsGroupData statistics_group_data = 3; + +} diff --git a/proto3/models/sta_statistics_config.proto b/proto3/models/sta_statistics_config.proto new file mode 100644 index 0000000..8cb8728 --- /dev/null +++ b/proto3/models/sta_statistics_config.proto @@ -0,0 +1,31 @@ +/* + ETSI GS MEC 028 - WLAN Access Information API + + The ETSI MEC ISG MEC028 WLAN Access Information API described using OpenAPI + + The version of the OpenAPI document: 2.1.1 + + Generated by OpenAPI Generator: https://openapi-generator.tech +*/ + +syntax = "proto3"; + +package mec028; + +import public "models/sta_identity.proto"; + +message StaStatisticsConfig { + + // As per table T 9-114 of IEEE 802.11-2012 [8]. + int32 group_identity = 1; + + StaIdentity sta_id = 2; + + int32 trigger_condition = 3; + + // The Trigger Timeout field contains a value in units of 100 TUs during which a measuring STA does not generate further triggered STA Statistics Reports after a trigger condition has been met. + int32 trigger_timeout = 4; + + bool triggered_report = 5; + +} diff --git a/proto3/models/statistics_group_data.proto b/proto3/models/statistics_group_data.proto new file mode 100644 index 0000000..f5b25ac --- /dev/null +++ b/proto3/models/statistics_group_data.proto @@ -0,0 +1,172 @@ +/* + ETSI GS MEC 028 - WLAN Access Information API + + The ETSI MEC ISG MEC028 WLAN Access Information API described using OpenAPI + + The version of the OpenAPI document: 2.1.1 + + Generated by OpenAPI Generator: https://openapi-generator.tech +*/ + +syntax = "proto3"; + +package mec028; + + +message StatisticsGroupData { + + int32 dot11_ampdu_delimiter_crc_error_count = 1; + + int32 dot11_ampdu_received_count = 2; + + int32 dot11_amsdu_ack_failure_count = 3; + + int32 dot11_ack_failure_count = 4; + + int32 dot11_beamforming_frame_count = 5; + + int32 dot11_channel_width_switch_count = 6; + + int32 dot11_dual_cts_failure_count = 7; + + int32 dot11_dual_cts_success_count = 8; + + int32 dot11_explicit_bar_failure_count = 9; + + int32 dot11_fcs_error_count = 10; + + int32 dot11_failed_amsdu_count = 11; + + int32 dot11_failed_count = 12; + + int32 dot11_forty_mhz_frame_received_count = 13; + + int32 dot11_forty_mhz_frame_transmitted_count = 14; + + int32 dot11_frame_duplicate_count = 15; + + int32 dot11_granted_rdg_unused_count = 16; + + int32 dot11_granted_rdg_used_count = 17; + + int32 dot11_group_received_frame_count = 18; + + int32 dot11_group_transmitted_frame_count = 19; + + int32 dot11_implicit_bar_failure_count = 20; + + int32 dot11_mpdu_in_received_ampdu_count = 21; + + int32 dot11_multiple_retry_amsdu_count = 22; + + int32 dot11_multiple_retry_count = 23; + + int32 dot11_psmputt_grant_duration = 24; + + int32 dot11_psmputt_used_duration = 25; + + int32 dot11_qos_ack_failure_count = 26; + + int32 dot11_qos_discarded_frame_count = 27; + + int32 dot11_qos_failed_count = 28; + + int32 dot11_qos_frame_duplicate_count = 29; + + int32 dot11_qos_mpdus_received_count = 30; + + int32 dot11_qos_multiple_retry_count = 31; + + int32 dot11_qos_rts_failure_count = 32; + + int32 dot11_qos_rts_success_count = 33; + + int32 dot11_qos_received_fragment_count = 34; + + int32 dot11_qos_retries_received_count = 35; + + int32 dot11_qos_retry_count = 36; + + int32 dot11_qos_transmitted_fragment_count = 37; + + int32 dot11_qos_transmitted_frame_count = 38; + + int32 dot11_rsna_stats_bipmic_errors = 39; + + int32 dot11_rsna_stats_ccmp_decrypt_errors = 40; + + int32 dot11_rsna_stats_ccmp_replays = 41; + + int32 dot11_rsna_stats_cmac_replays = 42; + + int32 dot11_rsna_stats_robust_mgmt_ccmp_replays = 43; + + int32 dot11_rsna_stats_tkipcve_rrors = 44; + + int32 dot11_rsna_stats_tkipr_eplays = 45; + + int32 dot11_rts_failure_count = 46; + + int32 dot11_rtsl_sig_failure_count = 47; + + int32 dot11_rtsl_sig_success_count = 48; + + int32 dot11_rts_success_count = 49; + + int32 dot11_received_amsdu_count = 50; + + int32 dot11_received_fragment_count = 51; + + int64 dot11_received_octets_in_ampdu_count = 52; + + int64 dot11_received_octets_in_amsdu_count = 53; + + int32 dot11_retry_amsdu_count = 54; + + int32 dot11_retry_count = 55; + + int32 dot11_sta_statistics_ap_average_access_delay = 56; + + int32 dot11_sta_statistics_average_access_delay_back_ground = 57; + + int32 dot11_sta_statistics_average_access_delay_best_effort = 58; + + int32 dot11_sta_statistics_average_access_delay_video = 59; + + int32 dot11_sta_statistics_average_access_delay_voice = 60; + + int32 dot11_sta_statistics_channel_utilization = 61; + + int32 dot11_sta_statistics_station_count = 62; + + int32 dot11_stbccts_failure_count = 63; + + int32 dot11_stbccts_success_count = 64; + + int32 dot11_transmitted_ampdu_count = 65; + + int32 dot11_transmitted_amsdu_count = 66; + + int32 dot11_transmitted_fragment_count = 67; + + int32 dot11_transmitted_frame_count = 68; + + int32 dot11_transmitted_frames_in_granted_rdg_count = 69; + + int32 dot11_transmitted_mpdus_in_ampdu_count = 70; + + int64 dot11_transmitted_octets_in_ampdu_count = 71; + + int64 dot11_transmitted_octets_in_amsdu_count = 72; + + int32 dot11_transmitted_octets_in_granted_rdg_count = 73; + + int32 dot11_twenty_mhz_frame_received_count = 74; + + int32 dot11_twenty_mhz_frame_transmitted_count = 75; + + int32 dot11non_stbccts_failure_count = 76; + + int32 dot11non_stbccts_success_count = 77; + +} diff --git a/proto3/models/subscription_link_list.proto b/proto3/models/subscription_link_list.proto new file mode 100644 index 0000000..2148878 --- /dev/null +++ b/proto3/models/subscription_link_list.proto @@ -0,0 +1,27 @@ +/* + ETSI GS MEC 028 - WLAN Access Information API + + The ETSI MEC ISG MEC028 WLAN Access Information API described using OpenAPI + + The version of the OpenAPI document: 2.1.1 + + Generated by OpenAPI Generator: https://openapi-generator.tech +*/ + +syntax = "proto3"; + +package mec028; + +import public "models/assoc_sta_subscription.proto"; +import public "models/sta_data_rate_subscription.proto"; +import public "models/subscription_link_list_links.proto"; + +message SubscriptionLinkList { + + SubscriptionLinkListLinks underscorelinks = 1; + + repeated AssocStaSubscription assoc_sta_subscription = 2; + + repeated StaDataRateSubscription sta_data_rate_subscription = 3; + +} diff --git a/proto3/models/subscription_link_list_links.proto b/proto3/models/subscription_link_list_links.proto new file mode 100644 index 0000000..f27358b --- /dev/null +++ b/proto3/models/subscription_link_list_links.proto @@ -0,0 +1,21 @@ +/* + ETSI GS MEC 028 - WLAN Access Information API + + The ETSI MEC ISG MEC028 WLAN Access Information API described using OpenAPI + + The version of the OpenAPI document: 2.1.1 + + Generated by OpenAPI Generator: https://openapi-generator.tech +*/ + +syntax = "proto3"; + +package mec028; + +import public "models/link_type.proto"; + +message SubscriptionLinkListLinks { + + LinkType self = 1; + +} diff --git a/proto3/models/time_stamp.proto b/proto3/models/time_stamp.proto new file mode 100644 index 0000000..5667346 --- /dev/null +++ b/proto3/models/time_stamp.proto @@ -0,0 +1,24 @@ +/* + ETSI GS MEC 028 - WLAN Access Information API + + The ETSI MEC ISG MEC028 WLAN Access Information API described using OpenAPI + + The version of the OpenAPI document: 2.1.1 + + Generated by OpenAPI Generator: https://openapi-generator.tech +*/ + +syntax = "proto3"; + +package mec028; + + +message TimeStamp { + + // The nanoseconds part of the time. Time is defined as Unix-time since January 1, 1970, 00:00:00 UTC. + int32 nano_seconds = 1; + + // The seconds part of the time. Time is defined as Unixtime since January 1, 1970, 00:00:00 UTC. + int32 seconds = 2; + +} diff --git a/proto3/models/vht_capabilities.proto b/proto3/models/vht_capabilities.proto new file mode 100644 index 0000000..b8ce0e7 --- /dev/null +++ b/proto3/models/vht_capabilities.proto @@ -0,0 +1,24 @@ +/* + ETSI GS MEC 028 - WLAN Access Information API + + The ETSI MEC ISG MEC028 WLAN Access Information API described using OpenAPI + + The version of the OpenAPI document: 2.1.1 + + Generated by OpenAPI Generator: https://openapi-generator.tech +*/ + +syntax = "proto3"; + +package mec028; + + +message VhtCapabilities { + + // VHT capabilities Info as defined in IEEE 802.11-2016 [8]. + int32 vht_cap_info = 1; + + // Supported VHT-MCS and NSS Set as defined in IEEE 802.11-2016 [8]. + int64 vht_mcs_nss = 2; + +} diff --git a/proto3/models/wan_metrics.proto b/proto3/models/wan_metrics.proto new file mode 100644 index 0000000..59b7d80 --- /dev/null +++ b/proto3/models/wan_metrics.proto @@ -0,0 +1,36 @@ +/* + ETSI GS MEC 028 - WLAN Access Information API + + The ETSI MEC ISG MEC028 WLAN Access Information API described using OpenAPI + + The version of the OpenAPI document: 2.1.1 + + Generated by OpenAPI Generator: https://openapi-generator.tech +*/ + +syntax = "proto3"; + +package mec028; + + +message WanMetrics { + + // 1-octet positive integer representing the current percentage loading of the downlink WAN connection, scaled linearly with 255 representing 100 %, as measured over an interval the duration of which is reported in Load Measurement Duration. In cases where the downlink load is unknown to the AP, the value is set to zero. + int32 downlink_load = 1; + + // 4-octet positive integer whose value is an estimate of the WAN Backhaul link current downlink speed in kilobits per second. + int32 downlink_speed = 2; + + // The LMD (Load Measurement Duration) field is a 2-octet positive integer representing the duration over which the Downlink Load and Uplink Load have been measured, in tenths of a second. When the actual load measurement duration is greater than the maximum value, the maximum value will be reported. The value of the LMD field is set to 0 when neither the uplink nor downlink load can be computed. When the uplink and downlink loads are computed over different intervals, the maximum interval is reported. + int32 lmd = 3; + + // 1-octet positive integer representing the current percentage loading of the uplink WAN connection, scaled linearly with 255 representing 100 %, as measured over an interval, the duration of which is reported in Load Measurement Duration. In cases where the uplink load is unknown to the AP, the value is set to zero. + int32 uplink_load = 4; + + // 4-octet positive integer whose value is an estimate of the WAN Backhaul link's current uplink speed in kilobits per second. + int32 uplink_speed = 5; + + // Info about WAN link status, link symmetricity and capacity currently used. + int32 wan_info = 6; + +} diff --git a/proto3/models/wlan_capabilities.proto b/proto3/models/wlan_capabilities.proto new file mode 100644 index 0000000..e86ab84 --- /dev/null +++ b/proto3/models/wlan_capabilities.proto @@ -0,0 +1,33 @@ +/* + ETSI GS MEC 028 - WLAN Access Information API + + The ETSI MEC ISG MEC028 WLAN Access Information API described using OpenAPI + + The version of the OpenAPI document: 2.1.1 + + Generated by OpenAPI Generator: https://openapi-generator.tech +*/ + +syntax = "proto3"; + +package mec028; + +import public "models/dmg_capabilities.proto"; +import public "models/edmg_capabilities.proto"; +import public "models/he_capabilities.proto"; +import public "models/ht_capabilities.proto"; +import public "models/vht_capabilities.proto"; + +message WlanCapabilities { + + DmgCapabilities dmg = 1; + + EdmgCapabilities edmg = 2; + + HeCapabilities he = 3; + + HtCapabilities ht = 4; + + VhtCapabilities vht = 5; + +} diff --git a/proto3/services/wai_service.proto b/proto3/services/wai_service.proto new file mode 100644 index 0000000..2a91b96 --- /dev/null +++ b/proto3/services/wai_service.proto @@ -0,0 +1,106 @@ +/* + ETSI GS MEC 028 - WLAN Access Information API + + The ETSI MEC ISG MEC028 WLAN Access Information API described using OpenAPI + + The version of the OpenAPI document: 2.1.1 + + Generated by OpenAPI Generator: https://openapi-generator.tech +*/ + +syntax = "proto3"; + +package mec028; + +import "google/protobuf/empty.proto"; +import public "models/ap_info.proto"; +import public "models/inline_subscription.proto"; +import public "models/problem_details.proto"; +import public "models/sta_info.proto"; +import public "models/subscription_link_list.proto"; + +service WaiService { + rpc ApInfoGET (ApInfoGETRequest) returns (ApInfoGETResponse); + + rpc StaInfoGET (StaInfoGETRequest) returns (StaInfoGETResponse); + + rpc SubscriptionLinkListSubscriptionsGET (SubscriptionLinkListSubscriptionsGETRequest) returns (SubscriptionLinkList); + + rpc SubscriptionsDELETE (SubscriptionsDELETERequest) returns (google.protobuf.Empty); + + rpc SubscriptionsGET (SubscriptionsGETRequest) returns (InlineSubscription); + + rpc SubscriptionsPOST (SubscriptionsPOSTRequest) returns (InlineSubscription); + + rpc SubscriptionsPUT (SubscriptionsPUTRequest) returns (InlineSubscription); + +} + +message ApInfoGETRequest { + // Attribute-based filtering expression according to clause 6.19 of ETSI GS MEC 009. . + string filter = 1; + // Include all complex attributes in the response. See clause 6.18 of ETSI GS MEC 009 for details. + string all_fields = 2; + // Complex attributes to be included into the response. See clause 6.18 of ETSI GS MEC 009 for details. + repeated string fields = 3; + // Complex attributes to be excluded from the response. See clause 6.18 of ETSI GS MEC 009 for details. + repeated string exclude_fields = 4; + // Indicates to exclude the following complex attributes from the response. See clause 6.18 of ETSI GS MEC 009 for details. The following attributes shall be excluded from the structure in the response body if this parameter is provided, or none of the parameters \"all_fields\", \"fields\", \"exclude_fields\", \"exclude_default\" are provided: Not applicable + repeated string exclude_default = 5; + +} + +message ApInfoGETResponse { + repeated ApInfo data = 1; +} + +message StaInfoGETRequest { + // Attribute-based filtering expression according to clause 6.19 of ETSI GS MEC 009. . + string filter = 1; + // Include all complex attributes in the response. See clause 6.18 of ETSI GS MEC 009 for details. + string all_fields = 2; + // Complex attributes to be included into the response. See clause 6.18 of ETSI GS MEC 009 for details. + repeated string fields = 3; + // Complex attributes to be excluded from the response. See clause 6.18 of ETSI GS MEC 009 for details. + repeated string exclude_fields = 4; + // Indicates to exclude the following complex attributes from the response. See clause 6.18 of ETSI GS MEC 009 for details. The following attributes shall be excluded from the structure in the response body if this parameter is provided, or none of the parameters \"all_fields\", \"fields\", \"exclude_fields\", \"exclude_default\" are provided: Not applicable + repeated string exclude_default = 5; + +} + +message StaInfoGETResponse { + repeated StaInfo data = 1; +} + +message SubscriptionLinkListSubscriptionsGETRequest { + // Filter on a specific subscription type. Permitted values: assoc_sta, sta_data_rate. + string subscription_type = 1; + +} + +message SubscriptionsDELETERequest { + // Subscription Id, specifically the \"self\" returned in the subscription request + string subscription_id = 1; + +} + +message SubscriptionsGETRequest { + // Subscription Id, specifically the \"self\" returned in the subscription request + string subscription_id = 1; + +} + +message SubscriptionsPOSTRequest { + // Subscription to be created + InlineSubscription inline_subscription = 1; + +} + +message SubscriptionsPUTRequest { + // Subscription Id, specifically the \"self\" returned in the subscription request + string subscription_id = 1; + // Subscription to be modified + InlineSubscription inline_subscription = 2; + +} + -- GitLab From 59bdd2b45c893be727cadd47189d6681e07202bd Mon Sep 17 00:00:00 2001 From: Elian Kraja Date: Mon, 14 Dec 2020 17:57:57 +0100 Subject: [PATCH 8/8] Update README.md --- README.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 1d6f88d..5f73aea 100644 --- a/README.md +++ b/README.md @@ -5,8 +5,8 @@ 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/gitlab/mec/gs028-wai-api/raw/stf593/WlanInformationApi.yaml). -* [Edit the API online](https://forge.etsi.org/swagger/editor/?url=https://forge.etsi.org/gitlab/mec/gs028-wai-api/raw/stf593/WlanInformationApi.yaml). +* [Navigate the API in the browser](https://forge.etsi.org/swagger/ui/?url=https://forge.etsi.org/gitlab/mec/gs028-wai-api/raw/develop/WlanInformationApi.yaml). +* [Edit the API online](https://forge.etsi.org/swagger/editor/?url=https://forge.etsi.org/gitlab/mec/gs028-wai-api/raw/develop/WlanInformationApi.yaml). ## License -- GitLab