The WLAN Access Information Service from ETSI GS MEC 028, exposing access-point, station and measurement information from Wi-Fi networks to edge applications alongside the cellular information services.
openapi: 3.1.0
jsonSchemaDialect: https://json-schema.org/draft/2020-12/schema
info:
contact:
url: https://forge.etsi.org/rep/mec/gs028-wai-api
title: ETSI GS MEC 028 MEC WLAN Information API
description: The ETSI MEC ISG MEC WLAN Information API described using OpenAPI.
license:
name: BSD-3-Clause
url: https://forge.etsi.org/legal-matters
version: 2.3.1
servers:
- url: https://localhost/wai/v2
paths:
/queries/ap/ap_information:
get:
summary: Retrieve current status of Access Point information.
description: The GET method is used to query information about the WLAN Access Points.
operationId: QueriesApApinformationGET
tags:
- queries
parameters:
- $ref: '#/components/parameters/Query.Filter'
- $ref: '#/components/parameters/Query.All_fields'
- $ref: '#/components/parameters/Query.Fields'
- $ref: '#/components/parameters/Query.Exclude_fields'
- $ref: '#/components/parameters/Query.Exclude_default'
responses:
'200':
description: 'Shall be returned when information about zero or more Access Points has been queried successfully.
The response body shall contain in an array the representations of zero or more Access Points, as defined in clause 6.2.2.
If the "filter" URI parameter or one of the "all_fields", "fields" (if supported), "exclude_fields" (if supported) or "exclude_default" URI parameters was supplied in the request, the data in the response body shall have been transformed according to the rules specified in clauses 6.19 and 6.18 of ETSI GS MEC 009 [10], respectively.'
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/ApInfo'
'400':
$ref: '#/components/responses/400'
'401':
$ref: '#/components/responses/401'
'403':
$ref: '#/components/responses/403'
'404':
$ref: '#/components/responses/404'
'406':
$ref: '#/components/responses/406'
'416':
$ref: '#/components/responses/416'
'429':
$ref: '#/components/responses/429'
/queries/sta/sta_information:
get:
summary: Retrieve current status of Station information.
description: The GET method is used to query information about the WLAN stations.
operationId: QueriesStaStainformationGET
tags:
- queries
parameters:
- $ref: '#/components/parameters/Query.Filter1'
- $ref: '#/components/parameters/Query.All_fields'
- $ref: '#/components/parameters/Query.Fields'
- $ref: '#/components/parameters/Query.Exclude_fields'
- $ref: '#/components/parameters/Query.Exclude_default'
responses:
'200':
description: 'Shall be returned when information about zero or more WLAN stations has been queried successfully.
The response body shall contain in an array the representations of zero or more WLAN stations, as defined in clause 6.2.2.
If the "filter" URI parameter or one of the "all_fields", "fields" (if supported), "exclude_fields" (if supported) or "exclude_default" URI parameters was supplied in the request, the data in the response body shall have been transformed according to the rules specified in clauses 6.19 and 6.18 of ETSI GS MEC 009 [10], respectively.'
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/StaInfo'
'400':
$ref: '#/components/responses/400'
'401':
$ref: '#/components/responses/401'
'403':
$ref: '#/components/responses/403'
'404':
$ref: '#/components/responses/404'
'406':
$ref: '#/components/responses/406'
'416':
$ref: '#/components/responses/416'
'429':
$ref: '#/components/responses/429'
/subscriptions:
get:
summary: Retrieve a list of active subscriptions for this subscriber.
description: The GET method is used to request information about the subscriptions for this requestor. Upon success, the response contains entity body with the list of links to the subscriptions that are present for the requestor.
operationId: SubscriptionsGET
tags:
- subscriptions
parameters:
- $ref: '#/components/parameters/Query.Subscription_type'
responses:
'200':
description: Upon success, a response body containing the list of links to requestor's subscriptions is returned.
content:
application/json:
schema:
type: object
properties:
SubscriptionLinkList:
$ref: '#/components/schemas/SubscriptionLinkList'
'400':
$ref: '#/components/responses/400'
'401':
$ref: '#/components/responses/401'
'403':
$ref: '#/components/responses/403'
'404':
$ref: '#/components/responses/404'
'406':
$ref: '#/components/responses/406'
'429':
$ref: '#/components/responses/429'
post:
summary: Create a new subscription.
description: The POST method is used to create a new subscription to WLAN notifications. Upon success, the response contains entity body describing the created subscription.
operationId: SubscriptionsPOST
tags:
- subscriptions
requestBody:
description: 'The entity body in the request contains data type of the specific WLAN event subscription that is to be created, where the data type options are listed below and defined in clauses 6.3.2, 6.3.3 and 6.3.5:
AssocStaSubscription.
StaDataRateSubscription.
MeasurementReportSubscription.'
content:
application/json:
schema:
type: object
properties:
AssocStaSubscription:
$ref: '#/components/schemas/AssocStaSubscription'
responses:
'201':
description: 'Indicates successful resource creation, where the resource URI shall be returned in the HTTP Location header field.
In the returned NotificationSubscription structure, the created subscription is described using the appropriate data type from the list below and as defined in clauses 6.3.2, 6.3.3 and 6.3.5:
AssocStaSubscription.
StaDataRateSubscription.
MeasurementReportSubscription.
The created resource is identified by its subscriptionId included in the "self" attribute (selfreferring URI).'
content:
application/json:
schema:
type: object
properties:
AssocStaSubscription:
$ref: '#/components/schemas/AssocStaSubscription'
'400':
$ref: '#/components/responses/400'
'401':
$ref: '#/components/responses/401'
'403':
$ref: '#/components/responses/403'
'404':
$ref: '#/components/responses/404'
'406':
$ref: '#/components/responses/406'
'415':
$ref: '#/components/responses/415'
callbacks:
notification:
'{$request.body#/callbackUri}':
post:
summary: Callback POST used to send a notification
description: Subscription notification
operationId: notificationPOST
requestBody:
description: Subscription notification
required: true
content:
application/json:
schema:
type: object
properties:
subscriptionNotification:
oneOf:
- $ref: '#/components/schemas/AssocStaSubscription'
- $ref: '#/components/schemas/StaDataRateSubscription'
- $ref: '#/components/schemas/MeasurementReportSubscription'
responses:
'204':
description: No content
'404':
description: Not found
parameters: []
/subscriptions/{subscriptionId}:
get:
summary: Retrieve information on current specific subscription.
description: The GET method is used to retrieve information about this subscription. Upon success, the response contains entity body with the data type describing the subscription.
operationId: SubscriptionsGETSubscriptionid
tags:
- subscriptions
responses:
'200':
description: "Upon success, a response body containing data type describing the specific WLAN event subscription is returned. The allowed data types for subscriptions are defined in clauses\_6.3.2, 6.3.3 and 6.3.5:\nAssocStaSubscription.\nStaDataRateSubscription.\nMeasurementReportSubscription."
content:
application/json:
schema:
type: object
properties:
AssocStaSubscription:
$ref: '#/components/schemas/AssocStaSubscription'
'400':
$ref: '#/components/responses/400'
'401':
$ref: '#/components/responses/401'
'403':
$ref: '#/components/responses/403'
'404':
$ref: '#/components/responses/404'
'406':
$ref: '#/components/responses/406'
'429':
$ref: '#/components/responses/429'
parameters:
- name: subscriptionId
in: path
required: true
description: The unique identifier of the subscriptionId.
schema:
type: string
put:
summary: Modify existing subscription by sending a new data structure.
description: The PUT method is used to update the existing subscription. PUT method in this case has "replace" semantics. Upon successful operation, the target resource is updated with new Data Type received within the message body of the PUT request.
operationId: SubscriptionsPUTSubscriptionid
tags:
- subscriptions
requestBody:
description: 'New NotificationSubscription is included as entity body of the request. The allowed data types for subscriptions are defined in clauses 6.3.2, 6.3.3 and 6.3.5:
AssocStaSubscription.
StaDataRateSubscription.
MeasurementReportSubscription.'
content:
application/json:
schema:
type: object
properties:
AssocStaSubscription:
$ref: '#/components/schemas/AssocStaSubscription'
responses:
'200':
description: 'Upon success, a response body containing data type describing the updated subscription is returned. The allowed data types for subscriptions are defined in clauses 6.3.2, 6.3.3 and 6.3.5:
AssocStaSubscription.
StaDataRateSubscription.
MeasurementReportSubscription.'
content:
application/json:
schema:
type: object
properties:
AssocStaSubscription:
$ref: '#/components/schemas/AssocStaSubscription'
'400':
$ref: '#/components/responses/400'
'401':
$ref: '#/components/responses/401'
'403':
$ref: '#/components/responses/403'
'404':
$ref: '#/components/responses/404'
'406':
$ref: '#/components/responses/406'
'412':
$ref: '#/components/responses/412'
parameters:
- name: subscriptionId
in: path
required: true
description: The unique identifier of the subscriptionId.
schema:
type: string
delete:
summary: Cancel an existing subscription.
description: The DELETE method is used to cancel the existing subscription. Cancellation can be made by deleting the resource that represents existing subscription.
operationId: SubscriptionsDELETESubscriptionid
tags:
- subscriptions
responses:
'204':
$ref: '#/components/responses/204'
'401':
$ref: '#/components/responses/401'
'403':
$ref: '#/components/responses/403'
'404':
$ref: '#/components/responses/404'
'429':
$ref: '#/components/responses/429'
parameters:
- name: subscriptionId
in: path
required: true
description: The unique identifier of the subscriptionId.
schema:
type: string
/measurements:
get:
summary: Retrieve a list of configured measurements for this subscriber.
description: The GET method is used to request information about the measurement configurations for this requestor. Upon success, the response contains an entity body with the list of links to the measurement configurations that are present for the requestor.
operationId: MeasurementsGET
tags:
- measurements
responses:
'200':
description: Upon success, a response body containing the list of links to requestor's measurement configurations is returned.
content:
application/json:
schema:
type: object
properties:
MeasurementConfigLinkList:
$ref: '#/components/schemas/MeasurementConfigLinkList'
'400':
$ref: '#/components/responses/400'
'401':
$ref: '#/components/responses/401'
'403':
$ref: '#/components/responses/403'
'404':
$ref: '#/components/responses/404'
'406':
$ref: '#/components/responses/406'
'429':
$ref: '#/components/responses/429'
parameters: []
post:
summary: Create a new measurement configuration.
description: The POST method is used to create a new WLAN measurement configuration. Upon success, the response contains an entity body describing the created measurement configuration.
operationId: MeasurementsPOST
tags:
- measurements
requestBody:
description: Entity body in the request contains the measurement configuration as defined in clause 6.2.4.
required: true
content:
application/json:
schema:
type: object
properties:
MeasurementConfig:
$ref: '#/components/schemas/MeasurementConfig'
responses:
'201':
description: "Indicates successful resource creation, where the resource URI shall be returned in the HTTP Location header field.\n\nThe returned MeasurementConfig structure describes the created configuration resource. \n\nThe created resource is identified by its measurementConfigId included in the \"self\" attribute (self-referring URI)."
content:
application/json:
schema:
type: object
properties:
MeasurementConfig:
$ref: '#/components/schemas/MeasurementConfig'
'400':
$ref: '#/components/responses/400'
'401':
$ref: '#/components/responses/401'
'403':
$ref: '#/components/responses/403'
'404':
$ref: '#/components/responses/404'
'406':
$ref: '#/components/responses/406'
'415':
$ref: '#/components/responses/415'
'422':
$ref: '#/components/responses/422'
'429':
$ref: '#/components/responses/429'
parameters: []
/measurements/{measurementConfigId}:
get:
summary: Retrieve information on an existing measurement configuration.
description: The GET method is used to retrieve information about this measurement configuration. Upon success, the response contains entity body with the data type describing the measurement configuration.
operationId: MeasurementsGETMeasurementconfigid
tags:
- measurements
responses:
'200':
description: Upon success, the response body contains the measurement configuration for the queried measurementConfigId.
content:
application/json:
schema:
type: object
properties:
MeasurementConfig:
$ref: '#/components/schemas/MeasurementConfig'
'400':
$ref: '#/components/responses/400'
'401':
$ref: '#/components/responses/401'
'403':
$ref: '#/components/responses/403'
'404':
$ref: '#/components/responses/404'
'406':
$ref: '#/components/responses/406'
'429':
$ref: '#/components/responses/429'
parameters:
- name: measurementConfigId
in: path
required: true
description: The unique identifier of the measurementConfigId.
schema:
type: string
put:
summary: Modify an existing measurement configuration by sending a new data structure.
description: The PUT method is used to update the existing WAI measurement configuration. PUT method in this case has "replace" semantics. Upon successful operation, the target resource is updated with new Data Type received within the message body of the PUT request.
operationId: MeasurementsPUTMeasurementconfigid
tags:
- measurements
requestBody:
description: Entity body in the request contains the measurement configuration as defined in clause 6.2.4.
required: true
content:
application/json:
schema:
type: object
properties:
MeasurementConfig:
$ref: '#/components/schemas/MeasurementConfig'
responses:
'200':
description: Indicates successful resource update. The returned MeasurementConfig structure describes the updated measurement configuration resource.
content:
application/json:
schema:
type: object
properties:
MeasurementConfig:
$ref: '#/components/schemas/MeasurementConfig'
'400':
$ref: '#/components/responses/400'
'401':
$ref: '#/components/responses/401'
'403':
$ref: '#/components/responses/403'
'404':
$ref: '#/components/responses/404'
'406':
$ref: '#/components/responses/406'
'412':
$ref: '#/components/responses/412'
'422':
$ref: '#/components/responses/422'
parameters:
- name: measurementConfigId
in: path
required: true
description: The unique identifier of the measurementConfigId.
schema:
type: string
delete:
summary: Cancel an existing measurement configuration.
description: The DELETE method is used to remove an existing measurement configuration. After the measurement configuration is removed, the configuration's associated measurementId will no longer be available in the ap_information and sta_information queries.
operationId: MeasurementsDELETEMeasurementconfigid
tags:
- measurements
responses:
'204':
$ref: '#/components/responses/204'
'401':
$ref: '#/components/responses/401'
'403':
$ref: '#/components/responses/403'
'404':
$ref: '#/components/responses/404'
'429':
$ref: '#/components/responses/429'
parameters:
- name: measurementConfigId
in: path
required: true
description: The unique identifier of the measurementConfigId.
schema:
type: string
components:
schemas:
ProblemDetails:
type: object
properties:
type:
type: string
format: uri
description: A URI reference according to IETF RFC 3986 that identifies the problem type
title:
type: string
description: A short, human-readable summary of the problem type
status:
type: integer
format: uint32
description: The HTTP status code for this occurrence of the problem
detail:
type: string
description: A human-readable explanation specific to this occurrence of the problem
instance:
type: string
format: uri
description: A URI reference that identifies the specific occurrence of the problem
MeasurementConfigLinkList1_:
properties:
_links:
description: Hyperlink related to the resource.
properties:
self:
description': Self-referring URI
$ref: '#/components/schemas/LinkType'
required:
- self
type: object
measurementConfig:
description: ''
items:
type: object
properties:
href:
description: The URI referring to a measurement configuration.
format: uri
type: string
measurementId:
description: Unique identifier allocated by the service consumer to identify measurement reports associated with this measurement configuration.
type: string
required:
- href
- measurementId
type: array
required:
- _links
type: object
x-etsi-ref: 6.2.5
SubscriptionLinkList1_:
properties:
_links:
description: List of hyperlinks related to the resource.
properties:
self:
description': Self referring URI
$ref: '#/components/schemas/LinkType'
required:
- self
type: object
subscription:
description: ''
items:
type: object
properties:
href:
description: The URI referring to the subscription.
format: uri
type: string
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\u201CAssocStaSubscription\u201D\n\u201CStaDataRateSubscription\u201D\n\u201CMeasurementReportSubscription\u201D"
type: string
minItems: 0
required:
- href
- subscriptionType
type: array
required:
- _links
type: object
x-etsi-ref: 6.3.4
InlineNotification:
oneOf:
- $ref: '#/components/schemas/AssocStaNotification'
- $ref: '#/components/schemas/StaDataRateNotification'
- $ref: '#/components/schemas/MeasurementReportNotification'
discriminator:
propertyName: notificationType
InlineSubscription:
oneOf:
- $ref: '#/components/schemas/AssocStaSubscription'
- $ref: '#/components/schemas/StaDataRateSubscription'
- $ref: '#/components/schemas/MeasurementReportSubscription'
discriminator:
propertyName: subscriptionType
ApInfo:
x-etsi-ref: 6.2.2
type: object
properties:
timeStamp:
description: Time stamp.
$ref: '#/components/schemas/TimeStamp'
type: object
apId:
description: Identifier(s) to uniquely specify the Access Point whose information is exposed within this data type.
$ref: '#/components/schemas/ApIdentity'
type: object
channel:
description: Channel configured for the Access Point.
type: integer
format: uint32
wlanCap:
description: WLAN capabilities of Access Point.
$ref: '#/components/schemas/WlanCapabilities'
type: object
wanMetrics:
description: WAN Metrics element provides information about the WAN link connecting an IEEE 802.11 Access Node and the Internet. Transmission characteristics such as the speed of the WAN connection to the Internet are included in Hotspot 2.0 Technical Specification v1.0.0 [i.3].
$ref: '#/components/schemas/WanMetrics'
type: object
bssLoad:
description: BSS Load attribute contains information on the current STA population and traffic levels in the BSS as defined in IEEE 802.11-2016 [8].
$ref: '#/components/schemas/BssLoad'
type: object
extBssLoad:
description: Extended BSS Load attribute contains more detailed information on the current STA population and traffic levels in the BSS as per ETSI GS MEC 002 [i.4].
$ref: '#/components/schemas/ExtBssLoad'
type: object
oBssLoad:
description: Overlapping BSS Load attribute contains information related to the contribution of channel usage by Access Points in proximity to the reporting Access Point and operating on the same channel.
$ref: '#/components/schemas/OBssLoad'
type: object
apLocation:
description: The location on the Access Point.
$ref: '#/components/schemas/ApLocation'
type: object
required:
- apId
StaInfo:
x-etsi-ref: 6.2.3
type: object
properties:
timeStamp:
description: Time stamp.
$ref: '#/components/schemas/TimeStamp'
type: object
staId:
description: Identifier(s) uniquely specify the station whose information is exposed within this data type.
$ref: '#/components/schemas/StaIdentity'
type: object
channel:
description: Channel currently used by the station to connect with its associated Access Point.
type: integer
format: uint32
apAssociated:
description: Information about the station's associated Access Point.
$ref: '#/components/schemas/ApAssociated'
type: object
rssi:
description: Receive Signal Strength Indicator.
$ref: '#/components/schemas/Rssi'
type: object
staDataRate:
description: Station Data Rate as defined in IEEE 802.11-2016 [8].
$ref: '#/components/schemas/StaDataRate'
type: object
staStatistics:
description: Statistics as defined in IEEE 802.11-2016 [8] for the client station collected over measurement duration.
type: array
minItems: 0
items:
$ref: '#/components/schemas/StaStatistics'
beaconReport:
description: 'Beacon Report as defined in IEEE 802.11-2016 [8]. '
type: array
minItems: 0
items:
$ref: '#/components/schemas/BeaconReport'
neighborReport:
description: Information about neighbor Access Points seen by the station as defined IEEE 802.11-2016 [8].
type: array
minItems: 0
items:
$ref: '#/components/schemas/NeighborReport'
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."
type: array
minItems: 0
items:
$ref: '#/components/schemas/ChannelLoad'
required:
- staId
MeasurementConfig:
description: ''
type: object
minItems: 0
properties:
href:
description: The URI referring to a measurement configuration.
type: string
format: uri
measurementId:
description: Unique identifier allocated by the service consumer to identify measurement reports associated with this measurement configuration.
type: string
required:
- href
- measurementId
MeasurementConfigLinkList:
x-etsi-ref: 6.2.5
type: object
properties:
_links:
$ref: '#/components/schemas/_links1'
measurementConfig:
type: array
items:
$ref: '#/components/schemas/MeasurementConfig'
required:
- _links
AssocStaSubscription:
x-etsi-ref: 6.3.2
type: object
properties:
subscriptionType:
description: Shall be set to "AssocStaSubscription".
type: string
callbackReference:
description: URI exposed by the client on which to receive notifications via HTTP. See note 1.
type: string
format: uri
requestTestNotification:
description: Set to TRUE by the service consumer to request a test notification via HTTP on the callbackReference URI, as specified in ETSI GS MEC 009 [10], clause 6.12a.
type: boolean
websockNotifConfig:
description: Provides details to negotiate and signal the use of a Websocket connection between the WAIS and the service consumer for notifications. See note 1.
$ref: '#/components/schemas/WebsockNotifConfig'
type: object
_links:
$ref: '#/components/schemas/_links2'
apId:
description: Identifier(s) to uniquely specify the target Access Point for the subscription.
$ref: '#/components/schemas/ApIdentity'
type: object
notificationPeriod:
description: 'Set for periodic notification reporting.
Value indicates the notification period in seconds.'
type: integer
format: uint8
notificationEvent:
$ref: '#/components/schemas/NotificationEvent'
expiryDeadline:
description: The expiration time of the subscription determined by the WLAN Access Information Service.
$ref: '#/components/schemas/TimeStamp'
type: object
required:
- subscriptionType
- apId
description: "|-\n 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 an alternative and return only that alternative in the response, as specified in ETSI GS MEC 009 [10], clause 6.12a.\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."
StaDataRateSubscription:
x-etsi-ref: 6.3.3
type: object
properties:
subscriptionType:
description: Shall be set to "StaDataRateSubscription".
type: string
callbackReference:
description: URI exposed by the client on which to receive notifications via HTTP. See note 1.
type: string
format: uri
requestTestNotification:
description: Set to TRUE by the service consumer to request a test notification via HTTP on the callbackReference URI, as specified in ETSI GS MEC 009 [10], clause 6.12a.
type: boolean
websockNotifConfig:
description: Provides details to negotiate and signal the use of a Websocket connection between the WAIS and the service consumer for notifications. See note 1.
$ref: '#/components/schemas/WebsockNotifConfig'
type: object
_links:
$ref: '#/components/schemas/_links2'
staId:
description: Identifier(s) to uniquely specify the target client station(s) for the subscription.
type: array
minItems: 1
items:
$ref: '#/components/schemas/StaIdentity'
notificationPeriod:
description: 'Set for periodic notification reporting.
Value indicates the notification period in seconds.'
type: integer
format: uint8
notificationEvent:
$ref: '#/components/schemas/NotificationEvent1'
expiryDeadline:
description: The expiration time of the subscription determined by the WLAN Access Information Service.
$ref: '#/components/schemas/TimeStamp'
type: object
required:
- subscriptionType
- staId
description: "|-\n NOTE
# --- truncated at 32 KB (98 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/etsi/refs/heads/main/openapi/mec/WlanInformationApi.yaml