From e91acfc3a8a2ccdfcf2ff88c62da8809bba7f1fd Mon Sep 17 00:00:00 2001 From: piscione Date: Fri, 19 Nov 2021 12:34:47 +0100 Subject: [PATCH 1/5] First draft of OAS3.1.0 added. --- ...WlanInformationApi.yaml-OpenApi31Yaml.yaml | 2824 +++++++++++++++++ 1 file changed, 2824 insertions(+) create mode 100644 OAS3.1.0/WlanInformationApi.yaml-OpenApi31Yaml.yaml diff --git a/OAS3.1.0/WlanInformationApi.yaml-OpenApi31Yaml.yaml b/OAS3.1.0/WlanInformationApi.yaml-OpenApi31Yaml.yaml new file mode 100644 index 0000000..804e875 --- /dev/null +++ b/OAS3.1.0/WlanInformationApi.yaml-OpenApi31Yaml.yaml @@ -0,0 +1,2824 @@ +openapi: 3.1.0 +info: + title: ETSI GS MEC 028 - WLAN Access Information API + description: The ETSI MEC ISG MEC028 WLAN Access Information API described using OpenAPI + contact: + url: https://forge.etsi.org/rep/mec/gs028-wai-api + version: '2.2.1' +jsonSchemaDialect: https://json-schema.org/draft/2020-12/schema +servers: +- url: https://localhost/wai/v2 + variables: {} +paths: + /queries/ap/ap_information: + get: + tags: + - wai + summary: apInfoGET + description: Queries information about existing WLAN Access Points + operationId: apInfoGET + parameters: + - name: filter + in: query + description: Attribute-based filtering expression according to clause 6.19 of ETSI GS MEC 009. . + style: form + explode: true + schema: + type: string + - name: all_fields + in: query + description: Include all complex attributes in the response. See clause 6.18 of ETSI GS MEC 009 for details. + style: form + explode: true + schema: + type: string + - name: fields + in: query + description: Complex attributes to be included into the response. See clause 6.18 of ETSI GS MEC 009 for details. + style: form + explode: true + schema: + type: array + items: + type: string + - 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. + style: form + explode: true + schema: + type: array + items: + type: string + - 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' + style: form + explode: true + schema: + type: array + items: + type: string + responses: + '200': + description: Successful response to ap_info request + headers: {} + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/ApInfo' + description: '' + contentMediaType: application/json + '400': + description: 'Bad Request : used to indicate that incorrect parameters were passed to the request.' + headers: {} + content: + application/problem+json: + schema: + $ref: '#/components/schemas/ProblemDetails' + '401': + description: 'Unauthorized : used when the client did not submit credentials.' + headers: {} + content: + application/problem+json: + schema: + $ref: '#/components/schemas/ProblemDetails' + '403': + description: 'Forbidden : operation is not allowed given the current status of the resource.' + headers: {} + 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.' + headers: {} + 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.' + headers: {} + content: + application/problem+json: + schema: + $ref: '#/components/schemas/ProblemDetails' + '429': + description: 'Too Many Requests : used when a rate limiter has triggered.' + headers: {} + content: + application/problem+json: + schema: + $ref: '#/components/schemas/ProblemDetails' + deprecated: false + parameters: [] + /queries/sta/sta_information: + get: + tags: + - wai + summary: staInfoGET + description: Queries information about existing WLAN stations + operationId: staInfoGET + parameters: + - name: filter + in: query + description: Attribute-based filtering expression according to clause 6.19 of ETSI GS MEC 009. . + style: form + explode: true + schema: + type: string + - name: all_fields + in: query + description: Include all complex attributes in the response. See clause 6.18 of ETSI GS MEC 009 for details. + style: form + explode: true + schema: + type: string + - name: fields + in: query + description: Complex attributes to be included into the response. See clause 6.18 of ETSI GS MEC 009 for details. + style: form + explode: true + schema: + type: array + items: + type: string + - 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. + style: form + explode: true + schema: + type: array + items: + type: string + - 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' + style: form + explode: true + schema: + type: array + items: + type: string + responses: + '200': + description: Successful response to sta_info request + headers: {} + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/StaInfo' + description: '' + contentMediaType: application/json + '400': + description: 'Bad Request : used to indicate that incorrect parameters were passed to the request.' + headers: {} + content: + application/problem+json: + schema: + $ref: '#/components/schemas/ProblemDetails' + '401': + description: 'Unauthorized : used when the client did not submit credentials.' + headers: {} + content: + application/problem+json: + schema: + $ref: '#/components/schemas/ProblemDetails' + '403': + description: 'Forbidden : operation is not allowed given the current status of the resource.' + headers: {} + 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.' + headers: {} + 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.' + headers: {} + content: + application/problem+json: + schema: + $ref: '#/components/schemas/ProblemDetails' + '429': + description: 'Too Many Requests : used when a rate limiter has triggered.' + headers: {} + content: + application/problem+json: + schema: + $ref: '#/components/schemas/ProblemDetails' + deprecated: false + parameters: [] + /subscriptions: + get: + tags: + - wai + summary: subscriptionLinkList_subscriptionsGET + description: Queries information on subscriptions for notifications + operationId: subscriptionLinkList_subscriptionsGET + parameters: + - name: subscription_type + in: query + description: 'Filter on a specific subscription type. Permitted values: assoc_sta, sta_data_rate, measure_report.' + style: form + explode: true + schema: + type: string + responses: + '200': + description: Response body contains the list of links to requestors subscriptions. + headers: {} + content: + application/json: + schema: + $ref: '#/components/schemas/SubscriptionLinkList' + '400': + description: 'Bad Request : used to indicate that incorrect parameters were passed to the request.' + headers: {} + content: + application/problem+json: + schema: + $ref: '#/components/schemas/ProblemDetails' + '401': + description: 'Unauthorized : used when the client did not submit credentials.' + headers: {} + content: + application/problem+json: + schema: + $ref: '#/components/schemas/ProblemDetails' + '403': + description: 'Forbidden : operation is not allowed given the current status of the resource.' + headers: {} + 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.' + headers: {} + 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.' + headers: {} + content: + application/problem+json: + schema: + $ref: '#/components/schemas/ProblemDetails' + '429': + description: 'Too Many Requests : used when a rate limiter has triggered.' + headers: {} + content: + application/problem+json: + schema: + $ref: '#/components/schemas/ProblemDetails' + deprecated: false + post: + tags: + - wai + summary: subscriptionsPOST + description: Creates a new subscription to WLAN Access Information notifications + operationId: subscriptionsPOST + parameters: [] + requestBody: + description: Subscription to be created + content: + application/json: + schema: + oneOf: + - $ref: '#/components/schemas/AssocStaSubscription' + - $ref: '#/components/schemas/StaDataRateSubscription' + - $ref: '#/components/schemas/MeasurementReportSubscription' + description: Subscription to be created + examples: + - subscriptionType: AssocStaSubscription + callbackReference: http://meAppClient.example.com/wai/v2/notifications/1 + expiryDeadline: + seconds: 1977836800 + nanoSeconds: 0 + apId: + bssid: 005C0A0A0A0A + ssid: + - myNetworkSsid + ipAddress: + - 10.10.100.1 + contentMediaType: application/json + example: + subscriptionType: AssocStaSubscription + callbackReference: http://meAppClient.example.com/wai/v2/notifications/1 + expiryDeadline: + seconds: 1977836800 + nanoSeconds: 0 + apId: + bssid: 005C0A0A0A0A + ssid: + - myNetworkSsid + ipAddress: + - 10.10.100.1 + required: true + responses: + '201': + description: Successful subscription response + headers: {} + content: + application/json: + schema: + oneOf: + - $ref: '#/components/schemas/AssocStaSubscription' + - $ref: '#/components/schemas/StaDataRateSubscription' + - $ref: '#/components/schemas/MeasurementReportSubscription' + examples: + - 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: + bssid: 005C0A0A0A0A + ssid: + - myNetworkSsid + ipAddress: + - 10.10.100.1 + contentMediaType: application/json + 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: + bssid: 005C0A0A0A0A + ssid: + - myNetworkSsid + ipAddress: + - 10.10.100.1 + '400': + description: 'Bad Request : used to indicate that incorrect parameters were passed to the request.' + headers: {} + content: + application/problem+json: + schema: + $ref: '#/components/schemas/ProblemDetails' + '401': + description: 'Unauthorized : used when the client did not submit credentials.' + headers: {} + content: + application/problem+json: + schema: + $ref: '#/components/schemas/ProblemDetails' + '403': + description: 'Forbidden : operation is not allowed given the current status of the resource.' + headers: {} + 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.' + headers: {} + 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.' + headers: {} + 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.' + headers: {} + 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.' + headers: {} + 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.' + headers: {} + content: + application/problem+json: + schema: + $ref: '#/components/schemas/ProblemDetails' + deprecated: false + parameters: [] + /subscriptions/{subscriptionId}: + get: + tags: + - wai + summary: subscriptionsGET + description: Queries information about an existing subscription, identified by its self-referring URI returned on creation (initial POST) + operationId: subscriptionsGET + parameters: + - name: subscriptionId + in: path + description: Subscription Id, specifically the "self" returned in the subscription request + required: true + style: simple + schema: + type: string + responses: + '200': + description: Subscription information regarding subscription notifications + headers: {} + content: + application/json: + schema: + oneOf: + - $ref: '#/components/schemas/AssocStaSubscription' + - $ref: '#/components/schemas/StaDataRateSubscription' + - $ref: '#/components/schemas/MeasurementReportSubscription' + examples: + - 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: + bssid: 005C0A0A0A0A + ssid: + - myNetworkSsid + ipAddress: + - 10.10.100.1 + contentMediaType: application/json + 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: + bssid: 005C0A0A0A0A + ssid: + - myNetworkSsid + ipAddress: + - 10.10.100.1 + '400': + description: 'Bad Request : used to indicate that incorrect parameters were passed to the request.' + headers: {} + content: + application/problem+json: + schema: + $ref: '#/components/schemas/ProblemDetails' + '401': + description: 'Unauthorized : used when the client did not submit credentials.' + headers: {} + content: + application/problem+json: + schema: + $ref: '#/components/schemas/ProblemDetails' + '403': + description: 'Forbidden : operation is not allowed given the current status of the resource.' + headers: {} + 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.' + headers: {} + 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.' + headers: {} + content: + application/problem+json: + schema: + $ref: '#/components/schemas/ProblemDetails' + '429': + description: 'Too Many Requests : used when a rate limiter has triggered.' + headers: {} + content: + application/problem+json: + schema: + $ref: '#/components/schemas/ProblemDetails' + deprecated: false + put: + tags: + - wai + summary: subscriptionsPUT + description: Updates an existing subscription, identified by its self-referring URI returned on creation (initial POST) + operationId: subscriptionsPUT + parameters: + - name: subscriptionId + in: path + description: Subscription Id, specifically the "self" returned in the subscription request + required: true + style: simple + schema: + type: string + requestBody: + description: Subscription to be modified + content: + application/json: + schema: + oneOf: + - $ref: '#/components/schemas/AssocStaSubscription' + - $ref: '#/components/schemas/StaDataRateSubscription' + - $ref: '#/components/schemas/MeasurementReportSubscription' + description: Subscription to be modified + examples: + - 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: + bssid: 005C0A0A0A0A + ssid: + - myNetworkSsid + ipAddress: + - 10.10.100.1 + contentMediaType: application/json + 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: + bssid: 005C0A0A0A0A + ssid: + - myNetworkSsid + ipAddress: + - 10.10.100.1 + required: true + responses: + '200': + description: Successful subscription modification + headers: {} + content: + application/json: + schema: + oneOf: + - $ref: '#/components/schemas/AssocStaSubscription' + - $ref: '#/components/schemas/StaDataRateSubscription' + - $ref: '#/components/schemas/MeasurementReportSubscription' + examples: + - _links: + self: + href: http://[hostIP]/sbox-xyz123/wai/v2/subscriptions/sub123 + callbackReference: http://my.callback.com/wai/some-id + apId: + bssid: 005C0A0A0A0A + ssid: + - myNetworkSsid + ipAddress: + - 10.10.100.1 + contentMediaType: application/json + example: + _links: + self: + href: http://[hostIP]/sbox-xyz123/wai/v2/subscriptions/sub123 + callbackReference: http://my.callback.com/wai/some-id + apId: + bssid: 005C0A0A0A0A + ssid: + - myNetworkSsid + ipAddress: + - 10.10.100.1 + '400': + description: 'Bad Request : used to indicate that incorrect parameters were passed to the request.' + headers: {} + content: + application/problem+json: + schema: + $ref: '#/components/schemas/ProblemDetails' + '401': + description: 'Unauthorized : used when the client did not submit credentials.' + headers: {} + content: + application/problem+json: + schema: + $ref: '#/components/schemas/ProblemDetails' + '403': + description: 'Forbidden : operation is not allowed given the current status of the resource.' + headers: {} + 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.' + headers: {} + 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.' + headers: {} + 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' + headers: {} + 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.' + headers: {} + 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.' + headers: {} + content: + application/problem+json: + schema: + $ref: '#/components/schemas/ProblemDetails' + deprecated: false + delete: + tags: + - wai + summary: subscriptionsDELETE + description: Cancels an existing subscription, identified by its self-referring URI returned on creation (initial POST) + operationId: subscriptionsDELETE + parameters: + - name: subscriptionId + in: path + description: Subscription Id, specifically the "self" returned in the subscription request + required: true + style: simple + schema: + type: string + responses: + '204': + description: No Content + headers: {} + content: {} + '401': + description: 'Unauthorized : used when the client did not submit credentials.' + headers: {} + content: + application/problem+json: + schema: + $ref: '#/components/schemas/ProblemDetails' + '403': + description: 'Forbidden : operation is not allowed given the current status of the resource.' + headers: {} + 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.' + headers: {} + content: + application/problem+json: + schema: + $ref: '#/components/schemas/ProblemDetails' + '429': + description: 'Too Many Requests : used when a rate limiter has triggered.' + headers: {} + content: + application/problem+json: + schema: + $ref: '#/components/schemas/ProblemDetails' + deprecated: false + parameters: [] + /measurements: + get: + tags: + - wai + summary: measurementLinkList_measurementsGET + description: Queries information on measurements configuration + operationId: measurementLinkList_measurementsGET + parameters: [] + responses: + '200': + description: Response body contains the list of links to requestors measurement configurations. + headers: {} + content: + application/json: + schema: + $ref: '#/components/schemas/MeasurementConfigLinkList' + example: + _links: + self: + href: http://meAppServer.example.com/wai/v2/measurements + measurementConfig: + - href: http://meAppServer.example.com/wai/v2/measurements/meas123 + measurementId: myId1 + '400': + description: 'Bad Request : used to indicate that incorrect parameters were passed to the request.' + headers: {} + content: + application/problem+json: + schema: + $ref: '#/components/schemas/ProblemDetails' + '401': + description: 'Unauthorized : used when the client did not submit credentials.' + headers: {} + content: + application/problem+json: + schema: + $ref: '#/components/schemas/ProblemDetails' + '403': + description: 'Forbidden : operation is not allowed given the current status of the resource.' + headers: {} + 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.' + headers: {} + 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.' + headers: {} + content: + application/problem+json: + schema: + $ref: '#/components/schemas/ProblemDetails' + '429': + description: 'Too Many Requests : used when a rate limiter has triggered.' + headers: {} + content: + application/problem+json: + schema: + $ref: '#/components/schemas/ProblemDetails' + deprecated: false + post: + tags: + - wai + summary: measurementsPOST + description: Creates a new measurement configuration + operationId: measurementsPOST + parameters: [] + requestBody: + description: Measurement configuration information + content: + application/json: + schema: + $ref: '#/components/schemas/MeasurementConfig' + required: true + responses: + '201': + description: Successful measurement configuration response + headers: {} + content: + application/json: + schema: + $ref: '#/components/schemas/MeasurementConfig' + '400': + description: 'Bad Request : used to indicate that incorrect parameters were passed to the request.' + headers: {} + content: + application/problem+json: + schema: + $ref: '#/components/schemas/ProblemDetails' + '401': + description: 'Unauthorized : used when the client did not submit credentials.' + headers: {} + content: + application/problem+json: + schema: + $ref: '#/components/schemas/ProblemDetails' + '403': + description: 'Forbidden : operation is not allowed given the current status of the resource.' + headers: {} + 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.' + headers: {} + 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.' + headers: {} + 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.' + headers: {} + 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.' + headers: {} + 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.' + headers: {} + content: + application/problem+json: + schema: + $ref: '#/components/schemas/ProblemDetails' + deprecated: false + parameters: [] + /measurements/{measurementConfigId}: + get: + tags: + - wai + summary: measurementsGET + description: Queries information about an existing measurement configuration, identified by its self-referring URI returned on creation (initial POST) + operationId: measurementsGET + parameters: + - name: measurementConfigId + in: path + description: Measurement configuration Id, specifically the "self" returned in the measurement configuration request + required: true + style: simple + schema: + type: string + responses: + '200': + description: Measurement configuration information + headers: {} + content: + application/json: + schema: + $ref: '#/components/schemas/MeasurementConfig' + '400': + description: 'Bad Request : used to indicate that incorrect parameters were passed to the request.' + headers: {} + content: + application/problem+json: + schema: + $ref: '#/components/schemas/ProblemDetails' + '401': + description: 'Unauthorized : used when the client did not submit credentials.' + headers: {} + content: + application/problem+json: + schema: + $ref: '#/components/schemas/ProblemDetails' + '403': + description: 'Forbidden : operation is not allowed given the current status of the resource.' + headers: {} + 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.' + headers: {} + 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.' + headers: {} + content: + application/problem+json: + schema: + $ref: '#/components/schemas/ProblemDetails' + '429': + description: 'Too Many Requests : used when a rate limiter has triggered.' + headers: {} + content: + application/problem+json: + schema: + $ref: '#/components/schemas/ProblemDetails' + deprecated: false + put: + tags: + - wai + summary: measurementsPUT + description: Updates an existing measurement configuration, identified by its self-referring URI returned on creation (initial POST) + operationId: measurementsPUT + parameters: + - name: measurementConfigId + in: path + description: Measurement configuration Id, specifically the "self" returned in the measurement configuration request + required: true + style: simple + schema: + type: string + requestBody: + description: Measurement configuration to be modified + content: + application/json: + schema: + $ref: '#/components/schemas/MeasurementConfig' + required: true + responses: + '200': + description: Successful measurement configuration modification + headers: {} + content: + application/json: + schema: + $ref: '#/components/schemas/MeasurementConfig' + '400': + description: 'Bad Request : used to indicate that incorrect parameters were passed to the request.' + headers: {} + content: + application/problem+json: + schema: + $ref: '#/components/schemas/ProblemDetails' + '401': + description: 'Unauthorized : used when the client did not submit credentials.' + headers: {} + content: + application/problem+json: + schema: + $ref: '#/components/schemas/ProblemDetails' + '403': + description: 'Forbidden : operation is not allowed given the current status of the resource.' + headers: {} + 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.' + headers: {} + 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.' + headers: {} + 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' + headers: {} + 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.' + headers: {} + 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.' + headers: {} + content: + application/problem+json: + schema: + $ref: '#/components/schemas/ProblemDetails' + deprecated: false + delete: + tags: + - wai + summary: measurementsDELETE + description: Cancels an existing measurement configuration, identified by its self-referring URI returned on creation (initial POST) + operationId: measurementsDELETE + parameters: + - name: measurementConfigId + in: path + description: Measurement configuration Id, specifically the "self" returned in the measurement configuration request + required: true + style: simple + schema: + type: string + responses: + '204': + description: No Content + headers: {} + content: {} + '401': + description: 'Unauthorized : used when the client did not submit credentials.' + headers: {} + content: + application/problem+json: + schema: + $ref: '#/components/schemas/ProblemDetails' + '403': + description: 'Forbidden : operation is not allowed given the current status of the resource.' + headers: {} + 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.' + headers: {} + content: + application/problem+json: + schema: + $ref: '#/components/schemas/ProblemDetails' + '429': + description: 'Too Many Requests : used when a rate limiter has triggered.' + headers: {} + content: + application/problem+json: + schema: + $ref: '#/components/schemas/ProblemDetails' + deprecated: false + parameters: [] +components: + schemas: + ApAssociated: + title: ApAssociated + required: + - bssid + type: object + properties: + assocId: + type: string + description: Unique number which identifies a particular association between the station and Access Point. + bssid: + type: string + description: Basic Service Set Identifier (BSSID) is a unique identifier assigned to the Access Point (as network interface controller) for communications at the data link layer of a network segment. BSSID is typically set to an access point's MAC address. + ipAddress: + minItems: 0 + type: array + items: + type: string + description: IPv4 or IPv6 address allocated for the Access Point. + ssid: + minItems: 0 + type: array + items: + type: string + description: Service Set Identifier to identify logical networks. + ApIdentity: + title: ApIdentity + required: + - bssid + type: object + properties: + bssid: + type: string + description: Basic Service Set Identifier (BSSID) is a unique Identifier assigned to an Access Point (as network interface controller) for communications at the data link layer of a network segment. BSSID is typically set to an access point's MAC address. + ipAddress: + minItems: 0 + type: array + items: + type: string + description: IPv4 or IPv6 address allocated for the Access Point. + ssid: + minItems: 0 + type: array + items: + type: string + description: Service Set Identifier (SSID) to identify logical WLAN networks available via the Access Point. + ApInfo: + title: ApInfo + required: + - apId + type: object + properties: + apId: + $ref: '#/components/schemas/ApIdentity' + apLocation: + $ref: '#/components/schemas/ApLocation' + bssLoad: + $ref: '#/components/schemas/BssLoad' + channel: + type: integer + description: Channel configured for the Access Point. + contentEncoding: int32 + extBssLoad: + $ref: '#/components/schemas/ExtBssLoad' + oBssLoad: + $ref: '#/components/schemas/OBssLoad' + timeStamp: + $ref: '#/components/schemas/TimeStamp' + wanMetrics: + $ref: '#/components/schemas/WanMetrics' + wlanCap: + $ref: '#/components/schemas/WlanCapabilities' + ApLocation: + title: ApLocation + type: object + properties: + civicLocation: + $ref: '#/components/schemas/CivicLocation' + geolocation: + $ref: '#/components/schemas/GeoLocation' + AssocStaNotification: + title: AssocStaNotification + allOf: + - $ref: '#/components/schemas/InlineNotification' + - required: + - apId + type: object + properties: + apId: + $ref: '#/components/schemas/ApIdentity' + staId: + minItems: 0 + type: array + items: + $ref: '#/components/schemas/StaIdentity' + description: Identifier(s) to uniquely specify the client station(s) associated. + timeStamp: + $ref: '#/components/schemas/TimeStamp' + AssocStaSubscription: + title: AssocStaSubscription + allOf: + - $ref: '#/components/schemas/InlineSubscription' + - required: + - apId + type: object + properties: + _links: + $ref: '#/components/schemas/Links' + apId: + $ref: '#/components/schemas/ApIdentity' + callbackReference: + type: string + expiryDeadline: + $ref: '#/components/schemas/TimeStamp' + notificationEvent: + $ref: '#/components/schemas/NotificationEvent' + notificationPeriod: + type: integer + description: >- + Set for periodic notification reporting. + + Value indicates the notification period in seconds. + contentEncoding: int32 + requestTestNotification: + type: boolean + description: Set to TRUE by the service consumer to request a test notification on the callbackReference URI to determine if it is reachable by the WAIS for notifications. + websockNotifConfig: + $ref: '#/components/schemas/WebsockNotifConfig' + BeaconReport: + title: BeaconReport + required: + - bssid + - channel + - measurementId + - operatingClass + - reportedFrameInfo + type: object + properties: + antennaId: + type: integer + description: The Antenna ID field contains the identifying number for the antenna(s) used for this measurement. Antenna ID is defined in section 9.4.2.40 of IEEE 802.11-2016 [8]. + contentEncoding: int32 + bssid: + type: string + description: Indicates the BSSID of the BSS for which a beacon report has been received. + channel: + type: integer + description: Channel number where the beacon was received. + contentEncoding: int32 + measurementId: + type: string + description: Measurement ID of the Measurement configuration applied to this Beacon Report. + operatingClass: + type: integer + description: Operating Class field indicates an operating class value as defined in Annex E within IEEE 802.11-2016 [8]. + contentEncoding: int32 + parentTsf: + type: integer + description: The Parent TSF field contains the lower 4 octets of the measuring STA's TSF timer value at the start of reception of the first octet of the timestamp field of the reported Beacon, Measurement Pilot, or Probe Response frame at the time the Beacon, Measurement Pilot, or Probe Response frame being reported was received. + contentEncoding: int32 + rcpi: + type: integer + description: RCPI indicates the received channel power of the Beacon, Measurement Pilot, or Probe Response frame, which is a logarithmic function of the received signal power, as defined in section 9.4.2.38 of IEEE 802.11-2016 [8]. + contentEncoding: int32 + reportedFrameInfo: + $ref: '#/components/schemas/ReportedBeaconFrameInfo' + rsni: + type: integer + description: RSNI indicates the received signal-to-noise indication for the Beacon, Measurement Pilot, or Probe Response frame, as described in section 9.4.2.41 of IEEE 802.11-2016 [8]. + contentEncoding: int32 + ssid: + type: string + description: The SSID subelement indicates the ESS or IBSS for which a beacon report is received. + staId: + $ref: '#/components/schemas/StaIdentity' + BeaconReportingConfig: + title: BeaconReportingConfig + required: + - reportingCondition + - threshold + type: object + properties: + reportingCondition: + type: integer + description: >- + Reporting condition for the Beacon Report as per Table 9-89 of IEEE 802.11-2016 [8]: + + 0 = Report to be issued after each measurement. + + 1 = measured RCPI level is greater than the threshold. + + 2 = measured RCPI level is less than the threshold. + + 3 = measured RSNI level is greater than the threshold. + + 4 = measured RSNI level is less than the threshold. + + 5 = measured RCPI level is greater than a threshold defined by an offset from the serving AP's reference RCPI. + + 6 = measured RCPI level is less than a threshold defined by an offset from the serving AP's reference RCPI. + + 7 = measured RSNI level is greater than a threshold defined by an offset from the serving AP's reference RSNI. + + 8 = measured RSNI level is less than a threshold defined by an offset from the serving AP's reference RSNI. + + 9 = measured RCPI level is in a range bound by the serving AP's reference RCPI and an offset from the serving AP's reference RCPI. + + 10 = measured RSNI level is in a range bound by the serving AP's reference RSNI and an offset from the serving AP's reference RSNI. + contentEncoding: int32 + threshold: + type: integer + description: >- + The threshold subfield contains either the threshold value or the offset value to be used for conditional reporting. + + + For reportingCondition subfield with values 1 and 2, the threshold value is a logarithmic function of the received signal power, as defined in section 9.4.2.38 of IEEE 802.11-2016 [8]. + + + For reportingCondition subfield values 3 and 4, the threshold value is a logarithmic function of the signal-to-noise ratio, as described in section 9.4.2.41 of IEEE 802.11-2016 [8]. + + + For reportingCondition subfield values 5 to 10, the offset value is an 8-bit 2s complement integer in units of 0,5 dBm. The indicated reporting condition applies individually to each measured Beacon, Measurement Pilot, or Probe Response frame. + contentEncoding: int32 + BeaconRequestConfig: + title: BeaconRequestConfig + required: + - beaconReportingConf + - channelId + - measurementMode + - operatingClass + type: object + properties: + beaconReportingConf: + $ref: '#/components/schemas/BeaconReportingConfig' + bssid: + type: string + description: The BSSID field indicates the BSS for which a beacon report is requested. If absent, the requested beacon reports should include all BSSs on the channel. + channelId: + type: integer + 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. + contentEncoding: int32 + measurementMode: + type: integer + description: >- + 0 for passive. + + 1 for active. + + 2 for beacon table. + contentEncoding: int32 + operatingClass: + type: integer + description: Operating Class field indicates an operating class value as defined in Annex E within IEEE 802.112016 [8]. + contentEncoding: int32 + ssid: + type: string + description: The SSID subelement indicates the ESS or IBSS for which a beacon report is requested. + BssCapabilities: + title: BssCapabilities + required: + - apsd + - delayedBACK + - immediateBACK + - qos + - radioMeasurements + - spectrumManagement + type: object + properties: + apsd: + type: boolean + description: APSD Option implemented + delayedBACK: + type: boolean + description: Delayed Block Ack Option implemented + immediateBACK: + type: boolean + description: Immediate Block Ack Option implemented + qos: + type: boolean + description: QoS Option implemented + radioMeasurements: + type: boolean + description: Radio Measurement Activated + spectrumManagement: + type: boolean + description: Spectrum Management required + BssLoad: + title: BssLoad + required: + - availAdmCap + - channelUtilization + - staCount + type: object + 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. + contentEncoding: int32 + 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. + contentEncoding: int32 + staCount: + type: integer + description: An unsigned integer that indicates the total number of STAs currently associated with this BSS. + contentEncoding: int32 + BssidInfo: + title: BssidInfo + required: + - apReachability + - capabilities + - ftm + - highThroughput + - mobilityDomain + - security + - veryHighThroughput + type: object + properties: + apReachability: + type: integer + description: >- + The apReachability field indicates whether the AP identified by this BSSID is reachable by the STA that requested the neighbor report. Valid values: + + 0 = reserved + + 1 = not reachable + + 2 = unknown + + 3 = reachable. + contentEncoding: int32 + capabilities: + $ref: '#/components/schemas/BssCapabilities' + ftm: + type: boolean + description: >- + True indicates the AP represented by this BSSID is an AP that has set the Fine Timing Measurement Responder field of the Extended Capabilities element to 1. + + + False indicates either that the reporting AP has dot11FineTimingMsmtRespActivated equal to false, or the reported AP has not set the Fine Timing Measurement Responder field of the Extended Capabilities element to 1 or that the Fine Timing Measurement Responder field of the reported AP is not available to the reporting AP at this time. + highThroughput: + type: boolean + description: True indicates that the AP represented by this BSSID is an HT AP including the HT Capabilities element in its Beacons, and that the contents of that HT Capabilities element are identical to the HT Capabilities element advertised by the AP sending the report. + mobilityDomain: + type: boolean + description: True indicates the AP represented by this BSSID is including an MDE in its Beacon frames and that the contents of that MDE are identical to the MDE advertised by the AP sending the report. + security: + type: boolean + description: >- + True indicates the AP identified by this BSSID supports the same security provisioning as used by the STA in its current association. + + + False indicates either that the AP does not support the same security provisioning or that the security information is not available at this time. + veryHighThroughput: + type: boolean + description: True indicates that the AP represented by this BSSID is a VHT AP and that the VHT Capabilities element, if included as a subelement in the report, is identical in content to the VHT Capabilities element included in the AP's Beacon. + ChannelLoad: + title: ChannelLoad + required: + - channel + - channelLoad + - measurementDuration + - measurementId + - operatingClass + type: object + properties: + channel: + type: integer + description: Channel number indicates the channel number for which the measurement report applies. + contentEncoding: int32 + channelLoad: + type: integer + description: Proportion of measurement duration for which the measuring STA determined the channel to be busy, as a percentage of time, linearly scaled with 255 representing 100 %. + contentEncoding: int32 + measurementDuration: + type: integer + description: Duration over which the Channel Load report was measured, in units of TUs of 1 024 µs. + contentEncoding: int32 + measurementId: + type: string + description: Measurement ID of the Measurement configuration applied to this Channel Load Report. + operatingClass: + type: integer + description: Operating Class field indicates an operating class value as defined in Annex E within IEEE 802.11-2016 [8]. + contentEncoding: int32 + staId: + $ref: '#/components/schemas/StaIdentity' + ChannelLoadConfig: + title: ChannelLoadConfig + required: + - channel + - operatingClass + type: object + properties: + channel: + type: integer + description: Channel for which the channel load report is requested. + contentEncoding: int32 + operatingClass: + type: integer + description: Operating Class field indicates an operating class value as defined in Annex E within IEEE 802.11-2016 [8]. + contentEncoding: int32 + reportingCondition: + type: integer + description: >- + Reporting condition for the Beacon Report as per Table 9-153 of IEEE 802.11-2016 [8]: + + 0 = Report to be issued after each measurement. + + 1 = Report to be issued when Channel Load is greater than or equal to the threshold. + + 2 = Report to be issued when Channel Load is less than or equal to the threshold. + + + If this optional field is not provided, channel load report should be issued after each measurement (reportingCondition = 0). + contentEncoding: int32 + threshold: + type: integer + description: Channel Load reference value for threshold reporting. This field shall be provided for reportingCondition values 1 and 2. + contentEncoding: int32 + CivicLocation: + title: CivicLocation + required: + - country + type: object + properties: + ca0: + type: string + description: Language + ca1: + type: string + description: National subdivisions (state, canton, region, province, prefecture) + ca128: + type: string + description: Script + ca16: + type: string + description: Leading street direction + ca17: + type: string + description: Trailing street suffix + ca18: + type: string + description: Street suffix or type + ca19: + type: string + description: House number + ca2: + type: string + description: County, parish, gun (JP), district (IN) + ca20: + type: string + description: House number suffix + ca21: + type: string + description: Landmark of vanity address + ca22: + type: string + description: Additional location information + ca23: + type: string + description: Name (residence and office occupant) + ca24: + type: string + description: Postal/zip code + ca25: + type: string + description: Building (structure) + ca26: + type: string + description: Unit (apartment/suite) + ca27: + type: string + description: Floor + ca28: + type: string + description: Room + ca29: + type: string + description: Type of place + ca3: + type: string + description: City, township, shi (JP) + ca30: + type: string + description: Postal community name + ca31: + type: string + description: Post office box + ca32: + type: string + description: Additional code + ca33: + type: string + description: Seat (desk.cubicle, workstation) + ca34: + type: string + description: Primary road name + ca35: + type: string + description: Road section + ca36: + type: string + description: Branch road name + ca37: + type: string + description: Sub-branch road name + ca38: + type: string + description: Street name pre-modifier + ca39: + type: string + description: Street name post-modifier + ca4: + type: string + description: City division, borough, city district, ward, chou (JP) + ca5: + type: string + description: Neighborhood, block + ca6: + type: string + description: Group of streets below the neighborhood level + country: + type: string + 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] + DmgCapabilities: + title: DmgCapabilities + required: + - ExtScMcsCap + - dmgApOrPcpCapInfo + - dmgStaBeamTrackTimeLimit + - dmgStaCapInfo + - maxNrBasicAmsduSubframes + - maxNrShortAmsduSubframes + type: object + properties: + ExtScMcsCap: + type: integer + description: Extended SC MCS capabilities as defined in IEEE 802.11-2016 [8]. + contentEncoding: int32 + dmgApOrPcpCapInfo: + type: integer + description: DMG AP or PCP capabilities information as defined in IEEE 802.11-2016 [8]. + contentEncoding: int32 + dmgStaBeamTrackTimeLimit: + type: integer + description: DMG station beam tracking time limit as defined in IEEE 802.11-2016 [8]. + contentEncoding: int32 + dmgStaCapInfo: + type: integer + description: DMG station capabilities information as defined in IEEE 802.11-2016 [8]. + contentEncoding: int32 + maxNrBasicAmsduSubframes: + type: integer + description: Number of basic A-MSDU subframes in A-MSDU as defined in IEEE 802.11-2016 [8]. + contentEncoding: int32 + maxNrShortAmsduSubframes: + type: integer + description: Number of short A-MSDU subframes in A-MSDU as defined in IEEE 802.11-2016 [8]. + contentEncoding: int32 + EdmgCapabilities: + title: EdmgCapabilities + required: + - ampduParameters + - supportedMcs + - trnParameters + type: object + properties: + ampduParameters: + type: integer + description: A-MPDU parameters as defined in draft IEEE P802.11ay [i.11] + contentEncoding: int32 + supportedMcs: + type: integer + description: Supported MCS as defined in draft IEEE P802.11ay [i.11] + contentEncoding: int32 + trnParameters: + type: integer + description: Training parameters as defined in draft IEEE P802.11ay [i.11] + contentEncoding: int32 + ExpiryNotification: + title: ExpiryNotification + required: + - _links + - expiryDeadline + - notificationType + type: object + properties: + _links: + $ref: '#/components/schemas/Links1' + expiryDeadline: + $ref: '#/components/schemas/TimeStamp' + notificationType: + type: string + description: Shall be set to "ExpiryNotification". + ExtBssLoad: + title: ExtBssLoad + required: + - muMimoStaCount + - obsSec20MhzUtil + - obsSec40MhzUtil + - obsSec80MhzUtil + - spatStreamUnderUtil + type: object + 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. + contentEncoding: int32 + obsSec20MhzUtil: + type: integer + description: Observable loading on each of the secondary 20 MHz channel. + contentEncoding: int32 + obsSec40MhzUtil: + type: integer + description: Observable loading on each of the secondary 40 MHz channel. + contentEncoding: int32 + obsSec80MhzUtil: + type: integer + description: Observable loading on each of the secondary 80 MHz channel. + contentEncoding: int32 + 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. + contentEncoding: int32 + GeoLocation: + title: GeoLocation + required: + - datum + - lat + - latUncertainty + - long + - longUncertainty + type: object + properties: + altitude: + type: integer + description: The altitude value of location as defined in IETF RFC 6225 [6] + contentEncoding: int32 + altitudeType: + type: integer + description: The type description for altitude information e.g. floors or meters as defined in IETF RFC 6225 [6] + contentEncoding: int32 + altitudeUncertainty: + type: integer + description: The uncertainty for altitude information as defined in IETF RFC 6225 [6] + contentEncoding: int32 + datum: + type: integer + description: The datum value to express how coordinates are organized and related to real world as defined in IETF RFC 6225 [6] + contentEncoding: int32 + lat: + type: integer + description: The latitude value of location as defined in IETF RFC 6225 [6] + contentEncoding: int32 + latUncertainty: + type: integer + description: The uncertainty for Latitude information as defined in IETF RFC 6225 [6] + contentEncoding: int32 + long: + type: integer + description: The longitude value of location as defined in IETF RFC 6225 [6] + contentEncoding: int32 + longUncertainty: + type: integer + description: The uncertainty for Longitude information as defined in IETF RFC 6225 [6] + contentEncoding: int32 + HeCapabilities: + title: HeCapabilities + required: + - heMacCapInfo + - hePhyCapinfo + - supportedHeMcsNssSet + type: object + properties: + heMacCapInfo: + type: integer + description: MAC capabilities of an Access Point. + contentEncoding: int32 + hePhyCapinfo: + type: integer + description: PHY capabilities of an Access Point. + contentEncoding: int32 + supportedHeMcsNssSet: + type: integer + description: Supported MCS and NSS Set. + contentEncoding: int32 + HtCapabilities: + title: HtCapabilities + required: + - ampduParameters + - aselCap + - htCapabilityInfo + - htExtendedCap + - supportedMcsSet + - txBeamFormCap + type: object + properties: + ampduParameters: + type: integer + description: A-MPDU parameters as defined in IEEE 802.11-2016 [8]. + contentEncoding: int32 + aselCap: + type: integer + description: ASEL capabilities as defined in IEEE 802.11-2016 [8]. + contentEncoding: int32 + htCapabilityInfo: + type: integer + description: HT Capability Information as defined in IEEE 802.11-2016 [8]. + contentEncoding: int32 + htExtendedCap: + type: integer + description: Extended HT Capabilities as defined in IEEE 802.11-2016 [8]. + contentEncoding: int32 + supportedMcsSet: + type: integer + description: Supported MCS set as defined in IEEE 802.11-2016 [8]. + contentEncoding: int32 + txBeamFormCap: + type: integer + description: Transmit Beamforming Capabilities as defined in IEEE 802.11-2016 [8]. + contentEncoding: int32 + LinkType: + title: LinkType + required: + - href + type: object + properties: + href: + type: string + MeasurementConfig: + title: MeasurementConfig + required: + - measurementId + - measurementInfo + - staId + type: object + properties: + _links: + $ref: '#/components/schemas/Links4' + measurementId: + type: string + description: Unique identifier allocated by the service consumer to identify measurement reports (within sta_information query), associated with this measurement configuration. + measurementInfo: + $ref: '#/components/schemas/MeasurementInfo' + staId: + minItems: 1 + type: array + items: + $ref: '#/components/schemas/StaIdentity' + description: Identifier(s) to uniquely specify the target client station(s) for the measurement configuration. + MeasurementConfigLinkList: + title: MeasurementConfigLinkList + required: + - _links + type: object + properties: + _links: + $ref: '#/components/schemas/Links4' + measurementConfig: + type: array + items: + $ref: '#/components/schemas/MeasurementConfig1' + description: '' + MeasurementInfo: + title: MeasurementInfo + type: object + properties: + beaconRequestConf: + $ref: '#/components/schemas/BeaconRequestConfig' + channelLoadConf: + $ref: '#/components/schemas/ChannelLoadConfig' + measurementDuration: + type: integer + description: Duration of the measurement in Time Units (TUs) of 1 024 µs, as defined in section 11.11.4 of IEEE 802.11-2016 [8]. If not provided, the underlying system may utilize a default configuration that will be indicated in resulting measurement reports. + contentEncoding: int32 + neighborReportConf: + $ref: '#/components/schemas/NeighborReportConfig' + randomInterval: + type: integer + description: Random interval to be used for starting the measurement in TUs of 1 024 µs, as specified in section 11.11.3 of IEEE 802.11-2016 [8]. If not provided, the underlying system may utilize a default configuration that will be indicated in resulting measurement reports. + contentEncoding: int32 + staStatisticsConf: + $ref: '#/components/schemas/StaStatisticsConfig' + MeasurementReportNotification: + title: MeasurementReportNotification + allOf: + - $ref: '#/components/schemas/InlineNotification' + - type: object + properties: + beaconReport: + minItems: 0 + type: array + items: + $ref: '#/components/schemas/BeaconReport' + description: Beacon Report as defined in IEEE 802.11-2016 [8]. + channelLoad: + minItems: 0 + type: array + items: + $ref: '#/components/schemas/ChannelLoad' + description: Channel Load reports as seen by the station as defined in IEEE 802.11-2016 [8]. + neighborReport: + minItems: 0 + type: array + items: + $ref: '#/components/schemas/NeighborReport' + description: Neighbor Report providing information about neighbor Access Points seen by the station as defined in IEEE 802.112016 [8]. + staStatistics: + minItems: 0 + type: array + items: + $ref: '#/components/schemas/StaStatistics' + description: STA Statistics Report as defined in IEEE 802.11-2016 [8]. + timeStamp: + $ref: '#/components/schemas/TimeStamp' + MeasurementReportSubscription: + title: MeasurementReportSubscription + allOf: + - $ref: '#/components/schemas/InlineSubscription' + - required: + - measurementId + - measurementInfo + - staId + type: object + properties: + _links: + $ref: '#/components/schemas/Links' + callbackReference: + type: string + expiryDeadline: + $ref: '#/components/schemas/TimeStamp' + measurementId: + type: string + description: Unique identifier allocated by the service consumer to identify measurement reports associated with this measurement subscription. + measurementInfo: + $ref: '#/components/schemas/MeasurementInfo' + requestTestNotification: + type: boolean + description: Set to TRUE by the service consumer to request a test notification on the callbackReference URI to determine if it is reachable by the WAIS for notifications. + staId: + minItems: 1 + type: array + items: + $ref: '#/components/schemas/StaIdentity' + description: Identifier(s) to uniquely specify the target client station(s) for the subscription. + websockNotifConfig: + $ref: '#/components/schemas/WebsockNotifConfig' + NeighborReport: + title: NeighborReport + required: + - bssid + - bssidInfo + - channel + - measurementId + - operatingClass + - phyType + type: object + properties: + bssTransitionCandidatePreference: + type: integer + description: Relative value indicating the preferred ordering for this BSS as a transition candidate for roaming. 255 indicating the most preferred candidate and 1 indicating the least preferred candidate, as defined in Table 9-152 within IEEE 802.112016 [8]. + contentEncoding: int32 + bssid: + type: string + description: BSSID (MAC address) of the Access Point that is being reported. + bssidInfo: + $ref: '#/components/schemas/BssidInfo' + channel: + type: integer + description: Channel field indicates a channel number, which is interpreted in the context of the indicated operating class. Channel numbers are defined in Annex E within IEEE 802.11-2016 [8]. + contentEncoding: int32 + measurementId: + type: string + description: Measurement ID of the Measurement configuration applied to this Neighbor Report. + operatingClass: + type: integer + description: Operating Class field indicates an operating class value as defined in Annex E within IEEE 802.11-2016 [8]. + contentEncoding: int32 + phyType: + type: integer + description: >- + PHY type of the AP indicated by this BSSID. It is an integer value coded according to the value of the dot11PHYType, Annex C within IEEE 802.11-2016 [8]. + + 2 = dsss + + 4 = ofdm + + 5 = hrdsss + + 6 = erp + + 7 = ht + + 8 = dmg + + 9 = vht + + 10 = tvht + contentEncoding: int32 + staId: + $ref: '#/components/schemas/StaIdentity' + NeighborReportConfig: + title: NeighborReportConfig + type: object + properties: + bssid: + type: string + description: BSSID of the neighbor AP which information is intended to obtain. If no specific BSSID is given, the information will be provided for all APs matching the ssid criteria. + ssid: + type: string + description: The SSID field is optionally present. If present, it contains an SSID element. The presence of an SSID element in a Neighbor Report indicates a request for a neighbor list for the specified SSID in the SSID Element. The absence of an SSID element indicates neighbor report for the current ESS. + OBssLoad: + title: OBssLoad + required: + - allocatedTrafficSelfMean + - allocatedTrafficShareMean + type: object + properties: + allocatedTrafficSelfMean: + type: integer + description: Mean of allocated traffic from this AP (BSS) in units of 32 µs per second. + contentEncoding: int32 + allocatedTrafficSelfStdDev: + type: integer + description: Standard deviation from the mean of allocation traffic from this BSS in units of 32 µs per second. + contentEncoding: int32 + allocatedTrafficShareMean: + type: integer + description: Mean of the sum of allocated traffic from other APs on the overlapping channel in unit of 32 µs per second. + contentEncoding: int32 + allocatedTrafficShareStdDev: + type: integer + description: Standard deviation from the mean of the sum of allocated traffic from other APs on the overlapping channel in unit of 32 µs per second. + contentEncoding: int32 + overlap: + type: integer + description: Indicates the number of other APs that are sharing the same channel as the reporting AP. + contentEncoding: int32 + ProblemDetails: + title: ProblemDetails + type: object + properties: + detail: + type: string + description: A human-readable explanation specific to this occurrence of the problem + instance: + type: string + description: A URI reference that identifies the specific occurrence of the problem + status: + type: integer + description: The HTTP status code for this occurrence of the problem + contentEncoding: int32 + title: + type: string + description: A short, human-readable summary of the problem type + type: + type: string + description: A URI reference according to IETF RFC 3986 that identifies the problem type + ReportedBeaconFrameInfo: + title: ReportedBeaconFrameInfo + required: + - frameType + - phyType + type: object + properties: + frameType: + type: integer + description: >- + A value of 0 indicates a Beacon or Probe Response. + + A value of 1 indicates a Measurement Pilot frame. + contentEncoding: int32 + phyType: + type: integer + description: Value between 0 and 127 coded according to dot11PHYType. + contentEncoding: int32 + ReportingReasonQoSCounters: + title: ReportingReasonQoSCounters + required: + - qosAckFailure + - qosDiscarded + - qosFailed + - qosFrameDuplicate + - qosMultipleRetry + - qosRetry + - qosRtsFailure + type: object + properties: + qosAckFailure: + type: boolean + description: dot11QoSAckFailure + qosDiscarded: + type: boolean + description: dot11QoSDiscarded + qosFailed: + type: boolean + description: dot11QoSFailed + qosFrameDuplicate: + type: boolean + description: dot11QoSFrameDuplicate + qosMultipleRetry: + type: boolean + description: dot11QoSMultipleRetry + qosRetry: + type: boolean + description: dot11QoSRetry + qosRtsFailure: + type: boolean + description: dot11QoSRTSFailure + ReportingReasonStaCounters: + title: ReportingReasonStaCounters + required: + - ackFailure + - failed + - fcsError + - frameDuplicate + - multipleRetry + - retry + - rtsFailure + type: object + properties: + ackFailure: + type: boolean + description: dot11AckFailure + failed: + type: boolean + description: dot11Failed + fcsError: + type: boolean + description: dot11FCSError + frameDuplicate: + type: boolean + description: dot11FrameDuplicate + multipleRetry: + type: boolean + description: dot11MultipleRetry + retry: + type: boolean + description: dot11Retry + rtsFailure: + type: boolean + description: dot11RTSFailure + Rssi: + title: Rssi + required: + - rssi + type: object + properties: + rssi: + type: integer + description: The Received Signal Strength Indicator from a station + contentEncoding: int32 + STACounterTriggerCondition: + title: STACounterTriggerCondition + type: object + properties: + ackFailureCountThreshold: + type: integer + description: Configure and set threshold for dot11AckFailureCount trigger + contentEncoding: int32 + failedCountThreshold: + type: integer + description: Configure and set threshold for dot11FailedCount trigger + contentEncoding: int32 + fcsErrorCountThreshold: + type: integer + description: Configure and set threshold for dot11FCSErrorCount trigger + contentEncoding: int32 + frameDuplicateCountThreshold: + type: integer + description: Configure and set threshold for dot11FrameDuplicateCount trigger + contentEncoding: int32 + multipleRetryCountThreshold: + type: integer + description: Configure and set threshold for dot11MultipleRetryCount trigger + contentEncoding: int32 + retryCountThreshold: + type: integer + description: Configure and set threshold for dot11RetryCount trigger + contentEncoding: int32 + rtsFailureCountThreshold: + type: integer + description: Configure and set threshold for dot11RTSFailureCount trigger + contentEncoding: int32 + StaDataRate: + title: StaDataRate + type: object + properties: + staId: + $ref: '#/components/schemas/StaIdentity' + staLastDataDownlinkRate: + type: integer + description: The data transmit rate in kbps that was most recently used for transmission of data PPDUs from the access point to the station. + contentEncoding: int32 + staLastDataUplinkRate: + type: integer + 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. + contentEncoding: int32 + StaDataRateNotification: + title: StaDataRateNotification + allOf: + - $ref: '#/components/schemas/InlineNotification' + - type: object + properties: + staDataRate: + minItems: 0 + type: array + items: + $ref: '#/components/schemas/StaDataRate' + description: Data rates of a client station. + timeStamp: + $ref: '#/components/schemas/TimeStamp' + StaDataRateSubscription: + title: StaDataRateSubscription + allOf: + - $ref: '#/components/schemas/InlineSubscription' + - required: + - staId + type: object + properties: + _links: + $ref: '#/components/schemas/Links' + callbackReference: + type: string + expiryDeadline: + $ref: '#/components/schemas/TimeStamp' + notificationEvent: + $ref: '#/components/schemas/NotificationEvent1' + notificationPeriod: + type: integer + description: >- + Set for periodic notification reporting. + + Value indicates the notification period in seconds. + contentEncoding: int32 + requestTestNotification: + type: boolean + description: Set to TRUE by the service consumer to request a test notification on the callbackReference URI to determine if it is reachable by the WAIS for notifications. + staId: + minItems: 1 + type: array + items: + $ref: '#/components/schemas/StaIdentity' + description: Identifier(s) to uniquely specify the target client station(s) for the subscription. + websockNotifConfig: + $ref: '#/components/schemas/WebsockNotifConfig' + StaIdentity: + title: StaIdentity + required: + - macId + type: object + properties: + aid: + type: string + description: Number which identifies a particular association between a station and an Access Point + ipAddress: + minItems: 0 + type: array + items: + type: string + description: IPv4 or IPv6 address(es) allocated for the station. + macId: + type: string + description: Unique identifier assigned to station (as network interface controller) for communications at the data link layer of a network segment. + ssid: + minItems: 0 + type: array + items: + type: string + description: Service Set Identifier(s) to identify logical networks. + StaInfo: + title: StaInfo + required: + - staId + type: object + properties: + apAssociated: + $ref: '#/components/schemas/ApAssociated' + beaconReport: + minItems: 0 + type: array + items: + $ref: '#/components/schemas/BeaconReport' + description: Beacon Report as defined in IEEE 802.11-2016 [8]. + channel: + type: integer + description: Channel currently used by the station to connect with its associated Access Point. + contentEncoding: int32 + channelLoad: + minItems: 0 + type: array + items: + $ref: '#/components/schemas/ChannelLoad' + description: Channel Load reports as seen by the station as defined IEEE 802.11-2016 [8]. Channel Load reports may be configured for any channel, including the station's current channel for association. + neighborReport: + minItems: 0 + type: array + items: + $ref: '#/components/schemas/NeighborReport' + description: Information about neighbor Access Points seen by the station as defined IEEE 802.11-2016 [8]. + rssi: + $ref: '#/components/schemas/Rssi' + staDataRate: + $ref: '#/components/schemas/StaDataRate' + staId: + $ref: '#/components/schemas/StaIdentity' + staStatistics: + minItems: 0 + type: array + items: + $ref: '#/components/schemas/StaStatistics' + description: Statistics as defined in IEEE 802.11-2016 [8] for the client station collected over measurement duration. + timeStamp: + $ref: '#/components/schemas/TimeStamp' + StaStatistics: + title: StaStatistics + required: + - groupIdentity + - measurementDuration + - measurementId + type: object + properties: + group2to9Data: + $ref: '#/components/schemas/StaStatisticsGroup2to9Data' + groupIdentity: + type: integer + description: >- + Indicates the requested statistics group describing the Statistics Group Data according to Table 9-114 of IEEE 802.11-2016 [8]. + + Depending on group identity, one and only one of the STA Statistics Group Data will be present. + contentEncoding: int32 + groupOneData: + $ref: '#/components/schemas/StaStatisticsGroupOneData' + groupZeroData: + $ref: '#/components/schemas/StaStatisticsGroupZeroData' + measurementDuration: + type: integer + description: Duration over which the Statistics Group Data was measured in time units of 1 024 µs. Duration equal to zero indicates a report of current values. + contentEncoding: int32 + measurementId: + type: string + description: Measurement ID of the Measurement configuration applied to this STA Statistics Report. + staId: + $ref: '#/components/schemas/StaIdentity' + StaStatisticsConfig: + title: StaStatisticsConfig + required: + - groupIdentity + - triggeredReport + type: object + properties: + groupIdentity: + type: integer + description: As per Table 9-92 of IEEE 802.11-2016 [8]. + contentEncoding: int32 + measurementCount: + type: integer + description: >- + Valid if triggeredReport = true. + + Specifies the number of MAC service data units or protocol data units to determine if the trigger conditions are met. + contentEncoding: int32 + triggerCondition: + $ref: '#/components/schemas/STACounterTriggerCondition' + triggerTimeout: + type: integer + description: >- + Valid if triggeredReport = true. + + The Trigger Timeout field contains a value in units of 100 time-units of 1 024 µs during which a measuring STA does not generate further triggered STA Statistics Reports after a trigger condition has been met. + contentEncoding: int32 + triggeredReport: + type: boolean + description: True = triggered reporting, otherwise duration. + StaStatisticsGroup2to9Data: + title: StaStatisticsGroup2to9Data + required: + - qosAckFailureCount + - qosDiscardedFrameCount + - qosFailedCount + - qosFrameDuplicateCount + - qosMPDUsReceivedCount + - qosMultipleRetryCount + - qosRTSFailureCount + - qosRTSSuccessCount + - qosReceivedFragmentCount + - qosRetriesReceivedCount + - qosRetryCount + - qosTransmittedFragmentCount + - qosTransmittedFrameCount + type: object + properties: + qosAckFailureCount: + type: integer + description: dot11QosAckFailureCount counter + contentEncoding: int32 + qosDiscardedFrameCount: + type: integer + description: dot11QosDiscardedFrameCount counter + contentEncoding: int32 + qosFailedCount: + type: integer + description: dot11QosFailedCount counter + contentEncoding: int32 + qosFrameDuplicateCount: + type: integer + description: dot11QosFrameDuplicateCount counter + contentEncoding: int32 + qosMPDUsReceivedCount: + type: integer + description: dot11QosMPDUsReceivedCount counter + contentEncoding: int32 + qosMultipleRetryCount: + type: integer + description: dot11QosMultipleRetryCount counter + contentEncoding: int32 + qosRTSFailureCount: + type: integer + description: dot11QosRTSFailureCount counter + contentEncoding: int32 + qosRTSSuccessCount: + type: integer + description: dot11QosRTSSuccessCount counter + contentEncoding: int32 + qosReceivedFragmentCount: + type: integer + description: dot11QosReceivedFragmentCount counter + contentEncoding: int32 + qosRetriesReceivedCount: + type: integer + description: dot11QosRetriesReceivedCount counter + contentEncoding: int32 + qosRetryCount: + type: integer + description: dot11QosRetryCount counter + contentEncoding: int32 + qosTransmittedFragmentCount: + type: integer + description: dot11QosTransmittedFragmentCount counter + contentEncoding: int32 + qosTransmittedFrameCount: + type: integer + description: dot11QosTransmittedFrameCount counter + contentEncoding: int32 + reportingReasonQoSCounters: + $ref: '#/components/schemas/ReportingReasonQoSCounters' + StaStatisticsGroupOneData: + title: StaStatisticsGroupOneData + required: + - ackFailureCount + - frameDuplicateCount + - multipleRetryCount + - retryCount + - rtsFailureCount + - rtsSuccessCount + type: object + properties: + ackFailureCount: + type: integer + description: dot11AckFailureCount counter + contentEncoding: int32 + frameDuplicateCount: + type: integer + description: dot11FrameDuplicateCount counter + contentEncoding: int32 + multipleRetryCount: + type: integer + description: dot11MultipleRetryCount counter + contentEncoding: int32 + reportingReasonStaCounters: + $ref: '#/components/schemas/ReportingReasonStaCounters' + retryCount: + type: integer + description: dot11RetryCount counter + contentEncoding: int32 + rtsFailureCount: + type: integer + description: dot11RTSFailureCount counter + contentEncoding: int32 + rtsSuccessCount: + type: integer + description: dot11RTSSuccessCount counter + contentEncoding: int32 + StaStatisticsGroupZeroData: + title: StaStatisticsGroupZeroData + required: + - failedCount + - fcsErrorCount + - groupReceivedFrameCount + - groupTransmittedFrameCount + - receivedFragmentCount + - transmittedFragmentCount + - transmittedFrameCount + type: object + properties: + failedCount: + type: integer + description: dot11FailedCount counter + contentEncoding: int32 + fcsErrorCount: + type: integer + description: dot11FCSErrorCount counter + contentEncoding: int32 + groupReceivedFrameCount: + type: integer + description: dot11GroupReceivedFrameCount counter + contentEncoding: int32 + groupTransmittedFrameCount: + type: integer + description: dot11GroupTransmittedFrameCount counter + contentEncoding: int32 + receivedFragmentCount: + type: integer + description: dot11ReceivedFragmentCount counter + contentEncoding: int32 + reportingReasonStaCounters: + $ref: '#/components/schemas/ReportingReasonStaCounters' + transmittedFragmentCount: + type: integer + description: dot11TransmittedFragmentCount counter + contentEncoding: int32 + transmittedFrameCount: + type: integer + description: dot11TransmittedFrameCount counter + contentEncoding: int32 + SubscriptionLinkList: + title: SubscriptionLinkList + required: + - _links + type: object + properties: + _links: + $ref: '#/components/schemas/Links6' + subscription: + type: array + items: + $ref: '#/components/schemas/Subscription' + description: '' + TestNotification: + title: TestNotification + required: + - _links + - notificationType + type: object + properties: + _links: + $ref: '#/components/schemas/Links1' + notificationType: + type: string + description: Shall be set to "TestNotification". + TimeStamp: + title: TimeStamp + required: + - nanoSeconds + - seconds + type: object + properties: + nanoSeconds: + type: integer + description: The nanoseconds part of the time. Time is defined as Unix-time since January 1, 1970, 00:00:00 UTC. + contentEncoding: int32 + seconds: + type: integer + description: The seconds part of the time. Time is defined as Unixtime since January 1, 1970, 00:00:00 UTC. + contentEncoding: int32 + VhtCapabilities: + title: VhtCapabilities + required: + - vhtCapInfo + - vhtMcsNss + type: object + properties: + vhtCapInfo: + type: integer + description: VHT capabilities Info as defined in IEEE 802.11-2016 [8]. + contentEncoding: int32 + vhtMcsNss: + type: integer + description: Supported VHT-MCS and NSS Set as defined in IEEE 802.11-2016 [8]. + contentEncoding: int32 + WanMetrics: + title: WanMetrics + required: + - downlinkLoad + - downlinkSpeed + - lmd + - uplinkLoad + - uplinkSpeed + - wanInfo + type: object + 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. + contentEncoding: int32 + downlinkSpeed: + type: integer + description: 4-octet positive integer whose value is an estimate of the WAN Backhaul link current downlink speed in kilobits per second. + contentEncoding: int32 + 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. + contentEncoding: int32 + uplinkLoad: + type: integer + 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. + contentEncoding: int32 + uplinkSpeed: + type: integer + description: 4-octet positive integer whose value is an estimate of the WAN Backhaul link's current uplink speed in kilobits per second. + contentEncoding: int32 + wanInfo: + type: integer + description: Info about WAN link status, link symmetricity and capacity currently used. + contentEncoding: int32 + WebsockNotifConfig: + title: WebsockNotifConfig + type: object + properties: + requestWebsocketUri: + type: boolean + description: Set to true by the service consumer to indicate that Websocket delivery is requested. + websocketUri: + type: string + description: Set by WAIS to indicate to the service consumer the Websocket URI to be used for delivering notifications. + WlanCapabilities: + title: WlanCapabilities + type: object + 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' + InlineNotification: + title: InlineNotification + required: + - notificationType + type: object + properties: + notificationType: + type: string + discriminator: + propertyName: notificationType + mapping: + AssocStaNotification: AssocStaNotification + MeasurementReportNotification: MeasurementReportNotification + StaDataRateNotification: StaDataRateNotification + InlineSubscription: + title: InlineSubscription + required: + - subscriptionType + type: object + properties: + subscriptionType: + type: string + discriminator: + propertyName: subscriptionType + mapping: + AssocStaSubscription: AssocStaSubscription + MeasurementReportSubscription: MeasurementReportSubscription + StaDataRateSubscription: StaDataRateSubscription + Links: + title: Links + required: + - self + type: object + properties: + self: + $ref: '#/components/schemas/LinkType' + description: Hyperlink related to the resource. This shall be only included in the HTTP responses and in HTTP PUT requests. + Links1: + title: Links1 + required: + - subscription + type: object + properties: + subscription: + $ref: '#/components/schemas/LinkType' + description: Hyperlink related to the resource. + Links4: + title: Links4 + required: + - self + type: object + properties: + self: + $ref: '#/components/schemas/LinkType' + description: Hyperlink related to the resource. + Links6: + title: Links6 + required: + - self + type: object + properties: + self: + $ref: '#/components/schemas/LinkType' + description: List of hyperlinks related to the resource. + MeasurementConfig1: + title: MeasurementConfig1 + required: + - href + - measurementId + type: object + properties: + href: + type: string + description: The URI referring to a measurement configuration. + measurementId: + type: string + description: Unique identifier allocated by the service consumer to identify measurement reports associated with this measurement configuration. + NotificationEvent: + title: NotificationEvent + required: + - threshold + - trigger + type: object + properties: + threshold: + type: integer + description: Number of connected stations threshold for trigger-based event reporting. + contentEncoding: int32 + trigger: + $ref: '#/components/schemas/Trigger' + description: Set for trigger-based event notification reporting. + NotificationEvent1: + title: NotificationEvent1 + required: + - trigger + type: object + properties: + downlinkRateThreshold: + type: integer + description: Downlink data rate threshold for StaDataRate reporting. + contentEncoding: int32 + trigger: + $ref: '#/components/schemas/Trigger1' + uplinkRateThreshold: + type: integer + description: Uplink data rate threshold for StaDataRate reporting. + contentEncoding: int32 + description: Set for trigger-based event notification reporting. + Subscription: + title: Subscription + required: + - href + - subscriptionType + type: object + properties: + href: + type: string + description: The URI referring to the subscription. + subscriptionType: + type: string + description: >- + Type of the subscription. The string shall be set according to the "subscriptionType" attribute of the associated subscription data type defined in 6.3.2, 6.3.3. and 6.3.5: + + “AssocStaSubscription” + + “StaDataRateSubscription” + + “MeasurementReportSubscription” + Trigger: + title: Trigger + enum: + - 1 + - 2 + type: integer + description: >- + Trigger for the notification: + + 1 = Notification issued when the number of connected stations is greater than or equal to the threshold. + + 2 = Notification issued when the number of connected stations is less than or equal to the threshold. + examples: + - 1 + Trigger1: + title: Trigger1 + enum: + - 1 + - 2 + - 3 + - 4 + - 5 + - 6 + - 7 + - 8 + type: integer + description: >- + Trigger event for the notification: + + 1 = Notification issued when the STA's downlink data rate is greater than or equal to the downlink threshold. + + 2 = Notification issued when the STA's downlink data rate is less than or equal to the downlink threshold. + + 3 = Notification issued when the STA's uplink data rate is greater than or equal to the uplink threshold. + + 4 = Notification issued when the STA's uplink data rate is less than or equal to the uplink threshold. + + 5 = Notification issued when the STA's downlink and uplink data rate is greater than or equal to their thresholds. + + 6 = Notification issued when the STA's downlink and uplink data rate is less than or equal to their thresholds. + + 7 = Notification issued when the STA's downlink or uplink data rate is greater than or equal to their thresholds. + + 8 = Notification issued when the STA's downlink or uplink data rate is less than or equal to their thresholds. + examples: + - 1 +security: +- {} +tags: +- name: wai +externalDocs: + description: ETSI MEC028 V2.2.1 WLAN Information API + url: https://www.etsi.org/deliver/etsi_gs/MEC/001_099/028/02.02.01_60/gs_mec028v020201p.pdf -- GitLab From ec634281e23ec1a1d85445819bef4cdcd2cadae6 Mon Sep 17 00:00:00 2001 From: piscione Date: Mon, 22 Nov 2021 09:01:19 +0100 Subject: [PATCH 2/5] Replaced YAML with OAS3.1 file to work on. --- ...WlanInformationApi.yaml-OpenApi31Yaml.yaml | 2824 ------------ WlanInformationApi.yaml | 3978 ++++++++--------- 2 files changed, 1820 insertions(+), 4982 deletions(-) delete mode 100644 OAS3.1.0/WlanInformationApi.yaml-OpenApi31Yaml.yaml diff --git a/OAS3.1.0/WlanInformationApi.yaml-OpenApi31Yaml.yaml b/OAS3.1.0/WlanInformationApi.yaml-OpenApi31Yaml.yaml deleted file mode 100644 index 804e875..0000000 --- a/OAS3.1.0/WlanInformationApi.yaml-OpenApi31Yaml.yaml +++ /dev/null @@ -1,2824 +0,0 @@ -openapi: 3.1.0 -info: - title: ETSI GS MEC 028 - WLAN Access Information API - description: The ETSI MEC ISG MEC028 WLAN Access Information API described using OpenAPI - contact: - url: https://forge.etsi.org/rep/mec/gs028-wai-api - version: '2.2.1' -jsonSchemaDialect: https://json-schema.org/draft/2020-12/schema -servers: -- url: https://localhost/wai/v2 - variables: {} -paths: - /queries/ap/ap_information: - get: - tags: - - wai - summary: apInfoGET - description: Queries information about existing WLAN Access Points - operationId: apInfoGET - parameters: - - name: filter - in: query - description: Attribute-based filtering expression according to clause 6.19 of ETSI GS MEC 009. . - style: form - explode: true - schema: - type: string - - name: all_fields - in: query - description: Include all complex attributes in the response. See clause 6.18 of ETSI GS MEC 009 for details. - style: form - explode: true - schema: - type: string - - name: fields - in: query - description: Complex attributes to be included into the response. See clause 6.18 of ETSI GS MEC 009 for details. - style: form - explode: true - schema: - type: array - items: - type: string - - 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. - style: form - explode: true - schema: - type: array - items: - type: string - - 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' - style: form - explode: true - schema: - type: array - items: - type: string - responses: - '200': - description: Successful response to ap_info request - headers: {} - content: - application/json: - schema: - type: array - items: - $ref: '#/components/schemas/ApInfo' - description: '' - contentMediaType: application/json - '400': - description: 'Bad Request : used to indicate that incorrect parameters were passed to the request.' - headers: {} - content: - application/problem+json: - schema: - $ref: '#/components/schemas/ProblemDetails' - '401': - description: 'Unauthorized : used when the client did not submit credentials.' - headers: {} - content: - application/problem+json: - schema: - $ref: '#/components/schemas/ProblemDetails' - '403': - description: 'Forbidden : operation is not allowed given the current status of the resource.' - headers: {} - 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.' - headers: {} - 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.' - headers: {} - content: - application/problem+json: - schema: - $ref: '#/components/schemas/ProblemDetails' - '429': - description: 'Too Many Requests : used when a rate limiter has triggered.' - headers: {} - content: - application/problem+json: - schema: - $ref: '#/components/schemas/ProblemDetails' - deprecated: false - parameters: [] - /queries/sta/sta_information: - get: - tags: - - wai - summary: staInfoGET - description: Queries information about existing WLAN stations - operationId: staInfoGET - parameters: - - name: filter - in: query - description: Attribute-based filtering expression according to clause 6.19 of ETSI GS MEC 009. . - style: form - explode: true - schema: - type: string - - name: all_fields - in: query - description: Include all complex attributes in the response. See clause 6.18 of ETSI GS MEC 009 for details. - style: form - explode: true - schema: - type: string - - name: fields - in: query - description: Complex attributes to be included into the response. See clause 6.18 of ETSI GS MEC 009 for details. - style: form - explode: true - schema: - type: array - items: - type: string - - 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. - style: form - explode: true - schema: - type: array - items: - type: string - - 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' - style: form - explode: true - schema: - type: array - items: - type: string - responses: - '200': - description: Successful response to sta_info request - headers: {} - content: - application/json: - schema: - type: array - items: - $ref: '#/components/schemas/StaInfo' - description: '' - contentMediaType: application/json - '400': - description: 'Bad Request : used to indicate that incorrect parameters were passed to the request.' - headers: {} - content: - application/problem+json: - schema: - $ref: '#/components/schemas/ProblemDetails' - '401': - description: 'Unauthorized : used when the client did not submit credentials.' - headers: {} - content: - application/problem+json: - schema: - $ref: '#/components/schemas/ProblemDetails' - '403': - description: 'Forbidden : operation is not allowed given the current status of the resource.' - headers: {} - 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.' - headers: {} - 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.' - headers: {} - content: - application/problem+json: - schema: - $ref: '#/components/schemas/ProblemDetails' - '429': - description: 'Too Many Requests : used when a rate limiter has triggered.' - headers: {} - content: - application/problem+json: - schema: - $ref: '#/components/schemas/ProblemDetails' - deprecated: false - parameters: [] - /subscriptions: - get: - tags: - - wai - summary: subscriptionLinkList_subscriptionsGET - description: Queries information on subscriptions for notifications - operationId: subscriptionLinkList_subscriptionsGET - parameters: - - name: subscription_type - in: query - description: 'Filter on a specific subscription type. Permitted values: assoc_sta, sta_data_rate, measure_report.' - style: form - explode: true - schema: - type: string - responses: - '200': - description: Response body contains the list of links to requestors subscriptions. - headers: {} - content: - application/json: - schema: - $ref: '#/components/schemas/SubscriptionLinkList' - '400': - description: 'Bad Request : used to indicate that incorrect parameters were passed to the request.' - headers: {} - content: - application/problem+json: - schema: - $ref: '#/components/schemas/ProblemDetails' - '401': - description: 'Unauthorized : used when the client did not submit credentials.' - headers: {} - content: - application/problem+json: - schema: - $ref: '#/components/schemas/ProblemDetails' - '403': - description: 'Forbidden : operation is not allowed given the current status of the resource.' - headers: {} - 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.' - headers: {} - 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.' - headers: {} - content: - application/problem+json: - schema: - $ref: '#/components/schemas/ProblemDetails' - '429': - description: 'Too Many Requests : used when a rate limiter has triggered.' - headers: {} - content: - application/problem+json: - schema: - $ref: '#/components/schemas/ProblemDetails' - deprecated: false - post: - tags: - - wai - summary: subscriptionsPOST - description: Creates a new subscription to WLAN Access Information notifications - operationId: subscriptionsPOST - parameters: [] - requestBody: - description: Subscription to be created - content: - application/json: - schema: - oneOf: - - $ref: '#/components/schemas/AssocStaSubscription' - - $ref: '#/components/schemas/StaDataRateSubscription' - - $ref: '#/components/schemas/MeasurementReportSubscription' - description: Subscription to be created - examples: - - subscriptionType: AssocStaSubscription - callbackReference: http://meAppClient.example.com/wai/v2/notifications/1 - expiryDeadline: - seconds: 1977836800 - nanoSeconds: 0 - apId: - bssid: 005C0A0A0A0A - ssid: - - myNetworkSsid - ipAddress: - - 10.10.100.1 - contentMediaType: application/json - example: - subscriptionType: AssocStaSubscription - callbackReference: http://meAppClient.example.com/wai/v2/notifications/1 - expiryDeadline: - seconds: 1977836800 - nanoSeconds: 0 - apId: - bssid: 005C0A0A0A0A - ssid: - - myNetworkSsid - ipAddress: - - 10.10.100.1 - required: true - responses: - '201': - description: Successful subscription response - headers: {} - content: - application/json: - schema: - oneOf: - - $ref: '#/components/schemas/AssocStaSubscription' - - $ref: '#/components/schemas/StaDataRateSubscription' - - $ref: '#/components/schemas/MeasurementReportSubscription' - examples: - - 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: - bssid: 005C0A0A0A0A - ssid: - - myNetworkSsid - ipAddress: - - 10.10.100.1 - contentMediaType: application/json - 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: - bssid: 005C0A0A0A0A - ssid: - - myNetworkSsid - ipAddress: - - 10.10.100.1 - '400': - description: 'Bad Request : used to indicate that incorrect parameters were passed to the request.' - headers: {} - content: - application/problem+json: - schema: - $ref: '#/components/schemas/ProblemDetails' - '401': - description: 'Unauthorized : used when the client did not submit credentials.' - headers: {} - content: - application/problem+json: - schema: - $ref: '#/components/schemas/ProblemDetails' - '403': - description: 'Forbidden : operation is not allowed given the current status of the resource.' - headers: {} - 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.' - headers: {} - 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.' - headers: {} - 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.' - headers: {} - 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.' - headers: {} - 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.' - headers: {} - content: - application/problem+json: - schema: - $ref: '#/components/schemas/ProblemDetails' - deprecated: false - parameters: [] - /subscriptions/{subscriptionId}: - get: - tags: - - wai - summary: subscriptionsGET - description: Queries information about an existing subscription, identified by its self-referring URI returned on creation (initial POST) - operationId: subscriptionsGET - parameters: - - name: subscriptionId - in: path - description: Subscription Id, specifically the "self" returned in the subscription request - required: true - style: simple - schema: - type: string - responses: - '200': - description: Subscription information regarding subscription notifications - headers: {} - content: - application/json: - schema: - oneOf: - - $ref: '#/components/schemas/AssocStaSubscription' - - $ref: '#/components/schemas/StaDataRateSubscription' - - $ref: '#/components/schemas/MeasurementReportSubscription' - examples: - - 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: - bssid: 005C0A0A0A0A - ssid: - - myNetworkSsid - ipAddress: - - 10.10.100.1 - contentMediaType: application/json - 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: - bssid: 005C0A0A0A0A - ssid: - - myNetworkSsid - ipAddress: - - 10.10.100.1 - '400': - description: 'Bad Request : used to indicate that incorrect parameters were passed to the request.' - headers: {} - content: - application/problem+json: - schema: - $ref: '#/components/schemas/ProblemDetails' - '401': - description: 'Unauthorized : used when the client did not submit credentials.' - headers: {} - content: - application/problem+json: - schema: - $ref: '#/components/schemas/ProblemDetails' - '403': - description: 'Forbidden : operation is not allowed given the current status of the resource.' - headers: {} - 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.' - headers: {} - 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.' - headers: {} - content: - application/problem+json: - schema: - $ref: '#/components/schemas/ProblemDetails' - '429': - description: 'Too Many Requests : used when a rate limiter has triggered.' - headers: {} - content: - application/problem+json: - schema: - $ref: '#/components/schemas/ProblemDetails' - deprecated: false - put: - tags: - - wai - summary: subscriptionsPUT - description: Updates an existing subscription, identified by its self-referring URI returned on creation (initial POST) - operationId: subscriptionsPUT - parameters: - - name: subscriptionId - in: path - description: Subscription Id, specifically the "self" returned in the subscription request - required: true - style: simple - schema: - type: string - requestBody: - description: Subscription to be modified - content: - application/json: - schema: - oneOf: - - $ref: '#/components/schemas/AssocStaSubscription' - - $ref: '#/components/schemas/StaDataRateSubscription' - - $ref: '#/components/schemas/MeasurementReportSubscription' - description: Subscription to be modified - examples: - - 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: - bssid: 005C0A0A0A0A - ssid: - - myNetworkSsid - ipAddress: - - 10.10.100.1 - contentMediaType: application/json - 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: - bssid: 005C0A0A0A0A - ssid: - - myNetworkSsid - ipAddress: - - 10.10.100.1 - required: true - responses: - '200': - description: Successful subscription modification - headers: {} - content: - application/json: - schema: - oneOf: - - $ref: '#/components/schemas/AssocStaSubscription' - - $ref: '#/components/schemas/StaDataRateSubscription' - - $ref: '#/components/schemas/MeasurementReportSubscription' - examples: - - _links: - self: - href: http://[hostIP]/sbox-xyz123/wai/v2/subscriptions/sub123 - callbackReference: http://my.callback.com/wai/some-id - apId: - bssid: 005C0A0A0A0A - ssid: - - myNetworkSsid - ipAddress: - - 10.10.100.1 - contentMediaType: application/json - example: - _links: - self: - href: http://[hostIP]/sbox-xyz123/wai/v2/subscriptions/sub123 - callbackReference: http://my.callback.com/wai/some-id - apId: - bssid: 005C0A0A0A0A - ssid: - - myNetworkSsid - ipAddress: - - 10.10.100.1 - '400': - description: 'Bad Request : used to indicate that incorrect parameters were passed to the request.' - headers: {} - content: - application/problem+json: - schema: - $ref: '#/components/schemas/ProblemDetails' - '401': - description: 'Unauthorized : used when the client did not submit credentials.' - headers: {} - content: - application/problem+json: - schema: - $ref: '#/components/schemas/ProblemDetails' - '403': - description: 'Forbidden : operation is not allowed given the current status of the resource.' - headers: {} - 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.' - headers: {} - 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.' - headers: {} - 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' - headers: {} - 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.' - headers: {} - 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.' - headers: {} - content: - application/problem+json: - schema: - $ref: '#/components/schemas/ProblemDetails' - deprecated: false - delete: - tags: - - wai - summary: subscriptionsDELETE - description: Cancels an existing subscription, identified by its self-referring URI returned on creation (initial POST) - operationId: subscriptionsDELETE - parameters: - - name: subscriptionId - in: path - description: Subscription Id, specifically the "self" returned in the subscription request - required: true - style: simple - schema: - type: string - responses: - '204': - description: No Content - headers: {} - content: {} - '401': - description: 'Unauthorized : used when the client did not submit credentials.' - headers: {} - content: - application/problem+json: - schema: - $ref: '#/components/schemas/ProblemDetails' - '403': - description: 'Forbidden : operation is not allowed given the current status of the resource.' - headers: {} - 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.' - headers: {} - content: - application/problem+json: - schema: - $ref: '#/components/schemas/ProblemDetails' - '429': - description: 'Too Many Requests : used when a rate limiter has triggered.' - headers: {} - content: - application/problem+json: - schema: - $ref: '#/components/schemas/ProblemDetails' - deprecated: false - parameters: [] - /measurements: - get: - tags: - - wai - summary: measurementLinkList_measurementsGET - description: Queries information on measurements configuration - operationId: measurementLinkList_measurementsGET - parameters: [] - responses: - '200': - description: Response body contains the list of links to requestors measurement configurations. - headers: {} - content: - application/json: - schema: - $ref: '#/components/schemas/MeasurementConfigLinkList' - example: - _links: - self: - href: http://meAppServer.example.com/wai/v2/measurements - measurementConfig: - - href: http://meAppServer.example.com/wai/v2/measurements/meas123 - measurementId: myId1 - '400': - description: 'Bad Request : used to indicate that incorrect parameters were passed to the request.' - headers: {} - content: - application/problem+json: - schema: - $ref: '#/components/schemas/ProblemDetails' - '401': - description: 'Unauthorized : used when the client did not submit credentials.' - headers: {} - content: - application/problem+json: - schema: - $ref: '#/components/schemas/ProblemDetails' - '403': - description: 'Forbidden : operation is not allowed given the current status of the resource.' - headers: {} - 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.' - headers: {} - 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.' - headers: {} - content: - application/problem+json: - schema: - $ref: '#/components/schemas/ProblemDetails' - '429': - description: 'Too Many Requests : used when a rate limiter has triggered.' - headers: {} - content: - application/problem+json: - schema: - $ref: '#/components/schemas/ProblemDetails' - deprecated: false - post: - tags: - - wai - summary: measurementsPOST - description: Creates a new measurement configuration - operationId: measurementsPOST - parameters: [] - requestBody: - description: Measurement configuration information - content: - application/json: - schema: - $ref: '#/components/schemas/MeasurementConfig' - required: true - responses: - '201': - description: Successful measurement configuration response - headers: {} - content: - application/json: - schema: - $ref: '#/components/schemas/MeasurementConfig' - '400': - description: 'Bad Request : used to indicate that incorrect parameters were passed to the request.' - headers: {} - content: - application/problem+json: - schema: - $ref: '#/components/schemas/ProblemDetails' - '401': - description: 'Unauthorized : used when the client did not submit credentials.' - headers: {} - content: - application/problem+json: - schema: - $ref: '#/components/schemas/ProblemDetails' - '403': - description: 'Forbidden : operation is not allowed given the current status of the resource.' - headers: {} - 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.' - headers: {} - 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.' - headers: {} - 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.' - headers: {} - 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.' - headers: {} - 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.' - headers: {} - content: - application/problem+json: - schema: - $ref: '#/components/schemas/ProblemDetails' - deprecated: false - parameters: [] - /measurements/{measurementConfigId}: - get: - tags: - - wai - summary: measurementsGET - description: Queries information about an existing measurement configuration, identified by its self-referring URI returned on creation (initial POST) - operationId: measurementsGET - parameters: - - name: measurementConfigId - in: path - description: Measurement configuration Id, specifically the "self" returned in the measurement configuration request - required: true - style: simple - schema: - type: string - responses: - '200': - description: Measurement configuration information - headers: {} - content: - application/json: - schema: - $ref: '#/components/schemas/MeasurementConfig' - '400': - description: 'Bad Request : used to indicate that incorrect parameters were passed to the request.' - headers: {} - content: - application/problem+json: - schema: - $ref: '#/components/schemas/ProblemDetails' - '401': - description: 'Unauthorized : used when the client did not submit credentials.' - headers: {} - content: - application/problem+json: - schema: - $ref: '#/components/schemas/ProblemDetails' - '403': - description: 'Forbidden : operation is not allowed given the current status of the resource.' - headers: {} - 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.' - headers: {} - 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.' - headers: {} - content: - application/problem+json: - schema: - $ref: '#/components/schemas/ProblemDetails' - '429': - description: 'Too Many Requests : used when a rate limiter has triggered.' - headers: {} - content: - application/problem+json: - schema: - $ref: '#/components/schemas/ProblemDetails' - deprecated: false - put: - tags: - - wai - summary: measurementsPUT - description: Updates an existing measurement configuration, identified by its self-referring URI returned on creation (initial POST) - operationId: measurementsPUT - parameters: - - name: measurementConfigId - in: path - description: Measurement configuration Id, specifically the "self" returned in the measurement configuration request - required: true - style: simple - schema: - type: string - requestBody: - description: Measurement configuration to be modified - content: - application/json: - schema: - $ref: '#/components/schemas/MeasurementConfig' - required: true - responses: - '200': - description: Successful measurement configuration modification - headers: {} - content: - application/json: - schema: - $ref: '#/components/schemas/MeasurementConfig' - '400': - description: 'Bad Request : used to indicate that incorrect parameters were passed to the request.' - headers: {} - content: - application/problem+json: - schema: - $ref: '#/components/schemas/ProblemDetails' - '401': - description: 'Unauthorized : used when the client did not submit credentials.' - headers: {} - content: - application/problem+json: - schema: - $ref: '#/components/schemas/ProblemDetails' - '403': - description: 'Forbidden : operation is not allowed given the current status of the resource.' - headers: {} - 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.' - headers: {} - 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.' - headers: {} - 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' - headers: {} - 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.' - headers: {} - 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.' - headers: {} - content: - application/problem+json: - schema: - $ref: '#/components/schemas/ProblemDetails' - deprecated: false - delete: - tags: - - wai - summary: measurementsDELETE - description: Cancels an existing measurement configuration, identified by its self-referring URI returned on creation (initial POST) - operationId: measurementsDELETE - parameters: - - name: measurementConfigId - in: path - description: Measurement configuration Id, specifically the "self" returned in the measurement configuration request - required: true - style: simple - schema: - type: string - responses: - '204': - description: No Content - headers: {} - content: {} - '401': - description: 'Unauthorized : used when the client did not submit credentials.' - headers: {} - content: - application/problem+json: - schema: - $ref: '#/components/schemas/ProblemDetails' - '403': - description: 'Forbidden : operation is not allowed given the current status of the resource.' - headers: {} - 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.' - headers: {} - content: - application/problem+json: - schema: - $ref: '#/components/schemas/ProblemDetails' - '429': - description: 'Too Many Requests : used when a rate limiter has triggered.' - headers: {} - content: - application/problem+json: - schema: - $ref: '#/components/schemas/ProblemDetails' - deprecated: false - parameters: [] -components: - schemas: - ApAssociated: - title: ApAssociated - required: - - bssid - type: object - properties: - assocId: - type: string - description: Unique number which identifies a particular association between the station and Access Point. - bssid: - type: string - description: Basic Service Set Identifier (BSSID) is a unique identifier assigned to the Access Point (as network interface controller) for communications at the data link layer of a network segment. BSSID is typically set to an access point's MAC address. - ipAddress: - minItems: 0 - type: array - items: - type: string - description: IPv4 or IPv6 address allocated for the Access Point. - ssid: - minItems: 0 - type: array - items: - type: string - description: Service Set Identifier to identify logical networks. - ApIdentity: - title: ApIdentity - required: - - bssid - type: object - properties: - bssid: - type: string - description: Basic Service Set Identifier (BSSID) is a unique Identifier assigned to an Access Point (as network interface controller) for communications at the data link layer of a network segment. BSSID is typically set to an access point's MAC address. - ipAddress: - minItems: 0 - type: array - items: - type: string - description: IPv4 or IPv6 address allocated for the Access Point. - ssid: - minItems: 0 - type: array - items: - type: string - description: Service Set Identifier (SSID) to identify logical WLAN networks available via the Access Point. - ApInfo: - title: ApInfo - required: - - apId - type: object - properties: - apId: - $ref: '#/components/schemas/ApIdentity' - apLocation: - $ref: '#/components/schemas/ApLocation' - bssLoad: - $ref: '#/components/schemas/BssLoad' - channel: - type: integer - description: Channel configured for the Access Point. - contentEncoding: int32 - extBssLoad: - $ref: '#/components/schemas/ExtBssLoad' - oBssLoad: - $ref: '#/components/schemas/OBssLoad' - timeStamp: - $ref: '#/components/schemas/TimeStamp' - wanMetrics: - $ref: '#/components/schemas/WanMetrics' - wlanCap: - $ref: '#/components/schemas/WlanCapabilities' - ApLocation: - title: ApLocation - type: object - properties: - civicLocation: - $ref: '#/components/schemas/CivicLocation' - geolocation: - $ref: '#/components/schemas/GeoLocation' - AssocStaNotification: - title: AssocStaNotification - allOf: - - $ref: '#/components/schemas/InlineNotification' - - required: - - apId - type: object - properties: - apId: - $ref: '#/components/schemas/ApIdentity' - staId: - minItems: 0 - type: array - items: - $ref: '#/components/schemas/StaIdentity' - description: Identifier(s) to uniquely specify the client station(s) associated. - timeStamp: - $ref: '#/components/schemas/TimeStamp' - AssocStaSubscription: - title: AssocStaSubscription - allOf: - - $ref: '#/components/schemas/InlineSubscription' - - required: - - apId - type: object - properties: - _links: - $ref: '#/components/schemas/Links' - apId: - $ref: '#/components/schemas/ApIdentity' - callbackReference: - type: string - expiryDeadline: - $ref: '#/components/schemas/TimeStamp' - notificationEvent: - $ref: '#/components/schemas/NotificationEvent' - notificationPeriod: - type: integer - description: >- - Set for periodic notification reporting. - - Value indicates the notification period in seconds. - contentEncoding: int32 - requestTestNotification: - type: boolean - description: Set to TRUE by the service consumer to request a test notification on the callbackReference URI to determine if it is reachable by the WAIS for notifications. - websockNotifConfig: - $ref: '#/components/schemas/WebsockNotifConfig' - BeaconReport: - title: BeaconReport - required: - - bssid - - channel - - measurementId - - operatingClass - - reportedFrameInfo - type: object - properties: - antennaId: - type: integer - description: The Antenna ID field contains the identifying number for the antenna(s) used for this measurement. Antenna ID is defined in section 9.4.2.40 of IEEE 802.11-2016 [8]. - contentEncoding: int32 - bssid: - type: string - description: Indicates the BSSID of the BSS for which a beacon report has been received. - channel: - type: integer - description: Channel number where the beacon was received. - contentEncoding: int32 - measurementId: - type: string - description: Measurement ID of the Measurement configuration applied to this Beacon Report. - operatingClass: - type: integer - description: Operating Class field indicates an operating class value as defined in Annex E within IEEE 802.11-2016 [8]. - contentEncoding: int32 - parentTsf: - type: integer - description: The Parent TSF field contains the lower 4 octets of the measuring STA's TSF timer value at the start of reception of the first octet of the timestamp field of the reported Beacon, Measurement Pilot, or Probe Response frame at the time the Beacon, Measurement Pilot, or Probe Response frame being reported was received. - contentEncoding: int32 - rcpi: - type: integer - description: RCPI indicates the received channel power of the Beacon, Measurement Pilot, or Probe Response frame, which is a logarithmic function of the received signal power, as defined in section 9.4.2.38 of IEEE 802.11-2016 [8]. - contentEncoding: int32 - reportedFrameInfo: - $ref: '#/components/schemas/ReportedBeaconFrameInfo' - rsni: - type: integer - description: RSNI indicates the received signal-to-noise indication for the Beacon, Measurement Pilot, or Probe Response frame, as described in section 9.4.2.41 of IEEE 802.11-2016 [8]. - contentEncoding: int32 - ssid: - type: string - description: The SSID subelement indicates the ESS or IBSS for which a beacon report is received. - staId: - $ref: '#/components/schemas/StaIdentity' - BeaconReportingConfig: - title: BeaconReportingConfig - required: - - reportingCondition - - threshold - type: object - properties: - reportingCondition: - type: integer - description: >- - Reporting condition for the Beacon Report as per Table 9-89 of IEEE 802.11-2016 [8]: - - 0 = Report to be issued after each measurement. - - 1 = measured RCPI level is greater than the threshold. - - 2 = measured RCPI level is less than the threshold. - - 3 = measured RSNI level is greater than the threshold. - - 4 = measured RSNI level is less than the threshold. - - 5 = measured RCPI level is greater than a threshold defined by an offset from the serving AP's reference RCPI. - - 6 = measured RCPI level is less than a threshold defined by an offset from the serving AP's reference RCPI. - - 7 = measured RSNI level is greater than a threshold defined by an offset from the serving AP's reference RSNI. - - 8 = measured RSNI level is less than a threshold defined by an offset from the serving AP's reference RSNI. - - 9 = measured RCPI level is in a range bound by the serving AP's reference RCPI and an offset from the serving AP's reference RCPI. - - 10 = measured RSNI level is in a range bound by the serving AP's reference RSNI and an offset from the serving AP's reference RSNI. - contentEncoding: int32 - threshold: - type: integer - description: >- - The threshold subfield contains either the threshold value or the offset value to be used for conditional reporting. - - - For reportingCondition subfield with values 1 and 2, the threshold value is a logarithmic function of the received signal power, as defined in section 9.4.2.38 of IEEE 802.11-2016 [8]. - - - For reportingCondition subfield values 3 and 4, the threshold value is a logarithmic function of the signal-to-noise ratio, as described in section 9.4.2.41 of IEEE 802.11-2016 [8]. - - - For reportingCondition subfield values 5 to 10, the offset value is an 8-bit 2s complement integer in units of 0,5 dBm. The indicated reporting condition applies individually to each measured Beacon, Measurement Pilot, or Probe Response frame. - contentEncoding: int32 - BeaconRequestConfig: - title: BeaconRequestConfig - required: - - beaconReportingConf - - channelId - - measurementMode - - operatingClass - type: object - properties: - beaconReportingConf: - $ref: '#/components/schemas/BeaconReportingConfig' - bssid: - type: string - description: The BSSID field indicates the BSS for which a beacon report is requested. If absent, the requested beacon reports should include all BSSs on the channel. - channelId: - type: integer - 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. - contentEncoding: int32 - measurementMode: - type: integer - description: >- - 0 for passive. - - 1 for active. - - 2 for beacon table. - contentEncoding: int32 - operatingClass: - type: integer - description: Operating Class field indicates an operating class value as defined in Annex E within IEEE 802.112016 [8]. - contentEncoding: int32 - ssid: - type: string - description: The SSID subelement indicates the ESS or IBSS for which a beacon report is requested. - BssCapabilities: - title: BssCapabilities - required: - - apsd - - delayedBACK - - immediateBACK - - qos - - radioMeasurements - - spectrumManagement - type: object - properties: - apsd: - type: boolean - description: APSD Option implemented - delayedBACK: - type: boolean - description: Delayed Block Ack Option implemented - immediateBACK: - type: boolean - description: Immediate Block Ack Option implemented - qos: - type: boolean - description: QoS Option implemented - radioMeasurements: - type: boolean - description: Radio Measurement Activated - spectrumManagement: - type: boolean - description: Spectrum Management required - BssLoad: - title: BssLoad - required: - - availAdmCap - - channelUtilization - - staCount - type: object - 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. - contentEncoding: int32 - 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. - contentEncoding: int32 - staCount: - type: integer - description: An unsigned integer that indicates the total number of STAs currently associated with this BSS. - contentEncoding: int32 - BssidInfo: - title: BssidInfo - required: - - apReachability - - capabilities - - ftm - - highThroughput - - mobilityDomain - - security - - veryHighThroughput - type: object - properties: - apReachability: - type: integer - description: >- - The apReachability field indicates whether the AP identified by this BSSID is reachable by the STA that requested the neighbor report. Valid values: - - 0 = reserved - - 1 = not reachable - - 2 = unknown - - 3 = reachable. - contentEncoding: int32 - capabilities: - $ref: '#/components/schemas/BssCapabilities' - ftm: - type: boolean - description: >- - True indicates the AP represented by this BSSID is an AP that has set the Fine Timing Measurement Responder field of the Extended Capabilities element to 1. - - - False indicates either that the reporting AP has dot11FineTimingMsmtRespActivated equal to false, or the reported AP has not set the Fine Timing Measurement Responder field of the Extended Capabilities element to 1 or that the Fine Timing Measurement Responder field of the reported AP is not available to the reporting AP at this time. - highThroughput: - type: boolean - description: True indicates that the AP represented by this BSSID is an HT AP including the HT Capabilities element in its Beacons, and that the contents of that HT Capabilities element are identical to the HT Capabilities element advertised by the AP sending the report. - mobilityDomain: - type: boolean - description: True indicates the AP represented by this BSSID is including an MDE in its Beacon frames and that the contents of that MDE are identical to the MDE advertised by the AP sending the report. - security: - type: boolean - description: >- - True indicates the AP identified by this BSSID supports the same security provisioning as used by the STA in its current association. - - - False indicates either that the AP does not support the same security provisioning or that the security information is not available at this time. - veryHighThroughput: - type: boolean - description: True indicates that the AP represented by this BSSID is a VHT AP and that the VHT Capabilities element, if included as a subelement in the report, is identical in content to the VHT Capabilities element included in the AP's Beacon. - ChannelLoad: - title: ChannelLoad - required: - - channel - - channelLoad - - measurementDuration - - measurementId - - operatingClass - type: object - properties: - channel: - type: integer - description: Channel number indicates the channel number for which the measurement report applies. - contentEncoding: int32 - channelLoad: - type: integer - description: Proportion of measurement duration for which the measuring STA determined the channel to be busy, as a percentage of time, linearly scaled with 255 representing 100 %. - contentEncoding: int32 - measurementDuration: - type: integer - description: Duration over which the Channel Load report was measured, in units of TUs of 1 024 µs. - contentEncoding: int32 - measurementId: - type: string - description: Measurement ID of the Measurement configuration applied to this Channel Load Report. - operatingClass: - type: integer - description: Operating Class field indicates an operating class value as defined in Annex E within IEEE 802.11-2016 [8]. - contentEncoding: int32 - staId: - $ref: '#/components/schemas/StaIdentity' - ChannelLoadConfig: - title: ChannelLoadConfig - required: - - channel - - operatingClass - type: object - properties: - channel: - type: integer - description: Channel for which the channel load report is requested. - contentEncoding: int32 - operatingClass: - type: integer - description: Operating Class field indicates an operating class value as defined in Annex E within IEEE 802.11-2016 [8]. - contentEncoding: int32 - reportingCondition: - type: integer - description: >- - Reporting condition for the Beacon Report as per Table 9-153 of IEEE 802.11-2016 [8]: - - 0 = Report to be issued after each measurement. - - 1 = Report to be issued when Channel Load is greater than or equal to the threshold. - - 2 = Report to be issued when Channel Load is less than or equal to the threshold. - - - If this optional field is not provided, channel load report should be issued after each measurement (reportingCondition = 0). - contentEncoding: int32 - threshold: - type: integer - description: Channel Load reference value for threshold reporting. This field shall be provided for reportingCondition values 1 and 2. - contentEncoding: int32 - CivicLocation: - title: CivicLocation - required: - - country - type: object - properties: - ca0: - type: string - description: Language - ca1: - type: string - description: National subdivisions (state, canton, region, province, prefecture) - ca128: - type: string - description: Script - ca16: - type: string - description: Leading street direction - ca17: - type: string - description: Trailing street suffix - ca18: - type: string - description: Street suffix or type - ca19: - type: string - description: House number - ca2: - type: string - description: County, parish, gun (JP), district (IN) - ca20: - type: string - description: House number suffix - ca21: - type: string - description: Landmark of vanity address - ca22: - type: string - description: Additional location information - ca23: - type: string - description: Name (residence and office occupant) - ca24: - type: string - description: Postal/zip code - ca25: - type: string - description: Building (structure) - ca26: - type: string - description: Unit (apartment/suite) - ca27: - type: string - description: Floor - ca28: - type: string - description: Room - ca29: - type: string - description: Type of place - ca3: - type: string - description: City, township, shi (JP) - ca30: - type: string - description: Postal community name - ca31: - type: string - description: Post office box - ca32: - type: string - description: Additional code - ca33: - type: string - description: Seat (desk.cubicle, workstation) - ca34: - type: string - description: Primary road name - ca35: - type: string - description: Road section - ca36: - type: string - description: Branch road name - ca37: - type: string - description: Sub-branch road name - ca38: - type: string - description: Street name pre-modifier - ca39: - type: string - description: Street name post-modifier - ca4: - type: string - description: City division, borough, city district, ward, chou (JP) - ca5: - type: string - description: Neighborhood, block - ca6: - type: string - description: Group of streets below the neighborhood level - country: - type: string - 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] - DmgCapabilities: - title: DmgCapabilities - required: - - ExtScMcsCap - - dmgApOrPcpCapInfo - - dmgStaBeamTrackTimeLimit - - dmgStaCapInfo - - maxNrBasicAmsduSubframes - - maxNrShortAmsduSubframes - type: object - properties: - ExtScMcsCap: - type: integer - description: Extended SC MCS capabilities as defined in IEEE 802.11-2016 [8]. - contentEncoding: int32 - dmgApOrPcpCapInfo: - type: integer - description: DMG AP or PCP capabilities information as defined in IEEE 802.11-2016 [8]. - contentEncoding: int32 - dmgStaBeamTrackTimeLimit: - type: integer - description: DMG station beam tracking time limit as defined in IEEE 802.11-2016 [8]. - contentEncoding: int32 - dmgStaCapInfo: - type: integer - description: DMG station capabilities information as defined in IEEE 802.11-2016 [8]. - contentEncoding: int32 - maxNrBasicAmsduSubframes: - type: integer - description: Number of basic A-MSDU subframes in A-MSDU as defined in IEEE 802.11-2016 [8]. - contentEncoding: int32 - maxNrShortAmsduSubframes: - type: integer - description: Number of short A-MSDU subframes in A-MSDU as defined in IEEE 802.11-2016 [8]. - contentEncoding: int32 - EdmgCapabilities: - title: EdmgCapabilities - required: - - ampduParameters - - supportedMcs - - trnParameters - type: object - properties: - ampduParameters: - type: integer - description: A-MPDU parameters as defined in draft IEEE P802.11ay [i.11] - contentEncoding: int32 - supportedMcs: - type: integer - description: Supported MCS as defined in draft IEEE P802.11ay [i.11] - contentEncoding: int32 - trnParameters: - type: integer - description: Training parameters as defined in draft IEEE P802.11ay [i.11] - contentEncoding: int32 - ExpiryNotification: - title: ExpiryNotification - required: - - _links - - expiryDeadline - - notificationType - type: object - properties: - _links: - $ref: '#/components/schemas/Links1' - expiryDeadline: - $ref: '#/components/schemas/TimeStamp' - notificationType: - type: string - description: Shall be set to "ExpiryNotification". - ExtBssLoad: - title: ExtBssLoad - required: - - muMimoStaCount - - obsSec20MhzUtil - - obsSec40MhzUtil - - obsSec80MhzUtil - - spatStreamUnderUtil - type: object - 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. - contentEncoding: int32 - obsSec20MhzUtil: - type: integer - description: Observable loading on each of the secondary 20 MHz channel. - contentEncoding: int32 - obsSec40MhzUtil: - type: integer - description: Observable loading on each of the secondary 40 MHz channel. - contentEncoding: int32 - obsSec80MhzUtil: - type: integer - description: Observable loading on each of the secondary 80 MHz channel. - contentEncoding: int32 - 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. - contentEncoding: int32 - GeoLocation: - title: GeoLocation - required: - - datum - - lat - - latUncertainty - - long - - longUncertainty - type: object - properties: - altitude: - type: integer - description: The altitude value of location as defined in IETF RFC 6225 [6] - contentEncoding: int32 - altitudeType: - type: integer - description: The type description for altitude information e.g. floors or meters as defined in IETF RFC 6225 [6] - contentEncoding: int32 - altitudeUncertainty: - type: integer - description: The uncertainty for altitude information as defined in IETF RFC 6225 [6] - contentEncoding: int32 - datum: - type: integer - description: The datum value to express how coordinates are organized and related to real world as defined in IETF RFC 6225 [6] - contentEncoding: int32 - lat: - type: integer - description: The latitude value of location as defined in IETF RFC 6225 [6] - contentEncoding: int32 - latUncertainty: - type: integer - description: The uncertainty for Latitude information as defined in IETF RFC 6225 [6] - contentEncoding: int32 - long: - type: integer - description: The longitude value of location as defined in IETF RFC 6225 [6] - contentEncoding: int32 - longUncertainty: - type: integer - description: The uncertainty for Longitude information as defined in IETF RFC 6225 [6] - contentEncoding: int32 - HeCapabilities: - title: HeCapabilities - required: - - heMacCapInfo - - hePhyCapinfo - - supportedHeMcsNssSet - type: object - properties: - heMacCapInfo: - type: integer - description: MAC capabilities of an Access Point. - contentEncoding: int32 - hePhyCapinfo: - type: integer - description: PHY capabilities of an Access Point. - contentEncoding: int32 - supportedHeMcsNssSet: - type: integer - description: Supported MCS and NSS Set. - contentEncoding: int32 - HtCapabilities: - title: HtCapabilities - required: - - ampduParameters - - aselCap - - htCapabilityInfo - - htExtendedCap - - supportedMcsSet - - txBeamFormCap - type: object - properties: - ampduParameters: - type: integer - description: A-MPDU parameters as defined in IEEE 802.11-2016 [8]. - contentEncoding: int32 - aselCap: - type: integer - description: ASEL capabilities as defined in IEEE 802.11-2016 [8]. - contentEncoding: int32 - htCapabilityInfo: - type: integer - description: HT Capability Information as defined in IEEE 802.11-2016 [8]. - contentEncoding: int32 - htExtendedCap: - type: integer - description: Extended HT Capabilities as defined in IEEE 802.11-2016 [8]. - contentEncoding: int32 - supportedMcsSet: - type: integer - description: Supported MCS set as defined in IEEE 802.11-2016 [8]. - contentEncoding: int32 - txBeamFormCap: - type: integer - description: Transmit Beamforming Capabilities as defined in IEEE 802.11-2016 [8]. - contentEncoding: int32 - LinkType: - title: LinkType - required: - - href - type: object - properties: - href: - type: string - MeasurementConfig: - title: MeasurementConfig - required: - - measurementId - - measurementInfo - - staId - type: object - properties: - _links: - $ref: '#/components/schemas/Links4' - measurementId: - type: string - description: Unique identifier allocated by the service consumer to identify measurement reports (within sta_information query), associated with this measurement configuration. - measurementInfo: - $ref: '#/components/schemas/MeasurementInfo' - staId: - minItems: 1 - type: array - items: - $ref: '#/components/schemas/StaIdentity' - description: Identifier(s) to uniquely specify the target client station(s) for the measurement configuration. - MeasurementConfigLinkList: - title: MeasurementConfigLinkList - required: - - _links - type: object - properties: - _links: - $ref: '#/components/schemas/Links4' - measurementConfig: - type: array - items: - $ref: '#/components/schemas/MeasurementConfig1' - description: '' - MeasurementInfo: - title: MeasurementInfo - type: object - properties: - beaconRequestConf: - $ref: '#/components/schemas/BeaconRequestConfig' - channelLoadConf: - $ref: '#/components/schemas/ChannelLoadConfig' - measurementDuration: - type: integer - description: Duration of the measurement in Time Units (TUs) of 1 024 µs, as defined in section 11.11.4 of IEEE 802.11-2016 [8]. If not provided, the underlying system may utilize a default configuration that will be indicated in resulting measurement reports. - contentEncoding: int32 - neighborReportConf: - $ref: '#/components/schemas/NeighborReportConfig' - randomInterval: - type: integer - description: Random interval to be used for starting the measurement in TUs of 1 024 µs, as specified in section 11.11.3 of IEEE 802.11-2016 [8]. If not provided, the underlying system may utilize a default configuration that will be indicated in resulting measurement reports. - contentEncoding: int32 - staStatisticsConf: - $ref: '#/components/schemas/StaStatisticsConfig' - MeasurementReportNotification: - title: MeasurementReportNotification - allOf: - - $ref: '#/components/schemas/InlineNotification' - - type: object - properties: - beaconReport: - minItems: 0 - type: array - items: - $ref: '#/components/schemas/BeaconReport' - description: Beacon Report as defined in IEEE 802.11-2016 [8]. - channelLoad: - minItems: 0 - type: array - items: - $ref: '#/components/schemas/ChannelLoad' - description: Channel Load reports as seen by the station as defined in IEEE 802.11-2016 [8]. - neighborReport: - minItems: 0 - type: array - items: - $ref: '#/components/schemas/NeighborReport' - description: Neighbor Report providing information about neighbor Access Points seen by the station as defined in IEEE 802.112016 [8]. - staStatistics: - minItems: 0 - type: array - items: - $ref: '#/components/schemas/StaStatistics' - description: STA Statistics Report as defined in IEEE 802.11-2016 [8]. - timeStamp: - $ref: '#/components/schemas/TimeStamp' - MeasurementReportSubscription: - title: MeasurementReportSubscription - allOf: - - $ref: '#/components/schemas/InlineSubscription' - - required: - - measurementId - - measurementInfo - - staId - type: object - properties: - _links: - $ref: '#/components/schemas/Links' - callbackReference: - type: string - expiryDeadline: - $ref: '#/components/schemas/TimeStamp' - measurementId: - type: string - description: Unique identifier allocated by the service consumer to identify measurement reports associated with this measurement subscription. - measurementInfo: - $ref: '#/components/schemas/MeasurementInfo' - requestTestNotification: - type: boolean - description: Set to TRUE by the service consumer to request a test notification on the callbackReference URI to determine if it is reachable by the WAIS for notifications. - staId: - minItems: 1 - type: array - items: - $ref: '#/components/schemas/StaIdentity' - description: Identifier(s) to uniquely specify the target client station(s) for the subscription. - websockNotifConfig: - $ref: '#/components/schemas/WebsockNotifConfig' - NeighborReport: - title: NeighborReport - required: - - bssid - - bssidInfo - - channel - - measurementId - - operatingClass - - phyType - type: object - properties: - bssTransitionCandidatePreference: - type: integer - description: Relative value indicating the preferred ordering for this BSS as a transition candidate for roaming. 255 indicating the most preferred candidate and 1 indicating the least preferred candidate, as defined in Table 9-152 within IEEE 802.112016 [8]. - contentEncoding: int32 - bssid: - type: string - description: BSSID (MAC address) of the Access Point that is being reported. - bssidInfo: - $ref: '#/components/schemas/BssidInfo' - channel: - type: integer - description: Channel field indicates a channel number, which is interpreted in the context of the indicated operating class. Channel numbers are defined in Annex E within IEEE 802.11-2016 [8]. - contentEncoding: int32 - measurementId: - type: string - description: Measurement ID of the Measurement configuration applied to this Neighbor Report. - operatingClass: - type: integer - description: Operating Class field indicates an operating class value as defined in Annex E within IEEE 802.11-2016 [8]. - contentEncoding: int32 - phyType: - type: integer - description: >- - PHY type of the AP indicated by this BSSID. It is an integer value coded according to the value of the dot11PHYType, Annex C within IEEE 802.11-2016 [8]. - - 2 = dsss - - 4 = ofdm - - 5 = hrdsss - - 6 = erp - - 7 = ht - - 8 = dmg - - 9 = vht - - 10 = tvht - contentEncoding: int32 - staId: - $ref: '#/components/schemas/StaIdentity' - NeighborReportConfig: - title: NeighborReportConfig - type: object - properties: - bssid: - type: string - description: BSSID of the neighbor AP which information is intended to obtain. If no specific BSSID is given, the information will be provided for all APs matching the ssid criteria. - ssid: - type: string - description: The SSID field is optionally present. If present, it contains an SSID element. The presence of an SSID element in a Neighbor Report indicates a request for a neighbor list for the specified SSID in the SSID Element. The absence of an SSID element indicates neighbor report for the current ESS. - OBssLoad: - title: OBssLoad - required: - - allocatedTrafficSelfMean - - allocatedTrafficShareMean - type: object - properties: - allocatedTrafficSelfMean: - type: integer - description: Mean of allocated traffic from this AP (BSS) in units of 32 µs per second. - contentEncoding: int32 - allocatedTrafficSelfStdDev: - type: integer - description: Standard deviation from the mean of allocation traffic from this BSS in units of 32 µs per second. - contentEncoding: int32 - allocatedTrafficShareMean: - type: integer - description: Mean of the sum of allocated traffic from other APs on the overlapping channel in unit of 32 µs per second. - contentEncoding: int32 - allocatedTrafficShareStdDev: - type: integer - description: Standard deviation from the mean of the sum of allocated traffic from other APs on the overlapping channel in unit of 32 µs per second. - contentEncoding: int32 - overlap: - type: integer - description: Indicates the number of other APs that are sharing the same channel as the reporting AP. - contentEncoding: int32 - ProblemDetails: - title: ProblemDetails - type: object - properties: - detail: - type: string - description: A human-readable explanation specific to this occurrence of the problem - instance: - type: string - description: A URI reference that identifies the specific occurrence of the problem - status: - type: integer - description: The HTTP status code for this occurrence of the problem - contentEncoding: int32 - title: - type: string - description: A short, human-readable summary of the problem type - type: - type: string - description: A URI reference according to IETF RFC 3986 that identifies the problem type - ReportedBeaconFrameInfo: - title: ReportedBeaconFrameInfo - required: - - frameType - - phyType - type: object - properties: - frameType: - type: integer - description: >- - A value of 0 indicates a Beacon or Probe Response. - - A value of 1 indicates a Measurement Pilot frame. - contentEncoding: int32 - phyType: - type: integer - description: Value between 0 and 127 coded according to dot11PHYType. - contentEncoding: int32 - ReportingReasonQoSCounters: - title: ReportingReasonQoSCounters - required: - - qosAckFailure - - qosDiscarded - - qosFailed - - qosFrameDuplicate - - qosMultipleRetry - - qosRetry - - qosRtsFailure - type: object - properties: - qosAckFailure: - type: boolean - description: dot11QoSAckFailure - qosDiscarded: - type: boolean - description: dot11QoSDiscarded - qosFailed: - type: boolean - description: dot11QoSFailed - qosFrameDuplicate: - type: boolean - description: dot11QoSFrameDuplicate - qosMultipleRetry: - type: boolean - description: dot11QoSMultipleRetry - qosRetry: - type: boolean - description: dot11QoSRetry - qosRtsFailure: - type: boolean - description: dot11QoSRTSFailure - ReportingReasonStaCounters: - title: ReportingReasonStaCounters - required: - - ackFailure - - failed - - fcsError - - frameDuplicate - - multipleRetry - - retry - - rtsFailure - type: object - properties: - ackFailure: - type: boolean - description: dot11AckFailure - failed: - type: boolean - description: dot11Failed - fcsError: - type: boolean - description: dot11FCSError - frameDuplicate: - type: boolean - description: dot11FrameDuplicate - multipleRetry: - type: boolean - description: dot11MultipleRetry - retry: - type: boolean - description: dot11Retry - rtsFailure: - type: boolean - description: dot11RTSFailure - Rssi: - title: Rssi - required: - - rssi - type: object - properties: - rssi: - type: integer - description: The Received Signal Strength Indicator from a station - contentEncoding: int32 - STACounterTriggerCondition: - title: STACounterTriggerCondition - type: object - properties: - ackFailureCountThreshold: - type: integer - description: Configure and set threshold for dot11AckFailureCount trigger - contentEncoding: int32 - failedCountThreshold: - type: integer - description: Configure and set threshold for dot11FailedCount trigger - contentEncoding: int32 - fcsErrorCountThreshold: - type: integer - description: Configure and set threshold for dot11FCSErrorCount trigger - contentEncoding: int32 - frameDuplicateCountThreshold: - type: integer - description: Configure and set threshold for dot11FrameDuplicateCount trigger - contentEncoding: int32 - multipleRetryCountThreshold: - type: integer - description: Configure and set threshold for dot11MultipleRetryCount trigger - contentEncoding: int32 - retryCountThreshold: - type: integer - description: Configure and set threshold for dot11RetryCount trigger - contentEncoding: int32 - rtsFailureCountThreshold: - type: integer - description: Configure and set threshold for dot11RTSFailureCount trigger - contentEncoding: int32 - StaDataRate: - title: StaDataRate - type: object - properties: - staId: - $ref: '#/components/schemas/StaIdentity' - staLastDataDownlinkRate: - type: integer - description: The data transmit rate in kbps that was most recently used for transmission of data PPDUs from the access point to the station. - contentEncoding: int32 - staLastDataUplinkRate: - type: integer - 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. - contentEncoding: int32 - StaDataRateNotification: - title: StaDataRateNotification - allOf: - - $ref: '#/components/schemas/InlineNotification' - - type: object - properties: - staDataRate: - minItems: 0 - type: array - items: - $ref: '#/components/schemas/StaDataRate' - description: Data rates of a client station. - timeStamp: - $ref: '#/components/schemas/TimeStamp' - StaDataRateSubscription: - title: StaDataRateSubscription - allOf: - - $ref: '#/components/schemas/InlineSubscription' - - required: - - staId - type: object - properties: - _links: - $ref: '#/components/schemas/Links' - callbackReference: - type: string - expiryDeadline: - $ref: '#/components/schemas/TimeStamp' - notificationEvent: - $ref: '#/components/schemas/NotificationEvent1' - notificationPeriod: - type: integer - description: >- - Set for periodic notification reporting. - - Value indicates the notification period in seconds. - contentEncoding: int32 - requestTestNotification: - type: boolean - description: Set to TRUE by the service consumer to request a test notification on the callbackReference URI to determine if it is reachable by the WAIS for notifications. - staId: - minItems: 1 - type: array - items: - $ref: '#/components/schemas/StaIdentity' - description: Identifier(s) to uniquely specify the target client station(s) for the subscription. - websockNotifConfig: - $ref: '#/components/schemas/WebsockNotifConfig' - StaIdentity: - title: StaIdentity - required: - - macId - type: object - properties: - aid: - type: string - description: Number which identifies a particular association between a station and an Access Point - ipAddress: - minItems: 0 - type: array - items: - type: string - description: IPv4 or IPv6 address(es) allocated for the station. - macId: - type: string - description: Unique identifier assigned to station (as network interface controller) for communications at the data link layer of a network segment. - ssid: - minItems: 0 - type: array - items: - type: string - description: Service Set Identifier(s) to identify logical networks. - StaInfo: - title: StaInfo - required: - - staId - type: object - properties: - apAssociated: - $ref: '#/components/schemas/ApAssociated' - beaconReport: - minItems: 0 - type: array - items: - $ref: '#/components/schemas/BeaconReport' - description: Beacon Report as defined in IEEE 802.11-2016 [8]. - channel: - type: integer - description: Channel currently used by the station to connect with its associated Access Point. - contentEncoding: int32 - channelLoad: - minItems: 0 - type: array - items: - $ref: '#/components/schemas/ChannelLoad' - description: Channel Load reports as seen by the station as defined IEEE 802.11-2016 [8]. Channel Load reports may be configured for any channel, including the station's current channel for association. - neighborReport: - minItems: 0 - type: array - items: - $ref: '#/components/schemas/NeighborReport' - description: Information about neighbor Access Points seen by the station as defined IEEE 802.11-2016 [8]. - rssi: - $ref: '#/components/schemas/Rssi' - staDataRate: - $ref: '#/components/schemas/StaDataRate' - staId: - $ref: '#/components/schemas/StaIdentity' - staStatistics: - minItems: 0 - type: array - items: - $ref: '#/components/schemas/StaStatistics' - description: Statistics as defined in IEEE 802.11-2016 [8] for the client station collected over measurement duration. - timeStamp: - $ref: '#/components/schemas/TimeStamp' - StaStatistics: - title: StaStatistics - required: - - groupIdentity - - measurementDuration - - measurementId - type: object - properties: - group2to9Data: - $ref: '#/components/schemas/StaStatisticsGroup2to9Data' - groupIdentity: - type: integer - description: >- - Indicates the requested statistics group describing the Statistics Group Data according to Table 9-114 of IEEE 802.11-2016 [8]. - - Depending on group identity, one and only one of the STA Statistics Group Data will be present. - contentEncoding: int32 - groupOneData: - $ref: '#/components/schemas/StaStatisticsGroupOneData' - groupZeroData: - $ref: '#/components/schemas/StaStatisticsGroupZeroData' - measurementDuration: - type: integer - description: Duration over which the Statistics Group Data was measured in time units of 1 024 µs. Duration equal to zero indicates a report of current values. - contentEncoding: int32 - measurementId: - type: string - description: Measurement ID of the Measurement configuration applied to this STA Statistics Report. - staId: - $ref: '#/components/schemas/StaIdentity' - StaStatisticsConfig: - title: StaStatisticsConfig - required: - - groupIdentity - - triggeredReport - type: object - properties: - groupIdentity: - type: integer - description: As per Table 9-92 of IEEE 802.11-2016 [8]. - contentEncoding: int32 - measurementCount: - type: integer - description: >- - Valid if triggeredReport = true. - - Specifies the number of MAC service data units or protocol data units to determine if the trigger conditions are met. - contentEncoding: int32 - triggerCondition: - $ref: '#/components/schemas/STACounterTriggerCondition' - triggerTimeout: - type: integer - description: >- - Valid if triggeredReport = true. - - The Trigger Timeout field contains a value in units of 100 time-units of 1 024 µs during which a measuring STA does not generate further triggered STA Statistics Reports after a trigger condition has been met. - contentEncoding: int32 - triggeredReport: - type: boolean - description: True = triggered reporting, otherwise duration. - StaStatisticsGroup2to9Data: - title: StaStatisticsGroup2to9Data - required: - - qosAckFailureCount - - qosDiscardedFrameCount - - qosFailedCount - - qosFrameDuplicateCount - - qosMPDUsReceivedCount - - qosMultipleRetryCount - - qosRTSFailureCount - - qosRTSSuccessCount - - qosReceivedFragmentCount - - qosRetriesReceivedCount - - qosRetryCount - - qosTransmittedFragmentCount - - qosTransmittedFrameCount - type: object - properties: - qosAckFailureCount: - type: integer - description: dot11QosAckFailureCount counter - contentEncoding: int32 - qosDiscardedFrameCount: - type: integer - description: dot11QosDiscardedFrameCount counter - contentEncoding: int32 - qosFailedCount: - type: integer - description: dot11QosFailedCount counter - contentEncoding: int32 - qosFrameDuplicateCount: - type: integer - description: dot11QosFrameDuplicateCount counter - contentEncoding: int32 - qosMPDUsReceivedCount: - type: integer - description: dot11QosMPDUsReceivedCount counter - contentEncoding: int32 - qosMultipleRetryCount: - type: integer - description: dot11QosMultipleRetryCount counter - contentEncoding: int32 - qosRTSFailureCount: - type: integer - description: dot11QosRTSFailureCount counter - contentEncoding: int32 - qosRTSSuccessCount: - type: integer - description: dot11QosRTSSuccessCount counter - contentEncoding: int32 - qosReceivedFragmentCount: - type: integer - description: dot11QosReceivedFragmentCount counter - contentEncoding: int32 - qosRetriesReceivedCount: - type: integer - description: dot11QosRetriesReceivedCount counter - contentEncoding: int32 - qosRetryCount: - type: integer - description: dot11QosRetryCount counter - contentEncoding: int32 - qosTransmittedFragmentCount: - type: integer - description: dot11QosTransmittedFragmentCount counter - contentEncoding: int32 - qosTransmittedFrameCount: - type: integer - description: dot11QosTransmittedFrameCount counter - contentEncoding: int32 - reportingReasonQoSCounters: - $ref: '#/components/schemas/ReportingReasonQoSCounters' - StaStatisticsGroupOneData: - title: StaStatisticsGroupOneData - required: - - ackFailureCount - - frameDuplicateCount - - multipleRetryCount - - retryCount - - rtsFailureCount - - rtsSuccessCount - type: object - properties: - ackFailureCount: - type: integer - description: dot11AckFailureCount counter - contentEncoding: int32 - frameDuplicateCount: - type: integer - description: dot11FrameDuplicateCount counter - contentEncoding: int32 - multipleRetryCount: - type: integer - description: dot11MultipleRetryCount counter - contentEncoding: int32 - reportingReasonStaCounters: - $ref: '#/components/schemas/ReportingReasonStaCounters' - retryCount: - type: integer - description: dot11RetryCount counter - contentEncoding: int32 - rtsFailureCount: - type: integer - description: dot11RTSFailureCount counter - contentEncoding: int32 - rtsSuccessCount: - type: integer - description: dot11RTSSuccessCount counter - contentEncoding: int32 - StaStatisticsGroupZeroData: - title: StaStatisticsGroupZeroData - required: - - failedCount - - fcsErrorCount - - groupReceivedFrameCount - - groupTransmittedFrameCount - - receivedFragmentCount - - transmittedFragmentCount - - transmittedFrameCount - type: object - properties: - failedCount: - type: integer - description: dot11FailedCount counter - contentEncoding: int32 - fcsErrorCount: - type: integer - description: dot11FCSErrorCount counter - contentEncoding: int32 - groupReceivedFrameCount: - type: integer - description: dot11GroupReceivedFrameCount counter - contentEncoding: int32 - groupTransmittedFrameCount: - type: integer - description: dot11GroupTransmittedFrameCount counter - contentEncoding: int32 - receivedFragmentCount: - type: integer - description: dot11ReceivedFragmentCount counter - contentEncoding: int32 - reportingReasonStaCounters: - $ref: '#/components/schemas/ReportingReasonStaCounters' - transmittedFragmentCount: - type: integer - description: dot11TransmittedFragmentCount counter - contentEncoding: int32 - transmittedFrameCount: - type: integer - description: dot11TransmittedFrameCount counter - contentEncoding: int32 - SubscriptionLinkList: - title: SubscriptionLinkList - required: - - _links - type: object - properties: - _links: - $ref: '#/components/schemas/Links6' - subscription: - type: array - items: - $ref: '#/components/schemas/Subscription' - description: '' - TestNotification: - title: TestNotification - required: - - _links - - notificationType - type: object - properties: - _links: - $ref: '#/components/schemas/Links1' - notificationType: - type: string - description: Shall be set to "TestNotification". - TimeStamp: - title: TimeStamp - required: - - nanoSeconds - - seconds - type: object - properties: - nanoSeconds: - type: integer - description: The nanoseconds part of the time. Time is defined as Unix-time since January 1, 1970, 00:00:00 UTC. - contentEncoding: int32 - seconds: - type: integer - description: The seconds part of the time. Time is defined as Unixtime since January 1, 1970, 00:00:00 UTC. - contentEncoding: int32 - VhtCapabilities: - title: VhtCapabilities - required: - - vhtCapInfo - - vhtMcsNss - type: object - properties: - vhtCapInfo: - type: integer - description: VHT capabilities Info as defined in IEEE 802.11-2016 [8]. - contentEncoding: int32 - vhtMcsNss: - type: integer - description: Supported VHT-MCS and NSS Set as defined in IEEE 802.11-2016 [8]. - contentEncoding: int32 - WanMetrics: - title: WanMetrics - required: - - downlinkLoad - - downlinkSpeed - - lmd - - uplinkLoad - - uplinkSpeed - - wanInfo - type: object - 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. - contentEncoding: int32 - downlinkSpeed: - type: integer - description: 4-octet positive integer whose value is an estimate of the WAN Backhaul link current downlink speed in kilobits per second. - contentEncoding: int32 - 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. - contentEncoding: int32 - uplinkLoad: - type: integer - 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. - contentEncoding: int32 - uplinkSpeed: - type: integer - description: 4-octet positive integer whose value is an estimate of the WAN Backhaul link's current uplink speed in kilobits per second. - contentEncoding: int32 - wanInfo: - type: integer - description: Info about WAN link status, link symmetricity and capacity currently used. - contentEncoding: int32 - WebsockNotifConfig: - title: WebsockNotifConfig - type: object - properties: - requestWebsocketUri: - type: boolean - description: Set to true by the service consumer to indicate that Websocket delivery is requested. - websocketUri: - type: string - description: Set by WAIS to indicate to the service consumer the Websocket URI to be used for delivering notifications. - WlanCapabilities: - title: WlanCapabilities - type: object - 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' - InlineNotification: - title: InlineNotification - required: - - notificationType - type: object - properties: - notificationType: - type: string - discriminator: - propertyName: notificationType - mapping: - AssocStaNotification: AssocStaNotification - MeasurementReportNotification: MeasurementReportNotification - StaDataRateNotification: StaDataRateNotification - InlineSubscription: - title: InlineSubscription - required: - - subscriptionType - type: object - properties: - subscriptionType: - type: string - discriminator: - propertyName: subscriptionType - mapping: - AssocStaSubscription: AssocStaSubscription - MeasurementReportSubscription: MeasurementReportSubscription - StaDataRateSubscription: StaDataRateSubscription - Links: - title: Links - required: - - self - type: object - properties: - self: - $ref: '#/components/schemas/LinkType' - description: Hyperlink related to the resource. This shall be only included in the HTTP responses and in HTTP PUT requests. - Links1: - title: Links1 - required: - - subscription - type: object - properties: - subscription: - $ref: '#/components/schemas/LinkType' - description: Hyperlink related to the resource. - Links4: - title: Links4 - required: - - self - type: object - properties: - self: - $ref: '#/components/schemas/LinkType' - description: Hyperlink related to the resource. - Links6: - title: Links6 - required: - - self - type: object - properties: - self: - $ref: '#/components/schemas/LinkType' - description: List of hyperlinks related to the resource. - MeasurementConfig1: - title: MeasurementConfig1 - required: - - href - - measurementId - type: object - properties: - href: - type: string - description: The URI referring to a measurement configuration. - measurementId: - type: string - description: Unique identifier allocated by the service consumer to identify measurement reports associated with this measurement configuration. - NotificationEvent: - title: NotificationEvent - required: - - threshold - - trigger - type: object - properties: - threshold: - type: integer - description: Number of connected stations threshold for trigger-based event reporting. - contentEncoding: int32 - trigger: - $ref: '#/components/schemas/Trigger' - description: Set for trigger-based event notification reporting. - NotificationEvent1: - title: NotificationEvent1 - required: - - trigger - type: object - properties: - downlinkRateThreshold: - type: integer - description: Downlink data rate threshold for StaDataRate reporting. - contentEncoding: int32 - trigger: - $ref: '#/components/schemas/Trigger1' - uplinkRateThreshold: - type: integer - description: Uplink data rate threshold for StaDataRate reporting. - contentEncoding: int32 - description: Set for trigger-based event notification reporting. - Subscription: - title: Subscription - required: - - href - - subscriptionType - type: object - properties: - href: - type: string - description: The URI referring to the subscription. - subscriptionType: - type: string - description: >- - Type of the subscription. The string shall be set according to the "subscriptionType" attribute of the associated subscription data type defined in 6.3.2, 6.3.3. and 6.3.5: - - “AssocStaSubscription” - - “StaDataRateSubscription” - - “MeasurementReportSubscription” - Trigger: - title: Trigger - enum: - - 1 - - 2 - type: integer - description: >- - Trigger for the notification: - - 1 = Notification issued when the number of connected stations is greater than or equal to the threshold. - - 2 = Notification issued when the number of connected stations is less than or equal to the threshold. - examples: - - 1 - Trigger1: - title: Trigger1 - enum: - - 1 - - 2 - - 3 - - 4 - - 5 - - 6 - - 7 - - 8 - type: integer - description: >- - Trigger event for the notification: - - 1 = Notification issued when the STA's downlink data rate is greater than or equal to the downlink threshold. - - 2 = Notification issued when the STA's downlink data rate is less than or equal to the downlink threshold. - - 3 = Notification issued when the STA's uplink data rate is greater than or equal to the uplink threshold. - - 4 = Notification issued when the STA's uplink data rate is less than or equal to the uplink threshold. - - 5 = Notification issued when the STA's downlink and uplink data rate is greater than or equal to their thresholds. - - 6 = Notification issued when the STA's downlink and uplink data rate is less than or equal to their thresholds. - - 7 = Notification issued when the STA's downlink or uplink data rate is greater than or equal to their thresholds. - - 8 = Notification issued when the STA's downlink or uplink data rate is less than or equal to their thresholds. - examples: - - 1 -security: -- {} -tags: -- name: wai -externalDocs: - description: ETSI MEC028 V2.2.1 WLAN Information API - url: https://www.etsi.org/deliver/etsi_gs/MEC/001_099/028/02.02.01_60/gs_mec028v020201p.pdf diff --git a/WlanInformationApi.yaml b/WlanInformationApi.yaml index 198018b..804e875 100644 --- a/WlanInformationApi.yaml +++ b/WlanInformationApi.yaml @@ -1,374 +1,756 @@ -openapi: 3.0.0 +openapi: 3.1.0 info: - contact: - url: 'https://forge.etsi.org/rep/mec/gs028-wai-api' title: ETSI GS MEC 028 - WLAN Access Information API - version: 2.2.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.2.1 WLAN Information API - url: >- - https://www.etsi.org/deliver/etsi_gs/MEC/001_099/028/02.02.01_60/gs_mec028v020201p.pdf + contact: + url: https://forge.etsi.org/rep/mec/gs028-wai-api + version: '2.2.1' +jsonSchemaDialect: https://json-schema.org/draft/2020-12/schema servers: - - url: 'https://localhost/wai/v2' -tags: - - name: wai +- url: https://localhost/wai/v2 + variables: {} paths: /queries/ap/ap_information: get: tags: - - wai - summary: Retrieve information on existing Access Points + - wai + summary: apInfoGET 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' + - name: filter + in: query + description: Attribute-based filtering expression according to clause 6.19 of ETSI GS MEC 009. . + style: form + explode: true + schema: + type: string + - name: all_fields + in: query + description: Include all complex attributes in the response. See clause 6.18 of ETSI GS MEC 009 for details. + style: form + explode: true + schema: + type: string + - name: fields + in: query + description: Complex attributes to be included into the response. See clause 6.18 of ETSI GS MEC 009 for details. + style: form + explode: true + schema: + type: array + items: + type: string + - 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. + style: form + explode: true + schema: + type: array + items: + type: string + - 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' + style: form + explode: true + schema: + type: array + items: + type: string responses: '200': description: Successful response to ap_info request + headers: {} content: application/json: schema: type: array items: $ref: '#/components/schemas/ApInfo' + description: '' + contentMediaType: application/json '400': - $ref: '#/components/responses/400' + description: 'Bad Request : used to indicate that incorrect parameters were passed to the request.' + headers: {} + content: + application/problem+json: + schema: + $ref: '#/components/schemas/ProblemDetails' '401': - $ref: '#/components/responses/401' + description: 'Unauthorized : used when the client did not submit credentials.' + headers: {} + content: + application/problem+json: + schema: + $ref: '#/components/schemas/ProblemDetails' '403': - $ref: '#/components/responses/403' + description: 'Forbidden : operation is not allowed given the current status of the resource.' + headers: {} + content: + application/problem+json: + schema: + $ref: '#/components/schemas/ProblemDetails' '404': - $ref: '#/components/responses/404' + description: 'Not Found : used when a client provided a URI that cannot be mapped to a valid resource URI.' + headers: {} + content: + application/problem+json: + schema: + $ref: '#/components/schemas/ProblemDetails' '406': - $ref: '#/components/responses/406' + description: 'Not Acceptable : used to indicate that the server cannot provide the any of the content formats supported by the client.' + headers: {} + content: + application/problem+json: + schema: + $ref: '#/components/schemas/ProblemDetails' '429': - $ref: '#/components/responses/429' + description: 'Too Many Requests : used when a rate limiter has triggered.' + headers: {} + content: + application/problem+json: + schema: + $ref: '#/components/schemas/ProblemDetails' + deprecated: false + parameters: [] /queries/sta/sta_information: get: tags: - - wai - summary: Retrieve information on existing Stations + - wai + summary: staInfoGET 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' + - name: filter + in: query + description: Attribute-based filtering expression according to clause 6.19 of ETSI GS MEC 009. . + style: form + explode: true + schema: + type: string + - name: all_fields + in: query + description: Include all complex attributes in the response. See clause 6.18 of ETSI GS MEC 009 for details. + style: form + explode: true + schema: + type: string + - name: fields + in: query + description: Complex attributes to be included into the response. See clause 6.18 of ETSI GS MEC 009 for details. + style: form + explode: true + schema: + type: array + items: + type: string + - 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. + style: form + explode: true + schema: + type: array + items: + type: string + - 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' + style: form + explode: true + schema: + type: array + items: + type: string responses: '200': description: Successful response to sta_info request + headers: {} content: application/json: schema: type: array items: $ref: '#/components/schemas/StaInfo' + description: '' + contentMediaType: application/json '400': - $ref: '#/components/responses/400' + description: 'Bad Request : used to indicate that incorrect parameters were passed to the request.' + headers: {} + content: + application/problem+json: + schema: + $ref: '#/components/schemas/ProblemDetails' '401': - $ref: '#/components/responses/401' + description: 'Unauthorized : used when the client did not submit credentials.' + headers: {} + content: + application/problem+json: + schema: + $ref: '#/components/schemas/ProblemDetails' '403': - $ref: '#/components/responses/403' + description: 'Forbidden : operation is not allowed given the current status of the resource.' + headers: {} + content: + application/problem+json: + schema: + $ref: '#/components/schemas/ProblemDetails' '404': - $ref: '#/components/responses/404' + description: 'Not Found : used when a client provided a URI that cannot be mapped to a valid resource URI.' + headers: {} + content: + application/problem+json: + schema: + $ref: '#/components/schemas/ProblemDetails' '406': - $ref: '#/components/responses/406' + description: 'Not Acceptable : used to indicate that the server cannot provide the any of the content formats supported by the client.' + headers: {} + content: + application/problem+json: + schema: + $ref: '#/components/schemas/ProblemDetails' '429': - $ref: '#/components/responses/429' + description: 'Too Many Requests : used when a rate limiter has triggered.' + headers: {} + content: + application/problem+json: + schema: + $ref: '#/components/schemas/ProblemDetails' + deprecated: false + parameters: [] /subscriptions: get: tags: - - wai - summary: Retrieve information on subscriptions for notifications + - wai + summary: subscriptionLinkList_subscriptionsGET description: Queries information on subscriptions for notifications operationId: subscriptionLinkList_subscriptionsGET parameters: - - $ref: '#/components/parameters/Query.SubscriptionType' + - name: subscription_type + in: query + description: 'Filter on a specific subscription type. Permitted values: assoc_sta, sta_data_rate, measure_report.' + style: form + explode: true + schema: + type: string responses: '200': - description: >- - Response body contains the list of links to requestors - subscriptions. + description: Response body contains the list of links to requestors subscriptions. + headers: {} 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' + description: 'Bad Request : used to indicate that incorrect parameters were passed to the request.' + headers: {} + content: + application/problem+json: + schema: + $ref: '#/components/schemas/ProblemDetails' '401': - $ref: '#/components/responses/401' + description: 'Unauthorized : used when the client did not submit credentials.' + headers: {} + content: + application/problem+json: + schema: + $ref: '#/components/schemas/ProblemDetails' '403': - $ref: '#/components/responses/403' + description: 'Forbidden : operation is not allowed given the current status of the resource.' + headers: {} + content: + application/problem+json: + schema: + $ref: '#/components/schemas/ProblemDetails' '404': - $ref: '#/components/responses/404' + description: 'Not Found : used when a client provided a URI that cannot be mapped to a valid resource URI.' + headers: {} + content: + application/problem+json: + schema: + $ref: '#/components/schemas/ProblemDetails' '406': - $ref: '#/components/responses/406' + description: 'Not Acceptable : used to indicate that the server cannot provide the any of the content formats supported by the client.' + headers: {} + content: + application/problem+json: + schema: + $ref: '#/components/schemas/ProblemDetails' '429': - $ref: '#/components/responses/429' + description: 'Too Many Requests : used when a rate limiter has triggered.' + headers: {} + content: + application/problem+json: + schema: + $ref: '#/components/schemas/ProblemDetails' + deprecated: false post: tags: - - wai - summary: Create a new subscription + - wai + summary: subscriptionsPOST description: Creates a new subscription to WLAN Access Information notifications operationId: subscriptionsPOST + parameters: [] requestBody: description: Subscription to be created - required: true content: application/json: schema: - $ref: '#/components/schemas/InlineSubscription' + oneOf: + - $ref: '#/components/schemas/AssocStaSubscription' + - $ref: '#/components/schemas/StaDataRateSubscription' + - $ref: '#/components/schemas/MeasurementReportSubscription' + description: Subscription to be created + examples: + - subscriptionType: AssocStaSubscription + callbackReference: http://meAppClient.example.com/wai/v2/notifications/1 + expiryDeadline: + seconds: 1977836800 + nanoSeconds: 0 + apId: + bssid: 005C0A0A0A0A + ssid: + - myNetworkSsid + ipAddress: + - 10.10.100.1 + contentMediaType: application/json example: subscriptionType: AssocStaSubscription - callbackReference: 'http://meAppClient.example.com/wai/v2/notifications/1' + callbackReference: http://meAppClient.example.com/wai/v2/notifications/1 expiryDeadline: seconds: 1977836800 nanoSeconds: 0 apId: bssid: 005C0A0A0A0A ssid: - - myNetworkSsid + - myNetworkSsid ipAddress: - - 10.10.100.1 + - 10.10.100.1 + required: true responses: '201': description: Successful subscription response + headers: {} content: application/json: schema: - $ref: '#/components/schemas/InlineSubscription' + oneOf: + - $ref: '#/components/schemas/AssocStaSubscription' + - $ref: '#/components/schemas/StaDataRateSubscription' + - $ref: '#/components/schemas/MeasurementReportSubscription' + examples: + - 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: + bssid: 005C0A0A0A0A + ssid: + - myNetworkSsid + ipAddress: + - 10.10.100.1 + contentMediaType: application/json example: subscriptionType: AssocStaSubscription - callbackReference: 'http://meAppClient.example.com/wai/v2/notifications/1' + callbackReference: http://meAppClient.example.com/wai/v2/notifications/1 _links: self: - href: 'http://meAppServer.example.com/wai/v2/subscriptions/sub123' + href: http://meAppServer.example.com/wai/v2/subscriptions/sub123 expiryDeadline: seconds: 1977836800 nanoSeconds: 0 apId: bssid: 005C0A0A0A0A ssid: - - myNetworkSsid + - myNetworkSsid ipAddress: - - 10.10.100.1 + - 10.10.100.1 '400': - $ref: '#/components/responses/400' + description: 'Bad Request : used to indicate that incorrect parameters were passed to the request.' + headers: {} + content: + application/problem+json: + schema: + $ref: '#/components/schemas/ProblemDetails' '401': - $ref: '#/components/responses/401' + description: 'Unauthorized : used when the client did not submit credentials.' + headers: {} + content: + application/problem+json: + schema: + $ref: '#/components/schemas/ProblemDetails' '403': - $ref: '#/components/responses/403' + description: 'Forbidden : operation is not allowed given the current status of the resource.' + headers: {} + content: + application/problem+json: + schema: + $ref: '#/components/schemas/ProblemDetails' '404': - $ref: '#/components/responses/404' + description: 'Not Found : used when a client provided a URI that cannot be mapped to a valid resource URI.' + headers: {} + content: + application/problem+json: + schema: + $ref: '#/components/schemas/ProblemDetails' '406': - $ref: '#/components/responses/406' + description: 'Not Acceptable : used to indicate that the server cannot provide the any of the content formats supported by the client.' + headers: {} + content: + application/problem+json: + schema: + $ref: '#/components/schemas/ProblemDetails' '415': - $ref: '#/components/responses/415' + description: 'Unsupported Media Type : used to indicate that the server or the client does not support the content type of the entity body.' + headers: {} + content: + application/problem+json: + schema: + $ref: '#/components/schemas/ProblemDetails' '422': - $ref: '#/components/responses/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.' + headers: {} + 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': - $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: - bssid: 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}': + description: 'Too Many Requests : used when a rate limiter has triggered.' + headers: {} + content: + application/problem+json: + schema: + $ref: '#/components/schemas/ProblemDetails' + deprecated: false + parameters: [] + /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) + - wai + summary: subscriptionsGET + 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' + - name: subscriptionId + in: path + description: Subscription Id, specifically the "self" returned in the subscription request + required: true + style: simple + schema: + type: string responses: '200': description: Subscription information regarding subscription notifications + headers: {} content: application/json: schema: - $ref: '#/components/schemas/InlineSubscription' + oneOf: + - $ref: '#/components/schemas/AssocStaSubscription' + - $ref: '#/components/schemas/StaDataRateSubscription' + - $ref: '#/components/schemas/MeasurementReportSubscription' + examples: + - 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: + bssid: 005C0A0A0A0A + ssid: + - myNetworkSsid + ipAddress: + - 10.10.100.1 + contentMediaType: application/json example: subscriptionType: AssocStaSubscription - callbackReference: 'http://meAppClient.example.com/wai/v2/notifications/1' + callbackReference: http://meAppClient.example.com/wai/v2/notifications/1 _links: self: - href: 'http://meAppServer.example.com/wai/v2/subscriptions/sub123' + href: http://meAppServer.example.com/wai/v2/subscriptions/sub123 expiryDeadline: seconds: 1977836800 nanoSeconds: 0 apId: bssid: 005C0A0A0A0A ssid: - - myNetworkSsid + - myNetworkSsid ipAddress: - - 10.10.100.1 + - 10.10.100.1 '400': - $ref: '#/components/responses/400' + description: 'Bad Request : used to indicate that incorrect parameters were passed to the request.' + headers: {} + content: + application/problem+json: + schema: + $ref: '#/components/schemas/ProblemDetails' '401': - $ref: '#/components/responses/401' + description: 'Unauthorized : used when the client did not submit credentials.' + headers: {} + content: + application/problem+json: + schema: + $ref: '#/components/schemas/ProblemDetails' '403': - $ref: '#/components/responses/403' + description: 'Forbidden : operation is not allowed given the current status of the resource.' + headers: {} + content: + application/problem+json: + schema: + $ref: '#/components/schemas/ProblemDetails' '404': - $ref: '#/components/responses/404' + description: 'Not Found : used when a client provided a URI that cannot be mapped to a valid resource URI.' + headers: {} + content: + application/problem+json: + schema: + $ref: '#/components/schemas/ProblemDetails' '406': - $ref: '#/components/responses/406' + description: 'Not Acceptable : used to indicate that the server cannot provide the any of the content formats supported by the client.' + headers: {} + content: + application/problem+json: + schema: + $ref: '#/components/schemas/ProblemDetails' '429': - $ref: '#/components/responses/429' + description: 'Too Many Requests : used when a rate limiter has triggered.' + headers: {} + content: + application/problem+json: + schema: + $ref: '#/components/schemas/ProblemDetails' + deprecated: false put: tags: - - wai - summary: Modify an existing subscription - description: >- - Updates an existing subscription, identified by its self-referring URI - returned on creation (initial POST) + - wai + summary: subscriptionsPUT + description: Updates an existing subscription, identified by its self-referring URI returned on creation (initial POST) operationId: subscriptionsPUT + parameters: + - name: subscriptionId + in: path + description: Subscription Id, specifically the "self" returned in the subscription request + required: true + style: simple + schema: + type: string requestBody: description: Subscription to be modified - required: true content: application/json: schema: - $ref: '#/components/schemas/InlineSubscription' + oneOf: + - $ref: '#/components/schemas/AssocStaSubscription' + - $ref: '#/components/schemas/StaDataRateSubscription' + - $ref: '#/components/schemas/MeasurementReportSubscription' + description: Subscription to be modified + examples: + - 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: + bssid: 005C0A0A0A0A + ssid: + - myNetworkSsid + ipAddress: + - 10.10.100.1 + contentMediaType: application/json example: subscriptionType: AssocStaSubscription - callbackReference: 'http://meAppClient.example.com/wai/v2/notifications/1' + callbackReference: http://meAppClient.example.com/wai/v2/notifications/1 _links: self: - href: 'http://meAppServer.example.com/wai/v2/subscriptions/sub123' + href: http://meAppServer.example.com/wai/v2/subscriptions/sub123 expiryDeadline: seconds: 1977836800 nanoSeconds: 0 apId: bssid: 005C0A0A0A0A ssid: - - myNetworkSsid + - myNetworkSsid ipAddress: - - 10.10.100.1 - parameters: - - $ref: '#/components/parameters/Path.subscrId' + - 10.10.100.1 + required: true responses: '200': description: Successful subscription modification + headers: {} content: application/json: schema: - $ref: '#/components/schemas/InlineSubscription' + oneOf: + - $ref: '#/components/schemas/AssocStaSubscription' + - $ref: '#/components/schemas/StaDataRateSubscription' + - $ref: '#/components/schemas/MeasurementReportSubscription' + examples: + - _links: + self: + href: http://[hostIP]/sbox-xyz123/wai/v2/subscriptions/sub123 + callbackReference: http://my.callback.com/wai/some-id + apId: + bssid: 005C0A0A0A0A + ssid: + - myNetworkSsid + ipAddress: + - 10.10.100.1 + contentMediaType: application/json example: _links: self: - href: 'http://[hostIP]/sbox-xyz123/wai/v2/subscriptions/sub123' - callbackReference: 'http://my.callback.com/wai/some-id' + href: http://[hostIP]/sbox-xyz123/wai/v2/subscriptions/sub123 + callbackReference: http://my.callback.com/wai/some-id apId: bssid: 005C0A0A0A0A ssid: - - myNetworkSsid + - myNetworkSsid ipAddress: - - 10.10.100.1 + - 10.10.100.1 '400': - $ref: '#/components/responses/400' + description: 'Bad Request : used to indicate that incorrect parameters were passed to the request.' + headers: {} + content: + application/problem+json: + schema: + $ref: '#/components/schemas/ProblemDetails' '401': - $ref: '#/components/responses/401' + description: 'Unauthorized : used when the client did not submit credentials.' + headers: {} + content: + application/problem+json: + schema: + $ref: '#/components/schemas/ProblemDetails' '403': - $ref: '#/components/responses/403' + description: 'Forbidden : operation is not allowed given the current status of the resource.' + headers: {} + content: + application/problem+json: + schema: + $ref: '#/components/schemas/ProblemDetails' '404': - $ref: '#/components/responses/404' + description: 'Not Found : used when a client provided a URI that cannot be mapped to a valid resource URI.' + headers: {} + content: + application/problem+json: + schema: + $ref: '#/components/schemas/ProblemDetails' '406': - $ref: '#/components/responses/406' + description: 'Not Acceptable : used to indicate that the server cannot provide the any of the content formats supported by the client.' + headers: {} + content: + application/problem+json: + schema: + $ref: '#/components/schemas/ProblemDetails' '412': - $ref: '#/components/responses/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' + headers: {} + content: + application/problem+json: + schema: + $ref: '#/components/schemas/ProblemDetails' '422': - $ref: '#/components/responses/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.' + headers: {} + 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': - $ref: '#/components/responses/429' + description: 'Too Many Requests : used when a rate limiter has triggered.' + headers: {} + content: + application/problem+json: + schema: + $ref: '#/components/schemas/ProblemDetails' + deprecated: false delete: tags: - - wai - summary: Cancel an existing subscription - description: >- - Cancels an existing subscription, identified by its self-referring URI - returned on creation (initial POST) + - wai + summary: subscriptionsDELETE + description: Cancels an existing subscription, identified by its self-referring URI returned on creation (initial POST) operationId: subscriptionsDELETE parameters: - - $ref: '#/components/parameters/Path.subscrId' + - name: subscriptionId + in: path + description: Subscription Id, specifically the "self" returned in the subscription request + required: true + style: simple + schema: + type: string responses: '204': - $ref: '#/components/responses/204' + description: No Content + headers: {} + content: {} '401': - $ref: '#/components/responses/401' + description: 'Unauthorized : used when the client did not submit credentials.' + headers: {} + content: + application/problem+json: + schema: + $ref: '#/components/schemas/ProblemDetails' '403': - $ref: '#/components/responses/403' + description: 'Forbidden : operation is not allowed given the current status of the resource.' + headers: {} + content: + application/problem+json: + schema: + $ref: '#/components/schemas/ProblemDetails' '404': - $ref: '#/components/responses/404' + description: 'Not Found : used when a client provided a URI that cannot be mapped to a valid resource URI.' + headers: {} + content: + application/problem+json: + schema: + $ref: '#/components/schemas/ProblemDetails' '429': - $ref: '#/components/responses/429' + description: 'Too Many Requests : used when a rate limiter has triggered.' + headers: {} + content: + application/problem+json: + schema: + $ref: '#/components/schemas/ProblemDetails' + deprecated: false + parameters: [] /measurements: get: tags: - - wai - summary: Retrieve information on measurements configuration + - wai + summary: measurementLinkList_measurementsGET description: Queries information on measurements configuration operationId: measurementLinkList_measurementsGET + parameters: [] responses: '200': - description: >- - Response body contains the list of links to requestors measurement - configurations. + description: Response body contains the list of links to requestors measurement configurations. + headers: {} content: application/json: schema: @@ -376,446 +758,400 @@ paths: example: _links: self: - href: 'http://meAppServer.example.com/wai/v2/measurements' + href: http://meAppServer.example.com/wai/v2/measurements measurementConfig: - - href: 'http://meAppServer.example.com/wai/v2/measurements/meas123' - measurementId: myId1 + - href: http://meAppServer.example.com/wai/v2/measurements/meas123 + measurementId: myId1 '400': - $ref: '#/components/responses/400' + description: 'Bad Request : used to indicate that incorrect parameters were passed to the request.' + headers: {} + content: + application/problem+json: + schema: + $ref: '#/components/schemas/ProblemDetails' '401': - $ref: '#/components/responses/401' + description: 'Unauthorized : used when the client did not submit credentials.' + headers: {} + content: + application/problem+json: + schema: + $ref: '#/components/schemas/ProblemDetails' '403': - $ref: '#/components/responses/403' + description: 'Forbidden : operation is not allowed given the current status of the resource.' + headers: {} + content: + application/problem+json: + schema: + $ref: '#/components/schemas/ProblemDetails' '404': - $ref: '#/components/responses/404' + description: 'Not Found : used when a client provided a URI that cannot be mapped to a valid resource URI.' + headers: {} + content: + application/problem+json: + schema: + $ref: '#/components/schemas/ProblemDetails' '406': - $ref: '#/components/responses/406' + description: 'Not Acceptable : used to indicate that the server cannot provide the any of the content formats supported by the client.' + headers: {} + content: + application/problem+json: + schema: + $ref: '#/components/schemas/ProblemDetails' '429': - $ref: '#/components/responses/429' + description: 'Too Many Requests : used when a rate limiter has triggered.' + headers: {} + content: + application/problem+json: + schema: + $ref: '#/components/schemas/ProblemDetails' + deprecated: false post: tags: - - wai - summary: Create a new measurement configuration + - wai + summary: measurementsPOST description: Creates a new measurement configuration operationId: measurementsPOST + parameters: [] requestBody: description: Measurement configuration information - required: true content: application/json: schema: $ref: '#/components/schemas/MeasurementConfig' - example: - staId: - macId: 005C01111111 - ssid: - - myNetworkSsid - - myOtherNetworkSsid - measurementId: myId1 - measurementInfo: {} + required: true responses: '201': description: Successful measurement configuration response + headers: {} content: application/json: schema: $ref: '#/components/schemas/MeasurementConfig' - example: - _links: - self: - href: 'http://meAppServer.example.com/wai/v2/measurements/meas123' - staId: - macId: 005C01111111 - ssid: - - myNetworkSsid - - myOtherNetworkSsid - measurementId: myId1 - measurementInfo: {} '400': - $ref: '#/components/responses/400' + description: 'Bad Request : used to indicate that incorrect parameters were passed to the request.' + headers: {} + content: + application/problem+json: + schema: + $ref: '#/components/schemas/ProblemDetails' '401': - $ref: '#/components/responses/401' + description: 'Unauthorized : used when the client did not submit credentials.' + headers: {} + content: + application/problem+json: + schema: + $ref: '#/components/schemas/ProblemDetails' '403': - $ref: '#/components/responses/403' - '404': - $ref: '#/components/responses/404' - '406': - $ref: '#/components/responses/406' + description: 'Forbidden : operation is not allowed given the current status of the resource.' + headers: {} + 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.' + headers: {} + 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.' + headers: {} + content: + application/problem+json: + schema: + $ref: '#/components/schemas/ProblemDetails' '415': - $ref: '#/components/responses/415' + description: 'Unsupported Media Type : used to indicate that the server or the client does not support the content type of the entity body.' + headers: {} + content: + application/problem+json: + schema: + $ref: '#/components/schemas/ProblemDetails' '422': - $ref: '#/components/responses/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.' + headers: {} + 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': - $ref: '#/components/responses/429' - '/measurements/{measurementConfigId}': + description: 'Too Many Requests : used when a rate limiter has triggered.' + headers: {} + content: + application/problem+json: + schema: + $ref: '#/components/schemas/ProblemDetails' + deprecated: false + parameters: [] + /measurements/{measurementConfigId}: get: tags: - - wai - summary: Retrieve information on an existing measurement configuration - description: >- - Queries information about an existing measurement configuration, - identified by its self-referring URI returned on creation (initial POST) + - wai + summary: measurementsGET + description: Queries information about an existing measurement configuration, identified by its self-referring URI returned on creation (initial POST) operationId: measurementsGET parameters: - - $ref: '#/components/parameters/Path.measurementConfigId' + - name: measurementConfigId + in: path + description: Measurement configuration Id, specifically the "self" returned in the measurement configuration request + required: true + style: simple + schema: + type: string responses: '200': description: Measurement configuration information + headers: {} content: application/json: schema: $ref: '#/components/schemas/MeasurementConfig' - example: - _links: - self: - href: 'http://meAppServer.example.com/wai/v2/measurements/meas123' - staId: - macId: 005C01111111 - ssid: - - myNetworkSsid - - myOtherNetworkSsid - measurementId: myId1 - measurementInfo: {} '400': - $ref: '#/components/responses/400' + description: 'Bad Request : used to indicate that incorrect parameters were passed to the request.' + headers: {} + content: + application/problem+json: + schema: + $ref: '#/components/schemas/ProblemDetails' '401': - $ref: '#/components/responses/401' + description: 'Unauthorized : used when the client did not submit credentials.' + headers: {} + content: + application/problem+json: + schema: + $ref: '#/components/schemas/ProblemDetails' '403': - $ref: '#/components/responses/403' + description: 'Forbidden : operation is not allowed given the current status of the resource.' + headers: {} + content: + application/problem+json: + schema: + $ref: '#/components/schemas/ProblemDetails' '404': - $ref: '#/components/responses/404' + description: 'Not Found : used when a client provided a URI that cannot be mapped to a valid resource URI.' + headers: {} + content: + application/problem+json: + schema: + $ref: '#/components/schemas/ProblemDetails' '406': - $ref: '#/components/responses/406' + description: 'Not Acceptable : used to indicate that the server cannot provide the any of the content formats supported by the client.' + headers: {} + content: + application/problem+json: + schema: + $ref: '#/components/schemas/ProblemDetails' '429': - $ref: '#/components/responses/429' + description: 'Too Many Requests : used when a rate limiter has triggered.' + headers: {} + content: + application/problem+json: + schema: + $ref: '#/components/schemas/ProblemDetails' + deprecated: false put: tags: - - wai - summary: Modify an existing measurement configuration - description: >- - Updates an existing measurement configuration, identified by its - self-referring URI returned on creation (initial POST) + - wai + summary: measurementsPUT + description: Updates an existing measurement configuration, identified by its self-referring URI returned on creation (initial POST) operationId: measurementsPUT + parameters: + - name: measurementConfigId + in: path + description: Measurement configuration Id, specifically the "self" returned in the measurement configuration request + required: true + style: simple + schema: + type: string requestBody: description: Measurement configuration to be modified - required: true content: application/json: schema: $ref: '#/components/schemas/MeasurementConfig' - example: - _links: - self: - href: 'http://meAppServer.example.com/wai/v2/measurements/meas123' - staId: - macId: 005C01111111 - ssid: - - myNetworkSsid - - myOtherNetworkSsid - measurementId: myId1 - measurementInfo: {} - parameters: - - $ref: '#/components/parameters/Path.measurementConfigId' + required: true responses: '200': description: Successful measurement configuration modification + headers: {} content: application/json: schema: $ref: '#/components/schemas/MeasurementConfig' - example: - _links: - self: - href: 'http://meAppServer.example.com/wai/v2/measurements/123' - staId: - macId: 005C01111111 - ssid: - - myNetworkSsid - - myOtherNetworkSsid - measurementId: myId1 - measurementInfo: {} '400': - $ref: '#/components/responses/400' + description: 'Bad Request : used to indicate that incorrect parameters were passed to the request.' + headers: {} + content: + application/problem+json: + schema: + $ref: '#/components/schemas/ProblemDetails' '401': - $ref: '#/components/responses/401' + description: 'Unauthorized : used when the client did not submit credentials.' + headers: {} + content: + application/problem+json: + schema: + $ref: '#/components/schemas/ProblemDetails' '403': - $ref: '#/components/responses/403' + description: 'Forbidden : operation is not allowed given the current status of the resource.' + headers: {} + content: + application/problem+json: + schema: + $ref: '#/components/schemas/ProblemDetails' '404': - $ref: '#/components/responses/404' + description: 'Not Found : used when a client provided a URI that cannot be mapped to a valid resource URI.' + headers: {} + content: + application/problem+json: + schema: + $ref: '#/components/schemas/ProblemDetails' '406': - $ref: '#/components/responses/406' + description: 'Not Acceptable : used to indicate that the server cannot provide the any of the content formats supported by the client.' + headers: {} + content: + application/problem+json: + schema: + $ref: '#/components/schemas/ProblemDetails' '412': - $ref: '#/components/responses/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' + headers: {} + content: + application/problem+json: + schema: + $ref: '#/components/schemas/ProblemDetails' '422': - $ref: '#/components/responses/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.' + headers: {} + 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': - $ref: '#/components/responses/429' + description: 'Too Many Requests : used when a rate limiter has triggered.' + headers: {} + content: + application/problem+json: + schema: + $ref: '#/components/schemas/ProblemDetails' + deprecated: false delete: tags: - - wai - summary: Cancel a measurement configuration - description: >- - Cancels an existing measurement configuration, identified by its - self-referring URI returned on creation (initial POST) + - wai + summary: measurementsDELETE + description: Cancels an existing measurement configuration, identified by its self-referring URI returned on creation (initial POST) operationId: measurementsDELETE parameters: - - $ref: '#/components/parameters/Path.measurementConfigId' + - name: measurementConfigId + in: path + description: Measurement configuration Id, specifically the "self" returned in the measurement configuration request + required: true + style: simple + schema: + type: string responses: '204': - $ref: '#/components/responses/204' + description: No Content + headers: {} + content: {} '401': - $ref: '#/components/responses/401' + description: 'Unauthorized : used when the client did not submit credentials.' + headers: {} + content: + application/problem+json: + schema: + $ref: '#/components/schemas/ProblemDetails' '403': - $ref: '#/components/responses/403' + description: 'Forbidden : operation is not allowed given the current status of the resource.' + headers: {} + content: + application/problem+json: + schema: + $ref: '#/components/schemas/ProblemDetails' '404': - $ref: '#/components/responses/404' + description: 'Not Found : used when a client provided a URI that cannot be mapped to a valid resource URI.' + headers: {} + content: + application/problem+json: + schema: + $ref: '#/components/schemas/ProblemDetails' '429': - $ref: '#/components/responses/429' + description: 'Too Many Requests : used when a rate limiter has triggered.' + headers: {} + content: + application/problem+json: + schema: + $ref: '#/components/schemas/ProblemDetails' + deprecated: false + parameters: [] 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 - Path.measurementConfigId: - name: measurementConfigId - in: path - description: >- - Measurement configuration Id, specifically the "self" returned in the - measurement configuration 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, measure_report. - required: false - schema: - type: string schemas: ApAssociated: + title: ApAssociated + required: + - bssid + type: object 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 + description: Unique number which identifies a particular association between the station and Access Point. bssid: - description: >- - Basic Service Set Identifier (BSSID) is a unique identifier assigned - to the Access Point (as network interface controller) for - communications at the data link layer of a network segment. BSSID is - typically set to an access point's MAC address. type: string - x-etsi-mec-cardinality: '1' - x-etsi-mec-origin-type: String + description: Basic Service Set Identifier (BSSID) is a unique identifier assigned to the Access Point (as network interface controller) for communications at the data link layer of a network segment. BSSID is typically set to an access point's MAC address. 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 - ssid: - description: Service Set Identifier to identify logical networks. items: type: string + description: IPv4 or IPv6 address allocated for the Access Point. + ssid: minItems: 0 type: array - x-etsi-mec-cardinality: 0..N - x-etsi-mec-origin-type: String + items: + type: string + description: Service Set Identifier to identify logical networks. + ApIdentity: + title: ApIdentity required: - - bssid + - bssid type: object - x-etsi-ref: 6.5.12 - ApIdentity: properties: bssid: - description: >- - Basic Service Set Identifier (BSSID) is a unique Identifier assigned - to an Access Point (as network interface controller) for - communications at the data link layer of a network segment. BSSID is - typically set to an access point's MAC address. type: string - x-etsi-mec-cardinality: '1' - x-etsi-mec-origin-type: String + description: Basic Service Set Identifier (BSSID) is a unique Identifier assigned to an Access Point (as network interface controller) for communications at the data link layer of a network segment. BSSID is typically set to an access point's MAC address. 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 - ssid: - description: >- - Service Set Identifier (SSID) to identify logical WLAN networks - available via the Access Point. items: type: string + description: IPv4 or IPv6 address allocated for the Access Point. + ssid: minItems: 0 type: array - x-etsi-mec-cardinality: 0..N - x-etsi-mec-origin-type: String + items: + type: string + description: Service Set Identifier (SSID) to identify logical WLAN networks available via the Access Point. + ApInfo: + title: ApInfo required: - - bssid + - apId type: object - x-etsi-ref: 6.5.3 - ApInfo: properties: apId: $ref: '#/components/schemas/ApIdentity' @@ -824,11 +1160,9 @@ components: 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 + description: Channel configured for the Access Point. + contentEncoding: int32 extBssLoad: $ref: '#/components/schemas/ExtBssLoad' oBssLoad: @@ -839,207 +1173,120 @@ components: $ref: '#/components/schemas/WanMetrics' wlanCap: $ref: '#/components/schemas/WlanCapabilities' - required: - - apId - type: object - x-etsi-ref: 6.2.2 ApLocation: + title: ApLocation + type: object 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 + title: AssocStaNotification + allOf: + - $ref: '#/components/schemas/InlineNotification' + - required: - apId - type: object - x-etsi-ref: 6.4.2 + type: object + properties: + apId: + $ref: '#/components/schemas/ApIdentity' + staId: + minItems: 0 + type: array + items: + $ref: '#/components/schemas/StaIdentity' + description: Identifier(s) to uniquely specify the client station(s) associated. + timeStamp: + $ref: '#/components/schemas/TimeStamp' 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: - type: string - expiryDeadline: - $ref: '#/components/schemas/TimeStamp' - notificationEvent: - description: 'Set for trigger-based event notification reporting. ' - properties: - threshold: - description: >- - Number of connected stations threshold for trigger-based event - reporting. - format: uint8 - type: integer - x-etsi-mec-cardinality: '1' - x-etsi-mec-origin-type: Uint8 - trigger: - description: >- - Trigger for the notification: - - 1 = Notification issued when the number of connected stations is - greater than or equal to the threshold. + title: AssocStaSubscription + allOf: + - $ref: '#/components/schemas/InlineSubscription' + - required: + - apId + type: object + properties: + _links: + $ref: '#/components/schemas/Links' + apId: + $ref: '#/components/schemas/ApIdentity' + callbackReference: + type: string + expiryDeadline: + $ref: '#/components/schemas/TimeStamp' + notificationEvent: + $ref: '#/components/schemas/NotificationEvent' + notificationPeriod: + type: integer + description: >- + Set for periodic notification reporting. - 2 = Notification issued when the number of connected stations is - less than or equal to the threshold. - enum: - - 1 - - 2 - type: integer - x-etsi-mec-cardinality: '1' - x-etsi-mec-origin-type: Enum (inline) - required: - - trigger - - threshold - type: object - x-etsi-mec-cardinality: 0..1 - x-etsi-mec-origin-type: Structure (inline) - notificationPeriod: - description: |- - Set for periodic notification reporting. - Value indicates the notification period in seconds. - format: uint8 - type: integer - x-etsi-mec-cardinality: 0..1 - x-etsi-mec-origin-type: Uint8 - requestTestNotification: - description: >- - Set to TRUE by the service consumer to request a test notification - on the callbackReference URI to determine if it is reachable by the - WAIS for notifications. - type: boolean - x-etsi-mec-cardinality: 0..1 - x-etsi-mec-origin-type: Boolean - subscriptionType: - description: Shall be set to "AssocStaSubscription". - type: string - x-etsi-mec-cardinality: '1' - x-etsi-mec-origin-type: String - websockNotifConfig: - $ref: '#/components/schemas/WebsockNotifConfig' + Value indicates the notification period in seconds. + contentEncoding: int32 + requestTestNotification: + type: boolean + description: Set to TRUE by the service consumer to request a test notification on the callbackReference URI to determine if it is reachable by the WAIS for notifications. + websockNotifConfig: + $ref: '#/components/schemas/WebsockNotifConfig' + BeaconReport: + title: BeaconReport required: - - subscriptionType - - apId + - bssid + - channel + - measurementId + - operatingClass + - reportedFrameInfo type: object - x-etsi-notes: "NOTE 1:\tAt least one of callbackReference and websockNotifConfig shall be provided by the service consumer. If both are provided, it is up to WAIS to select the method to be used for notifications and to return only that method in the response.\nNOTE 2:\tAssocStaSubscription shall include either notificationPeriod or notificationEvent.\nNOTE 3:\tIf both notificationPeriod and notificationEvent attributes are set, notifications are issued periodically when the trigger threshold is satisfied." - x-etsi-ref: 6.3.2 - BeaconReport: properties: antennaId: - description: "The Antenna ID field contains the identifying number for the antenna(s) used for this measurement. Antenna ID is defined in section\_9.4.2.40 of IEEE 802.11-2016 [8]." - format: uint8 type: integer - x-etsi-mec-cardinality: 0..1 - x-etsi-mec-origin-type: Uint8 + description: The Antenna ID field contains the identifying number for the antenna(s) used for this measurement. Antenna ID is defined in section 9.4.2.40 of IEEE 802.11-2016 [8]. + contentEncoding: int32 bssid: - description: >- - Indicates the BSSID of the BSS for which a beacon report has been - received. type: string - x-etsi-mec-cardinality: '1' - x-etsi-mec-origin-type: String + description: Indicates the BSSID of the BSS for which a beacon report has been received. channel: - description: Channel number where the beacon was received. - format: uint8 type: integer - x-etsi-mec-cardinality: '1' - x-etsi-mec-origin-type: Uint8 + description: Channel number where the beacon was received. + contentEncoding: int32 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 + description: Measurement ID of the Measurement configuration applied to this Beacon Report. operatingClass: - description: >- - Operating Class field indicates an operating class value as defined - in Annex E within IEEE 802.11-2016 [8]. - format: uint8 type: integer - x-etsi-mec-cardinality: '1' - x-etsi-mec-origin-type: Uint8 + description: Operating Class field indicates an operating class value as defined in Annex E within IEEE 802.11-2016 [8]. + contentEncoding: int32 parentTsf: - description: >- - The Parent TSF field contains the lower 4 octets of the measuring - STA's TSF timer value at the start of reception of the first octet - of the timestamp field of the reported Beacon, Measurement Pilot, or - Probe Response frame at the time the Beacon, Measurement Pilot, or - Probe Response frame being reported was received. - format: uint32 - type: integer - x-etsi-mec-cardinality: 0..1 - x-etsi-mec-origin-type: Uint32 + type: integer + description: The Parent TSF field contains the lower 4 octets of the measuring STA's TSF timer value at the start of reception of the first octet of the timestamp field of the reported Beacon, Measurement Pilot, or Probe Response frame at the time the Beacon, Measurement Pilot, or Probe Response frame being reported was received. + contentEncoding: int32 rcpi: - description: "RCPI indicates the received channel power of the Beacon, Measurement Pilot, or Probe Response frame, which is a logarithmic function of the received signal power, as defined in section\_9.4.2.38 of IEEE 802.11-2016 [8]." - format: uint8 type: integer - x-etsi-mec-cardinality: 0..1 - x-etsi-mec-origin-type: Uint8 + description: RCPI indicates the received channel power of the Beacon, Measurement Pilot, or Probe Response frame, which is a logarithmic function of the received signal power, as defined in section 9.4.2.38 of IEEE 802.11-2016 [8]. + contentEncoding: int32 reportedFrameInfo: $ref: '#/components/schemas/ReportedBeaconFrameInfo' rsni: - description: "RSNI indicates the received signal-to-noise indication for the Beacon, Measurement Pilot, or Probe Response frame, as described in section\_9.4.2.41 of IEEE 802.11-2016 [8]." - format: uint8 type: integer - x-etsi-mec-cardinality: 0..1 - x-etsi-mec-origin-type: Uint8 + description: RSNI indicates the received signal-to-noise indication for the Beacon, Measurement Pilot, or Probe Response frame, as described in section 9.4.2.41 of IEEE 802.11-2016 [8]. + contentEncoding: int32 ssid: - description: >- - The SSID subelement indicates the ESS or IBSS for which a beacon - report is received. type: string - x-etsi-mec-cardinality: 0..1 - x-etsi-mec-origin-type: String + description: The SSID subelement indicates the ESS or IBSS for which a beacon report is received. staId: $ref: '#/components/schemas/StaIdentity' + BeaconReportingConfig: + title: BeaconReportingConfig required: - - measurementId - - operatingClass - - channel - - reportedFrameInfo - - bssid + - reportingCondition + - threshold type: object - x-etsi-ref: 6.5.27 - BeaconReportingConfig: properties: reportingCondition: + type: integer description: >- - Reporting condition for the Beacon Report as per Table 9-89 of IEEE - 802.11-2016 [8]: + Reporting condition for the Beacon Report as per Table 9-89 of IEEE 802.11-2016 [8]: 0 = Report to be issued after each measurement. @@ -1051,164 +1298,131 @@ components: 4 = measured RSNI level is less than the threshold. - 5 = measured RCPI level is greater than a threshold defined by an - offset from the serving AP's reference RCPI. + 5 = measured RCPI level is greater than a threshold defined by an offset from the serving AP's reference RCPI. - 6 = measured RCPI level is less than a threshold defined by an - offset from the serving AP's reference RCPI. + 6 = measured RCPI level is less than a threshold defined by an offset from the serving AP's reference RCPI. - 7 = measured RSNI level is greater than a threshold defined by an - offset from the serving AP's reference RSNI. + 7 = measured RSNI level is greater than a threshold defined by an offset from the serving AP's reference RSNI. - 8 = measured RSNI level is less than a threshold defined by an - offset from the serving AP's reference RSNI. + 8 = measured RSNI level is less than a threshold defined by an offset from the serving AP's reference RSNI. - 9 = measured RCPI level is in a range bound by the serving AP's - reference RCPI and an offset from the serving AP's reference RCPI. + 9 = measured RCPI level is in a range bound by the serving AP's reference RCPI and an offset from the serving AP's reference RCPI. - 10 = measured RSNI level is in a range bound by the serving AP's - reference RSNI and an offset from the serving AP's reference RSNI. - format: uint8 - type: integer - x-etsi-mec-cardinality: '1' - x-etsi-mec-origin-type: Uint8 + 10 = measured RSNI level is in a range bound by the serving AP's reference RSNI and an offset from the serving AP's reference RSNI. + contentEncoding: int32 threshold: - description: "The threshold subfield contains either the threshold value or the offset value to be used for conditional reporting.\n\nFor reportingCondition subfield with values 1 and 2, the threshold value is a logarithmic function of the received signal power, as defined in section\_9.4.2.38 of IEEE 802.11-2016 [8].\n\nFor reportingCondition subfield values 3 and 4, the threshold value is a logarithmic function of the signal-to-noise ratio, as described in section\_9.4.2.41 of IEEE 802.11-2016 [8].\n\nFor reportingCondition subfield values 5 to 10, the offset value is an 8-bit 2s complement integer in units of 0,5 dBm. The indicated reporting condition applies individually to each measured Beacon, Measurement Pilot, or Probe Response frame." - format: uint8 type: integer - x-etsi-mec-cardinality: '1' - x-etsi-mec-origin-type: Uint8 + description: >- + The threshold subfield contains either the threshold value or the offset value to be used for conditional reporting. + + + For reportingCondition subfield with values 1 and 2, the threshold value is a logarithmic function of the received signal power, as defined in section 9.4.2.38 of IEEE 802.11-2016 [8]. + + + For reportingCondition subfield values 3 and 4, the threshold value is a logarithmic function of the signal-to-noise ratio, as described in section 9.4.2.41 of IEEE 802.11-2016 [8]. + + + For reportingCondition subfield values 5 to 10, the offset value is an 8-bit 2s complement integer in units of 0,5 dBm. The indicated reporting condition applies individually to each measured Beacon, Measurement Pilot, or Probe Response frame. + contentEncoding: int32 + BeaconRequestConfig: + title: BeaconRequestConfig required: - - reportingCondition - - threshold + - beaconReportingConf + - channelId + - measurementMode + - operatingClass type: object - x-etsi-ref: 6.5.28 - BeaconRequestConfig: properties: beaconReportingConf: $ref: '#/components/schemas/BeaconReportingConfig' bssid: - description: >- - The BSSID field indicates the BSS for which a beacon report is - requested. If absent, the requested beacon reports should include - all BSSs on the channel. type: string - x-etsi-mec-cardinality: 0..1 - x-etsi-mec-origin-type: String + description: The BSSID field indicates the BSS for which a beacon report is requested. If absent, the requested beacon reports should include all BSSs on the channel. 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." - format: uint8 type: integer - x-etsi-mec-cardinality: '1' - x-etsi-mec-origin-type: Uint8 + 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. + contentEncoding: int32 measurementMode: - description: |- + type: integer + description: >- 0 for passive. + 1 for active. + 2 for beacon table. - format: uint8 - type: integer - x-etsi-mec-cardinality: '1' - x-etsi-mec-origin-type: Uint8 + contentEncoding: int32 operatingClass: - description: "Operating Class field indicates an operating class value as defined in Annex E within IEEE\_802.112016\_[8]." - format: uint8 type: integer - x-etsi-mec-cardinality: '1' - x-etsi-mec-origin-type: Uint8 + description: Operating Class field indicates an operating class value as defined in Annex E within IEEE 802.112016 [8]. + contentEncoding: int32 ssid: - description: >- - The SSID subelement indicates the ESS or IBSS for which a beacon - report is requested. type: string - x-etsi-mec-cardinality: 0..1 - x-etsi-mec-origin-type: String + description: The SSID subelement indicates the ESS or IBSS for which a beacon report is requested. + BssCapabilities: + title: BssCapabilities required: - - operatingClass - - channelId - - measurementMode - - beaconReportingConf + - apsd + - delayedBACK + - immediateBACK + - qos + - radioMeasurements + - spectrumManagement type: object - x-etsi-ref: 6.5.25 - BssCapabilities: properties: apsd: - description: APSD Option implemented type: boolean - x-etsi-mec-cardinality: '1' - x-etsi-mec-origin-type: Boolean + description: APSD Option implemented delayedBACK: - description: Delayed Block Ack Option implemented type: boolean - x-etsi-mec-cardinality: '1' - x-etsi-mec-origin-type: Boolean + description: Delayed Block Ack Option implemented immediateBACK: - description: Immediate Block Ack Option implemented type: boolean - x-etsi-mec-cardinality: '1' - x-etsi-mec-origin-type: Boolean + description: Immediate Block Ack Option implemented qos: - description: QoS Option implemented type: boolean - x-etsi-mec-cardinality: '1' - x-etsi-mec-origin-type: Boolean + description: QoS Option implemented radioMeasurements: - description: Radio Measurement Activated type: boolean - x-etsi-mec-cardinality: '1' - x-etsi-mec-origin-type: Boolean + description: Radio Measurement Activated spectrumManagement: - description: Spectrum Management required type: boolean - x-etsi-mec-cardinality: '1' - x-etsi-mec-origin-type: Boolean + description: Spectrum Management required + BssLoad: + title: BssLoad required: - - spectrumManagement - - qos - - apsd - - radioMeasurements - - delayedBACK - - immediateBACK + - availAdmCap + - channelUtilization + - staCount type: object - x-etsi-ref: 6.5.31 - 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 + description: Available Admission Capacity that specifies the remaining amount of medium time available via explicit admission control, in units of 32 s/s. + contentEncoding: int32 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 + 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. + contentEncoding: int32 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 + description: An unsigned integer that indicates the total number of STAs currently associated with this BSS. + contentEncoding: int32 + BssidInfo: + title: BssidInfo required: - - staCount - - channelUtilization - - availAdmCap + - apReachability + - capabilities + - ftm + - highThroughput + - mobilityDomain + - security + - veryHighThroughput type: object - x-etsi-ref: 6.5.7 - BssidInfo: properties: apReachability: + type: integer description: >- - The apReachability field indicates whether the AP identified by this - BSSID is reachable by the STA that requested the neighbor report. - Valid values: + The apReachability field indicates whether the AP identified by this BSSID is reachable by the STA that requested the neighbor report. Valid values: 0 = reserved @@ -1217,1441 +1431,877 @@ components: 2 = unknown 3 = reachable. - format: uint8 - type: integer - x-etsi-mec-cardinality: '1' - x-etsi-mec-origin-type: Uint8 + contentEncoding: int32 capabilities: $ref: '#/components/schemas/BssCapabilities' ftm: + type: boolean description: >- - True indicates the AP represented by this BSSID is an AP that has - set the Fine Timing Measurement Responder field of the Extended - Capabilities element to 1. + True indicates the AP represented by this BSSID is an AP that has set the Fine Timing Measurement Responder field of the Extended Capabilities element to 1. - False indicates either that the reporting AP has - dot11FineTimingMsmtRespActivated equal to false, or the reported AP - has not set the Fine Timing Measurement Responder field of the - Extended Capabilities element to 1 or that the Fine Timing - Measurement Responder field of the reported AP is not available to - the reporting AP at this time. - type: boolean - x-etsi-mec-cardinality: '1' - x-etsi-mec-origin-type: Boolean + False indicates either that the reporting AP has dot11FineTimingMsmtRespActivated equal to false, or the reported AP has not set the Fine Timing Measurement Responder field of the Extended Capabilities element to 1 or that the Fine Timing Measurement Responder field of the reported AP is not available to the reporting AP at this time. highThroughput: - description: >- - True indicates that the AP represented by this BSSID is an HT AP - including the HT Capabilities element in its Beacons, and that the - contents of that HT Capabilities element are identical to the HT - Capabilities element advertised by the AP sending the report. type: boolean - x-etsi-mec-cardinality: '1' - x-etsi-mec-origin-type: Boolean + description: True indicates that the AP represented by this BSSID is an HT AP including the HT Capabilities element in its Beacons, and that the contents of that HT Capabilities element are identical to the HT Capabilities element advertised by the AP sending the report. mobilityDomain: - description: >- - True indicates the AP represented by this BSSID is including an MDE - in its Beacon frames and that the contents of that MDE are identical - to the MDE advertised by the AP sending the report. type: boolean - x-etsi-mec-cardinality: '1' - x-etsi-mec-origin-type: Boolean + description: True indicates the AP represented by this BSSID is including an MDE in its Beacon frames and that the contents of that MDE are identical to the MDE advertised by the AP sending the report. security: + type: boolean description: >- - True indicates the AP identified by this BSSID supports the same - security provisioning as used by the STA in its current association. + True indicates the AP identified by this BSSID supports the same security provisioning as used by the STA in its current association. - False indicates either that the AP does not support the same - security provisioning or that the security information is not - available at this time. - type: boolean - x-etsi-mec-cardinality: '1' - x-etsi-mec-origin-type: Boolean + False indicates either that the AP does not support the same security provisioning or that the security information is not available at this time. veryHighThroughput: - description: >- - True indicates that the AP represented by this BSSID is a VHT AP and - that the VHT Capabilities element, if included as a subelement in - the report, is identical in content to the VHT Capabilities element - included in the AP's Beacon. type: boolean - x-etsi-mec-cardinality: '1' - x-etsi-mec-origin-type: Boolean + description: True indicates that the AP represented by this BSSID is a VHT AP and that the VHT Capabilities element, if included as a subelement in the report, is identical in content to the VHT Capabilities element included in the AP's Beacon. + ChannelLoad: + title: ChannelLoad required: - - apReachability - - security - - capabilities - - mobilityDomain - - highThroughput - - veryHighThroughput - - ftm + - channel + - channelLoad + - measurementDuration + - measurementId + - operatingClass type: object - x-etsi-ref: 6.5.30 - ChannelLoad: properties: channel: - description: >- - Channel number indicates the channel number for which the - measurement report applies. - format: uint8 type: integer - x-etsi-mec-cardinality: '1' - x-etsi-mec-origin-type: Uint8 + description: Channel number indicates the channel number for which the measurement report applies. + contentEncoding: int32 channelLoad: - description: "Proportion of measurement duration for which the measuring STA determined the channel to be busy, as a percentage of time, linearly scaled with 255 representing 100\_%." - format: uint8 type: integer - x-etsi-mec-cardinality: '1' - x-etsi-mec-origin-type: Uint8 + description: Proportion of measurement duration for which the measuring STA determined the channel to be busy, as a percentage of time, linearly scaled with 255 representing 100 %. + contentEncoding: int32 measurementDuration: - description: >- - Duration over which the Channel Load report was measured, in units - of TUs of 1 024 µs. - format: uint8 type: integer - x-etsi-mec-cardinality: '1' - x-etsi-mec-origin-type: Uint8 + description: Duration over which the Channel Load report was measured, in units of TUs of 1 024 µs. + contentEncoding: int32 measurementId: - description: >- - Measurement ID of the Measurement configuration applied to this - Channel Load Report. type: string - x-etsi-mec-cardinality: '1' - x-etsi-mec-origin-type: String + description: Measurement ID of the Measurement configuration applied to this Channel Load Report. operatingClass: - description: >- - Operating Class field indicates an operating class value as defined - in Annex E within IEEE 802.11-2016 [8]. - format: uint8 type: integer - x-etsi-mec-cardinality: '1' - x-etsi-mec-origin-type: Uint8 + description: Operating Class field indicates an operating class value as defined in Annex E within IEEE 802.11-2016 [8]. + contentEncoding: int32 staId: $ref: '#/components/schemas/StaIdentity' + ChannelLoadConfig: + title: ChannelLoadConfig required: - - measurementId - - operatingClass - - channel - - measurementDuration - - channelLoad + - channel + - operatingClass type: object - x-etsi-ref: 6.5.39 - ChannelLoadConfig: properties: channel: - description: Channel for which the channel load report is requested. type: integer - x-etsi-mec-cardinality: '1' - x-etsi-mec-origin-type: Integer + description: Channel for which the channel load report is requested. + contentEncoding: int32 operatingClass: - description: >- - Operating Class field indicates an operating class value as defined - in Annex E within IEEE 802.11-2016 [8]. - format: uint8 type: integer - x-etsi-mec-cardinality: '1' - x-etsi-mec-origin-type: Uint8 + description: Operating Class field indicates an operating class value as defined in Annex E within IEEE 802.11-2016 [8]. + contentEncoding: int32 reportingCondition: + type: integer description: >- - Reporting condition for the Beacon Report as per Table 9-153 of IEEE - 802.11-2016 [8]: + Reporting condition for the Beacon Report as per Table 9-153 of IEEE 802.11-2016 [8]: 0 = Report to be issued after each measurement. - 1 = Report to be issued when Channel Load is greater than or equal - to the threshold. + 1 = Report to be issued when Channel Load is greater than or equal to the threshold. - 2 = Report to be issued when Channel Load is less than or equal to - the threshold. + 2 = Report to be issued when Channel Load is less than or equal to the threshold. - If this optional field is not provided, channel load report should - be issued after each measurement (reportingCondition = 0). - format: uint8 - type: integer - x-etsi-mec-cardinality: 0..1 - x-etsi-mec-origin-type: Uint8 + If this optional field is not provided, channel load report should be issued after each measurement (reportingCondition = 0). + contentEncoding: int32 threshold: - description: >- - Channel Load reference value for threshold reporting. This field - shall be provided for reportingCondition values 1 and 2. - format: uint8 type: integer - x-etsi-mec-cardinality: 0..1 - x-etsi-mec-origin-type: Uint8 + description: Channel Load reference value for threshold reporting. This field shall be provided for reportingCondition values 1 and 2. + contentEncoding: int32 + CivicLocation: + title: CivicLocation required: - - operatingClass - - channel + - country 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 + description: Language ca1: - description: 'National subdivisions (state, canton, region, province, prefecture) ' type: string - x-etsi-mec-cardinality: 0..1 - x-etsi-mec-origin-type: String + description: National subdivisions (state, canton, region, province, prefecture) ca128: - description: Script type: string - x-etsi-mec-cardinality: 0..1 - x-etsi-mec-origin-type: String + description: Script ca16: - description: Leading street direction type: string - x-etsi-mec-cardinality: 0..1 - x-etsi-mec-origin-type: String + description: Leading street direction ca17: - description: Trailing street suffix type: string - x-etsi-mec-cardinality: 0..1 - x-etsi-mec-origin-type: String + description: Trailing street suffix ca18: - description: Street suffix or type type: string - x-etsi-mec-cardinality: 0..1 - x-etsi-mec-origin-type: String + description: Street suffix or type ca19: - description: House number type: string - x-etsi-mec-cardinality: 0..1 - x-etsi-mec-origin-type: String + description: House number ca2: - description: 'County, parish, gun (JP), district (IN)' type: string - x-etsi-mec-cardinality: 0..1 - x-etsi-mec-origin-type: String + description: County, parish, gun (JP), district (IN) ca20: - description: House number suffix type: string - x-etsi-mec-cardinality: 0..1 - x-etsi-mec-origin-type: String + description: House number suffix ca21: - description: Landmark of vanity address type: string - x-etsi-mec-cardinality: 0..1 - x-etsi-mec-origin-type: String + description: Landmark of vanity address ca22: - description: Additional location information type: string - x-etsi-mec-cardinality: 0..1 - x-etsi-mec-origin-type: String + description: Additional location information ca23: - description: Name (residence and office occupant) type: string - x-etsi-mec-cardinality: 0..1 - x-etsi-mec-origin-type: String + description: Name (residence and office occupant) ca24: - description: Postal/zip code type: string - x-etsi-mec-cardinality: 0..1 - x-etsi-mec-origin-type: String + description: Postal/zip code ca25: - description: Building (structure) type: string - x-etsi-mec-cardinality: 0..1 - x-etsi-mec-origin-type: String + description: Building (structure) ca26: - description: Unit (apartment/suite) type: string - x-etsi-mec-cardinality: 0..1 - x-etsi-mec-origin-type: String + description: Unit (apartment/suite) ca27: - description: Floor type: string - x-etsi-mec-cardinality: 0..1 - x-etsi-mec-origin-type: String + description: Floor ca28: - description: Room type: string - x-etsi-mec-cardinality: 0..1 - x-etsi-mec-origin-type: String + description: Room ca29: - description: Type of place type: string - x-etsi-mec-cardinality: 0..1 - x-etsi-mec-origin-type: String + description: Type of place ca3: - description: 'City, township, shi (JP)' type: string - x-etsi-mec-cardinality: 0..1 - x-etsi-mec-origin-type: String + description: City, township, shi (JP) ca30: - description: Postal community name type: string - x-etsi-mec-cardinality: 0..1 - x-etsi-mec-origin-type: String + description: Postal community name ca31: - description: Post office box type: string - x-etsi-mec-cardinality: 0..1 - x-etsi-mec-origin-type: String + description: Post office box ca32: - description: Additional code type: string - x-etsi-mec-cardinality: 0..1 - x-etsi-mec-origin-type: String + description: Additional code ca33: - description: 'Seat (desk.cubicle, workstation)' type: string - x-etsi-mec-cardinality: 0..1 - x-etsi-mec-origin-type: String + description: Seat (desk.cubicle, workstation) ca34: - description: Primary road name type: string - x-etsi-mec-cardinality: 0..1 - x-etsi-mec-origin-type: String + description: Primary road name ca35: - description: Road section type: string - x-etsi-mec-cardinality: 0..1 - x-etsi-mec-origin-type: String + description: Road section ca36: - description: Branch road name type: string - x-etsi-mec-cardinality: 0..1 - x-etsi-mec-origin-type: String + description: Branch road name ca37: - description: Sub-branch road name type: string - x-etsi-mec-cardinality: 0..1 - x-etsi-mec-origin-type: String + description: Sub-branch road name ca38: - description: Street name pre-modifier type: string - x-etsi-mec-cardinality: 0..1 - x-etsi-mec-origin-type: String + description: Street name pre-modifier ca39: - description: Street name post-modifier type: string - x-etsi-mec-cardinality: 0..1 - x-etsi-mec-origin-type: String + description: Street name post-modifier ca4: - description: 'City division, borough, city district, ward, chou (JP)' type: string - x-etsi-mec-cardinality: 0..1 - x-etsi-mec-origin-type: String + description: City division, borough, city district, ward, chou (JP) ca5: - description: 'Neighborhood, block' type: string - x-etsi-mec-cardinality: 0..1 - x-etsi-mec-origin-type: String + description: Neighborhood, block ca6: - description: 'Group of streets below the neighborhood level ' type: string - x-etsi-mec-cardinality: 0..1 - x-etsi-mec-origin-type: String + description: Group of streets below the neighborhood level 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 + 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] + DmgCapabilities: + title: DmgCapabilities required: - - country + - ExtScMcsCap + - dmgApOrPcpCapInfo + - dmgStaBeamTrackTimeLimit + - dmgStaCapInfo + - maxNrBasicAmsduSubframes + - maxNrShortAmsduSubframes type: object - x-etsi-ref: 6.5.20 - DmgCapabilities: properties: ExtScMcsCap: - description: "Extended SC MCS capabilities as defined in IEEE\_802.11-2016 [8]." - format: uint8 type: integer - x-etsi-mec-cardinality: '1' - x-etsi-mec-origin-type: Uint8 + description: Extended SC MCS capabilities as defined in IEEE 802.11-2016 [8]. + contentEncoding: int32 dmgApOrPcpCapInfo: - description: >- - DMG AP or PCP capabilities information as defined in IEEE - 802.11-2016 [8]. - format: uint16 type: integer - x-etsi-mec-cardinality: '1' - x-etsi-mec-origin-type: Uint16 + description: DMG AP or PCP capabilities information as defined in IEEE 802.11-2016 [8]. + contentEncoding: int32 dmgStaBeamTrackTimeLimit: - description: "DMG station beam tracking time limit as defined in IEEE\_802.11-2016 [8]. " - format: uint16 type: integer - x-etsi-mec-cardinality: '1' - x-etsi-mec-origin-type: Uint16 + description: DMG station beam tracking time limit as defined in IEEE 802.11-2016 [8]. + contentEncoding: int32 dmgStaCapInfo: - description: "DMG station capabilities information as defined in IEEE\_802.11-2016 [8]. " - format: uint64 type: integer - x-etsi-mec-cardinality: '1' - x-etsi-mec-origin-type: Uint64 + description: DMG station capabilities information as defined in IEEE 802.11-2016 [8]. + contentEncoding: int32 maxNrBasicAmsduSubframes: - description: >- - Number of basic A-MSDU subframes in A-MSDU as defined in IEEE - 802.11-2016 [8]. - format: uint8 type: integer - x-etsi-mec-cardinality: '1' - x-etsi-mec-origin-type: Uint8 + description: Number of basic A-MSDU subframes in A-MSDU as defined in IEEE 802.11-2016 [8]. + contentEncoding: int32 maxNrShortAmsduSubframes: - description: >- - Number of short A-MSDU subframes in A-MSDU as defined in IEEE - 802.11-2016 [8]. - format: uint8 type: integer - x-etsi-mec-cardinality: '1' - x-etsi-mec-origin-type: Uint8 + description: Number of short A-MSDU subframes in A-MSDU as defined in IEEE 802.11-2016 [8]. + contentEncoding: int32 + EdmgCapabilities: + title: EdmgCapabilities required: - - dmgStaCapInfo - - dmgApOrPcpCapInfo - - dmgStaBeamTrackTimeLimit - - ExtScMcsCap - - maxNrBasicAmsduSubframes - - maxNrShortAmsduSubframes + - ampduParameters + - supportedMcs + - trnParameters type: object - x-etsi-ref: 6.5.17 - EdmgCapabilities: properties: ampduParameters: - description: 'A-MPDU parameters as defined in draft IEEE P802.11ay [i.11]' - format: uint8 type: integer - x-etsi-mec-cardinality: '1' - x-etsi-mec-origin-type: Uint8 + description: A-MPDU parameters as defined in draft IEEE P802.11ay [i.11] + contentEncoding: int32 supportedMcs: - description: 'Supported MCS as defined in draft IEEE P802.11ay [i.11]' - format: uint32 type: integer - x-etsi-mec-cardinality: '1' - x-etsi-mec-origin-type: Uint32 + description: Supported MCS as defined in draft IEEE P802.11ay [i.11] + contentEncoding: int32 trnParameters: - description: 'Training parameters as defined in draft IEEE P802.11ay [i.11]' - format: uint16 type: integer - x-etsi-mec-cardinality: '1' - x-etsi-mec-origin-type: Uint16 + description: Training parameters as defined in draft IEEE P802.11ay [i.11] + contentEncoding: int32 + ExpiryNotification: + title: ExpiryNotification required: - - ampduParameters - - trnParameters - - supportedMcs + - _links + - expiryDeadline + - notificationType type: object - x-etsi-ref: 6.5.18 - ExpiryNotification: properties: _links: - description: Hyperlink related to the resource. - properties: - subscription: - $ref: '#/components/schemas/LinkType' - required: - - subscription - type: object - x-etsi-mec-cardinality: '1' - x-etsi-mec-origin-type: Structure (inlined) + $ref: '#/components/schemas/Links1' expiryDeadline: $ref: '#/components/schemas/TimeStamp' notificationType: - description: Shall be set to "ExpiryNotification". type: string - x-etsi-mec-cardinality: '1' - x-etsi-mec-origin-type: String + description: Shall be set to "ExpiryNotification". + ExtBssLoad: + title: ExtBssLoad required: - - notificationType - - _links - - expiryDeadline + - muMimoStaCount + - obsSec20MhzUtil + - obsSec40MhzUtil + - obsSec80MhzUtil + - spatStreamUnderUtil type: object - x-etsi-ref: 6.4.4 - 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 + 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. + contentEncoding: int32 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 + description: Observable loading on each of the secondary 20 MHz channel. + contentEncoding: int32 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 + description: Observable loading on each of the secondary 40 MHz channel. + contentEncoding: int32 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 + description: Observable loading on each of the secondary 80 MHz channel. + contentEncoding: int32 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 + 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. + contentEncoding: int32 + GeoLocation: + title: GeoLocation required: - - muMimoStaCount - - spatStreamUnderUtil - - obsSec20MhzUtil - - obsSec40MhzUtil - - obsSec80MhzUtil + - datum + - lat + - latUncertainty + - long + - longUncertainty 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 + description: The altitude value of location as defined in IETF RFC 6225 [6] + contentEncoding: int32 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 + description: The type description for altitude information e.g. floors or meters as defined in IETF RFC 6225 [6] + contentEncoding: int32 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 + description: The uncertainty for altitude information as defined in IETF RFC 6225 [6] + contentEncoding: int32 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 + description: The datum value to express how coordinates are organized and related to real world as defined in IETF RFC 6225 [6] + contentEncoding: int32 lat: - description: "The latitude value of location as defined in IETF RFC\_6225 [6]" - format: uint64 type: integer - x-etsi-mec-cardinality: '1' - x-etsi-mec-origin-type: Uint64 + description: The latitude value of location as defined in IETF RFC 6225 [6] + contentEncoding: int32 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 + description: The uncertainty for Latitude information as defined in IETF RFC 6225 [6] + contentEncoding: int32 long: - description: "The longitude value of location as defined in IETF RFC\_6225 [6]" - format: uint64 type: integer - x-etsi-mec-cardinality: '1' - x-etsi-mec-origin-type: Uint64 + description: The longitude value of location as defined in IETF RFC 6225 [6] + contentEncoding: int32 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 + description: The uncertainty for Longitude information as defined in IETF RFC 6225 [6] + contentEncoding: int32 + HeCapabilities: + title: HeCapabilities required: - - latUncertainty - - lat - - longUncertainty - - long - - datum + - heMacCapInfo + - hePhyCapinfo + - supportedHeMcsNssSet 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 + description: MAC capabilities of an Access Point. + contentEncoding: int32 hePhyCapinfo: - description: PHY capabilities of an Access Point. - format: uint8 type: integer - x-etsi-mec-cardinality: '1' - x-etsi-mec-origin-type: Uint8 + description: PHY capabilities of an Access Point. + contentEncoding: int32 supportedHeMcsNssSet: - description: Supported MCS and NSS Set. - format: uint8 type: integer - x-etsi-mec-cardinality: '1' - x-etsi-mec-origin-type: Uint8 + description: Supported MCS and NSS Set. + contentEncoding: int32 + HtCapabilities: + title: HtCapabilities required: - - heMacCapInfo - - hePhyCapinfo - - supportedHeMcsNssSet + - ampduParameters + - aselCap + - htCapabilityInfo + - htExtendedCap + - supportedMcsSet + - txBeamFormCap 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 + description: A-MPDU parameters as defined in IEEE 802.11-2016 [8]. + contentEncoding: int32 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 + description: ASEL capabilities as defined in IEEE 802.11-2016 [8]. + contentEncoding: int32 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 + description: HT Capability Information as defined in IEEE 802.11-2016 [8]. + contentEncoding: int32 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 + description: Extended HT Capabilities as defined in IEEE 802.11-2016 [8]. + contentEncoding: int32 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 + description: Supported MCS set as defined in IEEE 802.11-2016 [8]. + contentEncoding: int32 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 + description: Transmit Beamforming Capabilities as defined in IEEE 802.11-2016 [8]. + contentEncoding: int32 + LinkType: + title: LinkType required: - - htCapabilityInfo - - ampduParameters - - supportedMcsSet - - htExtendedCap - - txBeamFormCap - - aselCap + - href type: object - x-etsi-ref: 6.5.14 - InlineNotification: - discriminator: - propertyName: notificationType - oneOf: - - $ref: '#/components/schemas/AssocStaNotification' - - $ref: '#/components/schemas/StaDataRateNotification' - - $ref: '#/components/schemas/MeasurementReportNotification' - InlineSubscription: - discriminator: - propertyName: subscriptionType - oneOf: - - $ref: '#/components/schemas/AssocStaSubscription' - - $ref: '#/components/schemas/StaDataRateSubscription' - - $ref: '#/components/schemas/MeasurementReportSubscription' - LinkType: properties: href: type: string + MeasurementConfig: + title: MeasurementConfig required: - - href + - measurementId + - measurementInfo + - staId type: object - x-etsi-ref: 6.5.23 - MeasurementConfig: properties: _links: - description: Hyperlink related to the resource. - properties: - self: - $ref: '#/components/schemas/LinkType' - required: - - self - type: object - x-etsi-mec-cardinality: 0..1 - x-etsi-mec-origin-type: Structure (inlined) + $ref: '#/components/schemas/Links4' measurementId: - description: >- - Unique identifier allocated by the service consumer to identify - measurement reports (within sta_information query), associated with - this measurement configuration. type: string - x-etsi-mec-cardinality: '1' - x-etsi-mec-origin-type: String + description: Unique identifier allocated by the service consumer to identify measurement reports (within sta_information query), associated with this measurement configuration. measurementInfo: $ref: '#/components/schemas/MeasurementInfo' staId: - description: >- - Identifier(s) to uniquely specify the target client station(s) for - the measurement configuration. - items: - $ref: '#/components/schemas/StaIdentity' minItems: 1 type: array - x-etsi-mec-cardinality: 1..N - x-etsi-mec-origin-type: StaIdentity + items: + $ref: '#/components/schemas/StaIdentity' + description: Identifier(s) to uniquely specify the target client station(s) for the measurement configuration. + MeasurementConfigLinkList: + title: MeasurementConfigLinkList required: - - staId - - measurementId - - measurementInfo + - _links type: object - x-etsi-ref: 6.2.4 - MeasurementConfigLinkList: properties: _links: - description: Hyperlink related to the resource. - properties: - self: - $ref: '#/components/schemas/LinkType' - required: - - self - type: object - x-etsi-mec-cardinality: '1' - x-etsi-mec-origin-type: Structure (inlined) + $ref: '#/components/schemas/Links4' measurementConfig: - description: '' - items: - properties: - href: - description: The URI referring to a measurement configuration. - format: uri - type: string - x-etsi-mec-cardinality: '1' - x-etsi-mec-origin-type: URI - measurementId: - description: >- - Unique identifier allocated by the service consumer to - identify measurement reports associated with this measurement - configuration. - type: string - x-etsi-mec-cardinality: '1' - x-etsi-mec-origin-type: String - required: - - href - - measurementId - type: object type: array - x-etsi-mec-cardinality: 0..N - x-etsi-mec-origin-type: Structure (inlined) - required: - - _links - type: object - x-etsi-ref: 6.2.5 + items: + $ref: '#/components/schemas/MeasurementConfig1' + description: '' MeasurementInfo: + title: MeasurementInfo + type: object properties: beaconRequestConf: $ref: '#/components/schemas/BeaconRequestConfig' channelLoadConf: $ref: '#/components/schemas/ChannelLoadConfig' measurementDuration: - description: "Duration of the measurement in Time Units (TUs) of 1\_024 µs, as defined in section 11.11.4 of IEEE\_802.11-2016 [8]. If not provided, the underlying system may utilize a default configuration that will be indicated in resulting measurement reports." - format: uint16 type: integer - x-etsi-mec-cardinality: 0..1 - x-etsi-mec-origin-type: Uint16 + description: Duration of the measurement in Time Units (TUs) of 1 024 µs, as defined in section 11.11.4 of IEEE 802.11-2016 [8]. If not provided, the underlying system may utilize a default configuration that will be indicated in resulting measurement reports. + contentEncoding: int32 neighborReportConf: $ref: '#/components/schemas/NeighborReportConfig' randomInterval: - description: "Random interval to be used for starting the measurement in TUs of 1\_024 µs, as specified in section\_11.11.3 of IEEE 802.11-2016 [8]. If not provided, the underlying system may utilize a default configuration that will be indicated in resulting measurement reports." - format: uint16 type: integer - x-etsi-mec-cardinality: 0..1 - x-etsi-mec-origin-type: Uint16 + description: Random interval to be used for starting the measurement in TUs of 1 024 µs, as specified in section 11.11.3 of IEEE 802.11-2016 [8]. If not provided, the underlying system may utilize a default configuration that will be indicated in resulting measurement reports. + contentEncoding: int32 staStatisticsConf: $ref: '#/components/schemas/StaStatisticsConfig' - type: object - x-etsi-notes: "NOTE 1:\tOnly one of channelLoadConf, beaconRequestConf, staStatisticsConf or neighborReportConf is allowed in a MeasurementInfo instance.\nNOTE 2:\tAs per IEEE 802.11-2016 [8], measurementDuration and randomInterval apply to channelLoad, beaconRequest, staStatistics, and neighborReport configurations." - x-etsi-ref: 6.5.41 MeasurementReportNotification: - properties: - beaconReport: - description: 'Beacon Report as defined in IEEE 802.11-2016 [8].' - items: - $ref: '#/components/schemas/BeaconReport' - minItems: 0 - type: array - x-etsi-mec-cardinality: 0..N - x-etsi-mec-origin-type: BeaconReport - channelLoad: - description: >- - Channel Load reports as seen by the station as defined in IEEE - 802.11-2016 [8]. - items: - $ref: '#/components/schemas/ChannelLoad' - minItems: 0 - type: array - x-etsi-mec-cardinality: 0..N - x-etsi-mec-origin-type: ChannelLoad - neighborReport: - description: "Neighbor Report providing information about neighbor Access Points seen by the station as defined in IEEE\_802.112016 [8]." - items: - $ref: '#/components/schemas/NeighborReport' - minItems: 0 - type: array - x-etsi-mec-cardinality: 0..N - x-etsi-mec-origin-type: NeighborReport - notificationType: - description: Shall be set to "MeasurementReportNotification". - type: string - x-etsi-mec-cardinality: '1' - x-etsi-mec-origin-type: String - staStatistics: - description: 'STA Statistics Report as defined in IEEE 802.11-2016 [8].' - items: - $ref: '#/components/schemas/StaStatistics' - minItems: 0 - type: array - x-etsi-mec-cardinality: 0..N - x-etsi-mec-origin-type: StaStatistics - timeStamp: - $ref: '#/components/schemas/TimeStamp' - required: - - notificationType - type: object - x-etsi-notes: "NOTE 1:\tEach MeasurementReportNotification shall include a single measurement report type (channelLoad, beaconRequest, etc.), based on the MeasurementReportSubscription.\nNOTE 2:\tA single MeasurementReportNotification may include multiple measurement reports (of the same type), if the MeasurementReportSubscription configured the measurement report for several client stations and multiple reports are available to WAIS." - x-etsi-ref: 6.4.5 + title: MeasurementReportNotification + allOf: + - $ref: '#/components/schemas/InlineNotification' + - type: object + properties: + beaconReport: + minItems: 0 + type: array + items: + $ref: '#/components/schemas/BeaconReport' + description: Beacon Report as defined in IEEE 802.11-2016 [8]. + channelLoad: + minItems: 0 + type: array + items: + $ref: '#/components/schemas/ChannelLoad' + description: Channel Load reports as seen by the station as defined in IEEE 802.11-2016 [8]. + neighborReport: + minItems: 0 + type: array + items: + $ref: '#/components/schemas/NeighborReport' + description: Neighbor Report providing information about neighbor Access Points seen by the station as defined in IEEE 802.112016 [8]. + staStatistics: + minItems: 0 + type: array + items: + $ref: '#/components/schemas/StaStatistics' + description: STA Statistics Report as defined in IEEE 802.11-2016 [8]. + timeStamp: + $ref: '#/components/schemas/TimeStamp' MeasurementReportSubscription: - 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: - type: string - expiryDeadline: - $ref: '#/components/schemas/TimeStamp' - measurementId: - description: >- - Unique identifier allocated by the service consumer to identify - measurement reports associated with this measurement subscription. - type: string - x-etsi-mec-cardinality: '1' - x-etsi-mec-origin-type: String - measurementInfo: - $ref: '#/components/schemas/MeasurementInfo' - requestTestNotification: - description: >- - Set to TRUE by the service consumer to request a test notification - on the callbackReference URI to determine if it is reachable by the - WAIS for notifications. - type: boolean - x-etsi-mec-cardinality: 0..1 - x-etsi-mec-origin-type: Boolean - 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 "MeasurementReportSubscription". - type: string - x-etsi-mec-cardinality: '1' - x-etsi-mec-origin-type: String - websockNotifConfig: - $ref: '#/components/schemas/WebsockNotifConfig' - required: - - subscriptionType - - staId + title: MeasurementReportSubscription + allOf: + - $ref: '#/components/schemas/InlineSubscription' + - required: - measurementId - measurementInfo - type: object - x-etsi-notes: "NOTE:\tAt least one of callbackReference and websockNotifConfig shall be provided by the service consumer. If both are provided, it is up to WAIS to select the method to be used for notifications and to return only that method in the response." - x-etsi-ref: 6.3.5 + - staId + type: object + properties: + _links: + $ref: '#/components/schemas/Links' + callbackReference: + type: string + expiryDeadline: + $ref: '#/components/schemas/TimeStamp' + measurementId: + type: string + description: Unique identifier allocated by the service consumer to identify measurement reports associated with this measurement subscription. + measurementInfo: + $ref: '#/components/schemas/MeasurementInfo' + requestTestNotification: + type: boolean + description: Set to TRUE by the service consumer to request a test notification on the callbackReference URI to determine if it is reachable by the WAIS for notifications. + staId: + minItems: 1 + type: array + items: + $ref: '#/components/schemas/StaIdentity' + description: Identifier(s) to uniquely specify the target client station(s) for the subscription. + websockNotifConfig: + $ref: '#/components/schemas/WebsockNotifConfig' NeighborReport: + title: NeighborReport + required: + - bssid + - bssidInfo + - channel + - measurementId + - operatingClass + - phyType + type: object properties: bssTransitionCandidatePreference: - description: "Relative value indicating the preferred ordering for this BSS as a transition candidate for roaming. 255 indicating the most preferred candidate and 1 indicating the least preferred candidate, as defined in Table 9-152 within IEEE\_802.112016\_[8]." - format: uint8 type: integer - x-etsi-mec-cardinality: 0..1 - x-etsi-mec-origin-type: Uint8 + description: Relative value indicating the preferred ordering for this BSS as a transition candidate for roaming. 255 indicating the most preferred candidate and 1 indicating the least preferred candidate, as defined in Table 9-152 within IEEE 802.112016 [8]. + contentEncoding: int32 bssid: - description: BSSID (MAC address) of the Access Point that is being reported. type: string - x-etsi-mec-cardinality: '1' - x-etsi-mec-origin-type: String + description: BSSID (MAC address) of the Access Point that is being reported. bssidInfo: $ref: '#/components/schemas/BssidInfo' channel: - description: >- - Channel field indicates a channel number, which is interpreted in - the context of the indicated operating class. Channel numbers are - defined in Annex E within IEEE 802.11-2016 [8]. - format: uint8 type: integer - x-etsi-mec-cardinality: '1' - x-etsi-mec-origin-type: Uint8 + description: Channel field indicates a channel number, which is interpreted in the context of the indicated operating class. Channel numbers are defined in Annex E within IEEE 802.11-2016 [8]. + contentEncoding: int32 measurementId: - description: >- - Measurement ID of the Measurement configuration applied to this - Neighbor Report. type: string - x-etsi-mec-cardinality: '1' - x-etsi-mec-origin-type: String + description: Measurement ID of the Measurement configuration applied to this Neighbor Report. operatingClass: - description: >- - Operating Class field indicates an operating class value as defined - in Annex E within IEEE 802.11-2016 [8]. - format: uint8 type: integer - x-etsi-mec-cardinality: '1' - x-etsi-mec-origin-type: Uint8 + description: Operating Class field indicates an operating class value as defined in Annex E within IEEE 802.11-2016 [8]. + contentEncoding: int32 phyType: - description: "PHY type of the AP indicated by this BSSID. It is an integer value coded according to the value of the dot11PHYType, Annex\_C within IEEE 802.11-2016 [8].\n2 = dsss\n4 = ofdm\n5 = hrdsss\n6 = erp\n7 = ht\n8 = dmg\n9 = vht\n10 = tvht" - format: uint8 type: integer - x-etsi-mec-cardinality: '1' - x-etsi-mec-origin-type: Uint8 + description: >- + PHY type of the AP indicated by this BSSID. It is an integer value coded according to the value of the dot11PHYType, Annex C within IEEE 802.11-2016 [8]. + + 2 = dsss + + 4 = ofdm + + 5 = hrdsss + + 6 = erp + + 7 = ht + + 8 = dmg + + 9 = vht + + 10 = tvht + contentEncoding: int32 staId: $ref: '#/components/schemas/StaIdentity' - required: - - measurementId - - bssid - - bssidInfo - - operatingClass - - channel - - phyType - type: object - x-etsi-ref: 6.5.10 NeighborReportConfig: + title: NeighborReportConfig + type: object properties: bssid: - description: >- - BSSID of the neighbor AP which information is intended to obtain. If - no specific BSSID is given, the information will be provided for all - APs matching the ssid criteria. type: string - x-etsi-mec-cardinality: 0..1 - x-etsi-mec-origin-type: String + description: BSSID of the neighbor AP which information is intended to obtain. If no specific BSSID is given, the information will be provided for all APs matching the ssid criteria. ssid: - description: >- - The SSID field is optionally present. If present, it contains an - SSID element. The presence of an SSID element in a Neighbor Report - indicates a request for a neighbor list for the specified SSID in - the SSID Element. The absence of an SSID element indicates neighbor - report for the current ESS. - type: string - x-etsi-mec-cardinality: 0..1 - x-etsi-mec-origin-type: String - type: object - x-etsi-notes: "NOTE:\tBoth SSID and BSSID are optional configuration parameters. BSSID is valid when a SSID setting is provided, otherwise ignored. If SSID is not included, the neighbor report will be generated for the SSID (i.e.\_current ESS) that the station is associated." - x-etsi-ref: 6.5.32 + type: string + description: The SSID field is optionally present. If present, it contains an SSID element. The presence of an SSID element in a Neighbor Report indicates a request for a neighbor list for the specified SSID in the SSID Element. The absence of an SSID element indicates neighbor report for the current ESS. OBssLoad: + title: OBssLoad + required: + - allocatedTrafficSelfMean + - allocatedTrafficShareMean + type: object properties: allocatedTrafficSelfMean: - description: "Mean of allocated traffic from this AP (BSS) in units of 32\_µs per second." - format: uint16 type: integer - x-etsi-mec-cardinality: '1' - x-etsi-mec-origin-type: Uint16 + description: Mean of allocated traffic from this AP (BSS) in units of 32 µs per second. + contentEncoding: int32 allocatedTrafficSelfStdDev: - description: >- - Standard deviation from the mean of allocation traffic from this BSS - in units of 32 µs per second. - format: uint16 type: integer - x-etsi-mec-cardinality: 0..1 - x-etsi-mec-origin-type: Uint16 + description: Standard deviation from the mean of allocation traffic from this BSS in units of 32 µs per second. + contentEncoding: int32 allocatedTrafficShareMean: - description: >- - Mean of the sum of allocated traffic from other APs on the - overlapping channel in unit of 32 µs per second. - format: uint16 type: integer - x-etsi-mec-cardinality: '1' - x-etsi-mec-origin-type: Uint16 + description: Mean of the sum of allocated traffic from other APs on the overlapping channel in unit of 32 µs per second. + contentEncoding: int32 allocatedTrafficShareStdDev: - description: >- - Standard deviation from the mean of the sum of allocated traffic - from other APs on the overlapping channel in unit of 32 µs per - second. - format: uint16 type: integer - x-etsi-mec-cardinality: 0..1 - x-etsi-mec-origin-type: Uint16 + description: Standard deviation from the mean of the sum of allocated traffic from other APs on the overlapping channel in unit of 32 µs per second. + contentEncoding: int32 overlap: - description: >- - Indicates the number of other APs that are sharing the same channel - as the reporting AP. - format: uint8 type: integer - x-etsi-mec-cardinality: 0..1 - x-etsi-mec-origin-type: Uint8 - required: - - allocatedTrafficSelfMean - - allocatedTrafficShareMean - type: object - x-etsi-ref: 6.5.40 + description: Indicates the number of other APs that are sharing the same channel as the reporting AP. + contentEncoding: int32 ProblemDetails: + title: ProblemDetails + type: object 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 + description: A human-readable explanation specific to this occurrence of the problem 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 + description: A URI reference that identifies the specific occurrence of the problem 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 + description: The HTTP status code for this occurrence of the problem + contentEncoding: int32 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 + description: A short, human-readable summary of the problem type 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 + description: A URI reference according to IETF RFC 3986 that identifies the problem type ReportedBeaconFrameInfo: + title: ReportedBeaconFrameInfo + required: + - frameType + - phyType + type: object properties: frameType: - description: |- + type: integer + description: >- A value of 0 indicates a Beacon or Probe Response. + A value of 1 indicates a Measurement Pilot frame. - format: uint8 - type: integer - x-etsi-mec-cardinality: '1' - x-etsi-mec-origin-type: Uint8 + contentEncoding: int32 phyType: - description: Value between 0 and 127 coded according to dot11PHYType. - format: uint8 type: integer - x-etsi-mec-cardinality: '1' - x-etsi-mec-origin-type: Uint8 + description: Value between 0 and 127 coded according to dot11PHYType. + contentEncoding: int32 + ReportingReasonQoSCounters: + title: ReportingReasonQoSCounters required: - - phyType - - frameType + - qosAckFailure + - qosDiscarded + - qosFailed + - qosFrameDuplicate + - qosMultipleRetry + - qosRetry + - qosRtsFailure type: object - x-etsi-ref: 6.5.29 - ReportingReasonQoSCounters: properties: qosAckFailure: - description: dot11QoSAckFailure type: boolean - x-etsi-mec-cardinality: '1' - x-etsi-mec-origin-type: Boolean + description: dot11QoSAckFailure qosDiscarded: - description: dot11QoSDiscarded type: boolean - x-etsi-mec-cardinality: '1' - x-etsi-mec-origin-type: Boolean + description: dot11QoSDiscarded qosFailed: - description: 'dot11QoSFailed ' type: boolean - x-etsi-mec-cardinality: '1' - x-etsi-mec-origin-type: Boolean + description: dot11QoSFailed qosFrameDuplicate: - description: dot11QoSFrameDuplicate type: boolean - x-etsi-mec-cardinality: '1' - x-etsi-mec-origin-type: Boolean + description: dot11QoSFrameDuplicate qosMultipleRetry: - description: dot11QoSMultipleRetry type: boolean - x-etsi-mec-cardinality: '1' - x-etsi-mec-origin-type: Boolean + description: dot11QoSMultipleRetry qosRetry: - description: dot11QoSRetry type: boolean - x-etsi-mec-cardinality: '1' - x-etsi-mec-origin-type: Boolean + description: dot11QoSRetry qosRtsFailure: - description: dot11QoSRTSFailure type: boolean - x-etsi-mec-cardinality: '1' - x-etsi-mec-origin-type: Boolean + description: dot11QoSRTSFailure + ReportingReasonStaCounters: + title: ReportingReasonStaCounters required: - - qosFailed - - qosRetry - - qosMultipleRetry - - qosFrameDuplicate - - qosRtsFailure - - qosAckFailure - - qosDiscarded + - ackFailure + - failed + - fcsError + - frameDuplicate + - multipleRetry + - retry + - rtsFailure type: object - x-etsi-ref: 6.5.38 - ReportingReasonStaCounters: properties: ackFailure: - description: dot11AckFailure type: boolean - x-etsi-mec-cardinality: '1' - x-etsi-mec-origin-type: Boolean + description: dot11AckFailure failed: - description: dot11Failed type: boolean - x-etsi-mec-cardinality: '1' - x-etsi-mec-origin-type: Boolean + description: dot11Failed fcsError: - description: 'dot11FCSError ' type: boolean - x-etsi-mec-cardinality: '1' - x-etsi-mec-origin-type: Boolean + description: dot11FCSError frameDuplicate: - description: 'dot11FrameDuplicate ' type: boolean - x-etsi-mec-cardinality: '1' - x-etsi-mec-origin-type: Boolean + description: dot11FrameDuplicate multipleRetry: - description: dot11MultipleRetry type: boolean - x-etsi-mec-cardinality: '1' - x-etsi-mec-origin-type: Boolean + description: dot11MultipleRetry retry: - description: dot11Retry type: boolean - x-etsi-mec-cardinality: '1' - x-etsi-mec-origin-type: Boolean + description: dot11Retry rtsFailure: - description: dot11RTSFailure type: boolean - x-etsi-mec-cardinality: '1' - x-etsi-mec-origin-type: Boolean - required: - - failed - - fcsError - - multipleRetry - - frameDuplicate - - rtsFailure - - ackFailure - - retry - type: object - x-etsi-ref: 6.5.37 + description: dot11RTSFailure Rssi: + title: Rssi + required: + - rssi + type: object 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 + description: The Received Signal Strength Indicator from a station + contentEncoding: int32 STACounterTriggerCondition: + title: STACounterTriggerCondition + type: object properties: ackFailureCountThreshold: - description: Configure and set threshold for dot11AckFailureCount trigger - format: uint32 type: integer - x-etsi-mec-cardinality: 0..1 - x-etsi-mec-origin-type: Uint32 + description: Configure and set threshold for dot11AckFailureCount trigger + contentEncoding: int32 failedCountThreshold: - description: Configure and set threshold for dot11FailedCount trigger - format: uint32 type: integer - x-etsi-mec-cardinality: 0..1 - x-etsi-mec-origin-type: Uint32 + description: Configure and set threshold for dot11FailedCount trigger + contentEncoding: int32 fcsErrorCountThreshold: - description: Configure and set threshold for dot11FCSErrorCount trigger - format: uint32 type: integer - x-etsi-mec-cardinality: 0..1 - x-etsi-mec-origin-type: Uint32 + description: Configure and set threshold for dot11FCSErrorCount trigger + contentEncoding: int32 frameDuplicateCountThreshold: - description: Configure and set threshold for dot11FrameDuplicateCount trigger - format: uint32 type: integer - x-etsi-mec-cardinality: 0..1 - x-etsi-mec-origin-type: Uint32 + description: Configure and set threshold for dot11FrameDuplicateCount trigger + contentEncoding: int32 multipleRetryCountThreshold: - description: Configure and set threshold for dot11MultipleRetryCount trigger - format: uint32 type: integer - x-etsi-mec-cardinality: 0..1 - x-etsi-mec-origin-type: Uint32 + description: Configure and set threshold for dot11MultipleRetryCount trigger + contentEncoding: int32 retryCountThreshold: - description: Configure and set threshold for dot11RetryCount trigger - format: uint32 type: integer - x-etsi-mec-cardinality: 0..1 - x-etsi-mec-origin-type: Uint32 + description: Configure and set threshold for dot11RetryCount trigger + contentEncoding: int32 rtsFailureCountThreshold: - description: Configure and set threshold for dot11RTSFailureCount trigger - format: uint32 type: integer - x-etsi-mec-cardinality: 0..1 - x-etsi-mec-origin-type: Uint32 - type: object - x-etsi-ref: 6.5.33 + description: Configure and set threshold for dot11RTSFailureCount trigger + contentEncoding: int32 StaDataRate: + title: StaDataRate + type: object 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 + description: The data transmit rate in kbps that was most recently used for transmission of data PPDUs from the access point to the station. + contentEncoding: int32 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-notes: "NOTE:\tStaDataRate shall include at least one instance of either downlink rate or uplink rate and may include both.\n If this report is contained within a data type that provides the station's identifier, staId field may be omitted" - x-etsi-ref: 6.5.22 + 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. + contentEncoding: int32 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 + title: StaDataRateNotification + allOf: + - $ref: '#/components/schemas/InlineNotification' + - type: object + properties: + staDataRate: + minItems: 0 + type: array + items: + $ref: '#/components/schemas/StaDataRate' + description: Data rates of a client station. + timeStamp: + $ref: '#/components/schemas/TimeStamp' 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: - type: string - expiryDeadline: - $ref: '#/components/schemas/TimeStamp' - notificationEvent: - description: Set for trigger-based event notification reporting. - properties: - downlinkRateThreshold: - description: Downlink data rate threshold for StaDataRate reporting. - format: uint32 - type: integer - x-etsi-mec-cardinality: 0..1 - x-etsi-mec-origin-type: Uint32 - trigger: - description: >- - Trigger event for the notification: - - 1 = Notification issued when the STA's downlink data rate is - greater than or equal to the downlink threshold. - - 2 = Notification issued when the STA's downlink data rate is - less than or equal to the downlink threshold. - - 3 = Notification issued when the STA's uplink data rate is - greater than or equal to the uplink threshold. - - 4 = Notification issued when the STA's uplink data rate is less - than or equal to the uplink threshold. - - 5 = Notification issued when the STA's downlink and uplink data - rate is greater than or equal to their thresholds. - - 6 = Notification issued when the STA's downlink and uplink data - rate is less than or equal to their thresholds. - - 7 = Notification issued when the STA's downlink or uplink data - rate is greater than or equal to their thresholds. + title: StaDataRateSubscription + allOf: + - $ref: '#/components/schemas/InlineSubscription' + - required: + - staId + type: object + properties: + _links: + $ref: '#/components/schemas/Links' + callbackReference: + type: string + expiryDeadline: + $ref: '#/components/schemas/TimeStamp' + notificationEvent: + $ref: '#/components/schemas/NotificationEvent1' + notificationPeriod: + type: integer + description: >- + Set for periodic notification reporting. - 8 = Notification issued when the STA's downlink or uplink data - rate is less than or equal to their thresholds. - enum: - - 1 - - 2 - - 3 - - 4 - - 5 - - 6 - - 7 - - 8 - type: integer - x-etsi-mec-cardinality: '1' - x-etsi-mec-origin-type: Enum (inline) - uplinkRateThreshold: - description: Uplink data rate threshold for StaDataRate reporting. - format: uint32 - type: integer - x-etsi-mec-cardinality: 0..1 - x-etsi-mec-origin-type: Uint32 - required: - - trigger - type: object - x-etsi-mec-cardinality: 0..1 - x-etsi-mec-origin-type: Structure (inline) - notificationPeriod: - description: |- - Set for periodic notification reporting. - Value indicates the notification period in seconds. - format: uint8 - type: integer - x-etsi-mec-cardinality: 0..1 - x-etsi-mec-origin-type: Uint8 - requestTestNotification: - description: >- - Set to TRUE by the service consumer to request a test notification - on the callbackReference URI to determine if it is reachable by the - WAIS for notifications. - type: boolean - x-etsi-mec-cardinality: 0..1 - x-etsi-mec-origin-type: Boolean - 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 - websockNotifConfig: - $ref: '#/components/schemas/WebsockNotifConfig' + Value indicates the notification period in seconds. + contentEncoding: int32 + requestTestNotification: + type: boolean + description: Set to TRUE by the service consumer to request a test notification on the callbackReference URI to determine if it is reachable by the WAIS for notifications. + staId: + minItems: 1 + type: array + items: + $ref: '#/components/schemas/StaIdentity' + description: Identifier(s) to uniquely specify the target client station(s) for the subscription. + websockNotifConfig: + $ref: '#/components/schemas/WebsockNotifConfig' + StaIdentity: + title: StaIdentity required: - - subscriptionType - - staId + - macId type: object - x-etsi-notes: "NOTE 1:\tAt least one of callbackReference and websockNotifConfig shall be provided by the service consumer. If both are provided, it is up to WAIS to select the method to be used for notifications and to return only that method in the response.\nNOTE 2:\tStaDataRateSubscription shall include either notificationPeriod or notificationEvent.\nNOTE 3:\tIf both notificationPeriod and notificationEvent attributes are set, notifications are issued periodically when the trigger threshold is satisfied." - 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 + description: Number which identifies a particular association between a station and an Access Point ipAddress: - description: IPv4 or IPv6 address(es) allocated for the station. - items: - type: string minItems: 0 type: array - x-etsi-mec-cardinality: 0..N - x-etsi-mec-origin-type: String + items: + type: string + description: IPv4 or IPv6 address(es) allocated for the station. 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 + description: Unique identifier assigned to station (as network interface controller) for communications at the data link layer of a network segment. ssid: - description: Service Set Identifier(s) to identify logical networks. - items: - type: string minItems: 0 type: array - x-etsi-mec-cardinality: 0..N - x-etsi-mec-origin-type: String + items: + type: string + description: Service Set Identifier(s) to identify logical networks. + StaInfo: + title: StaInfo required: - - macId + - staId type: object - x-etsi-ref: 6.5.11 - StaInfo: properties: apAssociated: $ref: '#/components/schemas/ApAssociated' beaconReport: - description: 'Beacon Report as defined in IEEE 802.11-2016 [8]. ' - items: - $ref: '#/components/schemas/BeaconReport' minItems: 0 type: array - x-etsi-mec-cardinality: 0..N - x-etsi-mec-origin-type: BeaconReport + items: + $ref: '#/components/schemas/BeaconReport' + description: Beacon Report as defined in IEEE 802.11-2016 [8]. channel: - description: >- - Channel currently used by the station to connect with its associated - Access Point. - format: uint32 type: integer - x-etsi-mec-cardinality: 0..1 - x-etsi-mec-origin-type: Uint32 + description: Channel currently used by the station to connect with its associated Access Point. + contentEncoding: int32 channelLoad: - description: "Channel Load reports as seen by the station as defined IEEE\_802.11-2016 [8]. Channel Load reports may be configured for any channel, including the station's current channel for association." + minItems: 0 + type: array items: $ref: '#/components/schemas/ChannelLoad' + description: Channel Load reports as seen by the station as defined IEEE 802.11-2016 [8]. Channel Load reports may be configured for any channel, including the station's current channel for association. + neighborReport: minItems: 0 type: array - x-etsi-mec-cardinality: 0..N - x-etsi-mec-origin-type: ChannelLoad - neighborReport: - description: >- - Information about neighbor Access Points seen by the station as - defined IEEE 802.11-2016 [8]. items: $ref: '#/components/schemas/NeighborReport' - minItems: 0 - type: array - x-etsi-mec-cardinality: 0..N - x-etsi-mec-origin-type: NeighborReport + description: Information about neighbor Access Points seen by the station as defined IEEE 802.11-2016 [8]. rssi: $ref: '#/components/schemas/Rssi' staDataRate: @@ -2659,494 +2309,327 @@ components: staId: $ref: '#/components/schemas/StaIdentity' staStatistics: - description: >- - Statistics as defined in IEEE 802.11-2016 [8] for the client station - collected over measurement duration. - items: - $ref: '#/components/schemas/StaStatistics' minItems: 0 type: array - x-etsi-mec-cardinality: 0..N - x-etsi-mec-origin-type: StaStatistics + items: + $ref: '#/components/schemas/StaStatistics' + description: Statistics as defined in IEEE 802.11-2016 [8] for the client station collected over measurement duration. timeStamp: $ref: '#/components/schemas/TimeStamp' + StaStatistics: + title: StaStatistics required: - - staId + - groupIdentity + - measurementDuration + - measurementId type: object - x-etsi-ref: 6.2.3 - StaStatistics: properties: group2to9Data: $ref: '#/components/schemas/StaStatisticsGroup2to9Data' groupIdentity: - description: "Indicates the requested statistics group describing the Statistics Group Data according to Table 9-114 of IEEE\_802.11-2016 [8].\nDepending on group identity, one and only one of the STA Statistics Group Data will be present." - format: uint8 type: integer - x-etsi-mec-cardinality: '1' - x-etsi-mec-origin-type: UInt8 + description: >- + Indicates the requested statistics group describing the Statistics Group Data according to Table 9-114 of IEEE 802.11-2016 [8]. + + Depending on group identity, one and only one of the STA Statistics Group Data will be present. + contentEncoding: int32 groupOneData: $ref: '#/components/schemas/StaStatisticsGroupOneData' groupZeroData: $ref: '#/components/schemas/StaStatisticsGroupZeroData' measurementDuration: - description: >- - Duration over which the Statistics Group Data was measured in time - units of 1 024 µs. Duration equal to zero indicates a report of - current values. - format: uint16 type: integer - x-etsi-mec-cardinality: '1' - x-etsi-mec-origin-type: UInt16 + description: Duration over which the Statistics Group Data was measured in time units of 1 024 µs. Duration equal to zero indicates a report of current values. + contentEncoding: int32 measurementId: - description: >- - Measurement ID of the Measurement configuration applied to this STA - Statistics Report. type: string - x-etsi-mec-cardinality: '1' - x-etsi-mec-origin-type: String + description: Measurement ID of the Measurement configuration applied to this STA Statistics Report. staId: $ref: '#/components/schemas/StaIdentity' + StaStatisticsConfig: + title: StaStatisticsConfig required: - - measurementId - - measurementDuration - - groupIdentity + - groupIdentity + - triggeredReport type: object - x-etsi-ref: 6.5.13 - StaStatisticsConfig: properties: groupIdentity: - description: 'As per Table 9-92 of IEEE 802.11-2016 [8].' - format: uint8 type: integer - x-etsi-mec-cardinality: '1' - x-etsi-mec-origin-type: Uint8 + description: As per Table 9-92 of IEEE 802.11-2016 [8]. + contentEncoding: int32 measurementCount: + type: integer description: >- Valid if triggeredReport = true. - Specifies the number of MAC service data units or protocol data - units to determine if the trigger conditions are met. - format: uint32 - type: integer - x-etsi-mec-cardinality: 0..1 - x-etsi-mec-origin-type: Uint32 + Specifies the number of MAC service data units or protocol data units to determine if the trigger conditions are met. + contentEncoding: int32 triggerCondition: $ref: '#/components/schemas/STACounterTriggerCondition' triggerTimeout: + type: integer description: >- Valid if triggeredReport = true. - The Trigger Timeout field contains a value in units of 100 - time-units of 1 024 µs during which a measuring STA does not - generate further triggered STA Statistics Reports after a trigger - condition has been met. - format: uint16 - type: integer - x-etsi-mec-cardinality: 0..1 - x-etsi-mec-origin-type: Uint16 + The Trigger Timeout field contains a value in units of 100 time-units of 1 024 µs during which a measuring STA does not generate further triggered STA Statistics Reports after a trigger condition has been met. + contentEncoding: int32 triggeredReport: - description: 'True = triggered reporting, otherwise duration.' type: boolean - x-etsi-mec-cardinality: '1' - x-etsi-mec-origin-type: Boolean + description: True = triggered reporting, otherwise duration. + StaStatisticsGroup2to9Data: + title: StaStatisticsGroup2to9Data required: - - groupIdentity - - triggeredReport + - qosAckFailureCount + - qosDiscardedFrameCount + - qosFailedCount + - qosFrameDuplicateCount + - qosMPDUsReceivedCount + - qosMultipleRetryCount + - qosRTSFailureCount + - qosRTSSuccessCount + - qosReceivedFragmentCount + - qosRetriesReceivedCount + - qosRetryCount + - qosTransmittedFragmentCount + - qosTransmittedFrameCount type: object - x-etsi-ref: 6.5.26 - StaStatisticsGroup2to9Data: properties: qosAckFailureCount: - description: dot11QosAckFailureCount counter - format: uint32 type: integer - x-etsi-mec-cardinality: '1' - x-etsi-mec-origin-type: Uint32 + description: dot11QosAckFailureCount counter + contentEncoding: int32 qosDiscardedFrameCount: - description: dot11QosDiscardedFrameCount counter - format: uint32 type: integer - x-etsi-mec-cardinality: '1' - x-etsi-mec-origin-type: Uint32 + description: dot11QosDiscardedFrameCount counter + contentEncoding: int32 qosFailedCount: - description: dot11QosFailedCount counter - format: uint32 type: integer - x-etsi-mec-cardinality: '1' - x-etsi-mec-origin-type: Uint32 + description: dot11QosFailedCount counter + contentEncoding: int32 qosFrameDuplicateCount: - description: dot11QosFrameDuplicateCount counter - format: uint32 type: integer - x-etsi-mec-cardinality: '1' - x-etsi-mec-origin-type: Uint32 + description: dot11QosFrameDuplicateCount counter + contentEncoding: int32 qosMPDUsReceivedCount: - description: dot11QosMPDUsReceivedCount counter - format: uint32 type: integer - x-etsi-mec-cardinality: '1' - x-etsi-mec-origin-type: Uint32 + description: dot11QosMPDUsReceivedCount counter + contentEncoding: int32 qosMultipleRetryCount: - description: dot11QosMultipleRetryCount counter - format: uint32 type: integer - x-etsi-mec-cardinality: '1' - x-etsi-mec-origin-type: Uint32 + description: dot11QosMultipleRetryCount counter + contentEncoding: int32 qosRTSFailureCount: - description: dot11QosRTSFailureCount counter - format: uint32 type: integer - x-etsi-mec-cardinality: '1' - x-etsi-mec-origin-type: Uint32 + description: dot11QosRTSFailureCount counter + contentEncoding: int32 qosRTSSuccessCount: - description: dot11QosRTSSuccessCount counter - format: uint32 type: integer - x-etsi-mec-cardinality: '1' - x-etsi-mec-origin-type: Uint32 + description: dot11QosRTSSuccessCount counter + contentEncoding: int32 qosReceivedFragmentCount: - description: dot11QosReceivedFragmentCount counter - format: uint32 type: integer - x-etsi-mec-cardinality: '1' - x-etsi-mec-origin-type: Uint32 + description: dot11QosReceivedFragmentCount counter + contentEncoding: int32 qosRetriesReceivedCount: - description: dot11QosRetriesReceivedCount counter - format: uint32 type: integer - x-etsi-mec-cardinality: '1' - x-etsi-mec-origin-type: Uint32 + description: dot11QosRetriesReceivedCount counter + contentEncoding: int32 qosRetryCount: - description: dot11QosRetryCount counter - format: uint32 type: integer - x-etsi-mec-cardinality: '1' - x-etsi-mec-origin-type: Uint32 + description: dot11QosRetryCount counter + contentEncoding: int32 qosTransmittedFragmentCount: - description: dot11QosTransmittedFragmentCount counter - format: uint32 type: integer - x-etsi-mec-cardinality: '1' - x-etsi-mec-origin-type: Uint32 + description: dot11QosTransmittedFragmentCount counter + contentEncoding: int32 qosTransmittedFrameCount: - description: dot11QosTransmittedFrameCount counter - format: uint32 type: integer - x-etsi-mec-cardinality: '1' - x-etsi-mec-origin-type: Uint32 + description: dot11QosTransmittedFrameCount counter + contentEncoding: int32 reportingReasonQoSCounters: $ref: '#/components/schemas/ReportingReasonQoSCounters' + StaStatisticsGroupOneData: + title: StaStatisticsGroupOneData required: - - qosTransmittedFragmentCount - - qosFailedCount - - qosRetryCount - - qosMultipleRetryCount - - qosFrameDuplicateCount - - qosRTSSuccessCount - - qosRTSFailureCount - - qosAckFailureCount - - qosReceivedFragmentCount - - qosTransmittedFrameCount - - qosDiscardedFrameCount - - qosMPDUsReceivedCount - - qosRetriesReceivedCount + - ackFailureCount + - frameDuplicateCount + - multipleRetryCount + - retryCount + - rtsFailureCount + - rtsSuccessCount type: object - x-etsi-ref: 6.5.36 - StaStatisticsGroupOneData: properties: ackFailureCount: - description: dot11AckFailureCount counter - format: uint32 type: integer - x-etsi-mec-cardinality: '1' - x-etsi-mec-origin-type: Uint32 + description: dot11AckFailureCount counter + contentEncoding: int32 frameDuplicateCount: - description: dot11FrameDuplicateCount counter - format: uint32 type: integer - x-etsi-mec-cardinality: '1' - x-etsi-mec-origin-type: Uint32 + description: dot11FrameDuplicateCount counter + contentEncoding: int32 multipleRetryCount: - description: dot11MultipleRetryCount counter - format: uint32 type: integer - x-etsi-mec-cardinality: '1' - x-etsi-mec-origin-type: Uint32 + description: dot11MultipleRetryCount counter + contentEncoding: int32 reportingReasonStaCounters: $ref: '#/components/schemas/ReportingReasonStaCounters' retryCount: - description: dot11RetryCount counter - format: uint32 type: integer - x-etsi-mec-cardinality: '1' - x-etsi-mec-origin-type: Uint32 + description: dot11RetryCount counter + contentEncoding: int32 rtsFailureCount: - description: dot11RTSFailureCount counter - format: uint32 type: integer - x-etsi-mec-cardinality: '1' - x-etsi-mec-origin-type: Uint32 + description: dot11RTSFailureCount counter + contentEncoding: int32 rtsSuccessCount: - description: dot11RTSSuccessCount counter - format: uint32 type: integer - x-etsi-mec-cardinality: '1' - x-etsi-mec-origin-type: Uint32 + description: dot11RTSSuccessCount counter + contentEncoding: int32 + StaStatisticsGroupZeroData: + title: StaStatisticsGroupZeroData required: - - retryCount - - multipleRetryCount - - frameDuplicateCount - - rtsSuccessCount - - rtsFailureCount - - ackFailureCount + - failedCount + - fcsErrorCount + - groupReceivedFrameCount + - groupTransmittedFrameCount + - receivedFragmentCount + - transmittedFragmentCount + - transmittedFrameCount type: object - x-etsi-ref: 6.5.35 - StaStatisticsGroupZeroData: properties: failedCount: - description: dot11FailedCount counter - format: uint32 type: integer - x-etsi-mec-cardinality: '1' - x-etsi-mec-origin-type: Uint32 + description: dot11FailedCount counter + contentEncoding: int32 fcsErrorCount: - description: dot11FCSErrorCount counter - format: uint32 type: integer - x-etsi-mec-cardinality: '1' - x-etsi-mec-origin-type: Uint32 + description: dot11FCSErrorCount counter + contentEncoding: int32 groupReceivedFrameCount: - description: dot11GroupReceivedFrameCount counter - format: uint32 type: integer - x-etsi-mec-cardinality: '1' - x-etsi-mec-origin-type: Uint32 + description: dot11GroupReceivedFrameCount counter + contentEncoding: int32 groupTransmittedFrameCount: - description: dot11GroupTransmittedFrameCount counter - format: uint32 type: integer - x-etsi-mec-cardinality: '1' - x-etsi-mec-origin-type: Uint32 + description: dot11GroupTransmittedFrameCount counter + contentEncoding: int32 receivedFragmentCount: - description: dot11ReceivedFragmentCount counter - format: uint32 type: integer - x-etsi-mec-cardinality: '1' - x-etsi-mec-origin-type: Uint32 + description: dot11ReceivedFragmentCount counter + contentEncoding: int32 reportingReasonStaCounters: $ref: '#/components/schemas/ReportingReasonStaCounters' transmittedFragmentCount: - description: dot11TransmittedFragmentCount counter - format: uint32 type: integer - x-etsi-mec-cardinality: '1' - x-etsi-mec-origin-type: Uint32 + description: dot11TransmittedFragmentCount counter + contentEncoding: int32 transmittedFrameCount: - description: dot11TransmittedFrameCount counter - format: uint32 type: integer - x-etsi-mec-cardinality: '1' - x-etsi-mec-origin-type: Uint32 + description: dot11TransmittedFrameCount counter + contentEncoding: int32 + SubscriptionLinkList: + title: SubscriptionLinkList required: - - transmittedFragmentCount - - groupTransmittedFrameCount - - failedCount - - receivedFragmentCount - - groupReceivedFrameCount - - fcsErrorCount - - transmittedFrameCount + - _links type: object - x-etsi-ref: 6.5.34 - SubscriptionLinkList: properties: _links: - description: List of hyperlinks related to the resource. - properties: - self: - $ref: '#/components/schemas/LinkType' - required: - - self - type: object - x-etsi-mec-cardinality: '1' - x-etsi-mec-origin-type: Structure (inlined) + $ref: '#/components/schemas/Links6' subscription: - description: '' - items: - minItems: 0 - properties: - href: - description: The URI referring to the subscription. - format: uri - type: string - x-etsi-mec-cardinality: '1' - x-etsi-mec-origin-type: URI - subscriptionType: - description: >- - Type of the subscription. The string shall be set according to - the "subscriptionType" attribute of the associated - subscription data type defined in 6.3.2, 6.3.3. and 6.3.5: - - “AssocStaSubscription” - - “StaDataRateSubscription” - - “MeasurementReportSubscription” - type: string - x-etsi-mec-cardinality: '1' - x-etsi-mec-origin-type: String - required: - - href - - subscriptionType - type: object type: array - x-etsi-mec-cardinality: 0..N - x-etsi-mec-origin-type: Structure (inlined) + items: + $ref: '#/components/schemas/Subscription' + description: '' + TestNotification: + title: TestNotification required: - - _links + - _links + - notificationType type: object - x-etsi-ref: 6.3.4 - TestNotification: properties: _links: - description: 'Hyperlink related to the resource. ' - properties: - subscription: - $ref: '#/components/schemas/LinkType' - required: - - subscription - type: object - x-etsi-mec-cardinality: '1' - x-etsi-mec-origin-type: Structure (inlined) + $ref: '#/components/schemas/Links1' notificationType: - description: Shall be set to "TestNotification". type: string - x-etsi-mec-cardinality: '1' - x-etsi-mec-origin-type: String + description: Shall be set to "TestNotification". + TimeStamp: + title: TimeStamp required: - - notificationType - - _links + - nanoSeconds + - seconds type: object - x-etsi-ref: 6.4.6 - 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 + description: The nanoseconds part of the time. Time is defined as Unix-time since January 1, 1970, 00:00:00 UTC. + contentEncoding: int32 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 + description: The seconds part of the time. Time is defined as Unixtime since January 1, 1970, 00:00:00 UTC. + contentEncoding: int32 + VhtCapabilities: + title: VhtCapabilities required: - - seconds - - nanoSeconds + - vhtCapInfo + - vhtMcsNss 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 + description: VHT capabilities Info as defined in IEEE 802.11-2016 [8]. + contentEncoding: int32 vhtMcsNss: - description: 'Supported VHT-MCS and NSS Set as defined in IEEE 802.11-2016 [8].' - format: uint64 type: integer - x-etsi-mec-cardinality: '1' - x-etsi-mec-origin-type: UInt64 + description: Supported VHT-MCS and NSS Set as defined in IEEE 802.11-2016 [8]. + contentEncoding: int32 + WanMetrics: + title: WanMetrics required: - - vhtCapInfo - - vhtMcsNss + - downlinkLoad + - downlinkSpeed + - lmd + - uplinkLoad + - uplinkSpeed + - wanInfo 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 + 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. + contentEncoding: int32 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 + description: 4-octet positive integer whose value is an estimate of the WAN Backhaul link current downlink speed in kilobits per second. + contentEncoding: int32 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 + 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. + contentEncoding: int32 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 + 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. + contentEncoding: int32 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 + description: 4-octet positive integer whose value is an estimate of the WAN Backhaul link's current uplink speed in kilobits per second. + contentEncoding: int32 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 + description: Info about WAN link status, link symmetricity and capacity currently used. + contentEncoding: int32 WebsockNotifConfig: + title: WebsockNotifConfig + type: object properties: requestWebsocketUri: - description: >- - Set to true by the service consumer to indicate that Websocket - delivery is requested. type: boolean - x-etsi-mec-cardinality: 0..1 - x-etsi-mec-origin-type: Boolean + description: Set to true by the service consumer to indicate that Websocket delivery is requested. websocketUri: - description: >- - Set by WAIS to indicate to the service consumer the - Websocket URI to be used for delivering notifications. type: string - type: object - x-etsi-ref: 6.3.6 + description: Set by WAIS to indicate to the service consumer the Websocket URI to be used for delivering notifications. WlanCapabilities: + title: WlanCapabilities + type: object properties: dmg: $ref: '#/components/schemas/DmgCapabilities' @@ -3158,5 +2641,184 @@ components: $ref: '#/components/schemas/HtCapabilities' vht: $ref: '#/components/schemas/VhtCapabilities' + InlineNotification: + title: InlineNotification + required: + - notificationType + type: object + properties: + notificationType: + type: string + discriminator: + propertyName: notificationType + mapping: + AssocStaNotification: AssocStaNotification + MeasurementReportNotification: MeasurementReportNotification + StaDataRateNotification: StaDataRateNotification + InlineSubscription: + title: InlineSubscription + required: + - subscriptionType + type: object + properties: + subscriptionType: + type: string + discriminator: + propertyName: subscriptionType + mapping: + AssocStaSubscription: AssocStaSubscription + MeasurementReportSubscription: MeasurementReportSubscription + StaDataRateSubscription: StaDataRateSubscription + Links: + title: Links + required: + - self + type: object + properties: + self: + $ref: '#/components/schemas/LinkType' + description: Hyperlink related to the resource. This shall be only included in the HTTP responses and in HTTP PUT requests. + Links1: + title: Links1 + required: + - subscription + type: object + properties: + subscription: + $ref: '#/components/schemas/LinkType' + description: Hyperlink related to the resource. + Links4: + title: Links4 + required: + - self + type: object + properties: + self: + $ref: '#/components/schemas/LinkType' + description: Hyperlink related to the resource. + Links6: + title: Links6 + required: + - self + type: object + properties: + self: + $ref: '#/components/schemas/LinkType' + description: List of hyperlinks related to the resource. + MeasurementConfig1: + title: MeasurementConfig1 + required: + - href + - measurementId + type: object + properties: + href: + type: string + description: The URI referring to a measurement configuration. + measurementId: + type: string + description: Unique identifier allocated by the service consumer to identify measurement reports associated with this measurement configuration. + NotificationEvent: + title: NotificationEvent + required: + - threshold + - trigger type: object - x-etsi-ref: 6.5.4 + properties: + threshold: + type: integer + description: Number of connected stations threshold for trigger-based event reporting. + contentEncoding: int32 + trigger: + $ref: '#/components/schemas/Trigger' + description: Set for trigger-based event notification reporting. + NotificationEvent1: + title: NotificationEvent1 + required: + - trigger + type: object + properties: + downlinkRateThreshold: + type: integer + description: Downlink data rate threshold for StaDataRate reporting. + contentEncoding: int32 + trigger: + $ref: '#/components/schemas/Trigger1' + uplinkRateThreshold: + type: integer + description: Uplink data rate threshold for StaDataRate reporting. + contentEncoding: int32 + description: Set for trigger-based event notification reporting. + Subscription: + title: Subscription + required: + - href + - subscriptionType + type: object + properties: + href: + type: string + description: The URI referring to the subscription. + subscriptionType: + type: string + description: >- + Type of the subscription. The string shall be set according to the "subscriptionType" attribute of the associated subscription data type defined in 6.3.2, 6.3.3. and 6.3.5: + + “AssocStaSubscription” + + “StaDataRateSubscription” + + “MeasurementReportSubscription” + Trigger: + title: Trigger + enum: + - 1 + - 2 + type: integer + description: >- + Trigger for the notification: + + 1 = Notification issued when the number of connected stations is greater than or equal to the threshold. + + 2 = Notification issued when the number of connected stations is less than or equal to the threshold. + examples: + - 1 + Trigger1: + title: Trigger1 + enum: + - 1 + - 2 + - 3 + - 4 + - 5 + - 6 + - 7 + - 8 + type: integer + description: >- + Trigger event for the notification: + + 1 = Notification issued when the STA's downlink data rate is greater than or equal to the downlink threshold. + + 2 = Notification issued when the STA's downlink data rate is less than or equal to the downlink threshold. + + 3 = Notification issued when the STA's uplink data rate is greater than or equal to the uplink threshold. + + 4 = Notification issued when the STA's uplink data rate is less than or equal to the uplink threshold. + + 5 = Notification issued when the STA's downlink and uplink data rate is greater than or equal to their thresholds. + + 6 = Notification issued when the STA's downlink and uplink data rate is less than or equal to their thresholds. + + 7 = Notification issued when the STA's downlink or uplink data rate is greater than or equal to their thresholds. + + 8 = Notification issued when the STA's downlink or uplink data rate is less than or equal to their thresholds. + examples: + - 1 +security: +- {} +tags: +- name: wai +externalDocs: + description: ETSI MEC028 V2.2.1 WLAN Information API + url: https://www.etsi.org/deliver/etsi_gs/MEC/001_099/028/02.02.01_60/gs_mec028v020201p.pdf -- GitLab From 82872ed8f2a25c747edc226cf2c19d9bd3b8680a Mon Sep 17 00:00:00 2001 From: piscione Date: Fri, 26 Nov 2021 13:13:48 +0100 Subject: [PATCH 3/5] Updated specifications: fix on examples, callback and minor. --- WlanInformationApi.yaml | 341 ++++++++++++++++++++++++++-------------- 1 file changed, 226 insertions(+), 115 deletions(-) diff --git a/WlanInformationApi.yaml b/WlanInformationApi.yaml index 804e875..8accbd5 100644 --- a/WlanInformationApi.yaml +++ b/WlanInformationApi.yaml @@ -5,16 +5,26 @@ info: contact: url: https://forge.etsi.org/rep/mec/gs028-wai-api version: '2.2.1' + license: + name: BSD-3-Clause + url: 'https://forge.etsi.org/legal-matters' jsonSchemaDialect: https://json-schema.org/draft/2020-12/schema servers: - url: https://localhost/wai/v2 variables: {} +externalDocs: + description: ETSI MEC028 V2.2.1 WLAN Information API + url: https://www.etsi.org/deliver/etsi_gs/MEC/001_099/028/02.02.01_60/gs_mec028v020201p.pdf + +tags: +- name: wai + paths: /queries/ap/ap_information: get: tags: - wai - summary: apInfoGET + summary: 'Queries information about existing WLAN Access Points' description: Queries information about existing WLAN Access Points operationId: apInfoGET parameters: @@ -119,7 +129,7 @@ paths: get: tags: - wai - summary: staInfoGET + summary: 'Queries information about existing WLAN stations' description: Queries information about existing WLAN stations operationId: staInfoGET parameters: @@ -224,7 +234,7 @@ paths: get: tags: - wai - summary: subscriptionLinkList_subscriptionsGET + summary: 'Queries information on subscriptions for notifications' description: Queries information on subscriptions for notifications operationId: subscriptionLinkList_subscriptionsGET parameters: @@ -243,6 +253,15 @@ paths: application/json: schema: $ref: '#/components/schemas/SubscriptionLinkList' + examples: + example-of-subscription-link-list: + value: + _links: + self: + href: 'http://meAppServer.example.com/wai/v2/subscriptions' + subscription: + - href: http://meAppServer.example.com/wai/v2/subscriptions/sub123 + subscriptionType: AssocStaSubscription '400': description: 'Bad Request : used to indicate that incorrect parameters were passed to the request.' headers: {} @@ -289,7 +308,7 @@ paths: post: tags: - wai - summary: subscriptionsPOST + summary: 'Creates a new subscription to WLAN Access Information notifications' description: Creates a new subscription to WLAN Access Information notifications operationId: subscriptionsPOST parameters: [] @@ -316,18 +335,20 @@ paths: ipAddress: - 10.10.100.1 contentMediaType: application/json - example: - subscriptionType: AssocStaSubscription - callbackReference: http://meAppClient.example.com/wai/v2/notifications/1 - expiryDeadline: - seconds: 1977836800 - nanoSeconds: 0 - apId: - bssid: 005C0A0A0A0A - ssid: - - myNetworkSsid - ipAddress: - - 10.10.100.1 + examples: + example-of-AssocStaSubscription: + value: + subscriptionType: AssocStaSubscription + callbackReference: http://meAppClient.example.com/wai/v2/notifications/1 + expiryDeadline: + seconds: 1977836800 + nanoSeconds: 0 + apId: + bssid: 005C0A0A0A0A + ssid: + - myNetworkSsid + ipAddress: + - 10.10.100.1 required: true responses: '201': @@ -356,21 +377,23 @@ paths: ipAddress: - 10.10.100.1 contentMediaType: application/json - 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: - bssid: 005C0A0A0A0A - ssid: - - myNetworkSsid - ipAddress: - - 10.10.100.1 + examples: + example-of-assoc--sta-subscription: + value: + 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: + bssid: 005C0A0A0A0A + ssid: + - myNetworkSsid + ipAddress: + - 10.10.100.1 '400': description: 'Bad Request : used to indicate that incorrect parameters were passed to the request.' headers: {} @@ -420,13 +443,14 @@ paths: application/problem+json: schema: $ref: '#/components/schemas/ProblemDetails' - example: + examples: 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 + value: + 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.' headers: {} @@ -435,12 +459,52 @@ paths: schema: $ref: '#/components/schemas/ProblemDetails' deprecated: false + 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' + examples: + example-assoc-sta-notification: + value: + notificationType: AssocStaNotification + timeStamp: + seconds: 1977836800 + nanoSeconds: 0 + apId: + bssid: 005C0A0A0A0A + ssid: + - myNetworkSsid + ipAddress: + - 10.10.100.1 + staId: + macId: 005C01111111 + ssid: + - myNetworkSsid + - myOtherNetworkSsid + aid: '1122' + ipAddress: + - 10.10.1.255 + responses: + '204': + description: "No content" + + parameters: [] /subscriptions/{subscriptionId}: get: tags: - wai - summary: subscriptionsGET + summary: 'Queries information about an existing subscription, identified by its self-referring URI returned on creation (initial POST)' description: Queries information about an existing subscription, identified by its self-referring URI returned on creation (initial POST) operationId: subscriptionsGET parameters: @@ -478,21 +542,23 @@ paths: ipAddress: - 10.10.100.1 contentMediaType: application/json - 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: - bssid: 005C0A0A0A0A - ssid: - - myNetworkSsid - ipAddress: - - 10.10.100.1 + examples: + example-of-assoc-sta-subscription: + value: + 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: + bssid: 005C0A0A0A0A + ssid: + - myNetworkSsid + ipAddress: + - 10.10.100.1 '400': description: 'Bad Request : used to indicate that incorrect parameters were passed to the request.' headers: {} @@ -539,7 +605,7 @@ paths: put: tags: - wai - summary: subscriptionsPUT + summary: 'Updates an existing subscription, identified by its self-referring URI returned on creation (initial POST)' description: Updates an existing subscription, identified by its self-referring URI returned on creation (initial POST) operationId: subscriptionsPUT parameters: @@ -576,21 +642,24 @@ paths: ipAddress: - 10.10.100.1 contentMediaType: application/json - 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: - bssid: 005C0A0A0A0A - ssid: - - myNetworkSsid - ipAddress: - - 10.10.100.1 + examples: + example-of-assoc-sta-subscription: + value: + + 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: + bssid: 005C0A0A0A0A + ssid: + - myNetworkSsid + ipAddress: + - 10.10.100.1 required: true responses: '200': @@ -615,17 +684,20 @@ paths: ipAddress: - 10.10.100.1 contentMediaType: application/json - example: - _links: - self: + examples: + example-sub-type: + value: + subscriptionType: "AssocStaSubscription" + _links: + self: href: http://[hostIP]/sbox-xyz123/wai/v2/subscriptions/sub123 - callbackReference: http://my.callback.com/wai/some-id - apId: - bssid: 005C0A0A0A0A - ssid: - - myNetworkSsid - ipAddress: - - 10.10.100.1 + callbackReference: http://my.callback.com/wai/some-id + apId: + bssid: 005C0A0A0A0A + ssid: + - myNetworkSsid + ipAddress: + - 10.10.100.1 '400': description: 'Bad Request : used to indicate that incorrect parameters were passed to the request.' headers: {} @@ -675,13 +747,14 @@ paths: application/problem+json: schema: $ref: '#/components/schemas/ProblemDetails' - example: + examples: 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 + value: + 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.' headers: {} @@ -693,7 +766,7 @@ paths: delete: tags: - wai - summary: subscriptionsDELETE + summary: 'Cancels an existing subscription, identified by its self-referring URI returned on creation (initial POST)' description: Cancels an existing subscription, identified by its self-referring URI returned on creation (initial POST) operationId: subscriptionsDELETE parameters: @@ -743,7 +816,7 @@ paths: get: tags: - wai - summary: measurementLinkList_measurementsGET + summary: 'Queries information on measurements configuration' description: Queries information on measurements configuration operationId: measurementLinkList_measurementsGET parameters: [] @@ -755,13 +828,15 @@ paths: application/json: schema: $ref: '#/components/schemas/MeasurementConfigLinkList' - example: - _links: - self: - href: http://meAppServer.example.com/wai/v2/measurements - measurementConfig: - - href: http://meAppServer.example.com/wai/v2/measurements/meas123 - measurementId: myId1 + examples: + example-measurement: + value: + _links: + self: + href: http://meAppServer.example.com/wai/v2/measurements + measurementConfig: + - href: http://meAppServer.example.com/wai/v2/measurements/meas123 + measurementId: myId1 '400': description: 'Bad Request : used to indicate that incorrect parameters were passed to the request.' headers: {} @@ -808,7 +883,7 @@ paths: post: tags: - wai - summary: measurementsPOST + summary: 'Creates a new measurement configuration' description: Creates a new measurement configuration operationId: measurementsPOST parameters: [] @@ -818,6 +893,16 @@ paths: application/json: schema: $ref: '#/components/schemas/MeasurementConfig' + examples: + example-body: + value: + staId: + - macId: 005C01111111 + ssid: + - myNetworkSsid + - myOtherNetworkSsid + measurementId: myId1 + measurementInfo: {} required: true responses: '201': @@ -827,6 +912,19 @@ paths: application/json: schema: $ref: '#/components/schemas/MeasurementConfig' + examples: + example-response: + value: + _links: + self: + href: 'http://meAppServer.example.com/wai/v2/measurements/meas123' + staId: + - macId: 005C01111111 + ssid: + - myNetworkSsid + - myOtherNetworkSsid + measurementId: myId1 + measurementInfo: {} '400': description: 'Bad Request : used to indicate that incorrect parameters were passed to the request.' headers: {} @@ -876,13 +974,14 @@ paths: application/problem+json: schema: $ref: '#/components/schemas/ProblemDetails' - example: + examples: 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 + value: + 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.' headers: {} @@ -896,7 +995,7 @@ paths: get: tags: - wai - summary: measurementsGET + summary: 'Queries information about an existing measurement configuration, identified by its self-referring URI returned on creation (initial POST)' description: Queries information about an existing measurement configuration, identified by its self-referring URI returned on creation (initial POST) operationId: measurementsGET parameters: @@ -915,6 +1014,21 @@ paths: application/json: schema: $ref: '#/components/schemas/MeasurementConfig' + + examples: + response-example: + value: + _links: + self: + href: 'http://meAppServer.example.com/wai/v2/measurements/meas123' + staId: + - macId: 005C01111111 + ssid: + - myNetworkSsid + - myOtherNetworkSsid + measurementId: myId1 + measurementInfo: {} + '400': description: 'Bad Request : used to indicate that incorrect parameters were passed to the request.' headers: {} @@ -961,7 +1075,7 @@ paths: put: tags: - wai - summary: measurementsPUT + summary: 'Updates an existing measurement configuration, identified by its self-referring URI returned on creation (initial POST)' description: Updates an existing measurement configuration, identified by its self-referring URI returned on creation (initial POST) operationId: measurementsPUT parameters: @@ -1036,13 +1150,14 @@ paths: application/problem+json: schema: $ref: '#/components/schemas/ProblemDetails' - example: + examples: 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 + value: + 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.' headers: {} @@ -1054,7 +1169,7 @@ paths: delete: tags: - wai - summary: measurementsDELETE + summary: 'Cancels an existing measurement configuration, identified by its self-referring URI returned on creation (initial POST)' description: Cancels an existing measurement configuration, identified by its self-referring URI returned on creation (initial POST) operationId: measurementsDELETE parameters: @@ -2817,8 +2932,4 @@ components: - 1 security: - {} -tags: -- name: wai -externalDocs: - description: ETSI MEC028 V2.2.1 WLAN Information API - url: https://www.etsi.org/deliver/etsi_gs/MEC/001_099/028/02.02.01_60/gs_mec028v020201p.pdf + -- GitLab From 056f8c6de7b970c6eb0307f48b24268ea2175c36 Mon Sep 17 00:00:00 2001 From: piscione Date: Thu, 2 Dec 2021 19:48:24 +0100 Subject: [PATCH 4/5] Update JSON version of OAS3.1.0. --- WlanInformationApi.json | 4626 +++++++++++++++++++++------------------ 1 file changed, 2476 insertions(+), 2150 deletions(-) diff --git a/WlanInformationApi.json b/WlanInformationApi.json index cdbf80a..9dedba9 100644 --- a/WlanInformationApi.json +++ b/WlanInformationApi.json @@ -1,26 +1,28 @@ { - "openapi": "3.0.0", + "openapi": "3.1.0", "info": { + "title": "ETSI GS MEC 028 - WLAN Access Information API", + "description": "The ETSI MEC ISG MEC028 WLAN Access Information API described using OpenAPI", "contact": { "url": "https://forge.etsi.org/rep/mec/gs028-wai-api" }, - "title": "ETSI GS MEC 028 - WLAN Access Information API", "version": "2.2.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.2.1 WLAN Information API", - "url": "https://www.etsi.org/deliver/etsi_gs/MEC/001_099/028/02.02.01_60/gs_mec028v020201p.pdf" - }, + "jsonSchemaDialect": "https://json-schema.org/draft/2020-12/schema", "servers": [ { - "url": "https://localhost/wai/v2" + "url": "https://localhost/wai/v2", + "variables": {} } ], + "externalDocs": { + "description": "ETSI MEC028 V2.2.1 WLAN Information API", + "url": "https://www.etsi.org/deliver/etsi_gs/MEC/001_099/028/02.02.01_60/gs_mec028v020201p.pdf" + }, "tags": [ { "name": "wai" @@ -32,276 +34,678 @@ "tags": [ "wai" ], - "summary": "Retrieve information on existing Access Points", + "summary": "Queries information about existing WLAN Access Points", "description": "Queries information about existing WLAN Access Points", "operationId": "apInfoGET", "parameters": [ { - "$ref": "#/components/parameters/Query.Filter" + "name": "filter", + "in": "query", + "description": "Attribute-based filtering expression according to clause 6.19 of ETSI GS MEC 009. .", + "style": "form", + "explode": true, + "schema": { + "type": "string" + } }, { - "$ref": "#/components/parameters/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.", + "style": "form", + "explode": true, + "schema": { + "type": "string" + } }, { - "$ref": "#/components/parameters/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.", + "style": "form", + "explode": true, + "schema": { + "type": "array", + "items": { + "type": "string" + } + } }, { - "$ref": "#/components/parameters/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.", + "style": "form", + "explode": true, + "schema": { + "type": "array", + "items": { + "type": "string" + } + } }, { - "$ref": "#/components/parameters/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", + "style": "form", + "explode": true, + "schema": { + "type": "array", + "items": { + "type": "string" + } + } } ], "responses": { "200": { "description": "Successful response to ap_info request", + "headers": {}, "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ApInfo" - } + }, + "description": "", + "contentMediaType": "application/json" } } } }, "400": { - "$ref": "#/components/responses/400" + "description": "Bad Request : used to indicate that incorrect parameters were passed to the request.", + "headers": {}, + "content": { + "application/problem+json": { + "schema": { + "$ref": "#/components/schemas/ProblemDetails" + } + } + } }, "401": { - "$ref": "#/components/responses/401" + "description": "Unauthorized : used when the client did not submit credentials.", + "headers": {}, + "content": { + "application/problem+json": { + "schema": { + "$ref": "#/components/schemas/ProblemDetails" + } + } + } }, "403": { - "$ref": "#/components/responses/403" + "description": "Forbidden : operation is not allowed given the current status of the resource.", + "headers": {}, + "content": { + "application/problem+json": { + "schema": { + "$ref": "#/components/schemas/ProblemDetails" + } + } + } }, "404": { - "$ref": "#/components/responses/404" + "description": "Not Found : used when a client provided a URI that cannot be mapped to a valid resource URI.", + "headers": {}, + "content": { + "application/problem+json": { + "schema": { + "$ref": "#/components/schemas/ProblemDetails" + } + } + } }, "406": { - "$ref": "#/components/responses/406" + "description": "Not Acceptable : used to indicate that the server cannot provide the any of the content formats supported by the client.", + "headers": {}, + "content": { + "application/problem+json": { + "schema": { + "$ref": "#/components/schemas/ProblemDetails" + } + } + } }, "429": { - "$ref": "#/components/responses/429" + "description": "Too Many Requests : used when a rate limiter has triggered.", + "headers": {}, + "content": { + "application/problem+json": { + "schema": { + "$ref": "#/components/schemas/ProblemDetails" + } + } + } } - } - } + }, + "deprecated": false + }, + "parameters": [] }, "/queries/sta/sta_information": { "get": { "tags": [ "wai" ], - "summary": "Retrieve information on existing Stations", + "summary": "Queries information about existing WLAN stations", "description": "Queries information about existing WLAN stations", "operationId": "staInfoGET", "parameters": [ { - "$ref": "#/components/parameters/Query.Filter" + "name": "filter", + "in": "query", + "description": "Attribute-based filtering expression according to clause 6.19 of ETSI GS MEC 009. .", + "style": "form", + "explode": true, + "schema": { + "type": "string" + } }, { - "$ref": "#/components/parameters/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.", + "style": "form", + "explode": true, + "schema": { + "type": "string" + } }, { - "$ref": "#/components/parameters/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.", + "style": "form", + "explode": true, + "schema": { + "type": "array", + "items": { + "type": "string" + } + } }, { - "$ref": "#/components/parameters/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.", + "style": "form", + "explode": true, + "schema": { + "type": "array", + "items": { + "type": "string" + } + } }, { - "$ref": "#/components/parameters/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", + "style": "form", + "explode": true, + "schema": { + "type": "array", + "items": { + "type": "string" + } + } } ], "responses": { "200": { "description": "Successful response to sta_info request", + "headers": {}, "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/StaInfo" - } + }, + "description": "", + "contentMediaType": "application/json" } } } }, "400": { - "$ref": "#/components/responses/400" + "description": "Bad Request : used to indicate that incorrect parameters were passed to the request.", + "headers": {}, + "content": { + "application/problem+json": { + "schema": { + "$ref": "#/components/schemas/ProblemDetails" + } + } + } }, "401": { - "$ref": "#/components/responses/401" + "description": "Unauthorized : used when the client did not submit credentials.", + "headers": {}, + "content": { + "application/problem+json": { + "schema": { + "$ref": "#/components/schemas/ProblemDetails" + } + } + } }, "403": { - "$ref": "#/components/responses/403" + "description": "Forbidden : operation is not allowed given the current status of the resource.", + "headers": {}, + "content": { + "application/problem+json": { + "schema": { + "$ref": "#/components/schemas/ProblemDetails" + } + } + } }, "404": { - "$ref": "#/components/responses/404" + "description": "Not Found : used when a client provided a URI that cannot be mapped to a valid resource URI.", + "headers": {}, + "content": { + "application/problem+json": { + "schema": { + "$ref": "#/components/schemas/ProblemDetails" + } + } + } }, "406": { - "$ref": "#/components/responses/406" + "description": "Not Acceptable : used to indicate that the server cannot provide the any of the content formats supported by the client.", + "headers": {}, + "content": { + "application/problem+json": { + "schema": { + "$ref": "#/components/schemas/ProblemDetails" + } + } + } }, "429": { - "$ref": "#/components/responses/429" + "description": "Too Many Requests : used when a rate limiter has triggered.", + "headers": {}, + "content": { + "application/problem+json": { + "schema": { + "$ref": "#/components/schemas/ProblemDetails" + } + } + } } - } - } + }, + "deprecated": false + }, + "parameters": [] }, "/subscriptions": { "get": { "tags": [ "wai" ], - "summary": "Retrieve information on subscriptions for notifications", + "summary": "Queries information on subscriptions for notifications", "description": "Queries information on subscriptions for notifications", "operationId": "subscriptionLinkList_subscriptionsGET", "parameters": [ { - "$ref": "#/components/parameters/Query.SubscriptionType" + "name": "subscription_type", + "in": "query", + "description": "Filter on a specific subscription type. Permitted values: assoc_sta, sta_data_rate, measure_report.", + "style": "form", + "explode": true, + "schema": { + "type": "string" + } } ], "responses": { "200": { "description": "Response body contains the list of links to requestors subscriptions.", + "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SubscriptionLinkList" }, - "example": { - "_links": { - "self": { - "href": "http://meAppServer.example.com/wai/v2/subscriptions" - } - }, - "subscription": [ - { + "examples": { + "example-of-subscription-link-list": { + "value": { "_links": { "self": { - "href": "http://meAppServer.example.com/wai/v2/subscriptions/sub123" + "href": "http://meAppServer.example.com/wai/v2/subscriptions" } }, - "callbackReference": "http://my.callback.com/wai/assocStaSubscription/some-id", - "subscriptionType": "AssocStaSubscription" + "subscription": [ + { + "href": "http://meAppServer.example.com/wai/v2/subscriptions/sub123", + "subscriptionType": "AssocStaSubscription" + } + ] } - ] + } } } } }, "400": { - "$ref": "#/components/responses/400" + "description": "Bad Request : used to indicate that incorrect parameters were passed to the request.", + "headers": {}, + "content": { + "application/problem+json": { + "schema": { + "$ref": "#/components/schemas/ProblemDetails" + } + } + } }, "401": { - "$ref": "#/components/responses/401" + "description": "Unauthorized : used when the client did not submit credentials.", + "headers": {}, + "content": { + "application/problem+json": { + "schema": { + "$ref": "#/components/schemas/ProblemDetails" + } + } + } }, "403": { - "$ref": "#/components/responses/403" + "description": "Forbidden : operation is not allowed given the current status of the resource.", + "headers": {}, + "content": { + "application/problem+json": { + "schema": { + "$ref": "#/components/schemas/ProblemDetails" + } + } + } }, "404": { - "$ref": "#/components/responses/404" + "description": "Not Found : used when a client provided a URI that cannot be mapped to a valid resource URI.", + "headers": {}, + "content": { + "application/problem+json": { + "schema": { + "$ref": "#/components/schemas/ProblemDetails" + } + } + } }, "406": { - "$ref": "#/components/responses/406" + "description": "Not Acceptable : used to indicate that the server cannot provide the any of the content formats supported by the client.", + "headers": {}, + "content": { + "application/problem+json": { + "schema": { + "$ref": "#/components/schemas/ProblemDetails" + } + } + } }, "429": { - "$ref": "#/components/responses/429" + "description": "Too Many Requests : used when a rate limiter has triggered.", + "headers": {}, + "content": { + "application/problem+json": { + "schema": { + "$ref": "#/components/schemas/ProblemDetails" + } + } + } } - } + }, + "deprecated": false }, "post": { "tags": [ "wai" ], - "summary": "Create a new subscription", + "summary": "Creates a new subscription to WLAN Access Information notifications", "description": "Creates a new subscription to WLAN Access Information notifications", "operationId": "subscriptionsPOST", + "parameters": [], "requestBody": { "description": "Subscription to be created", - "required": true, "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/InlineSubscription" + "oneOf": [ + { + "$ref": "#/components/schemas/AssocStaSubscription" + }, + { + "$ref": "#/components/schemas/StaDataRateSubscription" + }, + { + "$ref": "#/components/schemas/MeasurementReportSubscription" + } + ], + "description": "Subscription to be created", + "examples": [ + { + "subscriptionType": "AssocStaSubscription", + "callbackReference": "http://meAppClient.example.com/wai/v2/notifications/1", + "expiryDeadline": { + "seconds": 1977836800, + "nanoSeconds": 0 + }, + "apId": { + "bssid": "005C0A0A0A0A", + "ssid": [ + "myNetworkSsid" + ], + "ipAddress": [ + "10.10.100.1" + ] + } + } + ], + "contentMediaType": "application/json" }, - "example": { - "subscriptionType": "AssocStaSubscription", - "callbackReference": "http://meAppClient.example.com/wai/v2/notifications/1", - "expiryDeadline": { - "seconds": 1977836800, - "nanoSeconds": 0 - }, - "apId": { - "bssid": "005C0A0A0A0A", - "ssid": [ - "myNetworkSsid" - ], - "ipAddress": [ - "10.10.100.1" - ] + "examples": { + "example-of-AssocStaSubscription": { + "value": { + "subscriptionType": "AssocStaSubscription", + "callbackReference": "http://meAppClient.example.com/wai/v2/notifications/1", + "expiryDeadline": { + "seconds": 1977836800, + "nanoSeconds": 0 + }, + "apId": { + "bssid": "005C0A0A0A0A", + "ssid": [ + "myNetworkSsid" + ], + "ipAddress": [ + "10.10.100.1" + ] + } + } } } } - } + }, + "required": true }, "responses": { "201": { "description": "Successful subscription response", + "headers": {}, "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/InlineSubscription" + "oneOf": [ + { + "$ref": "#/components/schemas/AssocStaSubscription" + }, + { + "$ref": "#/components/schemas/StaDataRateSubscription" + }, + { + "$ref": "#/components/schemas/MeasurementReportSubscription" + } + ], + "examples": [ + { + "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": { + "bssid": "005C0A0A0A0A", + "ssid": [ + "myNetworkSsid" + ], + "ipAddress": [ + "10.10.100.1" + ] + } + } + ], + "contentMediaType": "application/json" }, - "example": { - "subscriptionType": "AssocStaSubscription", - "callbackReference": "http://meAppClient.example.com/wai/v2/notifications/1", - "_links": { - "self": { - "href": "http://meAppServer.example.com/wai/v2/subscriptions/sub123" + "examples": { + "example-of-assoc--sta-subscription": { + "value": { + "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": { + "bssid": "005C0A0A0A0A", + "ssid": [ + "myNetworkSsid" + ], + "ipAddress": [ + "10.10.100.1" + ] + } } - }, - "expiryDeadline": { - "seconds": 1977836800, - "nanoSeconds": 0 - }, - "apId": { - "bssid": "005C0A0A0A0A", - "ssid": [ - "myNetworkSsid" - ], - "ipAddress": [ - "10.10.100.1" - ] } } } } }, "400": { - "$ref": "#/components/responses/400" + "description": "Bad Request : used to indicate that incorrect parameters were passed to the request.", + "headers": {}, + "content": { + "application/problem+json": { + "schema": { + "$ref": "#/components/schemas/ProblemDetails" + } + } + } }, "401": { - "$ref": "#/components/responses/401" + "description": "Unauthorized : used when the client did not submit credentials.", + "headers": {}, + "content": { + "application/problem+json": { + "schema": { + "$ref": "#/components/schemas/ProblemDetails" + } + } + } }, "403": { - "$ref": "#/components/responses/403" + "description": "Forbidden : operation is not allowed given the current status of the resource.", + "headers": {}, + "content": { + "application/problem+json": { + "schema": { + "$ref": "#/components/schemas/ProblemDetails" + } + } + } }, "404": { - "$ref": "#/components/responses/404" + "description": "Not Found : used when a client provided a URI that cannot be mapped to a valid resource URI.", + "headers": {}, + "content": { + "application/problem+json": { + "schema": { + "$ref": "#/components/schemas/ProblemDetails" + } + } + } }, "406": { - "$ref": "#/components/responses/406" + "description": "Not Acceptable : used to indicate that the server cannot provide the any of the content formats supported by the client.", + "headers": {}, + "content": { + "application/problem+json": { + "schema": { + "$ref": "#/components/schemas/ProblemDetails" + } + } + } }, "415": { - "$ref": "#/components/responses/415" + "description": "Unsupported Media Type : used to indicate that the server or the client does not support the content type of the entity body.", + "headers": {}, + "content": { + "application/problem+json": { + "schema": { + "$ref": "#/components/schemas/ProblemDetails" + } + } + } }, "422": { - "$ref": "#/components/responses/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.", + "headers": {}, + "content": { + "application/problem+json": { + "schema": { + "$ref": "#/components/schemas/ProblemDetails" + }, + "examples": { + "application/problem+json": { + "value": { + "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": { - "$ref": "#/components/responses/429" + "description": "Too Many Requests : used when a rate limiter has triggered.", + "headers": {}, + "content": { + "application/problem+json": { + "schema": { + "$ref": "#/components/schemas/ProblemDetails" + } + } + } } }, + "deprecated": false, "callbacks": { "notification": { "{$request.body#/callbackReference}": { @@ -317,31 +721,35 @@ "schema": { "$ref": "#/components/schemas/InlineNotification" }, - "example": { - "notificationType": "AssocStaNotification", - "timeStamp": { - "seconds": 1977836800, - "nanoseconds": 0 - }, - "apId": { - "bssid": "005C0A0A0A0A", - "ssid": [ - "myNetworkSsid" - ], - "ipAddress": [ - "10.10.100.1" - ] - }, - "staId": { - "macId": "005C01111111", - "ssid": [ - "myNetworkSsid", - "myOtherNetworkSsid" - ], - "aid": "1122", - "ipAddress": [ - "10.10.1.255" - ] + "examples": { + "example-assoc-sta-notification": { + "value": { + "notificationType": "AssocStaNotification", + "timeStamp": { + "seconds": 1977836800, + "nanoSeconds": 0 + }, + "apId": { + "bssid": "005C0A0A0A0A", + "ssid": [ + "myNetworkSsid" + ], + "ipAddress": [ + "10.10.100.1" + ] + }, + "staId": { + "macId": "005C01111111", + "ssid": [ + "myNetworkSsid", + "myOtherNetworkSsid" + ], + "aid": "1122", + "ipAddress": [ + "10.10.1.255" + ] + } + } } } } @@ -349,801 +757,1203 @@ }, "responses": { "204": { - "$ref": "#/components/responses/204" + "description": "No content" } } } } } } - } + }, + "parameters": [] }, "/subscriptions/{subscriptionId}": { "get": { "tags": [ "wai" ], - "summary": "Retrieve information on current specific subscription", + "summary": "Queries information about an existing subscription, identified by its self-referring URI returned on creation (initial POST)", "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" + "name": "subscriptionId", + "in": "path", + "description": "Subscription Id, specifically the \"self\" returned in the subscription request", + "required": true, + "style": "simple", + "schema": { + "type": "string" + } } ], "responses": { "200": { "description": "Subscription information regarding subscription notifications", + "headers": {}, "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/InlineSubscription" + "oneOf": [ + { + "$ref": "#/components/schemas/AssocStaSubscription" + }, + { + "$ref": "#/components/schemas/StaDataRateSubscription" + }, + { + "$ref": "#/components/schemas/MeasurementReportSubscription" + } + ], + "examples": [ + { + "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": { + "bssid": "005C0A0A0A0A", + "ssid": [ + "myNetworkSsid" + ], + "ipAddress": [ + "10.10.100.1" + ] + } + } + ], + "contentMediaType": "application/json" }, - "example": { - "subscriptionType": "AssocStaSubscription", - "callbackReference": "http://meAppClient.example.com/wai/v2/notifications/1", - "_links": { - "self": { - "href": "http://meAppServer.example.com/wai/v2/subscriptions/sub123" + "examples": { + "example-of-assoc-sta-subscription": { + "value": { + "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": { + "bssid": "005C0A0A0A0A", + "ssid": [ + "myNetworkSsid" + ], + "ipAddress": [ + "10.10.100.1" + ] + } } - }, - "expiryDeadline": { - "seconds": 1977836800, - "nanoSeconds": 0 - }, - "apId": { - "bssid": "005C0A0A0A0A", - "ssid": [ - "myNetworkSsid" - ], - "ipAddress": [ - "10.10.100.1" - ] } } } } }, "400": { - "$ref": "#/components/responses/400" + "description": "Bad Request : used to indicate that incorrect parameters were passed to the request.", + "headers": {}, + "content": { + "application/problem+json": { + "schema": { + "$ref": "#/components/schemas/ProblemDetails" + } + } + } }, "401": { - "$ref": "#/components/responses/401" + "description": "Unauthorized : used when the client did not submit credentials.", + "headers": {}, + "content": { + "application/problem+json": { + "schema": { + "$ref": "#/components/schemas/ProblemDetails" + } + } + } }, "403": { - "$ref": "#/components/responses/403" + "description": "Forbidden : operation is not allowed given the current status of the resource.", + "headers": {}, + "content": { + "application/problem+json": { + "schema": { + "$ref": "#/components/schemas/ProblemDetails" + } + } + } }, "404": { - "$ref": "#/components/responses/404" + "description": "Not Found : used when a client provided a URI that cannot be mapped to a valid resource URI.", + "headers": {}, + "content": { + "application/problem+json": { + "schema": { + "$ref": "#/components/schemas/ProblemDetails" + } + } + } }, "406": { - "$ref": "#/components/responses/406" + "description": "Not Acceptable : used to indicate that the server cannot provide the any of the content formats supported by the client.", + "headers": {}, + "content": { + "application/problem+json": { + "schema": { + "$ref": "#/components/schemas/ProblemDetails" + } + } + } }, "429": { - "$ref": "#/components/responses/429" + "description": "Too Many Requests : used when a rate limiter has triggered.", + "headers": {}, + "content": { + "application/problem+json": { + "schema": { + "$ref": "#/components/schemas/ProblemDetails" + } + } + } } - } + }, + "deprecated": false }, "put": { "tags": [ "wai" ], - "summary": "Modify an existing subscription", + "summary": "Updates an existing subscription, identified by its self-referring URI returned on creation (initial POST)", "description": "Updates an existing subscription, identified by its self-referring URI returned on creation (initial POST)", "operationId": "subscriptionsPUT", + "parameters": [ + { + "name": "subscriptionId", + "in": "path", + "description": "Subscription Id, specifically the \"self\" returned in the subscription request", + "required": true, + "style": "simple", + "schema": { + "type": "string" + } + } + ], "requestBody": { "description": "Subscription to be modified", - "required": true, "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/InlineSubscription" + "oneOf": [ + { + "$ref": "#/components/schemas/AssocStaSubscription" + }, + { + "$ref": "#/components/schemas/StaDataRateSubscription" + }, + { + "$ref": "#/components/schemas/MeasurementReportSubscription" + } + ], + "description": "Subscription to be modified", + "examples": [ + { + "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": { + "bssid": "005C0A0A0A0A", + "ssid": [ + "myNetworkSsid" + ], + "ipAddress": [ + "10.10.100.1" + ] + } + } + ], + "contentMediaType": "application/json" }, - "example": { - "subscriptionType": "AssocStaSubscription", - "callbackReference": "http://meAppClient.example.com/wai/v2/notifications/1", - "_links": { - "self": { - "href": "http://meAppServer.example.com/wai/v2/subscriptions/sub123" + "examples": { + "example-of-assoc-sta-subscription": { + "value": { + "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": { + "bssid": "005C0A0A0A0A", + "ssid": [ + "myNetworkSsid" + ], + "ipAddress": [ + "10.10.100.1" + ] + } } - }, - "expiryDeadline": { - "seconds": 1977836800, - "nanoSeconds": 0 - }, - "apId": { - "bssid": "005C0A0A0A0A", - "ssid": [ - "myNetworkSsid" - ], - "ipAddress": [ - "10.10.100.1" - ] } } } - } + }, + "required": true }, - "parameters": [ - { - "$ref": "#/components/parameters/Path.subscrId" - } - ], "responses": { "200": { "description": "Successful subscription modification", + "headers": {}, "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/InlineSubscription" + "oneOf": [ + { + "$ref": "#/components/schemas/AssocStaSubscription" + }, + { + "$ref": "#/components/schemas/StaDataRateSubscription" + }, + { + "$ref": "#/components/schemas/MeasurementReportSubscription" + } + ], + "examples": [ + { + "_links": { + "self": { + "href": "http://[hostIP]/sbox-xyz123/wai/v2/subscriptions/sub123" + } + }, + "callbackReference": "http://my.callback.com/wai/some-id", + "apId": { + "bssid": "005C0A0A0A0A", + "ssid": [ + "myNetworkSsid" + ], + "ipAddress": [ + "10.10.100.1" + ] + } + } + ], + "contentMediaType": "application/json" }, - "example": { - "_links": { - "self": { - "href": "http://[hostIP]/sbox-xyz123/wai/v2/subscriptions/sub123" + "examples": { + "example-sub-type": { + "value": { + "subscriptionType": "AssocStaSubscription", + "_links": { + "self": { + "href": "http://[hostIP]/sbox-xyz123/wai/v2/subscriptions/sub123" + } + }, + "callbackReference": "http://my.callback.com/wai/some-id", + "apId": { + "bssid": "005C0A0A0A0A", + "ssid": [ + "myNetworkSsid" + ], + "ipAddress": [ + "10.10.100.1" + ] + } } - }, - "callbackReference": "http://my.callback.com/wai/some-id", - "apId": { - "bssid": "005C0A0A0A0A", - "ssid": [ - "myNetworkSsid" - ], - "ipAddress": [ - "10.10.100.1" - ] } } } } }, "400": { - "$ref": "#/components/responses/400" + "description": "Bad Request : used to indicate that incorrect parameters were passed to the request.", + "headers": {}, + "content": { + "application/problem+json": { + "schema": { + "$ref": "#/components/schemas/ProblemDetails" + } + } + } }, "401": { - "$ref": "#/components/responses/401" + "description": "Unauthorized : used when the client did not submit credentials.", + "headers": {}, + "content": { + "application/problem+json": { + "schema": { + "$ref": "#/components/schemas/ProblemDetails" + } + } + } }, "403": { - "$ref": "#/components/responses/403" + "description": "Forbidden : operation is not allowed given the current status of the resource.", + "headers": {}, + "content": { + "application/problem+json": { + "schema": { + "$ref": "#/components/schemas/ProblemDetails" + } + } + } }, "404": { - "$ref": "#/components/responses/404" + "description": "Not Found : used when a client provided a URI that cannot be mapped to a valid resource URI.", + "headers": {}, + "content": { + "application/problem+json": { + "schema": { + "$ref": "#/components/schemas/ProblemDetails" + } + } + } }, "406": { - "$ref": "#/components/responses/406" + "description": "Not Acceptable : used to indicate that the server cannot provide the any of the content formats supported by the client.", + "headers": {}, + "content": { + "application/problem+json": { + "schema": { + "$ref": "#/components/schemas/ProblemDetails" + } + } + } }, "412": { - "$ref": "#/components/responses/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", + "headers": {}, + "content": { + "application/problem+json": { + "schema": { + "$ref": "#/components/schemas/ProblemDetails" + } + } + } }, "422": { - "$ref": "#/components/responses/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.", + "headers": {}, + "content": { + "application/problem+json": { + "schema": { + "$ref": "#/components/schemas/ProblemDetails" + }, + "examples": { + "application/problem+json": { + "value": { + "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": { - "$ref": "#/components/responses/429" + "description": "Too Many Requests : used when a rate limiter has triggered.", + "headers": {}, + "content": { + "application/problem+json": { + "schema": { + "$ref": "#/components/schemas/ProblemDetails" + } + } + } } - } + }, + "deprecated": false }, "delete": { "tags": [ "wai" ], - "summary": "Cancel an existing subscription", + "summary": "Cancels an existing subscription, identified by its self-referring URI returned on creation (initial POST)", "description": "Cancels an existing subscription, identified by its self-referring URI returned on creation (initial POST)", "operationId": "subscriptionsDELETE", "parameters": [ { - "$ref": "#/components/parameters/Path.subscrId" + "name": "subscriptionId", + "in": "path", + "description": "Subscription Id, specifically the \"self\" returned in the subscription request", + "required": true, + "style": "simple", + "schema": { + "type": "string" + } } ], "responses": { "204": { - "$ref": "#/components/responses/204" + "description": "No Content", + "headers": {}, + "content": {} }, "401": { - "$ref": "#/components/responses/401" + "description": "Unauthorized : used when the client did not submit credentials.", + "headers": {}, + "content": { + "application/problem+json": { + "schema": { + "$ref": "#/components/schemas/ProblemDetails" + } + } + } }, "403": { - "$ref": "#/components/responses/403" + "description": "Forbidden : operation is not allowed given the current status of the resource.", + "headers": {}, + "content": { + "application/problem+json": { + "schema": { + "$ref": "#/components/schemas/ProblemDetails" + } + } + } }, "404": { - "$ref": "#/components/responses/404" + "description": "Not Found : used when a client provided a URI that cannot be mapped to a valid resource URI.", + "headers": {}, + "content": { + "application/problem+json": { + "schema": { + "$ref": "#/components/schemas/ProblemDetails" + } + } + } }, "429": { - "$ref": "#/components/responses/429" + "description": "Too Many Requests : used when a rate limiter has triggered.", + "headers": {}, + "content": { + "application/problem+json": { + "schema": { + "$ref": "#/components/schemas/ProblemDetails" + } + } + } } - } - } + }, + "deprecated": false + }, + "parameters": [] }, "/measurements": { "get": { "tags": [ "wai" ], - "summary": "Retrieve information on measurements configuration", + "summary": "Queries information on measurements configuration", "description": "Queries information on measurements configuration", "operationId": "measurementLinkList_measurementsGET", + "parameters": [], "responses": { "200": { "description": "Response body contains the list of links to requestors measurement configurations.", + "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MeasurementConfigLinkList" }, - "example": { - "_links": { - "self": { - "href": "http://meAppServer.example.com/wai/v2/measurements" - } - }, - "measurementConfig": [ - { - "href": "http://meAppServer.example.com/wai/v2/measurements/meas123", - "measurementId": "myId1" + "examples": { + "example-measurement": { + "value": { + "_links": { + "self": { + "href": "http://meAppServer.example.com/wai/v2/measurements" + } + }, + "measurementConfig": [ + { + "href": "http://meAppServer.example.com/wai/v2/measurements/meas123", + "measurementId": "myId1" + } + ] } - ] + } } } } }, "400": { - "$ref": "#/components/responses/400" + "description": "Bad Request : used to indicate that incorrect parameters were passed to the request.", + "headers": {}, + "content": { + "application/problem+json": { + "schema": { + "$ref": "#/components/schemas/ProblemDetails" + } + } + } }, "401": { - "$ref": "#/components/responses/401" + "description": "Unauthorized : used when the client did not submit credentials.", + "headers": {}, + "content": { + "application/problem+json": { + "schema": { + "$ref": "#/components/schemas/ProblemDetails" + } + } + } }, "403": { - "$ref": "#/components/responses/403" + "description": "Forbidden : operation is not allowed given the current status of the resource.", + "headers": {}, + "content": { + "application/problem+json": { + "schema": { + "$ref": "#/components/schemas/ProblemDetails" + } + } + } }, "404": { - "$ref": "#/components/responses/404" + "description": "Not Found : used when a client provided a URI that cannot be mapped to a valid resource URI.", + "headers": {}, + "content": { + "application/problem+json": { + "schema": { + "$ref": "#/components/schemas/ProblemDetails" + } + } + } }, "406": { - "$ref": "#/components/responses/406" + "description": "Not Acceptable : used to indicate that the server cannot provide the any of the content formats supported by the client.", + "headers": {}, + "content": { + "application/problem+json": { + "schema": { + "$ref": "#/components/schemas/ProblemDetails" + } + } + } }, "429": { - "$ref": "#/components/responses/429" + "description": "Too Many Requests : used when a rate limiter has triggered.", + "headers": {}, + "content": { + "application/problem+json": { + "schema": { + "$ref": "#/components/schemas/ProblemDetails" + } + } + } } - } + }, + "deprecated": false }, "post": { "tags": [ "wai" ], - "summary": "Create a new measurement configuration", + "summary": "Creates a new measurement configuration", "description": "Creates a new measurement configuration", "operationId": "measurementsPOST", + "parameters": [], "requestBody": { "description": "Measurement configuration information", - "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MeasurementConfig" }, - "example": { - "staId": { - "macId": "005C01111111", - "ssid": [ - "myNetworkSsid", - "myOtherNetworkSsid" - ] - }, - "measurementId": "myId1", - "measurementInfo": {} + "examples": { + "example-body": { + "value": { + "staId": [ + { + "macId": "005C01111111", + "ssid": [ + "myNetworkSsid", + "myOtherNetworkSsid" + ] + } + ], + "measurementId": "myId1", + "measurementInfo": {} + } + } } } - } + }, + "required": true }, "responses": { "201": { "description": "Successful measurement configuration response", + "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MeasurementConfig" }, - "example": { - "_links": { - "self": { - "href": "http://meAppServer.example.com/wai/v2/measurements/meas123" + "examples": { + "example-response": { + "value": { + "_links": { + "self": { + "href": "http://meAppServer.example.com/wai/v2/measurements/meas123" + } + }, + "staId": [ + { + "macId": "005C01111111", + "ssid": [ + "myNetworkSsid", + "myOtherNetworkSsid" + ] + } + ], + "measurementId": "myId1", + "measurementInfo": {} } - }, - "staId": { - "macId": "005C01111111", - "ssid": [ - "myNetworkSsid", - "myOtherNetworkSsid" - ] - }, - "measurementId": "myId1", - "measurementInfo": {} + } } } } }, "400": { - "$ref": "#/components/responses/400" + "description": "Bad Request : used to indicate that incorrect parameters were passed to the request.", + "headers": {}, + "content": { + "application/problem+json": { + "schema": { + "$ref": "#/components/schemas/ProblemDetails" + } + } + } }, "401": { - "$ref": "#/components/responses/401" + "description": "Unauthorized : used when the client did not submit credentials.", + "headers": {}, + "content": { + "application/problem+json": { + "schema": { + "$ref": "#/components/schemas/ProblemDetails" + } + } + } }, "403": { - "$ref": "#/components/responses/403" + "description": "Forbidden : operation is not allowed given the current status of the resource.", + "headers": {}, + "content": { + "application/problem+json": { + "schema": { + "$ref": "#/components/schemas/ProblemDetails" + } + } + } }, "404": { - "$ref": "#/components/responses/404" + "description": "Not Found : used when a client provided a URI that cannot be mapped to a valid resource URI.", + "headers": {}, + "content": { + "application/problem+json": { + "schema": { + "$ref": "#/components/schemas/ProblemDetails" + } + } + } }, "406": { - "$ref": "#/components/responses/406" + "description": "Not Acceptable : used to indicate that the server cannot provide the any of the content formats supported by the client.", + "headers": {}, + "content": { + "application/problem+json": { + "schema": { + "$ref": "#/components/schemas/ProblemDetails" + } + } + } }, "415": { - "$ref": "#/components/responses/415" + "description": "Unsupported Media Type : used to indicate that the server or the client does not support the content type of the entity body.", + "headers": {}, + "content": { + "application/problem+json": { + "schema": { + "$ref": "#/components/schemas/ProblemDetails" + } + } + } }, "422": { - "$ref": "#/components/responses/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.", + "headers": {}, + "content": { + "application/problem+json": { + "schema": { + "$ref": "#/components/schemas/ProblemDetails" + }, + "examples": { + "application/problem+json": { + "value": { + "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": { - "$ref": "#/components/responses/429" + "description": "Too Many Requests : used when a rate limiter has triggered.", + "headers": {}, + "content": { + "application/problem+json": { + "schema": { + "$ref": "#/components/schemas/ProblemDetails" + } + } + } } - } - } + }, + "deprecated": false + }, + "parameters": [] }, "/measurements/{measurementConfigId}": { "get": { "tags": [ "wai" ], - "summary": "Retrieve information on an existing measurement configuration", + "summary": "Queries information about an existing measurement configuration, identified by its self-referring URI returned on creation (initial POST)", "description": "Queries information about an existing measurement configuration, identified by its self-referring URI returned on creation (initial POST)", "operationId": "measurementsGET", "parameters": [ { - "$ref": "#/components/parameters/Path.measurementConfigId" + "name": "measurementConfigId", + "in": "path", + "description": "Measurement configuration Id, specifically the \"self\" returned in the measurement configuration request", + "required": true, + "style": "simple", + "schema": { + "type": "string" + } } ], "responses": { "200": { "description": "Measurement configuration information", + "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MeasurementConfig" }, - "example": { - "_links": { - "self": { - "href": "http://meAppServer.example.com/wai/v2/measurements/meas123" + "examples": { + "response-example": { + "value": { + "_links": { + "self": { + "href": "http://meAppServer.example.com/wai/v2/measurements/meas123" + } + }, + "staId": [ + { + "macId": "005C01111111", + "ssid": [ + "myNetworkSsid", + "myOtherNetworkSsid" + ] + } + ], + "measurementId": "myId1", + "measurementInfo": {} } - }, - "staId": { - "macId": "005C01111111", - "ssid": [ - "myNetworkSsid", - "myOtherNetworkSsid" - ] - }, - "measurementId": "myId1", - "measurementInfo": {} + } } } } }, "400": { - "$ref": "#/components/responses/400" + "description": "Bad Request : used to indicate that incorrect parameters were passed to the request.", + "headers": {}, + "content": { + "application/problem+json": { + "schema": { + "$ref": "#/components/schemas/ProblemDetails" + } + } + } }, "401": { - "$ref": "#/components/responses/401" + "description": "Unauthorized : used when the client did not submit credentials.", + "headers": {}, + "content": { + "application/problem+json": { + "schema": { + "$ref": "#/components/schemas/ProblemDetails" + } + } + } }, "403": { - "$ref": "#/components/responses/403" + "description": "Forbidden : operation is not allowed given the current status of the resource.", + "headers": {}, + "content": { + "application/problem+json": { + "schema": { + "$ref": "#/components/schemas/ProblemDetails" + } + } + } }, "404": { - "$ref": "#/components/responses/404" + "description": "Not Found : used when a client provided a URI that cannot be mapped to a valid resource URI.", + "headers": {}, + "content": { + "application/problem+json": { + "schema": { + "$ref": "#/components/schemas/ProblemDetails" + } + } + } }, "406": { - "$ref": "#/components/responses/406" + "description": "Not Acceptable : used to indicate that the server cannot provide the any of the content formats supported by the client.", + "headers": {}, + "content": { + "application/problem+json": { + "schema": { + "$ref": "#/components/schemas/ProblemDetails" + } + } + } }, "429": { - "$ref": "#/components/responses/429" + "description": "Too Many Requests : used when a rate limiter has triggered.", + "headers": {}, + "content": { + "application/problem+json": { + "schema": { + "$ref": "#/components/schemas/ProblemDetails" + } + } + } } - } + }, + "deprecated": false }, "put": { "tags": [ "wai" ], - "summary": "Modify an existing measurement configuration", + "summary": "Updates an existing measurement configuration, identified by its self-referring URI returned on creation (initial POST)", "description": "Updates an existing measurement configuration, identified by its self-referring URI returned on creation (initial POST)", "operationId": "measurementsPUT", + "parameters": [ + { + "name": "measurementConfigId", + "in": "path", + "description": "Measurement configuration Id, specifically the \"self\" returned in the measurement configuration request", + "required": true, + "style": "simple", + "schema": { + "type": "string" + } + } + ], "requestBody": { "description": "Measurement configuration to be modified", - "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MeasurementConfig" - }, - "example": { - "_links": { - "self": { - "href": "http://meAppServer.example.com/wai/v2/measurements/meas123" - } - }, - "staId": { - "macId": "005C01111111", - "ssid": [ - "myNetworkSsid", - "myOtherNetworkSsid" - ] - }, - "measurementId": "myId1", - "measurementInfo": {} } } - } + }, + "required": true }, - "parameters": [ - { - "$ref": "#/components/parameters/Path.measurementConfigId" - } - ], "responses": { "200": { "description": "Successful measurement configuration modification", + "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MeasurementConfig" - }, - "example": { - "_links": { - "self": { - "href": "http://meAppServer.example.com/wai/v2/measurements/123" - } - }, - "staId": { - "macId": "005C01111111", - "ssid": [ - "myNetworkSsid", - "myOtherNetworkSsid" - ] - }, - "measurementId": "myId1", - "measurementInfo": {} } } } }, "400": { - "$ref": "#/components/responses/400" + "description": "Bad Request : used to indicate that incorrect parameters were passed to the request.", + "headers": {}, + "content": { + "application/problem+json": { + "schema": { + "$ref": "#/components/schemas/ProblemDetails" + } + } + } }, "401": { - "$ref": "#/components/responses/401" + "description": "Unauthorized : used when the client did not submit credentials.", + "headers": {}, + "content": { + "application/problem+json": { + "schema": { + "$ref": "#/components/schemas/ProblemDetails" + } + } + } }, "403": { - "$ref": "#/components/responses/403" + "description": "Forbidden : operation is not allowed given the current status of the resource.", + "headers": {}, + "content": { + "application/problem+json": { + "schema": { + "$ref": "#/components/schemas/ProblemDetails" + } + } + } }, "404": { - "$ref": "#/components/responses/404" + "description": "Not Found : used when a client provided a URI that cannot be mapped to a valid resource URI.", + "headers": {}, + "content": { + "application/problem+json": { + "schema": { + "$ref": "#/components/schemas/ProblemDetails" + } + } + } }, "406": { - "$ref": "#/components/responses/406" + "description": "Not Acceptable : used to indicate that the server cannot provide the any of the content formats supported by the client.", + "headers": {}, + "content": { + "application/problem+json": { + "schema": { + "$ref": "#/components/schemas/ProblemDetails" + } + } + } }, "412": { - "$ref": "#/components/responses/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", + "headers": {}, + "content": { + "application/problem+json": { + "schema": { + "$ref": "#/components/schemas/ProblemDetails" + } + } + } }, "422": { - "$ref": "#/components/responses/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.", + "headers": {}, + "content": { + "application/problem+json": { + "schema": { + "$ref": "#/components/schemas/ProblemDetails" + }, + "examples": { + "application/problem+json": { + "value": { + "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": { - "$ref": "#/components/responses/429" + "description": "Too Many Requests : used when a rate limiter has triggered.", + "headers": {}, + "content": { + "application/problem+json": { + "schema": { + "$ref": "#/components/schemas/ProblemDetails" + } + } + } } - } + }, + "deprecated": false }, "delete": { "tags": [ "wai" ], - "summary": "Cancel a measurement configuration", + "summary": "Cancels an existing measurement configuration, identified by its self-referring URI returned on creation (initial POST)", "description": "Cancels an existing measurement configuration, identified by its self-referring URI returned on creation (initial POST)", "operationId": "measurementsDELETE", "parameters": [ { - "$ref": "#/components/parameters/Path.measurementConfigId" + "name": "measurementConfigId", + "in": "path", + "description": "Measurement configuration Id, specifically the \"self\" returned in the measurement configuration request", + "required": true, + "style": "simple", + "schema": { + "type": "string" + } } ], "responses": { "204": { - "$ref": "#/components/responses/204" + "description": "No Content", + "headers": {}, + "content": {} }, "401": { - "$ref": "#/components/responses/401" + "description": "Unauthorized : used when the client did not submit credentials.", + "headers": {}, + "content": { + "application/problem+json": { + "schema": { + "$ref": "#/components/schemas/ProblemDetails" + } + } + } }, "403": { - "$ref": "#/components/responses/403" + "description": "Forbidden : operation is not allowed given the current status of the resource.", + "headers": {}, + "content": { + "application/problem+json": { + "schema": { + "$ref": "#/components/schemas/ProblemDetails" + } + } + } }, "404": { - "$ref": "#/components/responses/404" + "description": "Not Found : used when a client provided a URI that cannot be mapped to a valid resource URI.", + "headers": {}, + "content": { + "application/problem+json": { + "schema": { + "$ref": "#/components/schemas/ProblemDetails" + } + } + } }, "429": { - "$ref": "#/components/responses/429" + "description": "Too Many Requests : used when a rate limiter has triggered.", + "headers": {}, + "content": { + "application/problem+json": { + "schema": { + "$ref": "#/components/schemas/ProblemDetails" + } + } + } } - } - } + }, + "deprecated": false + }, + "parameters": [] } }, "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" - } - }, - "Path.measurementConfigId": { - "name": "measurementConfigId", - "in": "path", - "description": "Measurement configuration Id, specifically the \"self\" returned in the measurement configuration 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, measure_report.", - "required": false, - "schema": { - "type": "string" - } - } - }, "schemas": { "ApAssociated": { + "title": "ApAssociated", + "required": [ + "bssid" + ], + "type": "object", "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" + "description": "Unique number which identifies a particular association between the station and Access Point." }, "bssid": { - "description": "Basic Service Set Identifier (BSSID) is a unique identifier assigned to the Access Point (as network interface controller) for communications at the data link layer of a network segment. BSSID is typically set to an access point's MAC address.", "type": "string", - "x-etsi-mec-cardinality": "1", - "x-etsi-mec-origin-type": "String" + "description": "Basic Service Set Identifier (BSSID) is a unique identifier assigned to the Access Point (as network interface controller) for communications at the data link layer of a network segment. BSSID is typically set to an access point's MAC address." }, "ipAddress": { - "description": "IPv4 or IPv6 address allocated for the Access Point.", + "minItems": 0, + "type": "array", "items": { "type": "string" }, - "minItems": 0, - "type": "array", - "x-etsi-mec-cardinality": "0..N", - "x-etsi-mec-origin-type": "String" + "description": "IPv4 or IPv6 address allocated for the Access Point." }, "ssid": { - "description": "Service Set Identifier to identify logical networks.", + "minItems": 0, + "type": "array", "items": { "type": "string" }, - "minItems": 0, - "type": "array", - "x-etsi-mec-cardinality": "0..N", - "x-etsi-mec-origin-type": "String" + "description": "Service Set Identifier to identify logical networks." } - }, + } + }, + "ApIdentity": { + "title": "ApIdentity", "required": [ "bssid" ], "type": "object", - "x-etsi-ref": "6.5.12" - }, - "ApIdentity": { "properties": { "bssid": { - "description": "Basic Service Set Identifier (BSSID) is a unique Identifier assigned to an Access Point (as network interface controller) for communications at the data link layer of a network segment. BSSID is typically set to an access point's MAC address.", "type": "string", - "x-etsi-mec-cardinality": "1", - "x-etsi-mec-origin-type": "String" + "description": "Basic Service Set Identifier (BSSID) is a unique Identifier assigned to an Access Point (as network interface controller) for communications at the data link layer of a network segment. BSSID is typically set to an access point's MAC address." }, "ipAddress": { - "description": "IPv4 or IPv6 address allocated for the Access Point.", + "minItems": 0, + "type": "array", "items": { "type": "string" }, - "minItems": 0, - "type": "array", - "x-etsi-mec-cardinality": "0..N", - "x-etsi-mec-origin-type": "String" + "description": "IPv4 or IPv6 address allocated for the Access Point." }, "ssid": { - "description": "Service Set Identifier (SSID) to identify logical WLAN networks available via the Access Point.", + "minItems": 0, + "type": "array", "items": { "type": "string" }, - "minItems": 0, - "type": "array", - "x-etsi-mec-cardinality": "0..N", - "x-etsi-mec-origin-type": "String" + "description": "Service Set Identifier (SSID) to identify logical WLAN networks available via the Access Point." } - }, + } + }, + "ApInfo": { + "title": "ApInfo", "required": [ - "bssid" + "apId" ], "type": "object", - "x-etsi-ref": "6.5.3" - }, - "ApInfo": { "properties": { "apId": { "$ref": "#/components/schemas/ApIdentity" @@ -1155,11 +1965,9 @@ "$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" + "description": "Channel configured for the Access Point.", + "contentEncoding": "int32" }, "extBssLoad": { "$ref": "#/components/schemas/ExtBssLoad" @@ -1176,14 +1984,11 @@ "wlanCap": { "$ref": "#/components/schemas/WlanCapabilities" } - }, - "required": [ - "apId" - ], - "type": "object", - "x-etsi-ref": "6.2.2" + } }, "ApLocation": { + "title": "ApLocation", + "type": "object", "properties": { "civicLocation": { "$ref": "#/components/schemas/CivicLocation" @@ -1191,1176 +1996,833 @@ "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" + "title": "AssocStaNotification", + "allOf": [ + { + "$ref": "#/components/schemas/InlineNotification" }, - "timeStamp": { - "$ref": "#/components/schemas/TimeStamp" + { + "required": [ + "apId" + ], + "type": "object", + "properties": { + "apId": { + "$ref": "#/components/schemas/ApIdentity" + }, + "staId": { + "minItems": 0, + "type": "array", + "items": { + "$ref": "#/components/schemas/StaIdentity" + }, + "description": "Identifier(s) to uniquely specify the client station(s) associated." + }, + "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" - } - }, + "title": "AssocStaSubscription", + "allOf": [ + { + "$ref": "#/components/schemas/InlineSubscription" + }, + { "required": [ - "self" + "apId" ], "type": "object", - "x-etsi-mec-cardinality": "0..1", - "x-etsi-mec-origin-type": "Structure (inlined)" - }, - "apId": { - "$ref": "#/components/schemas/ApIdentity" - }, - "callbackReference": { - "type": "string" - }, - "expiryDeadline": { - "$ref": "#/components/schemas/TimeStamp" - }, - "notificationEvent": { - "description": "Set for trigger-based event notification reporting. ", "properties": { - "threshold": { - "description": "Number of connected stations threshold for trigger-based event reporting.", - "format": "uint8", - "type": "integer", - "x-etsi-mec-cardinality": "1", - "x-etsi-mec-origin-type": "Uint8" + "_links": { + "$ref": "#/components/schemas/Links" }, - "trigger": { - "description": "Trigger for the notification:\n1 = Notification issued when the number of connected stations is greater than or equal to the threshold.\n2 = Notification issued when the number of connected stations is less than or equal to the threshold.", - "enum": [ - 1, - 2 - ], + "apId": { + "$ref": "#/components/schemas/ApIdentity" + }, + "callbackReference": { + "type": "string" + }, + "expiryDeadline": { + "$ref": "#/components/schemas/TimeStamp" + }, + "notificationEvent": { + "$ref": "#/components/schemas/NotificationEvent" + }, + "notificationPeriod": { "type": "integer", - "x-etsi-mec-cardinality": "1", - "x-etsi-mec-origin-type": "Enum (inline)" + "description": "Set for periodic notification reporting.\nValue indicates the notification period in seconds.", + "contentEncoding": "int32" + }, + "requestTestNotification": { + "type": "boolean", + "description": "Set to TRUE by the service consumer to request a test notification on the callbackReference URI to determine if it is reachable by the WAIS for notifications." + }, + "websockNotifConfig": { + "$ref": "#/components/schemas/WebsockNotifConfig" } - }, - "required": [ - "trigger", - "threshold" - ], - "type": "object", - "x-etsi-mec-cardinality": "0..1", - "x-etsi-mec-origin-type": "Structure (inline)" - }, - "notificationPeriod": { - "description": "Set for periodic notification reporting.\nValue indicates the notification period in seconds.", - "format": "uint8", - "type": "integer", - "x-etsi-mec-cardinality": "0..1", - "x-etsi-mec-origin-type": "Uint8" - }, - "requestTestNotification": { - "description": "Set to TRUE by the service consumer to request a test notification on the callbackReference URI to determine if it is reachable by the WAIS for notifications.", - "type": "boolean", - "x-etsi-mec-cardinality": "0..1", - "x-etsi-mec-origin-type": "Boolean" - }, - "subscriptionType": { - "description": "Shall be set to \"AssocStaSubscription\".", - "type": "string", - "x-etsi-mec-cardinality": "1", - "x-etsi-mec-origin-type": "String" - }, - "websockNotifConfig": { - "$ref": "#/components/schemas/WebsockNotifConfig" + } } - }, + ] + }, + "BeaconReport": { + "title": "BeaconReport", "required": [ - "subscriptionType", - "apId" + "bssid", + "channel", + "measurementId", + "operatingClass", + "reportedFrameInfo" ], "type": "object", - "x-etsi-notes": "NOTE 1:\tAt least one of callbackReference and websockNotifConfig shall be provided by the service consumer. If both are provided, it is up to WAIS to select the method to be used for notifications and to return only that method in the response.\nNOTE 2:\tAssocStaSubscription shall include either notificationPeriod or notificationEvent.\nNOTE 3:\tIf both notificationPeriod and notificationEvent attributes are set, notifications are issued periodically when the trigger threshold is satisfied.", - "x-etsi-ref": "6.3.2" - }, - "BeaconReport": { "properties": { "antennaId": { - "description": "The Antenna ID field contains the identifying number for the antenna(s) used for this measurement. Antenna ID is defined in section 9.4.2.40 of IEEE 802.11-2016 [8].", - "format": "uint8", "type": "integer", - "x-etsi-mec-cardinality": "0..1", - "x-etsi-mec-origin-type": "Uint8" + "description": "The Antenna ID field contains the identifying number for the antenna(s) used for this measurement. Antenna ID is defined in section 9.4.2.40 of IEEE 802.11-2016 [8].", + "contentEncoding": "int32" }, "bssid": { - "description": "Indicates the BSSID of the BSS for which a beacon report has been received.", "type": "string", - "x-etsi-mec-cardinality": "1", - "x-etsi-mec-origin-type": "String" + "description": "Indicates the BSSID of the BSS for which a beacon report has been received." }, "channel": { - "description": "Channel number where the beacon was received.", - "format": "uint8", "type": "integer", - "x-etsi-mec-cardinality": "1", - "x-etsi-mec-origin-type": "Uint8" + "description": "Channel number where the beacon was received.", + "contentEncoding": "int32" }, "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" + "description": "Measurement ID of the Measurement configuration applied to this Beacon Report." }, "operatingClass": { - "description": "Operating Class field indicates an operating class value as defined in Annex E within IEEE 802.11-2016 [8].", - "format": "uint8", "type": "integer", - "x-etsi-mec-cardinality": "1", - "x-etsi-mec-origin-type": "Uint8" + "description": "Operating Class field indicates an operating class value as defined in Annex E within IEEE 802.11-2016 [8].", + "contentEncoding": "int32" }, "parentTsf": { - "description": "The Parent TSF field contains the lower 4 octets of the measuring STA's TSF timer value at the start of reception of the first octet of the timestamp field of the reported Beacon, Measurement Pilot, or Probe Response frame at the time the Beacon, Measurement Pilot, or Probe Response frame being reported was received.", - "format": "uint32", "type": "integer", - "x-etsi-mec-cardinality": "0..1", - "x-etsi-mec-origin-type": "Uint32" + "description": "The Parent TSF field contains the lower 4 octets of the measuring STA's TSF timer value at the start of reception of the first octet of the timestamp field of the reported Beacon, Measurement Pilot, or Probe Response frame at the time the Beacon, Measurement Pilot, or Probe Response frame being reported was received.", + "contentEncoding": "int32" }, "rcpi": { - "description": "RCPI indicates the received channel power of the Beacon, Measurement Pilot, or Probe Response frame, which is a logarithmic function of the received signal power, as defined in section 9.4.2.38 of IEEE 802.11-2016 [8].", - "format": "uint8", "type": "integer", - "x-etsi-mec-cardinality": "0..1", - "x-etsi-mec-origin-type": "Uint8" + "description": "RCPI indicates the received channel power of the Beacon, Measurement Pilot, or Probe Response frame, which is a logarithmic function of the received signal power, as defined in section 9.4.2.38 of IEEE 802.11-2016 [8].", + "contentEncoding": "int32" }, "reportedFrameInfo": { "$ref": "#/components/schemas/ReportedBeaconFrameInfo" }, "rsni": { - "description": "RSNI indicates the received signal-to-noise indication for the Beacon, Measurement Pilot, or Probe Response frame, as described in section 9.4.2.41 of IEEE 802.11-2016 [8].", - "format": "uint8", "type": "integer", - "x-etsi-mec-cardinality": "0..1", - "x-etsi-mec-origin-type": "Uint8" + "description": "RSNI indicates the received signal-to-noise indication for the Beacon, Measurement Pilot, or Probe Response frame, as described in section 9.4.2.41 of IEEE 802.11-2016 [8].", + "contentEncoding": "int32" }, "ssid": { - "description": "The SSID subelement indicates the ESS or IBSS for which a beacon report is received.", "type": "string", - "x-etsi-mec-cardinality": "0..1", - "x-etsi-mec-origin-type": "String" + "description": "The SSID subelement indicates the ESS or IBSS for which a beacon report is received." }, "staId": { "$ref": "#/components/schemas/StaIdentity" } - }, + } + }, + "BeaconReportingConfig": { + "title": "BeaconReportingConfig", "required": [ - "measurementId", - "operatingClass", - "channel", - "reportedFrameInfo", - "bssid" + "reportingCondition", + "threshold" ], "type": "object", - "x-etsi-ref": "6.5.27" - }, - "BeaconReportingConfig": { "properties": { "reportingCondition": { - "description": "Reporting condition for the Beacon Report as per Table 9-89 of IEEE 802.11-2016 [8]:\n0 = Report to be issued after each measurement.\n1 = measured RCPI level is greater than the threshold.\n2 = measured RCPI level is less than the threshold.\n3 = measured RSNI level is greater than the threshold.\n4 = measured RSNI level is less than the threshold.\n5 = measured RCPI level is greater than a threshold defined by an offset from the serving AP's reference RCPI.\n6 = measured RCPI level is less than a threshold defined by an offset from the serving AP's reference RCPI.\n7 = measured RSNI level is greater than a threshold defined by an offset from the serving AP's reference RSNI.\n8 = measured RSNI level is less than a threshold defined by an offset from the serving AP's reference RSNI.\n9 = measured RCPI level is in a range bound by the serving AP's reference RCPI and an offset from the serving AP's reference RCPI.\n10 = measured RSNI level is in a range bound by the serving AP's reference RSNI and an offset from the serving AP's reference RSNI.", - "format": "uint8", "type": "integer", - "x-etsi-mec-cardinality": "1", - "x-etsi-mec-origin-type": "Uint8" + "description": "Reporting condition for the Beacon Report as per Table 9-89 of IEEE 802.11-2016 [8]:\n0 = Report to be issued after each measurement.\n1 = measured RCPI level is greater than the threshold.\n2 = measured RCPI level is less than the threshold.\n3 = measured RSNI level is greater than the threshold.\n4 = measured RSNI level is less than the threshold.\n5 = measured RCPI level is greater than a threshold defined by an offset from the serving AP's reference RCPI.\n6 = measured RCPI level is less than a threshold defined by an offset from the serving AP's reference RCPI.\n7 = measured RSNI level is greater than a threshold defined by an offset from the serving AP's reference RSNI.\n8 = measured RSNI level is less than a threshold defined by an offset from the serving AP's reference RSNI.\n9 = measured RCPI level is in a range bound by the serving AP's reference RCPI and an offset from the serving AP's reference RCPI.\n10 = measured RSNI level is in a range bound by the serving AP's reference RSNI and an offset from the serving AP's reference RSNI.", + "contentEncoding": "int32" }, "threshold": { - "description": "The threshold subfield contains either the threshold value or the offset value to be used for conditional reporting.\n\nFor reportingCondition subfield with values 1 and 2, the threshold value is a logarithmic function of the received signal power, as defined in section 9.4.2.38 of IEEE 802.11-2016 [8].\n\nFor reportingCondition subfield values 3 and 4, the threshold value is a logarithmic function of the signal-to-noise ratio, as described in section 9.4.2.41 of IEEE 802.11-2016 [8].\n\nFor reportingCondition subfield values 5 to 10, the offset value is an 8-bit 2s complement integer in units of 0,5 dBm. The indicated reporting condition applies individually to each measured Beacon, Measurement Pilot, or Probe Response frame.", - "format": "uint8", "type": "integer", - "x-etsi-mec-cardinality": "1", - "x-etsi-mec-origin-type": "Uint8" + "description": "The threshold subfield contains either the threshold value or the offset value to be used for conditional reporting.\n\nFor reportingCondition subfield with values 1 and 2, the threshold value is a logarithmic function of the received signal power, as defined in section 9.4.2.38 of IEEE 802.11-2016 [8].\n\nFor reportingCondition subfield values 3 and 4, the threshold value is a logarithmic function of the signal-to-noise ratio, as described in section 9.4.2.41 of IEEE 802.11-2016 [8].\n\nFor reportingCondition subfield values 5 to 10, the offset value is an 8-bit 2s complement integer in units of 0,5 dBm. The indicated reporting condition applies individually to each measured Beacon, Measurement Pilot, or Probe Response frame.", + "contentEncoding": "int32" } - }, + } + }, + "BeaconRequestConfig": { + "title": "BeaconRequestConfig", "required": [ - "reportingCondition", - "threshold" + "beaconReportingConf", + "channelId", + "measurementMode", + "operatingClass" ], "type": "object", - "x-etsi-ref": "6.5.28" - }, - "BeaconRequestConfig": { "properties": { "beaconReportingConf": { "$ref": "#/components/schemas/BeaconReportingConfig" }, "bssid": { - "description": "The BSSID field indicates the BSS for which a beacon report is requested. If absent, the requested beacon reports should include all BSSs on the channel.", "type": "string", - "x-etsi-mec-cardinality": "0..1", - "x-etsi-mec-origin-type": "String" + "description": "The BSSID field indicates the BSS for which a beacon report is requested. If absent, the requested beacon reports should include all BSSs on the channel." }, "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.", - "format": "uint8", "type": "integer", - "x-etsi-mec-cardinality": "1", - "x-etsi-mec-origin-type": "Uint8" + "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.", + "contentEncoding": "int32" }, "measurementMode": { - "description": "0 for passive.\n1 for active.\n2 for beacon table.", - "format": "uint8", "type": "integer", - "x-etsi-mec-cardinality": "1", - "x-etsi-mec-origin-type": "Uint8" + "description": "0 for passive.\n1 for active.\n2 for beacon table.", + "contentEncoding": "int32" }, "operatingClass": { - "description": "Operating Class field indicates an operating class value as defined in Annex E within IEEE 802.112016 [8].", - "format": "uint8", "type": "integer", - "x-etsi-mec-cardinality": "1", - "x-etsi-mec-origin-type": "Uint8" + "description": "Operating Class field indicates an operating class value as defined in Annex E within IEEE 802.112016 [8].", + "contentEncoding": "int32" }, "ssid": { - "description": "The SSID subelement indicates the ESS or IBSS for which a beacon report is requested.", "type": "string", - "x-etsi-mec-cardinality": "0..1", - "x-etsi-mec-origin-type": "String" + "description": "The SSID subelement indicates the ESS or IBSS for which a beacon report is requested." } - }, + } + }, + "BssCapabilities": { + "title": "BssCapabilities", "required": [ - "operatingClass", - "channelId", - "measurementMode", - "beaconReportingConf" + "apsd", + "delayedBACK", + "immediateBACK", + "qos", + "radioMeasurements", + "spectrumManagement" ], "type": "object", - "x-etsi-ref": "6.5.25" - }, - "BssCapabilities": { "properties": { "apsd": { - "description": "APSD Option implemented", "type": "boolean", - "x-etsi-mec-cardinality": "1", - "x-etsi-mec-origin-type": "Boolean" + "description": "APSD Option implemented" }, "delayedBACK": { - "description": "Delayed Block Ack Option implemented", "type": "boolean", - "x-etsi-mec-cardinality": "1", - "x-etsi-mec-origin-type": "Boolean" + "description": "Delayed Block Ack Option implemented" }, "immediateBACK": { - "description": "Immediate Block Ack Option implemented", "type": "boolean", - "x-etsi-mec-cardinality": "1", - "x-etsi-mec-origin-type": "Boolean" + "description": "Immediate Block Ack Option implemented" }, "qos": { - "description": "QoS Option implemented", "type": "boolean", - "x-etsi-mec-cardinality": "1", - "x-etsi-mec-origin-type": "Boolean" + "description": "QoS Option implemented" }, "radioMeasurements": { - "description": "Radio Measurement Activated", "type": "boolean", - "x-etsi-mec-cardinality": "1", - "x-etsi-mec-origin-type": "Boolean" + "description": "Radio Measurement Activated" }, "spectrumManagement": { - "description": "Spectrum Management required", "type": "boolean", - "x-etsi-mec-cardinality": "1", - "x-etsi-mec-origin-type": "Boolean" + "description": "Spectrum Management required" } - }, + } + }, + "BssLoad": { + "title": "BssLoad", "required": [ - "spectrumManagement", - "qos", - "apsd", - "radioMeasurements", - "delayedBACK", - "immediateBACK" + "availAdmCap", + "channelUtilization", + "staCount" ], "type": "object", - "x-etsi-ref": "6.5.31" - }, - "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" + "description": "Available Admission Capacity that specifies the remaining amount of medium time available via explicit admission control, in units of 32 s/s.", + "contentEncoding": "int32" }, "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" + "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.", + "contentEncoding": "int32" }, "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" + "description": "An unsigned integer that indicates the total number of STAs currently associated with this BSS.", + "contentEncoding": "int32" } - }, + } + }, + "BssidInfo": { + "title": "BssidInfo", "required": [ - "staCount", - "channelUtilization", - "availAdmCap" + "apReachability", + "capabilities", + "ftm", + "highThroughput", + "mobilityDomain", + "security", + "veryHighThroughput" ], "type": "object", - "x-etsi-ref": "6.5.7" - }, - "BssidInfo": { "properties": { "apReachability": { - "description": "The apReachability field indicates whether the AP identified by this BSSID is reachable by the STA that requested the neighbor report. Valid values:\n0 = reserved\n1 = not reachable\n2 = unknown\n3 = reachable.", - "format": "uint8", "type": "integer", - "x-etsi-mec-cardinality": "1", - "x-etsi-mec-origin-type": "Uint8" + "description": "The apReachability field indicates whether the AP identified by this BSSID is reachable by the STA that requested the neighbor report. Valid values:\n0 = reserved\n1 = not reachable\n2 = unknown\n3 = reachable.", + "contentEncoding": "int32" }, "capabilities": { "$ref": "#/components/schemas/BssCapabilities" }, "ftm": { - "description": "True indicates the AP represented by this BSSID is an AP that has set the Fine Timing Measurement Responder field of the Extended Capabilities element to 1.\n\nFalse indicates either that the reporting AP has dot11FineTimingMsmtRespActivated equal to false, or the reported AP has not set the Fine Timing Measurement Responder field of the Extended Capabilities element to 1 or that the Fine Timing Measurement Responder field of the reported AP is not available to the reporting AP at this time.", "type": "boolean", - "x-etsi-mec-cardinality": "1", - "x-etsi-mec-origin-type": "Boolean" + "description": "True indicates the AP represented by this BSSID is an AP that has set the Fine Timing Measurement Responder field of the Extended Capabilities element to 1.\n\nFalse indicates either that the reporting AP has dot11FineTimingMsmtRespActivated equal to false, or the reported AP has not set the Fine Timing Measurement Responder field of the Extended Capabilities element to 1 or that the Fine Timing Measurement Responder field of the reported AP is not available to the reporting AP at this time." }, "highThroughput": { - "description": "True indicates that the AP represented by this BSSID is an HT AP including the HT Capabilities element in its Beacons, and that the contents of that HT Capabilities element are identical to the HT Capabilities element advertised by the AP sending the report.", "type": "boolean", - "x-etsi-mec-cardinality": "1", - "x-etsi-mec-origin-type": "Boolean" + "description": "True indicates that the AP represented by this BSSID is an HT AP including the HT Capabilities element in its Beacons, and that the contents of that HT Capabilities element are identical to the HT Capabilities element advertised by the AP sending the report." }, "mobilityDomain": { - "description": "True indicates the AP represented by this BSSID is including an MDE in its Beacon frames and that the contents of that MDE are identical to the MDE advertised by the AP sending the report.", "type": "boolean", - "x-etsi-mec-cardinality": "1", - "x-etsi-mec-origin-type": "Boolean" + "description": "True indicates the AP represented by this BSSID is including an MDE in its Beacon frames and that the contents of that MDE are identical to the MDE advertised by the AP sending the report." }, "security": { - "description": "True indicates the AP identified by this BSSID supports the same security provisioning as used by the STA in its current association.\n\nFalse indicates either that the AP does not support the same security provisioning or that the security information is not available at this time.", "type": "boolean", - "x-etsi-mec-cardinality": "1", - "x-etsi-mec-origin-type": "Boolean" + "description": "True indicates the AP identified by this BSSID supports the same security provisioning as used by the STA in its current association.\n\nFalse indicates either that the AP does not support the same security provisioning or that the security information is not available at this time." }, "veryHighThroughput": { - "description": "True indicates that the AP represented by this BSSID is a VHT AP and that the VHT Capabilities element, if included as a subelement in the report, is identical in content to the VHT Capabilities element included in the AP's Beacon.", "type": "boolean", - "x-etsi-mec-cardinality": "1", - "x-etsi-mec-origin-type": "Boolean" + "description": "True indicates that the AP represented by this BSSID is a VHT AP and that the VHT Capabilities element, if included as a subelement in the report, is identical in content to the VHT Capabilities element included in the AP's Beacon." } - }, + } + }, + "ChannelLoad": { + "title": "ChannelLoad", "required": [ - "apReachability", - "security", - "capabilities", - "mobilityDomain", - "highThroughput", - "veryHighThroughput", - "ftm" + "channel", + "channelLoad", + "measurementDuration", + "measurementId", + "operatingClass" ], "type": "object", - "x-etsi-ref": "6.5.30" - }, - "ChannelLoad": { "properties": { "channel": { - "description": "Channel number indicates the channel number for which the measurement report applies.", - "format": "uint8", "type": "integer", - "x-etsi-mec-cardinality": "1", - "x-etsi-mec-origin-type": "Uint8" + "description": "Channel number indicates the channel number for which the measurement report applies.", + "contentEncoding": "int32" }, "channelLoad": { - "description": "Proportion of measurement duration for which the measuring STA determined the channel to be busy, as a percentage of time, linearly scaled with 255 representing 100 %.", - "format": "uint8", "type": "integer", - "x-etsi-mec-cardinality": "1", - "x-etsi-mec-origin-type": "Uint8" + "description": "Proportion of measurement duration for which the measuring STA determined the channel to be busy, as a percentage of time, linearly scaled with 255 representing 100 %.", + "contentEncoding": "int32" }, "measurementDuration": { - "description": "Duration over which the Channel Load report was measured, in units of TUs of 1 024 µs.", - "format": "uint8", "type": "integer", - "x-etsi-mec-cardinality": "1", - "x-etsi-mec-origin-type": "Uint8" + "description": "Duration over which the Channel Load report was measured, in units of TUs of 1 024 µs.", + "contentEncoding": "int32" }, "measurementId": { - "description": "Measurement ID of the Measurement configuration applied to this Channel Load Report.", "type": "string", - "x-etsi-mec-cardinality": "1", - "x-etsi-mec-origin-type": "String" + "description": "Measurement ID of the Measurement configuration applied to this Channel Load Report." }, "operatingClass": { - "description": "Operating Class field indicates an operating class value as defined in Annex E within IEEE 802.11-2016 [8].", - "format": "uint8", "type": "integer", - "x-etsi-mec-cardinality": "1", - "x-etsi-mec-origin-type": "Uint8" + "description": "Operating Class field indicates an operating class value as defined in Annex E within IEEE 802.11-2016 [8].", + "contentEncoding": "int32" }, "staId": { "$ref": "#/components/schemas/StaIdentity" } - }, + } + }, + "ChannelLoadConfig": { + "title": "ChannelLoadConfig", "required": [ - "measurementId", - "operatingClass", "channel", - "measurementDuration", - "channelLoad" + "operatingClass" ], "type": "object", - "x-etsi-ref": "6.5.39" - }, - "ChannelLoadConfig": { "properties": { "channel": { - "description": "Channel for which the channel load report is requested.", "type": "integer", - "x-etsi-mec-cardinality": "1", - "x-etsi-mec-origin-type": "Integer" + "description": "Channel for which the channel load report is requested.", + "contentEncoding": "int32" }, "operatingClass": { - "description": "Operating Class field indicates an operating class value as defined in Annex E within IEEE 802.11-2016 [8].", - "format": "uint8", "type": "integer", - "x-etsi-mec-cardinality": "1", - "x-etsi-mec-origin-type": "Uint8" + "description": "Operating Class field indicates an operating class value as defined in Annex E within IEEE 802.11-2016 [8].", + "contentEncoding": "int32" }, "reportingCondition": { - "description": "Reporting condition for the Beacon Report as per Table 9-153 of IEEE 802.11-2016 [8]:\n0 = Report to be issued after each measurement.\n1 = Report to be issued when Channel Load is greater than or equal to the threshold.\n2 = Report to be issued when Channel Load is less than or equal to the threshold.\n\nIf this optional field is not provided, channel load report should be issued after each measurement (reportingCondition = 0).", - "format": "uint8", "type": "integer", - "x-etsi-mec-cardinality": "0..1", - "x-etsi-mec-origin-type": "Uint8" + "description": "Reporting condition for the Beacon Report as per Table 9-153 of IEEE 802.11-2016 [8]:\n0 = Report to be issued after each measurement.\n1 = Report to be issued when Channel Load is greater than or equal to the threshold.\n2 = Report to be issued when Channel Load is less than or equal to the threshold.\n\nIf this optional field is not provided, channel load report should be issued after each measurement (reportingCondition = 0).", + "contentEncoding": "int32" }, "threshold": { - "description": "Channel Load reference value for threshold reporting. This field shall be provided for reportingCondition values 1 and 2.", - "format": "uint8", "type": "integer", - "x-etsi-mec-cardinality": "0..1", - "x-etsi-mec-origin-type": "Uint8" + "description": "Channel Load reference value for threshold reporting. This field shall be provided for reportingCondition values 1 and 2.", + "contentEncoding": "int32" } - }, + } + }, + "CivicLocation": { + "title": "CivicLocation", "required": [ - "operatingClass", - "channel" + "country" ], "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" + "description": "Language" }, "ca1": { - "description": "National subdivisions (state, canton, region, province, prefecture) ", "type": "string", - "x-etsi-mec-cardinality": "0..1", - "x-etsi-mec-origin-type": "String" + "description": "National subdivisions (state, canton, region, province, prefecture)" }, "ca128": { - "description": "Script", "type": "string", - "x-etsi-mec-cardinality": "0..1", - "x-etsi-mec-origin-type": "String" + "description": "Script" }, "ca16": { - "description": "Leading street direction", "type": "string", - "x-etsi-mec-cardinality": "0..1", - "x-etsi-mec-origin-type": "String" + "description": "Leading street direction" }, "ca17": { - "description": "Trailing street suffix", "type": "string", - "x-etsi-mec-cardinality": "0..1", - "x-etsi-mec-origin-type": "String" + "description": "Trailing street suffix" }, "ca18": { - "description": "Street suffix or type", "type": "string", - "x-etsi-mec-cardinality": "0..1", - "x-etsi-mec-origin-type": "String" + "description": "Street suffix or type" }, "ca19": { - "description": "House number", "type": "string", - "x-etsi-mec-cardinality": "0..1", - "x-etsi-mec-origin-type": "String" + "description": "House number" }, "ca2": { - "description": "County, parish, gun (JP), district (IN)", "type": "string", - "x-etsi-mec-cardinality": "0..1", - "x-etsi-mec-origin-type": "String" + "description": "County, parish, gun (JP), district (IN)" }, "ca20": { - "description": "House number suffix", "type": "string", - "x-etsi-mec-cardinality": "0..1", - "x-etsi-mec-origin-type": "String" + "description": "House number suffix" }, "ca21": { - "description": "Landmark of vanity address", "type": "string", - "x-etsi-mec-cardinality": "0..1", - "x-etsi-mec-origin-type": "String" + "description": "Landmark of vanity address" }, "ca22": { - "description": "Additional location information", "type": "string", - "x-etsi-mec-cardinality": "0..1", - "x-etsi-mec-origin-type": "String" + "description": "Additional location information" }, "ca23": { - "description": "Name (residence and office occupant)", "type": "string", - "x-etsi-mec-cardinality": "0..1", - "x-etsi-mec-origin-type": "String" + "description": "Name (residence and office occupant)" }, "ca24": { - "description": "Postal/zip code", "type": "string", - "x-etsi-mec-cardinality": "0..1", - "x-etsi-mec-origin-type": "String" + "description": "Postal/zip code" }, "ca25": { - "description": "Building (structure)", "type": "string", - "x-etsi-mec-cardinality": "0..1", - "x-etsi-mec-origin-type": "String" + "description": "Building (structure)" }, "ca26": { - "description": "Unit (apartment/suite)", "type": "string", - "x-etsi-mec-cardinality": "0..1", - "x-etsi-mec-origin-type": "String" + "description": "Unit (apartment/suite)" }, "ca27": { - "description": "Floor", "type": "string", - "x-etsi-mec-cardinality": "0..1", - "x-etsi-mec-origin-type": "String" + "description": "Floor" }, "ca28": { - "description": "Room", "type": "string", - "x-etsi-mec-cardinality": "0..1", - "x-etsi-mec-origin-type": "String" + "description": "Room" }, "ca29": { - "description": "Type of place", "type": "string", - "x-etsi-mec-cardinality": "0..1", - "x-etsi-mec-origin-type": "String" + "description": "Type of place" }, "ca3": { - "description": "City, township, shi (JP)", "type": "string", - "x-etsi-mec-cardinality": "0..1", - "x-etsi-mec-origin-type": "String" + "description": "City, township, shi (JP)" }, "ca30": { - "description": "Postal community name", "type": "string", - "x-etsi-mec-cardinality": "0..1", - "x-etsi-mec-origin-type": "String" + "description": "Postal community name" }, "ca31": { - "description": "Post office box", "type": "string", - "x-etsi-mec-cardinality": "0..1", - "x-etsi-mec-origin-type": "String" + "description": "Post office box" }, "ca32": { - "description": "Additional code", "type": "string", - "x-etsi-mec-cardinality": "0..1", - "x-etsi-mec-origin-type": "String" + "description": "Additional code" }, "ca33": { - "description": "Seat (desk.cubicle, workstation)", "type": "string", - "x-etsi-mec-cardinality": "0..1", - "x-etsi-mec-origin-type": "String" + "description": "Seat (desk.cubicle, workstation)" }, "ca34": { - "description": "Primary road name", "type": "string", - "x-etsi-mec-cardinality": "0..1", - "x-etsi-mec-origin-type": "String" + "description": "Primary road name" }, "ca35": { - "description": "Road section", "type": "string", - "x-etsi-mec-cardinality": "0..1", - "x-etsi-mec-origin-type": "String" + "description": "Road section" }, "ca36": { - "description": "Branch road name", "type": "string", - "x-etsi-mec-cardinality": "0..1", - "x-etsi-mec-origin-type": "String" + "description": "Branch road name" }, "ca37": { - "description": "Sub-branch road name", "type": "string", - "x-etsi-mec-cardinality": "0..1", - "x-etsi-mec-origin-type": "String" + "description": "Sub-branch road name" }, "ca38": { - "description": "Street name pre-modifier", "type": "string", - "x-etsi-mec-cardinality": "0..1", - "x-etsi-mec-origin-type": "String" + "description": "Street name pre-modifier" }, "ca39": { - "description": "Street name post-modifier", "type": "string", - "x-etsi-mec-cardinality": "0..1", - "x-etsi-mec-origin-type": "String" + "description": "Street name post-modifier" }, "ca4": { - "description": "City division, borough, city district, ward, chou (JP)", "type": "string", - "x-etsi-mec-cardinality": "0..1", - "x-etsi-mec-origin-type": "String" + "description": "City division, borough, city district, ward, chou (JP)" }, "ca5": { - "description": "Neighborhood, block", "type": "string", - "x-etsi-mec-cardinality": "0..1", - "x-etsi-mec-origin-type": "String" + "description": "Neighborhood, block" }, "ca6": { - "description": "Group of streets below the neighborhood level ", "type": "string", - "x-etsi-mec-cardinality": "0..1", - "x-etsi-mec-origin-type": "String" + "description": "Group of streets below the neighborhood level" }, "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" + "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]" } - }, + } + }, + "DmgCapabilities": { + "title": "DmgCapabilities", "required": [ - "country" + "ExtScMcsCap", + "dmgApOrPcpCapInfo", + "dmgStaBeamTrackTimeLimit", + "dmgStaCapInfo", + "maxNrBasicAmsduSubframes", + "maxNrShortAmsduSubframes" ], "type": "object", - "x-etsi-ref": "6.5.20" - }, - "DmgCapabilities": { "properties": { "ExtScMcsCap": { - "description": "Extended SC MCS capabilities as defined in IEEE 802.11-2016 [8].", - "format": "uint8", "type": "integer", - "x-etsi-mec-cardinality": "1", - "x-etsi-mec-origin-type": "Uint8" + "description": "Extended SC MCS capabilities as defined in IEEE 802.11-2016 [8].", + "contentEncoding": "int32" }, "dmgApOrPcpCapInfo": { - "description": "DMG AP or PCP capabilities information as defined in IEEE 802.11-2016 [8].", - "format": "uint16", "type": "integer", - "x-etsi-mec-cardinality": "1", - "x-etsi-mec-origin-type": "Uint16" + "description": "DMG AP or PCP capabilities information as defined in IEEE 802.11-2016 [8].", + "contentEncoding": "int32" }, "dmgStaBeamTrackTimeLimit": { - "description": "DMG station beam tracking time limit as defined in IEEE 802.11-2016 [8]. ", - "format": "uint16", "type": "integer", - "x-etsi-mec-cardinality": "1", - "x-etsi-mec-origin-type": "Uint16" + "description": "DMG station beam tracking time limit as defined in IEEE 802.11-2016 [8].", + "contentEncoding": "int32" }, "dmgStaCapInfo": { - "description": "DMG station capabilities information as defined in IEEE 802.11-2016 [8]. ", - "format": "uint64", "type": "integer", - "x-etsi-mec-cardinality": "1", - "x-etsi-mec-origin-type": "Uint64" + "description": "DMG station capabilities information as defined in IEEE 802.11-2016 [8].", + "contentEncoding": "int32" }, "maxNrBasicAmsduSubframes": { - "description": "Number of basic A-MSDU subframes in A-MSDU as defined in IEEE 802.11-2016 [8].", - "format": "uint8", "type": "integer", - "x-etsi-mec-cardinality": "1", - "x-etsi-mec-origin-type": "Uint8" + "description": "Number of basic A-MSDU subframes in A-MSDU as defined in IEEE 802.11-2016 [8].", + "contentEncoding": "int32" }, "maxNrShortAmsduSubframes": { - "description": "Number of short A-MSDU subframes in A-MSDU as defined in IEEE 802.11-2016 [8].", - "format": "uint8", "type": "integer", - "x-etsi-mec-cardinality": "1", - "x-etsi-mec-origin-type": "Uint8" + "description": "Number of short A-MSDU subframes in A-MSDU as defined in IEEE 802.11-2016 [8].", + "contentEncoding": "int32" } - }, + } + }, + "EdmgCapabilities": { + "title": "EdmgCapabilities", "required": [ - "dmgStaCapInfo", - "dmgApOrPcpCapInfo", - "dmgStaBeamTrackTimeLimit", - "ExtScMcsCap", - "maxNrBasicAmsduSubframes", - "maxNrShortAmsduSubframes" + "ampduParameters", + "supportedMcs", + "trnParameters" ], "type": "object", - "x-etsi-ref": "6.5.17" - }, - "EdmgCapabilities": { "properties": { "ampduParameters": { - "description": "A-MPDU parameters as defined in draft IEEE P802.11ay [i.11]", - "format": "uint8", "type": "integer", - "x-etsi-mec-cardinality": "1", - "x-etsi-mec-origin-type": "Uint8" + "description": "A-MPDU parameters as defined in draft IEEE P802.11ay [i.11]", + "contentEncoding": "int32" }, "supportedMcs": { - "description": "Supported MCS as defined in draft IEEE P802.11ay [i.11]", - "format": "uint32", "type": "integer", - "x-etsi-mec-cardinality": "1", - "x-etsi-mec-origin-type": "Uint32" + "description": "Supported MCS as defined in draft IEEE P802.11ay [i.11]", + "contentEncoding": "int32" }, "trnParameters": { - "description": "Training parameters as defined in draft IEEE P802.11ay [i.11]", - "format": "uint16", "type": "integer", - "x-etsi-mec-cardinality": "1", - "x-etsi-mec-origin-type": "Uint16" + "description": "Training parameters as defined in draft IEEE P802.11ay [i.11]", + "contentEncoding": "int32" } - }, + } + }, + "ExpiryNotification": { + "title": "ExpiryNotification", "required": [ - "ampduParameters", - "trnParameters", - "supportedMcs" + "_links", + "expiryDeadline", + "notificationType" ], "type": "object", - "x-etsi-ref": "6.5.18" - }, - "ExpiryNotification": { "properties": { "_links": { - "description": "Hyperlink related to the resource.", - "properties": { - "subscription": { - "$ref": "#/components/schemas/LinkType" - } - }, - "required": [ - "subscription" - ], - "type": "object", - "x-etsi-mec-cardinality": "1", - "x-etsi-mec-origin-type": "Structure (inlined)" + "$ref": "#/components/schemas/Links1" }, "expiryDeadline": { "$ref": "#/components/schemas/TimeStamp" }, "notificationType": { - "description": "Shall be set to \"ExpiryNotification\".", "type": "string", - "x-etsi-mec-cardinality": "1", - "x-etsi-mec-origin-type": "String" + "description": "Shall be set to \"ExpiryNotification\"." } - }, + } + }, + "ExtBssLoad": { + "title": "ExtBssLoad", "required": [ - "notificationType", - "_links", - "expiryDeadline" + "muMimoStaCount", + "obsSec20MhzUtil", + "obsSec40MhzUtil", + "obsSec80MhzUtil", + "spatStreamUnderUtil" ], "type": "object", - "x-etsi-ref": "6.4.4" - }, - "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" + "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.", + "contentEncoding": "int32" }, "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" + "description": "Observable loading on each of the secondary 20 MHz channel.", + "contentEncoding": "int32" }, "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" + "description": "Observable loading on each of the secondary 40 MHz channel.", + "contentEncoding": "int32" }, "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" + "description": "Observable loading on each of the secondary 80 MHz channel.", + "contentEncoding": "int32" }, "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" + "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.", + "contentEncoding": "int32" } - }, + } + }, + "GeoLocation": { + "title": "GeoLocation", "required": [ - "muMimoStaCount", - "spatStreamUnderUtil", - "obsSec20MhzUtil", - "obsSec40MhzUtil", - "obsSec80MhzUtil" + "datum", + "lat", + "latUncertainty", + "long", + "longUncertainty" ], "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" + "description": "The altitude value of location as defined in IETF RFC 6225 [6]", + "contentEncoding": "int32" }, "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" + "description": "The type description for altitude information e.g. floors or meters as defined in IETF RFC 6225 [6]", + "contentEncoding": "int32" }, "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" + "description": "The uncertainty for altitude information as defined in IETF RFC 6225 [6]", + "contentEncoding": "int32" }, "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" + "description": "The datum value to express how coordinates are organized and related to real world as defined in IETF RFC 6225 [6]", + "contentEncoding": "int32" }, "lat": { - "description": "The latitude value of location as defined in IETF RFC 6225 [6]", - "format": "uint64", "type": "integer", - "x-etsi-mec-cardinality": "1", - "x-etsi-mec-origin-type": "Uint64" + "description": "The latitude value of location as defined in IETF RFC 6225 [6]", + "contentEncoding": "int32" }, "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" + "description": "The uncertainty for Latitude information as defined in IETF RFC 6225 [6]", + "contentEncoding": "int32" }, "long": { - "description": "The longitude value of location as defined in IETF RFC 6225 [6]", - "format": "uint64", "type": "integer", - "x-etsi-mec-cardinality": "1", - "x-etsi-mec-origin-type": "Uint64" + "description": "The longitude value of location as defined in IETF RFC 6225 [6]", + "contentEncoding": "int32" }, "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" + "description": "The uncertainty for Longitude information as defined in IETF RFC 6225 [6]", + "contentEncoding": "int32" } - }, + } + }, + "HeCapabilities": { + "title": "HeCapabilities", "required": [ - "latUncertainty", - "lat", - "longUncertainty", - "long", - "datum" + "heMacCapInfo", + "hePhyCapinfo", + "supportedHeMcsNssSet" ], "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" + "description": "MAC capabilities of an Access Point.", + "contentEncoding": "int32" }, "hePhyCapinfo": { - "description": "PHY capabilities of an Access Point.", - "format": "uint8", "type": "integer", - "x-etsi-mec-cardinality": "1", - "x-etsi-mec-origin-type": "Uint8" + "description": "PHY capabilities of an Access Point.", + "contentEncoding": "int32" }, "supportedHeMcsNssSet": { - "description": "Supported MCS and NSS Set.", - "format": "uint8", "type": "integer", - "x-etsi-mec-cardinality": "1", - "x-etsi-mec-origin-type": "Uint8" + "description": "Supported MCS and NSS Set.", + "contentEncoding": "int32" } - }, + } + }, + "HtCapabilities": { + "title": "HtCapabilities", "required": [ - "heMacCapInfo", - "hePhyCapinfo", - "supportedHeMcsNssSet" + "ampduParameters", + "aselCap", + "htCapabilityInfo", + "htExtendedCap", + "supportedMcsSet", + "txBeamFormCap" ], "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" + "description": "A-MPDU parameters as defined in IEEE 802.11-2016 [8].", + "contentEncoding": "int32" }, "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" + "description": "ASEL capabilities as defined in IEEE 802.11-2016 [8].", + "contentEncoding": "int32" }, "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" + "description": "HT Capability Information as defined in IEEE 802.11-2016 [8].", + "contentEncoding": "int32" }, "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" + "description": "Extended HT Capabilities as defined in IEEE 802.11-2016 [8].", + "contentEncoding": "int32" }, "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" + "description": "Supported MCS set as defined in IEEE 802.11-2016 [8].", + "contentEncoding": "int32" }, "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" + "description": "Transmit Beamforming Capabilities as defined in IEEE 802.11-2016 [8].", + "contentEncoding": "int32" } - }, + } + }, + "LinkType": { + "title": "LinkType", "required": [ - "htCapabilityInfo", - "ampduParameters", - "supportedMcsSet", - "htExtendedCap", - "txBeamFormCap", - "aselCap" + "href" ], "type": "object", - "x-etsi-ref": "6.5.14" - }, - "InlineNotification": { - "discriminator": { - "propertyName": "notificationType" - }, - "oneOf": [ - { - "$ref": "#/components/schemas/AssocStaNotification" - }, - { - "$ref": "#/components/schemas/StaDataRateNotification" - }, - { - "$ref": "#/components/schemas/MeasurementReportNotification" - } - ] - }, - "InlineSubscription": { - "discriminator": { - "propertyName": "subscriptionType" - }, - "oneOf": [ - { - "$ref": "#/components/schemas/AssocStaSubscription" - }, - { - "$ref": "#/components/schemas/StaDataRateSubscription" - }, - { - "$ref": "#/components/schemas/MeasurementReportSubscription" - } - ] - }, - "LinkType": { "properties": { "href": { "type": "string" } - }, + } + }, + "MeasurementConfig": { + "title": "MeasurementConfig", "required": [ - "href" + "measurementId", + "measurementInfo", + "staId" ], "type": "object", - "x-etsi-ref": "6.5.23" - }, - "MeasurementConfig": { "properties": { "_links": { - "description": "Hyperlink related to the resource.", - "properties": { - "self": { - "$ref": "#/components/schemas/LinkType" - } - }, - "required": [ - "self" - ], - "type": "object", - "x-etsi-mec-cardinality": "0..1", - "x-etsi-mec-origin-type": "Structure (inlined)" + "$ref": "#/components/schemas/Links4" }, "measurementId": { - "description": "Unique identifier allocated by the service consumer to identify measurement reports (within sta_information query), associated with this measurement configuration.", "type": "string", - "x-etsi-mec-cardinality": "1", - "x-etsi-mec-origin-type": "String" + "description": "Unique identifier allocated by the service consumer to identify measurement reports (within sta_information query), associated with this measurement configuration." }, "measurementInfo": { "$ref": "#/components/schemas/MeasurementInfo" }, "staId": { - "description": "Identifier(s) to uniquely specify the target client station(s) for the measurement configuration.", + "minItems": 1, + "type": "array", "items": { "$ref": "#/components/schemas/StaIdentity" }, - "minItems": 1, - "type": "array", - "x-etsi-mec-cardinality": "1..N", - "x-etsi-mec-origin-type": "StaIdentity" + "description": "Identifier(s) to uniquely specify the target client station(s) for the measurement configuration." } - }, + } + }, + "MeasurementConfigLinkList": { + "title": "MeasurementConfigLinkList", "required": [ - "staId", - "measurementId", - "measurementInfo" + "_links" ], "type": "object", - "x-etsi-ref": "6.2.4" - }, - "MeasurementConfigLinkList": { "properties": { "_links": { - "description": "Hyperlink related to the resource.", - "properties": { - "self": { - "$ref": "#/components/schemas/LinkType" - } - }, - "required": [ - "self" - ], - "type": "object", - "x-etsi-mec-cardinality": "1", - "x-etsi-mec-origin-type": "Structure (inlined)" + "$ref": "#/components/schemas/Links4" }, "measurementConfig": { - "description": "", + "type": "array", "items": { - "properties": { - "href": { - "description": "The URI referring to a measurement configuration.", - "format": "uri", - "type": "string", - "x-etsi-mec-cardinality": "1", - "x-etsi-mec-origin-type": "URI" - }, - "measurementId": { - "description": "Unique identifier allocated by the service consumer to identify measurement reports associated with this measurement configuration.", - "type": "string", - "x-etsi-mec-cardinality": "1", - "x-etsi-mec-origin-type": "String" - } - }, - "required": [ - "href", - "measurementId" - ], - "type": "object" + "$ref": "#/components/schemas/MeasurementConfig1" }, - "type": "array", - "x-etsi-mec-cardinality": "0..N", - "x-etsi-mec-origin-type": "Structure (inlined)" + "description": "" } - }, - "required": [ - "_links" - ], - "type": "object", - "x-etsi-ref": "6.2.5" + } }, "MeasurementInfo": { + "title": "MeasurementInfo", + "type": "object", "properties": { "beaconRequestConf": { "$ref": "#/components/schemas/BeaconRequestConfig" @@ -2369,765 +2831,567 @@ "$ref": "#/components/schemas/ChannelLoadConfig" }, "measurementDuration": { - "description": "Duration of the measurement in Time Units (TUs) of 1 024 µs, as defined in section 11.11.4 of IEEE 802.11-2016 [8]. If not provided, the underlying system may utilize a default configuration that will be indicated in resulting measurement reports.", - "format": "uint16", "type": "integer", - "x-etsi-mec-cardinality": "0..1", - "x-etsi-mec-origin-type": "Uint16" + "description": "Duration of the measurement in Time Units (TUs) of 1 024 µs, as defined in section 11.11.4 of IEEE 802.11-2016 [8]. If not provided, the underlying system may utilize a default configuration that will be indicated in resulting measurement reports.", + "contentEncoding": "int32" }, "neighborReportConf": { "$ref": "#/components/schemas/NeighborReportConfig" }, "randomInterval": { - "description": "Random interval to be used for starting the measurement in TUs of 1 024 µs, as specified in section 11.11.3 of IEEE 802.11-2016 [8]. If not provided, the underlying system may utilize a default configuration that will be indicated in resulting measurement reports.", - "format": "uint16", "type": "integer", - "x-etsi-mec-cardinality": "0..1", - "x-etsi-mec-origin-type": "Uint16" + "description": "Random interval to be used for starting the measurement in TUs of 1 024 µs, as specified in section 11.11.3 of IEEE 802.11-2016 [8]. If not provided, the underlying system may utilize a default configuration that will be indicated in resulting measurement reports.", + "contentEncoding": "int32" }, "staStatisticsConf": { "$ref": "#/components/schemas/StaStatisticsConfig" } - }, - "type": "object", - "x-etsi-notes": "NOTE 1:\tOnly one of channelLoadConf, beaconRequestConf, staStatisticsConf or neighborReportConf is allowed in a MeasurementInfo instance.\nNOTE 2:\tAs per IEEE 802.11-2016 [8], measurementDuration and randomInterval apply to channelLoad, beaconRequest, staStatistics, and neighborReport configurations.", - "x-etsi-ref": "6.5.41" + } }, "MeasurementReportNotification": { - "properties": { - "beaconReport": { - "description": "Beacon Report as defined in IEEE 802.11-2016 [8].", - "items": { - "$ref": "#/components/schemas/BeaconReport" - }, - "minItems": 0, - "type": "array", - "x-etsi-mec-cardinality": "0..N", - "x-etsi-mec-origin-type": "BeaconReport" - }, - "channelLoad": { - "description": "Channel Load reports as seen by the station as defined in IEEE 802.11-2016 [8].", - "items": { - "$ref": "#/components/schemas/ChannelLoad" - }, - "minItems": 0, - "type": "array", - "x-etsi-mec-cardinality": "0..N", - "x-etsi-mec-origin-type": "ChannelLoad" - }, - "neighborReport": { - "description": "Neighbor Report providing information about neighbor Access Points seen by the station as defined in IEEE 802.112016 [8].", - "items": { - "$ref": "#/components/schemas/NeighborReport" - }, - "minItems": 0, - "type": "array", - "x-etsi-mec-cardinality": "0..N", - "x-etsi-mec-origin-type": "NeighborReport" - }, - "notificationType": { - "description": "Shall be set to \"MeasurementReportNotification\".", - "type": "string", - "x-etsi-mec-cardinality": "1", - "x-etsi-mec-origin-type": "String" - }, - "staStatistics": { - "description": "STA Statistics Report as defined in IEEE 802.11-2016 [8].", - "items": { - "$ref": "#/components/schemas/StaStatistics" - }, - "minItems": 0, - "type": "array", - "x-etsi-mec-cardinality": "0..N", - "x-etsi-mec-origin-type": "StaStatistics" + "title": "MeasurementReportNotification", + "allOf": [ + { + "$ref": "#/components/schemas/InlineNotification" }, - "timeStamp": { - "$ref": "#/components/schemas/TimeStamp" + { + "type": "object", + "properties": { + "beaconReport": { + "minItems": 0, + "type": "array", + "items": { + "$ref": "#/components/schemas/BeaconReport" + }, + "description": "Beacon Report as defined in IEEE 802.11-2016 [8]." + }, + "channelLoad": { + "minItems": 0, + "type": "array", + "items": { + "$ref": "#/components/schemas/ChannelLoad" + }, + "description": "Channel Load reports as seen by the station as defined in IEEE 802.11-2016 [8]." + }, + "neighborReport": { + "minItems": 0, + "type": "array", + "items": { + "$ref": "#/components/schemas/NeighborReport" + }, + "description": "Neighbor Report providing information about neighbor Access Points seen by the station as defined in IEEE 802.112016 [8]." + }, + "staStatistics": { + "minItems": 0, + "type": "array", + "items": { + "$ref": "#/components/schemas/StaStatistics" + }, + "description": "STA Statistics Report as defined in IEEE 802.11-2016 [8]." + }, + "timeStamp": { + "$ref": "#/components/schemas/TimeStamp" + } + } } - }, - "required": [ - "notificationType" - ], - "type": "object", - "x-etsi-notes": "NOTE 1:\tEach MeasurementReportNotification shall include a single measurement report type (channelLoad, beaconRequest, etc.), based on the MeasurementReportSubscription.\nNOTE 2:\tA single MeasurementReportNotification may include multiple measurement reports (of the same type), if the MeasurementReportSubscription configured the measurement report for several client stations and multiple reports are available to WAIS.", - "x-etsi-ref": "6.4.5" + ] }, "MeasurementReportSubscription": { - "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" - } - }, + "title": "MeasurementReportSubscription", + "allOf": [ + { + "$ref": "#/components/schemas/InlineSubscription" + }, + { "required": [ - "self" + "measurementId", + "measurementInfo", + "staId" ], "type": "object", - "x-etsi-mec-cardinality": "0..1", - "x-etsi-mec-origin-type": "Structure (inlined)" - }, - "callbackReference": { - "type": "string" - }, - "expiryDeadline": { - "$ref": "#/components/schemas/TimeStamp" - }, - "measurementId": { - "description": "Unique identifier allocated by the service consumer to identify measurement reports associated with this measurement subscription.", - "type": "string", - "x-etsi-mec-cardinality": "1", - "x-etsi-mec-origin-type": "String" - }, - "measurementInfo": { - "$ref": "#/components/schemas/MeasurementInfo" - }, - "requestTestNotification": { - "description": "Set to TRUE by the service consumer to request a test notification on the callbackReference URI to determine if it is reachable by the WAIS for notifications.", - "type": "boolean", - "x-etsi-mec-cardinality": "0..1", - "x-etsi-mec-origin-type": "Boolean" - }, - "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 \"MeasurementReportSubscription\".", - "type": "string", - "x-etsi-mec-cardinality": "1", - "x-etsi-mec-origin-type": "String" - }, - "websockNotifConfig": { - "$ref": "#/components/schemas/WebsockNotifConfig" + "properties": { + "_links": { + "$ref": "#/components/schemas/Links" + }, + "callbackReference": { + "type": "string" + }, + "expiryDeadline": { + "$ref": "#/components/schemas/TimeStamp" + }, + "measurementId": { + "type": "string", + "description": "Unique identifier allocated by the service consumer to identify measurement reports associated with this measurement subscription." + }, + "measurementInfo": { + "$ref": "#/components/schemas/MeasurementInfo" + }, + "requestTestNotification": { + "type": "boolean", + "description": "Set to TRUE by the service consumer to request a test notification on the callbackReference URI to determine if it is reachable by the WAIS for notifications." + }, + "staId": { + "minItems": 1, + "type": "array", + "items": { + "$ref": "#/components/schemas/StaIdentity" + }, + "description": "Identifier(s) to uniquely specify the target client station(s) for the subscription." + }, + "websockNotifConfig": { + "$ref": "#/components/schemas/WebsockNotifConfig" + } + } } - }, + ] + }, + "NeighborReport": { + "title": "NeighborReport", "required": [ - "subscriptionType", - "staId", + "bssid", + "bssidInfo", + "channel", "measurementId", - "measurementInfo" + "operatingClass", + "phyType" ], "type": "object", - "x-etsi-notes": "NOTE:\tAt least one of callbackReference and websockNotifConfig shall be provided by the service consumer. If both are provided, it is up to WAIS to select the method to be used for notifications and to return only that method in the response.", - "x-etsi-ref": "6.3.5" - }, - "NeighborReport": { "properties": { "bssTransitionCandidatePreference": { - "description": "Relative value indicating the preferred ordering for this BSS as a transition candidate for roaming. 255 indicating the most preferred candidate and 1 indicating the least preferred candidate, as defined in Table 9-152 within IEEE 802.112016 [8].", - "format": "uint8", "type": "integer", - "x-etsi-mec-cardinality": "0..1", - "x-etsi-mec-origin-type": "Uint8" + "description": "Relative value indicating the preferred ordering for this BSS as a transition candidate for roaming. 255 indicating the most preferred candidate and 1 indicating the least preferred candidate, as defined in Table 9-152 within IEEE 802.112016 [8].", + "contentEncoding": "int32" }, "bssid": { - "description": "BSSID (MAC address) of the Access Point that is being reported.", "type": "string", - "x-etsi-mec-cardinality": "1", - "x-etsi-mec-origin-type": "String" + "description": "BSSID (MAC address) of the Access Point that is being reported." }, "bssidInfo": { "$ref": "#/components/schemas/BssidInfo" }, "channel": { - "description": "Channel field indicates a channel number, which is interpreted in the context of the indicated operating class. Channel numbers are defined in Annex E within IEEE 802.11-2016 [8].", - "format": "uint8", "type": "integer", - "x-etsi-mec-cardinality": "1", - "x-etsi-mec-origin-type": "Uint8" + "description": "Channel field indicates a channel number, which is interpreted in the context of the indicated operating class. Channel numbers are defined in Annex E within IEEE 802.11-2016 [8].", + "contentEncoding": "int32" }, "measurementId": { - "description": "Measurement ID of the Measurement configuration applied to this Neighbor Report.", "type": "string", - "x-etsi-mec-cardinality": "1", - "x-etsi-mec-origin-type": "String" + "description": "Measurement ID of the Measurement configuration applied to this Neighbor Report." }, "operatingClass": { - "description": "Operating Class field indicates an operating class value as defined in Annex E within IEEE 802.11-2016 [8].", - "format": "uint8", "type": "integer", - "x-etsi-mec-cardinality": "1", - "x-etsi-mec-origin-type": "Uint8" + "description": "Operating Class field indicates an operating class value as defined in Annex E within IEEE 802.11-2016 [8].", + "contentEncoding": "int32" }, "phyType": { - "description": "PHY type of the AP indicated by this BSSID. It is an integer value coded according to the value of the dot11PHYType, Annex C within IEEE 802.11-2016 [8].\n2 = dsss\n4 = ofdm\n5 = hrdsss\n6 = erp\n7 = ht\n8 = dmg\n9 = vht\n10 = tvht", - "format": "uint8", "type": "integer", - "x-etsi-mec-cardinality": "1", - "x-etsi-mec-origin-type": "Uint8" + "description": "PHY type of the AP indicated by this BSSID. It is an integer value coded according to the value of the dot11PHYType, Annex C within IEEE 802.11-2016 [8].\n2 = dsss\n4 = ofdm\n5 = hrdsss\n6 = erp\n7 = ht\n8 = dmg\n9 = vht\n10 = tvht", + "contentEncoding": "int32" }, "staId": { "$ref": "#/components/schemas/StaIdentity" } - }, - "required": [ - "measurementId", - "bssid", - "bssidInfo", - "operatingClass", - "channel", - "phyType" - ], - "type": "object", - "x-etsi-ref": "6.5.10" + } }, "NeighborReportConfig": { + "title": "NeighborReportConfig", + "type": "object", "properties": { "bssid": { - "description": "BSSID of the neighbor AP which information is intended to obtain. If no specific BSSID is given, the information will be provided for all APs matching the ssid criteria.", "type": "string", - "x-etsi-mec-cardinality": "0..1", - "x-etsi-mec-origin-type": "String" + "description": "BSSID of the neighbor AP which information is intended to obtain. If no specific BSSID is given, the information will be provided for all APs matching the ssid criteria." }, "ssid": { - "description": "The SSID field is optionally present. If present, it contains an SSID element. The presence of an SSID element in a Neighbor Report indicates a request for a neighbor list for the specified SSID in the SSID Element. The absence of an SSID element indicates neighbor report for the current ESS.", "type": "string", - "x-etsi-mec-cardinality": "0..1", - "x-etsi-mec-origin-type": "String" + "description": "The SSID field is optionally present. If present, it contains an SSID element. The presence of an SSID element in a Neighbor Report indicates a request for a neighbor list for the specified SSID in the SSID Element. The absence of an SSID element indicates neighbor report for the current ESS." } - }, - "type": "object", - "x-etsi-notes": "NOTE:\tBoth SSID and BSSID are optional configuration parameters. BSSID is valid when a SSID setting is provided, otherwise ignored. If SSID is not included, the neighbor report will be generated for the SSID (i.e. current ESS) that the station is associated.", - "x-etsi-ref": "6.5.32" + } }, "OBssLoad": { + "title": "OBssLoad", + "required": [ + "allocatedTrafficSelfMean", + "allocatedTrafficShareMean" + ], + "type": "object", "properties": { "allocatedTrafficSelfMean": { - "description": "Mean of allocated traffic from this AP (BSS) in units of 32 µs per second.", - "format": "uint16", "type": "integer", - "x-etsi-mec-cardinality": "1", - "x-etsi-mec-origin-type": "Uint16" + "description": "Mean of allocated traffic from this AP (BSS) in units of 32 µs per second.", + "contentEncoding": "int32" }, "allocatedTrafficSelfStdDev": { - "description": "Standard deviation from the mean of allocation traffic from this BSS in units of 32 µs per second.", - "format": "uint16", "type": "integer", - "x-etsi-mec-cardinality": "0..1", - "x-etsi-mec-origin-type": "Uint16" + "description": "Standard deviation from the mean of allocation traffic from this BSS in units of 32 µs per second.", + "contentEncoding": "int32" }, "allocatedTrafficShareMean": { - "description": "Mean of the sum of allocated traffic from other APs on the overlapping channel in unit of 32 µs per second.", - "format": "uint16", "type": "integer", - "x-etsi-mec-cardinality": "1", - "x-etsi-mec-origin-type": "Uint16" + "description": "Mean of the sum of allocated traffic from other APs on the overlapping channel in unit of 32 µs per second.", + "contentEncoding": "int32" }, "allocatedTrafficShareStdDev": { - "description": "Standard deviation from the mean of the sum of allocated traffic from other APs on the overlapping channel in unit of 32 µs per second.", - "format": "uint16", "type": "integer", - "x-etsi-mec-cardinality": "0..1", - "x-etsi-mec-origin-type": "Uint16" + "description": "Standard deviation from the mean of the sum of allocated traffic from other APs on the overlapping channel in unit of 32 µs per second.", + "contentEncoding": "int32" }, "overlap": { - "description": "Indicates the number of other APs that are sharing the same channel as the reporting AP.", - "format": "uint8", "type": "integer", - "x-etsi-mec-cardinality": "0..1", - "x-etsi-mec-origin-type": "Uint8" + "description": "Indicates the number of other APs that are sharing the same channel as the reporting AP.", + "contentEncoding": "int32" } - }, - "required": [ - "allocatedTrafficSelfMean", - "allocatedTrafficShareMean" - ], - "type": "object", - "x-etsi-ref": "6.5.40" + } }, "ProblemDetails": { + "title": "ProblemDetails", + "type": "object", "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" + "description": "A human-readable explanation specific to this occurrence of the problem" }, "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" + "description": "A URI reference that identifies the specific occurrence of the problem" }, "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" + "description": "The HTTP status code for this occurrence of the problem", + "contentEncoding": "int32" }, "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" + "description": "A short, human-readable summary of the problem type" }, "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" + "description": "A URI reference according to IETF RFC 3986 that identifies the problem type" } - }, - "type": "object" + } }, "ReportedBeaconFrameInfo": { + "title": "ReportedBeaconFrameInfo", + "required": [ + "frameType", + "phyType" + ], + "type": "object", "properties": { "frameType": { - "description": "A value of 0 indicates a Beacon or Probe Response.\nA value of 1 indicates a Measurement Pilot frame.", - "format": "uint8", "type": "integer", - "x-etsi-mec-cardinality": "1", - "x-etsi-mec-origin-type": "Uint8" + "description": "A value of 0 indicates a Beacon or Probe Response.\nA value of 1 indicates a Measurement Pilot frame.", + "contentEncoding": "int32" }, "phyType": { - "description": "Value between 0 and 127 coded according to dot11PHYType.", - "format": "uint8", "type": "integer", - "x-etsi-mec-cardinality": "1", - "x-etsi-mec-origin-type": "Uint8" + "description": "Value between 0 and 127 coded according to dot11PHYType.", + "contentEncoding": "int32" } - }, + } + }, + "ReportingReasonQoSCounters": { + "title": "ReportingReasonQoSCounters", "required": [ - "phyType", - "frameType" + "qosAckFailure", + "qosDiscarded", + "qosFailed", + "qosFrameDuplicate", + "qosMultipleRetry", + "qosRetry", + "qosRtsFailure" ], "type": "object", - "x-etsi-ref": "6.5.29" - }, - "ReportingReasonQoSCounters": { "properties": { "qosAckFailure": { - "description": "dot11QoSAckFailure", "type": "boolean", - "x-etsi-mec-cardinality": "1", - "x-etsi-mec-origin-type": "Boolean" + "description": "dot11QoSAckFailure" }, "qosDiscarded": { - "description": "dot11QoSDiscarded", "type": "boolean", - "x-etsi-mec-cardinality": "1", - "x-etsi-mec-origin-type": "Boolean" + "description": "dot11QoSDiscarded" }, "qosFailed": { - "description": "dot11QoSFailed ", "type": "boolean", - "x-etsi-mec-cardinality": "1", - "x-etsi-mec-origin-type": "Boolean" + "description": "dot11QoSFailed" }, "qosFrameDuplicate": { - "description": "dot11QoSFrameDuplicate", "type": "boolean", - "x-etsi-mec-cardinality": "1", - "x-etsi-mec-origin-type": "Boolean" + "description": "dot11QoSFrameDuplicate" }, "qosMultipleRetry": { - "description": "dot11QoSMultipleRetry", "type": "boolean", - "x-etsi-mec-cardinality": "1", - "x-etsi-mec-origin-type": "Boolean" + "description": "dot11QoSMultipleRetry" }, "qosRetry": { - "description": "dot11QoSRetry", "type": "boolean", - "x-etsi-mec-cardinality": "1", - "x-etsi-mec-origin-type": "Boolean" + "description": "dot11QoSRetry" }, "qosRtsFailure": { - "description": "dot11QoSRTSFailure", "type": "boolean", - "x-etsi-mec-cardinality": "1", - "x-etsi-mec-origin-type": "Boolean" + "description": "dot11QoSRTSFailure" } - }, + } + }, + "ReportingReasonStaCounters": { + "title": "ReportingReasonStaCounters", "required": [ - "qosFailed", - "qosRetry", - "qosMultipleRetry", - "qosFrameDuplicate", - "qosRtsFailure", - "qosAckFailure", - "qosDiscarded" + "ackFailure", + "failed", + "fcsError", + "frameDuplicate", + "multipleRetry", + "retry", + "rtsFailure" ], "type": "object", - "x-etsi-ref": "6.5.38" - }, - "ReportingReasonStaCounters": { "properties": { "ackFailure": { - "description": "dot11AckFailure", "type": "boolean", - "x-etsi-mec-cardinality": "1", - "x-etsi-mec-origin-type": "Boolean" + "description": "dot11AckFailure" }, "failed": { - "description": "dot11Failed", "type": "boolean", - "x-etsi-mec-cardinality": "1", - "x-etsi-mec-origin-type": "Boolean" + "description": "dot11Failed" }, "fcsError": { - "description": "dot11FCSError ", "type": "boolean", - "x-etsi-mec-cardinality": "1", - "x-etsi-mec-origin-type": "Boolean" + "description": "dot11FCSError" }, "frameDuplicate": { - "description": "dot11FrameDuplicate ", "type": "boolean", - "x-etsi-mec-cardinality": "1", - "x-etsi-mec-origin-type": "Boolean" + "description": "dot11FrameDuplicate" }, "multipleRetry": { - "description": "dot11MultipleRetry", "type": "boolean", - "x-etsi-mec-cardinality": "1", - "x-etsi-mec-origin-type": "Boolean" + "description": "dot11MultipleRetry" }, "retry": { - "description": "dot11Retry", "type": "boolean", - "x-etsi-mec-cardinality": "1", - "x-etsi-mec-origin-type": "Boolean" + "description": "dot11Retry" }, "rtsFailure": { - "description": "dot11RTSFailure", "type": "boolean", - "x-etsi-mec-cardinality": "1", - "x-etsi-mec-origin-type": "Boolean" + "description": "dot11RTSFailure" } - }, + } + }, + "Rssi": { + "title": "Rssi", "required": [ - "failed", - "fcsError", - "multipleRetry", - "frameDuplicate", - "rtsFailure", - "ackFailure", - "retry" + "rssi" ], "type": "object", - "x-etsi-ref": "6.5.37" - }, - "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" + "description": "The Received Signal Strength Indicator from a station", + "contentEncoding": "int32" } - }, - "required": [ - "rssi" - ], - "type": "object", - "x-etsi-ref": "6.5.21" + } }, "STACounterTriggerCondition": { + "title": "STACounterTriggerCondition", + "type": "object", "properties": { "ackFailureCountThreshold": { - "description": "Configure and set threshold for dot11AckFailureCount trigger", - "format": "uint32", "type": "integer", - "x-etsi-mec-cardinality": "0..1", - "x-etsi-mec-origin-type": "Uint32" + "description": "Configure and set threshold for dot11AckFailureCount trigger", + "contentEncoding": "int32" }, "failedCountThreshold": { - "description": "Configure and set threshold for dot11FailedCount trigger", - "format": "uint32", "type": "integer", - "x-etsi-mec-cardinality": "0..1", - "x-etsi-mec-origin-type": "Uint32" + "description": "Configure and set threshold for dot11FailedCount trigger", + "contentEncoding": "int32" }, "fcsErrorCountThreshold": { - "description": "Configure and set threshold for dot11FCSErrorCount trigger", - "format": "uint32", "type": "integer", - "x-etsi-mec-cardinality": "0..1", - "x-etsi-mec-origin-type": "Uint32" + "description": "Configure and set threshold for dot11FCSErrorCount trigger", + "contentEncoding": "int32" }, "frameDuplicateCountThreshold": { - "description": "Configure and set threshold for dot11FrameDuplicateCount trigger", - "format": "uint32", "type": "integer", - "x-etsi-mec-cardinality": "0..1", - "x-etsi-mec-origin-type": "Uint32" + "description": "Configure and set threshold for dot11FrameDuplicateCount trigger", + "contentEncoding": "int32" }, "multipleRetryCountThreshold": { - "description": "Configure and set threshold for dot11MultipleRetryCount trigger", - "format": "uint32", "type": "integer", - "x-etsi-mec-cardinality": "0..1", - "x-etsi-mec-origin-type": "Uint32" + "description": "Configure and set threshold for dot11MultipleRetryCount trigger", + "contentEncoding": "int32" }, "retryCountThreshold": { - "description": "Configure and set threshold for dot11RetryCount trigger", - "format": "uint32", "type": "integer", - "x-etsi-mec-cardinality": "0..1", - "x-etsi-mec-origin-type": "Uint32" + "description": "Configure and set threshold for dot11RetryCount trigger", + "contentEncoding": "int32" }, "rtsFailureCountThreshold": { - "description": "Configure and set threshold for dot11RTSFailureCount trigger", - "format": "uint32", "type": "integer", - "x-etsi-mec-cardinality": "0..1", - "x-etsi-mec-origin-type": "Uint32" + "description": "Configure and set threshold for dot11RTSFailureCount trigger", + "contentEncoding": "int32" } - }, - "type": "object", - "x-etsi-ref": "6.5.33" + } }, "StaDataRate": { + "title": "StaDataRate", + "type": "object", "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" + "description": "The data transmit rate in kbps that was most recently used for transmission of data PPDUs from the access point to the station.", + "contentEncoding": "int32" }, "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" + "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.", + "contentEncoding": "int32" } - }, - "type": "object", - "x-etsi-notes": "NOTE:\tStaDataRate shall include at least one instance of either downlink rate or uplink rate and may include both.\n If this report is contained within a data type that provides the station's identifier, staId field may be omitted", - "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" + "title": "StaDataRateNotification", + "allOf": [ + { + "$ref": "#/components/schemas/InlineNotification" }, - "timeStamp": { - "$ref": "#/components/schemas/TimeStamp" + { + "type": "object", + "properties": { + "staDataRate": { + "minItems": 0, + "type": "array", + "items": { + "$ref": "#/components/schemas/StaDataRate" + }, + "description": "Data rates of a client station." + }, + "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" - } - }, + "title": "StaDataRateSubscription", + "allOf": [ + { + "$ref": "#/components/schemas/InlineSubscription" + }, + { "required": [ - "self" + "staId" ], "type": "object", - "x-etsi-mec-cardinality": "0..1", - "x-etsi-mec-origin-type": "Structure (inlined)" - }, - "callbackReference": { - "type": "string" - }, - "expiryDeadline": { - "$ref": "#/components/schemas/TimeStamp" - }, - "notificationEvent": { - "description": "Set for trigger-based event notification reporting.", "properties": { - "downlinkRateThreshold": { - "description": "Downlink data rate threshold for StaDataRate reporting.", - "format": "uint32", - "type": "integer", - "x-etsi-mec-cardinality": "0..1", - "x-etsi-mec-origin-type": "Uint32" + "_links": { + "$ref": "#/components/schemas/Links" }, - "trigger": { - "description": "Trigger event for the notification:\n1 = Notification issued when the STA's downlink data rate is greater than or equal to the downlink threshold.\n2 = Notification issued when the STA's downlink data rate is less than or equal to the downlink threshold.\n3 = Notification issued when the STA's uplink data rate is greater than or equal to the uplink threshold.\n4 = Notification issued when the STA's uplink data rate is less than or equal to the uplink threshold.\n5 = Notification issued when the STA's downlink and uplink data rate is greater than or equal to their thresholds.\n6 = Notification issued when the STA's downlink and uplink data rate is less than or equal to their thresholds.\n7 = Notification issued when the STA's downlink or uplink data rate is greater than or equal to their thresholds.\n8 = Notification issued when the STA's downlink or uplink data rate is less than or equal to their thresholds.", - "enum": [ - 1, - 2, - 3, - 4, - 5, - 6, - 7, - 8 - ], - "type": "integer", - "x-etsi-mec-cardinality": "1", - "x-etsi-mec-origin-type": "Enum (inline)" + "callbackReference": { + "type": "string" + }, + "expiryDeadline": { + "$ref": "#/components/schemas/TimeStamp" }, - "uplinkRateThreshold": { - "description": "Uplink data rate threshold for StaDataRate reporting.", - "format": "uint32", + "notificationEvent": { + "$ref": "#/components/schemas/NotificationEvent1" + }, + "notificationPeriod": { "type": "integer", - "x-etsi-mec-cardinality": "0..1", - "x-etsi-mec-origin-type": "Uint32" + "description": "Set for periodic notification reporting.\nValue indicates the notification period in seconds.", + "contentEncoding": "int32" + }, + "requestTestNotification": { + "type": "boolean", + "description": "Set to TRUE by the service consumer to request a test notification on the callbackReference URI to determine if it is reachable by the WAIS for notifications." + }, + "staId": { + "minItems": 1, + "type": "array", + "items": { + "$ref": "#/components/schemas/StaIdentity" + }, + "description": "Identifier(s) to uniquely specify the target client station(s) for the subscription." + }, + "websockNotifConfig": { + "$ref": "#/components/schemas/WebsockNotifConfig" } - }, - "required": [ - "trigger" - ], - "type": "object", - "x-etsi-mec-cardinality": "0..1", - "x-etsi-mec-origin-type": "Structure (inline)" - }, - "notificationPeriod": { - "description": "Set for periodic notification reporting.\nValue indicates the notification period in seconds.", - "format": "uint8", - "type": "integer", - "x-etsi-mec-cardinality": "0..1", - "x-etsi-mec-origin-type": "Uint8" - }, - "requestTestNotification": { - "description": "Set to TRUE by the service consumer to request a test notification on the callbackReference URI to determine if it is reachable by the WAIS for notifications.", - "type": "boolean", - "x-etsi-mec-cardinality": "0..1", - "x-etsi-mec-origin-type": "Boolean" - }, - "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" - }, - "websockNotifConfig": { - "$ref": "#/components/schemas/WebsockNotifConfig" + } } - }, + ] + }, + "StaIdentity": { + "title": "StaIdentity", "required": [ - "subscriptionType", - "staId" + "macId" ], "type": "object", - "x-etsi-notes": "NOTE 1:\tAt least one of callbackReference and websockNotifConfig shall be provided by the service consumer. If both are provided, it is up to WAIS to select the method to be used for notifications and to return only that method in the response.\nNOTE 2:\tStaDataRateSubscription shall include either notificationPeriod or notificationEvent.\nNOTE 3:\tIf both notificationPeriod and notificationEvent attributes are set, notifications are issued periodically when the trigger threshold is satisfied.", - "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" + "description": "Number which identifies a particular association between a station and an Access Point" }, "ipAddress": { - "description": "IPv4 or IPv6 address(es) allocated for the station.", + "minItems": 0, + "type": "array", "items": { "type": "string" }, - "minItems": 0, - "type": "array", - "x-etsi-mec-cardinality": "0..N", - "x-etsi-mec-origin-type": "String" + "description": "IPv4 or IPv6 address(es) allocated for the station." }, "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" + "description": "Unique identifier assigned to station (as network interface controller) for communications at the data link layer of a network segment." }, "ssid": { - "description": "Service Set Identifier(s) to identify logical networks.", + "minItems": 0, + "type": "array", "items": { "type": "string" }, - "minItems": 0, - "type": "array", - "x-etsi-mec-cardinality": "0..N", - "x-etsi-mec-origin-type": "String" + "description": "Service Set Identifier(s) to identify logical networks." } - }, + } + }, + "StaInfo": { + "title": "StaInfo", "required": [ - "macId" + "staId" ], "type": "object", - "x-etsi-ref": "6.5.11" - }, - "StaInfo": { "properties": { "apAssociated": { "$ref": "#/components/schemas/ApAssociated" }, "beaconReport": { - "description": "Beacon Report as defined in IEEE 802.11-2016 [8]. ", + "minItems": 0, + "type": "array", "items": { "$ref": "#/components/schemas/BeaconReport" }, - "minItems": 0, - "type": "array", - "x-etsi-mec-cardinality": "0..N", - "x-etsi-mec-origin-type": "BeaconReport" + "description": "Beacon Report as defined in IEEE 802.11-2016 [8]." }, "channel": { - "description": "Channel currently used by the station to connect with its associated Access Point.", - "format": "uint32", "type": "integer", - "x-etsi-mec-cardinality": "0..1", - "x-etsi-mec-origin-type": "Uint32" + "description": "Channel currently used by the station to connect with its associated Access Point.", + "contentEncoding": "int32" }, "channelLoad": { - "description": "Channel Load reports as seen by the station as defined IEEE 802.11-2016 [8]. Channel Load reports may be configured for any channel, including the station's current channel for association.", + "minItems": 0, + "type": "array", "items": { "$ref": "#/components/schemas/ChannelLoad" }, - "minItems": 0, - "type": "array", - "x-etsi-mec-cardinality": "0..N", - "x-etsi-mec-origin-type": "ChannelLoad" + "description": "Channel Load reports as seen by the station as defined IEEE 802.11-2016 [8]. Channel Load reports may be configured for any channel, including the station's current channel for association." }, "neighborReport": { - "description": "Information about neighbor Access Points seen by the station as defined IEEE 802.11-2016 [8].", + "minItems": 0, + "type": "array", "items": { "$ref": "#/components/schemas/NeighborReport" }, - "minItems": 0, - "type": "array", - "x-etsi-mec-cardinality": "0..N", - "x-etsi-mec-origin-type": "NeighborReport" + "description": "Information about neighbor Access Points seen by the station as defined IEEE 802.11-2016 [8]." }, "rssi": { "$ref": "#/components/schemas/Rssi" @@ -3139,36 +3403,34 @@ "$ref": "#/components/schemas/StaIdentity" }, "staStatistics": { - "description": "Statistics as defined in IEEE 802.11-2016 [8] for the client station collected over measurement duration.", + "minItems": 0, + "type": "array", "items": { "$ref": "#/components/schemas/StaStatistics" }, - "minItems": 0, - "type": "array", - "x-etsi-mec-cardinality": "0..N", - "x-etsi-mec-origin-type": "StaStatistics" + "description": "Statistics as defined in IEEE 802.11-2016 [8] for the client station collected over measurement duration." }, "timeStamp": { "$ref": "#/components/schemas/TimeStamp" } - }, + } + }, + "StaStatistics": { + "title": "StaStatistics", "required": [ - "staId" + "groupIdentity", + "measurementDuration", + "measurementId" ], "type": "object", - "x-etsi-ref": "6.2.3" - }, - "StaStatistics": { "properties": { "group2to9Data": { "$ref": "#/components/schemas/StaStatisticsGroup2to9Data" }, "groupIdentity": { - "description": "Indicates the requested statistics group describing the Statistics Group Data according to Table 9-114 of IEEE 802.11-2016 [8].\nDepending on group identity, one and only one of the STA Statistics Group Data will be present.", - "format": "uint8", "type": "integer", - "x-etsi-mec-cardinality": "1", - "x-etsi-mec-origin-type": "UInt8" + "description": "Indicates the requested statistics group describing the Statistics Group Data according to Table 9-114 of IEEE 802.11-2016 [8].\nDepending on group identity, one and only one of the STA Statistics Group Data will be present.", + "contentEncoding": "int32" }, "groupOneData": { "$ref": "#/components/schemas/StaStatisticsGroupOneData" @@ -3177,514 +3439,377 @@ "$ref": "#/components/schemas/StaStatisticsGroupZeroData" }, "measurementDuration": { - "description": "Duration over which the Statistics Group Data was measured in time units of 1 024 µs. Duration equal to zero indicates a report of current values.", - "format": "uint16", "type": "integer", - "x-etsi-mec-cardinality": "1", - "x-etsi-mec-origin-type": "UInt16" + "description": "Duration over which the Statistics Group Data was measured in time units of 1 024 µs. Duration equal to zero indicates a report of current values.", + "contentEncoding": "int32" }, "measurementId": { - "description": "Measurement ID of the Measurement configuration applied to this STA Statistics Report.", "type": "string", - "x-etsi-mec-cardinality": "1", - "x-etsi-mec-origin-type": "String" + "description": "Measurement ID of the Measurement configuration applied to this STA Statistics Report." }, "staId": { "$ref": "#/components/schemas/StaIdentity" } - }, + } + }, + "StaStatisticsConfig": { + "title": "StaStatisticsConfig", "required": [ - "measurementId", - "measurementDuration", - "groupIdentity" + "groupIdentity", + "triggeredReport" ], "type": "object", - "x-etsi-ref": "6.5.13" - }, - "StaStatisticsConfig": { "properties": { "groupIdentity": { - "description": "As per Table 9-92 of IEEE 802.11-2016 [8].", - "format": "uint8", "type": "integer", - "x-etsi-mec-cardinality": "1", - "x-etsi-mec-origin-type": "Uint8" + "description": "As per Table 9-92 of IEEE 802.11-2016 [8].", + "contentEncoding": "int32" }, "measurementCount": { - "description": "Valid if triggeredReport = true.\nSpecifies the number of MAC service data units or protocol data units to determine if the trigger conditions are met.", - "format": "uint32", "type": "integer", - "x-etsi-mec-cardinality": "0..1", - "x-etsi-mec-origin-type": "Uint32" + "description": "Valid if triggeredReport = true.\nSpecifies the number of MAC service data units or protocol data units to determine if the trigger conditions are met.", + "contentEncoding": "int32" }, "triggerCondition": { "$ref": "#/components/schemas/STACounterTriggerCondition" }, "triggerTimeout": { - "description": "Valid if triggeredReport = true.\nThe Trigger Timeout field contains a value in units of 100 time-units of 1 024 µs during which a measuring STA does not generate further triggered STA Statistics Reports after a trigger condition has been met.", - "format": "uint16", "type": "integer", - "x-etsi-mec-cardinality": "0..1", - "x-etsi-mec-origin-type": "Uint16" + "description": "Valid if triggeredReport = true.\nThe Trigger Timeout field contains a value in units of 100 time-units of 1 024 µs during which a measuring STA does not generate further triggered STA Statistics Reports after a trigger condition has been met.", + "contentEncoding": "int32" }, "triggeredReport": { - "description": "True = triggered reporting, otherwise duration.", "type": "boolean", - "x-etsi-mec-cardinality": "1", - "x-etsi-mec-origin-type": "Boolean" + "description": "True = triggered reporting, otherwise duration." } - }, + } + }, + "StaStatisticsGroup2to9Data": { + "title": "StaStatisticsGroup2to9Data", "required": [ - "groupIdentity", - "triggeredReport" + "qosAckFailureCount", + "qosDiscardedFrameCount", + "qosFailedCount", + "qosFrameDuplicateCount", + "qosMPDUsReceivedCount", + "qosMultipleRetryCount", + "qosRTSFailureCount", + "qosRTSSuccessCount", + "qosReceivedFragmentCount", + "qosRetriesReceivedCount", + "qosRetryCount", + "qosTransmittedFragmentCount", + "qosTransmittedFrameCount" ], "type": "object", - "x-etsi-ref": "6.5.26" - }, - "StaStatisticsGroup2to9Data": { "properties": { "qosAckFailureCount": { - "description": "dot11QosAckFailureCount counter", - "format": "uint32", "type": "integer", - "x-etsi-mec-cardinality": "1", - "x-etsi-mec-origin-type": "Uint32" + "description": "dot11QosAckFailureCount counter", + "contentEncoding": "int32" }, "qosDiscardedFrameCount": { - "description": "dot11QosDiscardedFrameCount counter", - "format": "uint32", "type": "integer", - "x-etsi-mec-cardinality": "1", - "x-etsi-mec-origin-type": "Uint32" + "description": "dot11QosDiscardedFrameCount counter", + "contentEncoding": "int32" }, "qosFailedCount": { - "description": "dot11QosFailedCount counter", - "format": "uint32", "type": "integer", - "x-etsi-mec-cardinality": "1", - "x-etsi-mec-origin-type": "Uint32" + "description": "dot11QosFailedCount counter", + "contentEncoding": "int32" }, "qosFrameDuplicateCount": { - "description": "dot11QosFrameDuplicateCount counter", - "format": "uint32", "type": "integer", - "x-etsi-mec-cardinality": "1", - "x-etsi-mec-origin-type": "Uint32" + "description": "dot11QosFrameDuplicateCount counter", + "contentEncoding": "int32" }, "qosMPDUsReceivedCount": { - "description": "dot11QosMPDUsReceivedCount counter", - "format": "uint32", "type": "integer", - "x-etsi-mec-cardinality": "1", - "x-etsi-mec-origin-type": "Uint32" + "description": "dot11QosMPDUsReceivedCount counter", + "contentEncoding": "int32" }, "qosMultipleRetryCount": { - "description": "dot11QosMultipleRetryCount counter", - "format": "uint32", "type": "integer", - "x-etsi-mec-cardinality": "1", - "x-etsi-mec-origin-type": "Uint32" + "description": "dot11QosMultipleRetryCount counter", + "contentEncoding": "int32" }, "qosRTSFailureCount": { - "description": "dot11QosRTSFailureCount counter", - "format": "uint32", "type": "integer", - "x-etsi-mec-cardinality": "1", - "x-etsi-mec-origin-type": "Uint32" + "description": "dot11QosRTSFailureCount counter", + "contentEncoding": "int32" }, "qosRTSSuccessCount": { - "description": "dot11QosRTSSuccessCount counter", - "format": "uint32", "type": "integer", - "x-etsi-mec-cardinality": "1", - "x-etsi-mec-origin-type": "Uint32" + "description": "dot11QosRTSSuccessCount counter", + "contentEncoding": "int32" }, "qosReceivedFragmentCount": { - "description": "dot11QosReceivedFragmentCount counter", - "format": "uint32", "type": "integer", - "x-etsi-mec-cardinality": "1", - "x-etsi-mec-origin-type": "Uint32" + "description": "dot11QosReceivedFragmentCount counter", + "contentEncoding": "int32" }, "qosRetriesReceivedCount": { - "description": "dot11QosRetriesReceivedCount counter", - "format": "uint32", "type": "integer", - "x-etsi-mec-cardinality": "1", - "x-etsi-mec-origin-type": "Uint32" + "description": "dot11QosRetriesReceivedCount counter", + "contentEncoding": "int32" }, "qosRetryCount": { - "description": "dot11QosRetryCount counter", - "format": "uint32", "type": "integer", - "x-etsi-mec-cardinality": "1", - "x-etsi-mec-origin-type": "Uint32" + "description": "dot11QosRetryCount counter", + "contentEncoding": "int32" }, "qosTransmittedFragmentCount": { - "description": "dot11QosTransmittedFragmentCount counter", - "format": "uint32", "type": "integer", - "x-etsi-mec-cardinality": "1", - "x-etsi-mec-origin-type": "Uint32" + "description": "dot11QosTransmittedFragmentCount counter", + "contentEncoding": "int32" }, "qosTransmittedFrameCount": { - "description": "dot11QosTransmittedFrameCount counter", - "format": "uint32", "type": "integer", - "x-etsi-mec-cardinality": "1", - "x-etsi-mec-origin-type": "Uint32" + "description": "dot11QosTransmittedFrameCount counter", + "contentEncoding": "int32" }, "reportingReasonQoSCounters": { "$ref": "#/components/schemas/ReportingReasonQoSCounters" } - }, + } + }, + "StaStatisticsGroupOneData": { + "title": "StaStatisticsGroupOneData", "required": [ - "qosTransmittedFragmentCount", - "qosFailedCount", - "qosRetryCount", - "qosMultipleRetryCount", - "qosFrameDuplicateCount", - "qosRTSSuccessCount", - "qosRTSFailureCount", - "qosAckFailureCount", - "qosReceivedFragmentCount", - "qosTransmittedFrameCount", - "qosDiscardedFrameCount", - "qosMPDUsReceivedCount", - "qosRetriesReceivedCount" + "ackFailureCount", + "frameDuplicateCount", + "multipleRetryCount", + "retryCount", + "rtsFailureCount", + "rtsSuccessCount" ], "type": "object", - "x-etsi-ref": "6.5.36" - }, - "StaStatisticsGroupOneData": { "properties": { "ackFailureCount": { - "description": "dot11AckFailureCount counter", - "format": "uint32", "type": "integer", - "x-etsi-mec-cardinality": "1", - "x-etsi-mec-origin-type": "Uint32" + "description": "dot11AckFailureCount counter", + "contentEncoding": "int32" }, "frameDuplicateCount": { - "description": "dot11FrameDuplicateCount counter", - "format": "uint32", "type": "integer", - "x-etsi-mec-cardinality": "1", - "x-etsi-mec-origin-type": "Uint32" + "description": "dot11FrameDuplicateCount counter", + "contentEncoding": "int32" }, "multipleRetryCount": { - "description": "dot11MultipleRetryCount counter", - "format": "uint32", "type": "integer", - "x-etsi-mec-cardinality": "1", - "x-etsi-mec-origin-type": "Uint32" + "description": "dot11MultipleRetryCount counter", + "contentEncoding": "int32" }, "reportingReasonStaCounters": { "$ref": "#/components/schemas/ReportingReasonStaCounters" }, "retryCount": { - "description": "dot11RetryCount counter", - "format": "uint32", "type": "integer", - "x-etsi-mec-cardinality": "1", - "x-etsi-mec-origin-type": "Uint32" + "description": "dot11RetryCount counter", + "contentEncoding": "int32" }, "rtsFailureCount": { - "description": "dot11RTSFailureCount counter", - "format": "uint32", "type": "integer", - "x-etsi-mec-cardinality": "1", - "x-etsi-mec-origin-type": "Uint32" + "description": "dot11RTSFailureCount counter", + "contentEncoding": "int32" }, "rtsSuccessCount": { - "description": "dot11RTSSuccessCount counter", - "format": "uint32", "type": "integer", - "x-etsi-mec-cardinality": "1", - "x-etsi-mec-origin-type": "Uint32" + "description": "dot11RTSSuccessCount counter", + "contentEncoding": "int32" } - }, + } + }, + "StaStatisticsGroupZeroData": { + "title": "StaStatisticsGroupZeroData", "required": [ - "retryCount", - "multipleRetryCount", - "frameDuplicateCount", - "rtsSuccessCount", - "rtsFailureCount", - "ackFailureCount" + "failedCount", + "fcsErrorCount", + "groupReceivedFrameCount", + "groupTransmittedFrameCount", + "receivedFragmentCount", + "transmittedFragmentCount", + "transmittedFrameCount" ], "type": "object", - "x-etsi-ref": "6.5.35" - }, - "StaStatisticsGroupZeroData": { "properties": { "failedCount": { - "description": "dot11FailedCount counter", - "format": "uint32", "type": "integer", - "x-etsi-mec-cardinality": "1", - "x-etsi-mec-origin-type": "Uint32" + "description": "dot11FailedCount counter", + "contentEncoding": "int32" }, "fcsErrorCount": { - "description": "dot11FCSErrorCount counter", - "format": "uint32", "type": "integer", - "x-etsi-mec-cardinality": "1", - "x-etsi-mec-origin-type": "Uint32" + "description": "dot11FCSErrorCount counter", + "contentEncoding": "int32" }, "groupReceivedFrameCount": { - "description": "dot11GroupReceivedFrameCount counter", - "format": "uint32", "type": "integer", - "x-etsi-mec-cardinality": "1", - "x-etsi-mec-origin-type": "Uint32" + "description": "dot11GroupReceivedFrameCount counter", + "contentEncoding": "int32" }, "groupTransmittedFrameCount": { - "description": "dot11GroupTransmittedFrameCount counter", - "format": "uint32", "type": "integer", - "x-etsi-mec-cardinality": "1", - "x-etsi-mec-origin-type": "Uint32" + "description": "dot11GroupTransmittedFrameCount counter", + "contentEncoding": "int32" }, "receivedFragmentCount": { - "description": "dot11ReceivedFragmentCount counter", - "format": "uint32", "type": "integer", - "x-etsi-mec-cardinality": "1", - "x-etsi-mec-origin-type": "Uint32" + "description": "dot11ReceivedFragmentCount counter", + "contentEncoding": "int32" }, "reportingReasonStaCounters": { "$ref": "#/components/schemas/ReportingReasonStaCounters" }, "transmittedFragmentCount": { - "description": "dot11TransmittedFragmentCount counter", - "format": "uint32", "type": "integer", - "x-etsi-mec-cardinality": "1", - "x-etsi-mec-origin-type": "Uint32" + "description": "dot11TransmittedFragmentCount counter", + "contentEncoding": "int32" }, "transmittedFrameCount": { - "description": "dot11TransmittedFrameCount counter", - "format": "uint32", "type": "integer", - "x-etsi-mec-cardinality": "1", - "x-etsi-mec-origin-type": "Uint32" + "description": "dot11TransmittedFrameCount counter", + "contentEncoding": "int32" } - }, + } + }, + "SubscriptionLinkList": { + "title": "SubscriptionLinkList", "required": [ - "transmittedFragmentCount", - "groupTransmittedFrameCount", - "failedCount", - "receivedFragmentCount", - "groupReceivedFrameCount", - "fcsErrorCount", - "transmittedFrameCount" + "_links" ], "type": "object", - "x-etsi-ref": "6.5.34" - }, - "SubscriptionLinkList": { "properties": { "_links": { - "description": "List of hyperlinks related to the resource.", - "properties": { - "self": { - "$ref": "#/components/schemas/LinkType" - } - }, - "required": [ - "self" - ], - "type": "object", - "x-etsi-mec-cardinality": "1", - "x-etsi-mec-origin-type": "Structure (inlined)" + "$ref": "#/components/schemas/Links6" }, "subscription": { - "description": "", + "type": "array", "items": { - "minItems": 0, - "properties": { - "href": { - "description": "The URI referring to the subscription.", - "format": "uri", - "type": "string", - "x-etsi-mec-cardinality": "1", - "x-etsi-mec-origin-type": "URI" - }, - "subscriptionType": { - "description": "Type of the subscription. The string shall be set according to the \"subscriptionType\" attribute of the associated subscription data type defined in 6.3.2, 6.3.3. and 6.3.5:\n“AssocStaSubscription”\n“StaDataRateSubscription”\n“MeasurementReportSubscription”", - "type": "string", - "x-etsi-mec-cardinality": "1", - "x-etsi-mec-origin-type": "String" - } - }, - "required": [ - "href", - "subscriptionType" - ], - "type": "object" + "$ref": "#/components/schemas/Subscription" }, - "type": "array", - "x-etsi-mec-cardinality": "0..N", - "x-etsi-mec-origin-type": "Structure (inlined)" + "description": "" } - }, + } + }, + "TestNotification": { + "title": "TestNotification", "required": [ - "_links" + "_links", + "notificationType" ], "type": "object", - "x-etsi-ref": "6.3.4" - }, - "TestNotification": { "properties": { "_links": { - "description": "Hyperlink related to the resource. ", - "properties": { - "subscription": { - "$ref": "#/components/schemas/LinkType" - } - }, - "required": [ - "subscription" - ], - "type": "object", - "x-etsi-mec-cardinality": "1", - "x-etsi-mec-origin-type": "Structure (inlined)" + "$ref": "#/components/schemas/Links1" }, "notificationType": { - "description": "Shall be set to \"TestNotification\".", "type": "string", - "x-etsi-mec-cardinality": "1", - "x-etsi-mec-origin-type": "String" + "description": "Shall be set to \"TestNotification\"." } - }, + } + }, + "TimeStamp": { + "title": "TimeStamp", "required": [ - "notificationType", - "_links" + "nanoSeconds", + "seconds" ], "type": "object", - "x-etsi-ref": "6.4.6" - }, - "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" + "description": "The nanoseconds part of the time. Time is defined as Unix-time since January 1, 1970, 00:00:00 UTC.", + "contentEncoding": "int32" }, "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" + "description": "The seconds part of the time. Time is defined as Unixtime since January 1, 1970, 00:00:00 UTC.", + "contentEncoding": "int32" } - }, + } + }, + "VhtCapabilities": { + "title": "VhtCapabilities", "required": [ - "seconds", - "nanoSeconds" + "vhtCapInfo", + "vhtMcsNss" ], "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" + "description": "VHT capabilities Info as defined in IEEE 802.11-2016 [8].", + "contentEncoding": "int32" }, "vhtMcsNss": { - "description": "Supported VHT-MCS and NSS Set as defined in IEEE 802.11-2016 [8].", - "format": "uint64", "type": "integer", - "x-etsi-mec-cardinality": "1", - "x-etsi-mec-origin-type": "UInt64" + "description": "Supported VHT-MCS and NSS Set as defined in IEEE 802.11-2016 [8].", + "contentEncoding": "int32" } - }, + } + }, + "WanMetrics": { + "title": "WanMetrics", "required": [ - "vhtCapInfo", - "vhtMcsNss" + "downlinkLoad", + "downlinkSpeed", + "lmd", + "uplinkLoad", + "uplinkSpeed", + "wanInfo" ], "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" + "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.", + "contentEncoding": "int32" }, "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" + "description": "4-octet positive integer whose value is an estimate of the WAN Backhaul link current downlink speed in kilobits per second.", + "contentEncoding": "int32" }, "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" + "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.", + "contentEncoding": "int32" }, "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" + "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.", + "contentEncoding": "int32" }, "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" + "description": "4-octet positive integer whose value is an estimate of the WAN Backhaul link's current uplink speed in kilobits per second.", + "contentEncoding": "int32" }, "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" + "description": "Info about WAN link status, link symmetricity and capacity currently used.", + "contentEncoding": "int32" } - }, - "required": [ - "wanInfo", - "downlinkSpeed", - "uplinkSpeed", - "downlinkLoad", - "uplinkLoad", - "lmd" - ], - "type": "object", - "x-etsi-ref": "6.5.6" + } }, "WebsockNotifConfig": { + "title": "WebsockNotifConfig", + "type": "object", "properties": { "requestWebsocketUri": { - "description": "Set to true by the service consumer to indicate that Websocket delivery is requested.", "type": "boolean", - "x-etsi-mec-cardinality": "0..1", - "x-etsi-mec-origin-type": "Boolean" + "description": "Set to true by the service consumer to indicate that Websocket delivery is requested." }, "websocketUri": { - "description": "Set by WAIS to indicate to the service consumer the Websocket URI to be used for delivering notifications.", - "type": "string" + "type": "string", + "description": "Set by WAIS to indicate to the service consumer the Websocket URI to be used for delivering notifications." } - }, - "type": "object", - "x-etsi-ref": "6.3.6" + } }, "WlanCapabilities": { + "title": "WlanCapabilities", + "type": "object", "properties": { "dmg": { "$ref": "#/components/schemas/DmgCapabilities" @@ -3701,10 +3826,211 @@ "vht": { "$ref": "#/components/schemas/VhtCapabilities" } + } + }, + "InlineNotification": { + "title": "InlineNotification", + "required": [ + "notificationType" + ], + "type": "object", + "properties": { + "notificationType": { + "type": "string" + } + }, + "discriminator": { + "propertyName": "notificationType", + "mapping": { + "AssocStaNotification": "AssocStaNotification", + "MeasurementReportNotification": "MeasurementReportNotification", + "StaDataRateNotification": "StaDataRateNotification" + } + } + }, + "InlineSubscription": { + "title": "InlineSubscription", + "required": [ + "subscriptionType" + ], + "type": "object", + "properties": { + "subscriptionType": { + "type": "string" + } + }, + "discriminator": { + "propertyName": "subscriptionType", + "mapping": { + "AssocStaSubscription": "AssocStaSubscription", + "MeasurementReportSubscription": "MeasurementReportSubscription", + "StaDataRateSubscription": "StaDataRateSubscription" + } + } + }, + "Links": { + "title": "Links", + "required": [ + "self" + ], + "type": "object", + "properties": { + "self": { + "$ref": "#/components/schemas/LinkType" + } + }, + "description": "Hyperlink related to the resource. This shall be only included in the HTTP responses and in HTTP PUT requests." + }, + "Links1": { + "title": "Links1", + "required": [ + "subscription" + ], + "type": "object", + "properties": { + "subscription": { + "$ref": "#/components/schemas/LinkType" + } + }, + "description": "Hyperlink related to the resource." + }, + "Links4": { + "title": "Links4", + "required": [ + "self" + ], + "type": "object", + "properties": { + "self": { + "$ref": "#/components/schemas/LinkType" + } }, + "description": "Hyperlink related to the resource." + }, + "Links6": { + "title": "Links6", + "required": [ + "self" + ], + "type": "object", + "properties": { + "self": { + "$ref": "#/components/schemas/LinkType" + } + }, + "description": "List of hyperlinks related to the resource." + }, + "MeasurementConfig1": { + "title": "MeasurementConfig1", + "required": [ + "href", + "measurementId" + ], + "type": "object", + "properties": { + "href": { + "type": "string", + "description": "The URI referring to a measurement configuration." + }, + "measurementId": { + "type": "string", + "description": "Unique identifier allocated by the service consumer to identify measurement reports associated with this measurement configuration." + } + } + }, + "NotificationEvent": { + "title": "NotificationEvent", + "required": [ + "threshold", + "trigger" + ], "type": "object", - "x-etsi-ref": "6.5.4" + "properties": { + "threshold": { + "type": "integer", + "description": "Number of connected stations threshold for trigger-based event reporting.", + "contentEncoding": "int32" + }, + "trigger": { + "$ref": "#/components/schemas/Trigger" + } + }, + "description": "Set for trigger-based event notification reporting." + }, + "NotificationEvent1": { + "title": "NotificationEvent1", + "required": [ + "trigger" + ], + "type": "object", + "properties": { + "downlinkRateThreshold": { + "type": "integer", + "description": "Downlink data rate threshold for StaDataRate reporting.", + "contentEncoding": "int32" + }, + "trigger": { + "$ref": "#/components/schemas/Trigger1" + }, + "uplinkRateThreshold": { + "type": "integer", + "description": "Uplink data rate threshold for StaDataRate reporting.", + "contentEncoding": "int32" + } + }, + "description": "Set for trigger-based event notification reporting." + }, + "Subscription": { + "title": "Subscription", + "required": [ + "href", + "subscriptionType" + ], + "type": "object", + "properties": { + "href": { + "type": "string", + "description": "The URI referring to the subscription." + }, + "subscriptionType": { + "type": "string", + "description": "Type of the subscription. The string shall be set according to the \"subscriptionType\" attribute of the associated subscription data type defined in 6.3.2, 6.3.3. and 6.3.5:\n“AssocStaSubscription”\n“StaDataRateSubscription”\n“MeasurementReportSubscription”" + } + } + }, + "Trigger": { + "title": "Trigger", + "enum": [ + 1, + 2 + ], + "type": "integer", + "description": "Trigger for the notification:\n1 = Notification issued when the number of connected stations is greater than or equal to the threshold.\n2 = Notification issued when the number of connected stations is less than or equal to the threshold.", + "examples": [ + 1 + ] + }, + "Trigger1": { + "title": "Trigger1", + "enum": [ + 1, + 2, + 3, + 4, + 5, + 6, + 7, + 8 + ], + "type": "integer", + "description": "Trigger event for the notification:\n1 = Notification issued when the STA's downlink data rate is greater than or equal to the downlink threshold.\n2 = Notification issued when the STA's downlink data rate is less than or equal to the downlink threshold.\n3 = Notification issued when the STA's uplink data rate is greater than or equal to the uplink threshold.\n4 = Notification issued when the STA's uplink data rate is less than or equal to the uplink threshold.\n5 = Notification issued when the STA's downlink and uplink data rate is greater than or equal to their thresholds.\n6 = Notification issued when the STA's downlink and uplink data rate is less than or equal to their thresholds.\n7 = Notification issued when the STA's downlink or uplink data rate is greater than or equal to their thresholds.\n8 = Notification issued when the STA's downlink or uplink data rate is less than or equal to their thresholds.", + "examples": [ + 1 + ] } } - } + }, + "security": [ + {} + ] } \ No newline at end of file -- GitLab From 6351ae2e08379b301d3763a7078dd51272e43b2b Mon Sep 17 00:00:00 2001 From: Elian Kraja Date: Mon, 13 Dec 2021 14:59:33 +0100 Subject: [PATCH 5/5] Update README.md --- README.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index b112f71..e33f36e 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.02.01_60/gs_MEC028v020201p.pdf) -* [Navigate the API in the browser](https://forge.etsi.org/swagger/ui/?url=https://forge.etsi.org/rep/mec/gs028-wai-api/raw/v2.2.1/WlanInformationApi.yaml). -* [Edit the API online](https://forge.etsi.org/swagger/editor/?url=https://forge.etsi.org/rep/mec/gs028-wai-api/raw/v2.2.1/WlanInformationApi.yaml). +* [Navigate the API in the browser](https://forge.etsi.org/swagger/ui/?url=https://forge.etsi.org/rep/mec/gs028-wai-api/raw/stf606-final/WlanInformationApi.yaml). +* [Edit the API online](https://forge.etsi.org/swagger/editor/?url=https://forge.etsi.org/rep/mec/gs028-wai-api/raw/stf606-final/WlanInformationApi.yaml). ## License -- GitLab