{ "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": "uint32", "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": "uint16", "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": "uint8", "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": "uint16", "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": "uint8", "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": "uint16", "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": "uint16", "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": "uint8", "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": "uint8", "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": "uint8", "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": "uint16", "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": "uint8", "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": "uint32", "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": "uint16", "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": "uint16", "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": "uint8", "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": "uint8", "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": "uint8", "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": "uint8", "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": "uint32", "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": "uint8", "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": "uint8", "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": "uint8", "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": "uint8", "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": "uint8", "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.", "format": "uint8", "type": "integer", "x-etsi-mec-cardinality": "1", "x-etsi-mec-origin-type": "Uint8" }, "hePhyCapinfo": { "description": "PHY capabilities of an Access Point.", "format": "uint8", "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.", "format": "uint8", "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": "uint8", "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": "uint8", "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": "uint16", "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": "uint16", "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": "uint128", "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": "uint32", "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" }, "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": "uint32", "type": "integer", "x-etsi-mec-cardinality": "1", "x-etsi-mec-origin-type": "UInt32" }, "channel": { "description": "The channel currently used by this Access Point.", "format": "uint8", "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.", "format": "uint8", "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.", "format": "uint8", "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", "format": "uint8", "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": "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": { "$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": "uint32", "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].", "format": "uint8", "type": "integer", "x-etsi-mec-cardinality": "1", "x-etsi-mec-origin-type": "UInt8" }, "md": { "description": "Measurement Duration.", "format": "uint16", "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": "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": "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": "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": { "format": "uint8", "type": "integer", "x-etsi-mec-cardinality": "0..1", "x-etsi-mec-origin-type": "Uint8" }, "dot11STAStatisticsAverageAccessDelayBackGround": { "format": "uint8", "type": "integer", "x-etsi-mec-cardinality": "0..1", "x-etsi-mec-origin-type": "Uint8" }, "dot11STAStatisticsAverageAccessDelayBestEffort": { "format": "uint8", "type": "integer", "x-etsi-mec-cardinality": "0..1", "x-etsi-mec-origin-type": "Uint8" }, "dot11STAStatisticsAverageAccessDelayVideo": { "format": "uint8", "type": "integer", "x-etsi-mec-cardinality": "0..1", "x-etsi-mec-origin-type": "Uint8" }, "dot11STAStatisticsAverageAccessDelayVoice": { "format": "uint8", "type": "integer", "x-etsi-mec-cardinality": "0..1", "x-etsi-mec-origin-type": "Uint8" }, "dot11STAStatisticsChannelUtilization": { "format": "uint8", "type": "integer", "x-etsi-mec-cardinality": "0..1", "x-etsi-mec-origin-type": "Uint8" }, "dot11STAStatisticsStationCount": { "format": "uint8", "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": "int64", "type": "integer", "x-etsi-mec-cardinality": "0..1", "x-etsi-mec-origin-type": "Uint64" }, "dot11TransmittedOctetsInAMSDUCount": { "format": "uint32", "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": { "$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": "uint32", "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": "uint32", "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": "uint32", "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": "uint8", "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": "uint32", "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": "uint16", "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": "uint8", "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": "uint32", "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": "uint8", "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" } } } }