WlanInformationApi.yaml

openapi: 3.0.0
info:
  title: ETSI GS MEC 028 - WLAN Access Information API
  version: 2.1.1
  description: The ETSI MEC ISG MEC028 WLAN Access Information API described using OpenAPI
  license:
    name: BSD-3-Clause
    url: 'https://forge.etsi.org/legal-matters'
externalDocs:
  description: ETSI MEC028 V2.1.1 WLAN Information API
  url: 'http://www.etsi.org/deliver/etsi_gs/MEC/001_099/028/02.01.01_60/gs_mec028v020101p.pdf'
servers:
  - url: 'https://{apiRoot}/wai/v2'
paths:
  /queries/ap/ap_information:
    get:
      tags:
      - ''
      summary: 'Retrieve information on existing Access Points' 
      description: 'Queries information about existing WLAN Access Points'
      operationId: apInfoGET
      parameters:
        - $ref: '#/components/parameters/Query.Filter'
        - $ref: '#/components/parameters/Query.AllFields'
        - $ref: '#/components/parameters/Query.Fields'
        - $ref: '#/components/parameters/Query.ExcludeFields'
        - $ref: '#/components/parameters/Query.ExcludeDefault'
      responses:
        '200':
          description: Successful response to ap_info request
          content:
            application/json:
              schema:
                type: object
                properties:
                  apInfo:
                    type: array
                    items:
                      $ref: '#/components/schemas/ApInfo'
        '400':
          $ref: '#/components/responses/400'
        '401':
          $ref: '#/components/responses/401'
        '403':
          $ref: '#/components/responses/403'
        '404':
          $ref: '#/components/responses/404'
        '406':
          $ref: '#/components/responses/406'
        '429':
          $ref: '#/components/responses/429'
  /queries/sta/sta_information:
    get:
      tags:
      - ''
      summary: 'Retrieve information on existing Stations'
      description: 'Queries information about existing WLAN stations'
      operationId: staInfoGET
      parameters:
        - $ref: '#/components/parameters/Query.Filter'
        - $ref: '#/components/parameters/Query.AllFields'
        - $ref: '#/components/parameters/Query.Fields'
        - $ref: '#/components/parameters/Query.ExcludeFields'
        - $ref: '#/components/parameters/Query.ExcludeDefault'
      responses:
        '200':
          description: Successful response to sta_info request
          content:
            application/json:
              schema:
                type: object
                properties:
                  staInfo:
                    type: array
                    items:
                      $ref: '#/components/schemas/StaInfo'
        '400':
          $ref: '#/components/responses/400'
        '401':
          $ref: '#/components/responses/401'
        '403':
          $ref: '#/components/responses/403'
        '404':
          $ref: '#/components/responses/404'
        '406':
          $ref: '#/components/responses/406'
        '429':
          $ref: '#/components/responses/429'
  /subscriptions/:
    get:
      tags:
      - ''
      summary: 'Retrieve information on subscriptions for notifications'
      description: 'Queries information on subscriptions for notifications'
      operationId: subscriptionLinkList_subscriptionsGET
      parameters:
        - $ref: '#/components/parameters/Query.SubscriptionType'
      responses:
        '200':
          description: 'Response body contains the list of links to requestors subscriptions.'
          content:
            application/json:
              schema:
                type: object
                required:
                  - subscriptionLinkList
                properties:
                  subscriptionLinkList:
                    $ref: '#/components/schemas/SubscriptionLinkList'
              example:
                subscriptionLinkList:
                  _links:
                    self:
                      href: 'http://meAppServer.example.com/wai/v2/subscriptions'
                  subscription:
                    - _links:
                        self:
                          href: 'http://meAppServer.example.com/wai/v2/subscriptions/sub123'
                      callbackReference: 'http://my.callback.com/wai/assocStaSubscription/some-id'
                      subscriptionType: AssocStaSubscription
        '400':
          $ref: '#/components/responses/400'
        '401':
          $ref: '#/components/responses/401'
        '403':
          $ref: '#/components/responses/403'
        '404':
          $ref: '#/components/responses/404'
        '406':
          $ref: '#/components/responses/406'
        '429':
          $ref: '#/components/responses/429'
    post:
      tags:
      - ''
      summary: 'Create a new subscription'
      description: 'Creates a new subscription to WLAN Access Information notifications'
      operationId: subscriptionsPOST
      requestBody:
        description: Subscription to be created
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                notificationSubscription:
                  oneOf:
                    - $ref: '#/components/schemas/AssocStaSubscription'
                    - $ref: '#/components/schemas/StaDataRateSubscription'
                  discriminator:
                    propertyName: subscriptionType
              example:
                notificationSubscription:
                  subscriptionType: AssocStaSubscription
                  callbackReference: 'http://meAppClient.example.com/wai/v2/notifications/1'
                  expiryDeadline:
                    seconds: 1977836800
                    nanoSeconds: 0
                  apId:
                    macId: 005C0A0A0A0A                    
                    ssid: 'myNetworkSsid'
                    ipAddress: 10.10.100.1
      responses:
        '201':
          description: Successful subscription response
          content:
            application/json:
              schema:
                type: object
                properties:
                  notificationSubscription:
                    oneOf:
                      - $ref: '#/components/schemas/AssocStaSubscription'
                      - $ref: '#/components/schemas/StaDataRateSubscription'
                    discriminator:
                      propertyName: subscriptionType
              example:
                notificationSubscription:
                  subscriptionType: AssocStaSubscription
                  callbackReference: 'http://meAppClient.example.com/wai/v2/notifications/1'
                  _links:
                    self:
                      href: 'http://meAppServer.example.com/wai/v2/subscriptions/sub123'
                  expiryDeadline:
                    seconds: 1977836800
                    nanoSeconds: 0
                  apId:
                    macId: 005C0A0A0A0A
                    ssid: 'myNetworkSsid'
                    ipAddress: 10.10.100.1
        '400':
          $ref: '#/components/responses/400'
        '401':
          $ref: '#/components/responses/401'
        '403':
          $ref: '#/components/responses/403'
        '404':
          $ref: '#/components/responses/404'
        '406':
          $ref: '#/components/responses/406'
        '415':
          $ref: '#/components/responses/415'
        '422':
          $ref: '#/components/responses/422'
        '429':
          $ref: '#/components/responses/429'
      callbacks:
        notification:
          '{$request.body#/callbackReference}':
            post:
              summary: 'Callback POST used to send a notification'
              description: 'Notification from WAIS, content based on subscription type'
              operationId: notificationPOST
              requestBody: 
                description: Subscription notification
                required: true
                content:
                  application/json:
                    schema:
                      type: object
                      properties:
                        notification:
                          oneOf:
                            - $ref: '#/components/schemas/AssocStaNotification'
                            - $ref: '#/components/schemas/StaDataRateNotification'
                          discriminator:
                            propertyName: notificationType
                      example:
                        notification:
                          notificationType: AssocStaNotification
                          timeStamp:
                            seconds: 1977836800
                            nanoseconds: 0
                          apId:
                            macId: 005C0A0A0A0A                    
                            ssid: 'myNetworkSsid'
                            ipAddress: 10.10.100.1
                          staId:
                            macId: 005C01111111
                            ssid: 
                            - 'myNetworkSsid'
                            - 'myOtherNetworkSsid'
                            aid: '1122'
                            ipAddress: 10.10.1.255
              responses:
                '204':
                  $ref: '#/components/responses/204'
  '/subscriptions/{subscriptionId}':
    get:
      tags:
      - ''
      summary: 'Retrieve information on current specific subscription'
      description: 'Queries information about an existing subscription, identified by its self-referring URI returned on creation (initial POST)'
      operationId: subscriptionsGET
      parameters:
        - $ref: '#/components/parameters/Path.subscrId'
      responses:
        '200':
          description: Subscription information regarding subscription notifications
          content:
            application/json:
              schema:
                type: object
                required:
                  - notificationSubscription
                properties:
                  notificationSubscription:
                    oneOf:
                      - $ref: '#/components/schemas/AssocStaSubscription'
                      - $ref: '#/components/schemas/StaDataRateSubscription'
                    discriminator:
                      propertyName: subscriptionType
              example:
                notificationSubscription:
                  subscriptionType: AssocStaSubscription
                  callbackReference: 'http://meAppClient.example.com/wai/v2/notifications/1'
                  _links:
                    self:
                      href: 'http://meAppServer.example.com/wai/v2/subscriptions/sub123'
                  expiryDeadline:
                    seconds: 1977836800
                    nanoSeconds: 0
                  apId:
                    macId: 005C0A0A0A0A
                    ssid: 'myNetworkSsid'
                    ipAddress: 10.10.100.1
        '400':
          $ref: '#/components/responses/400'
        '401':
          $ref: '#/components/responses/401'
        '403':
          $ref: '#/components/responses/403'
        '404':
          $ref: '#/components/responses/404'
        '406':
          $ref: '#/components/responses/406'
        '429':
          $ref: '#/components/responses/429'
    put:
      tags:
      - ''
      summary: 'Modify an existing subscription'
      description: 'Updates an existing subscription, identified by its self-referring URI returned on creation (initial POST)'
      operationId: subscriptionsPUT
      requestBody:
        description: Subscription to be modified
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                notificationSubscription:
                  oneOf:
                    - $ref: '#/components/schemas/AssocStaSubscription'
                    - $ref: '#/components/schemas/StaDataRateSubscription'
                  discriminator:
                    propertyName: subscriptionType
              example:
                notificationSubscription:
                  subscriptionType: AssocStaSubscription
                  callbackReference: 'http://meAppClient.example.com/wai/v2/notifications/1'
                  _links:
                    self:
                      href: 'http://meAppServer.example.com/wai/v2/subscriptions/sub123'
                  expiryDeadline:
                    seconds: 1977836800
                    nanoSeconds: 0
                  apId:
                    macId: 005C0A0A0A0A
                    ssid: 'myNetworkSsid'
                    ipAddress: 10.10.100.1
      parameters:
        - $ref: '#/components/parameters/Path.subscrId'
      responses:
        '200':
          description: Successful subscription modification
          content:
            application/json:
              schema:
                type: object
                properties:
                  subscription:
                    oneOf:
                      - $ref: '#/components/schemas/AssocStaSubscription'
                      - $ref: '#/components/schemas/StaDataRateSubscription'
                    discriminator:
                      propertyName: subscriptionType
              example:
                subscription:
                  _links:
                    self:
                      href: 'http://[hostIP]/sbox-xyz123/wai/v2/subscriptions/sub123'
                  callbackReference: 'http://my.callback.com/wai/some-id'
                  apId:
                    macId: 005C0A0A0A0A
        '400':
          $ref: '#/components/responses/400'
        '401':
          $ref: '#/components/responses/401'
        '403':
          $ref: '#/components/responses/403'
        '404':
          $ref: '#/components/responses/404'
        '406':
          $ref: '#/components/responses/406'
        '412':
          $ref: '#/components/responses/412'
        '422':
          $ref: '#/components/responses/422'
        '429':
          $ref: '#/components/responses/429'
    delete:
      tags:
      - ''
      summary: 'Cancel an existing subscription'
      description: 'Cancels an existing subscription, identified by its self-referring URI returned on creation (initial POST)'
      operationId: subscriptionsDELETE
      parameters:
        - $ref: '#/components/parameters/Path.subscrId'
      responses:
        '204':
          $ref: '#/components/responses/204'
        '401':
          $ref: '#/components/responses/401'
        '403':
          $ref: '#/components/responses/403'
        '404':
          $ref: '#/components/responses/404'
        '429':
          $ref: '#/components/responses/429'
components:
  responses:
    200:
      description: OK
    204:
      description: No Content
    400:
      description: 'Bad Request : used to indicate that incorrect parameters were passed to the request.'
      content:
        application/json:
          schema:
            type: object
            properties:
              problemDetails:
                $ref: '#/components/schemas/ProblemDetails'  
    401:
      description: 'Unauthorized :  used when the client did not submit credentials.'
      content:
        application/json:
          schema:
            type: object
            properties:
              problemDetails:
                $ref: '#/components/schemas/ProblemDetails'
    403:                
      description: 'Forbidden :  operation is not allowed given the current status of the resource.'
      content:
        application/json:
          schema:
            type: object
            required:
              - problemDetails
            properties:
              problemDetails:
                $ref: '#/components/schemas/ProblemDetails'
    404:
      description: 'Not Found :  used when a client provided a URI that cannot be mapped to a valid resource URI.'
      content:
        application/json:
          schema:
            type: object
            properties:
              problemDetails:
                $ref: '#/components/schemas/ProblemDetails'
    406:
      description: 'Not Acceptable : used to indicate that the server cannot provide the any of the content formats supported by the client.'
      content:
        application/json:
          schema:
            type: object
            properties:
              problemDetails:
                $ref: '#/components/schemas/ProblemDetails'
    412:
      description: 'Precondition failed :  used when a condition has failed during conditional requests, e.g. when
        using ETags to avoid write conflicts when using PUT'
      content:
        application/json:
          schema:
            type: object
            properties:
              problemDetails:
                $ref: '#/components/schemas/ProblemDetails'
    415:
      description: 'Unsupported Media Type :  used to indicate that the server or the client does not support the content type of the entity body.'
      content:
        application/json:
          schema:
            type: object
            properties:
              problemDetails:
                $ref: '#/components/schemas/ProblemDetails'
    422:
      description: 'Unprocessable Entity : used to indicate that the server understands the content type of the request entity and that the
        syntax of the request entity is correct but that the server is unable to process the contained instructions. This error condition can occur if an
        JSON request body is syntactically correct but semantically incorrect, for example if the target area for the request is considered too large. This
        error condition can also occur if the capabilities required by the request are not supported.'
      content:
        application/json:
          schema:
            type: object
            properties:
              problemDetails:
                $ref: '#/components/schemas/ProblemDetails'
          example:
            application/problem+json:
              ProblemDetails:
                type: 'https://meAppServer.example.com/wai/v2/probs/too-many targets'
                title: Too many targets
                status: '422'
                detail: The target area for the request is considered too large
                instance: /meAppClient.example.com/77777/msgs/abc
    429:
      description: 'Too Many Requests : used when a rate limiter has triggered.'
      content:
        application/json:
          schema:
            type: object
            properties:
              problemDetails:
                $ref: '#/components/schemas/ProblemDetails'
  parameters:
    Path.subscrId:
      name: subscriptionId
      in: path
      description: 'Subscription Id, specifically the "self" returned in the subscription request'
      required: true
      schema:
        type: string
        format: uri
    Query.Filter:
      name: filter
      in: query
      description: Attribute-based filtering expression according to clause 6.19 of ETSI GS MEC 009. .
      required: false
      schema:
        type: string
    Query.AllFields:
      name: all_fields
      in: query
      description: Include all complex attributes in the response. See clause 6.18 of ETSI GS MEC 009 for details.
      required: false
      schema:
        type: string
    Query.Fields:
      name: fields
      in: query
      description: Complex attributes to be included into the response. See clause 6.18 of ETSI GS MEC 009 for details. 
      required: false
      schema:
        type: array
        items:
          type: string
    Query.ExcludeFields:
      name: exclude_fields
      in: query
      description: Complex attributes to be excluded from the response. See clause 6.18 of ETSI GS MEC 009 for details.
      required: false
      schema:
        type: array
        items:
          type: string
    Query.ExcludeDefault:
      name: exclude_default
      in: query
      description: 'Indicates to exclude the following complex attributes from the response. See clause 6.18 of ETSI GS MEC 009 for details.
        The following attributes shall be excluded from the structure in the response body if this parameter is provided, or none of the parameters
        "all_fields", "fields", "exclude_fields", "exclude_default" are provided: Not applicable'
      required: false
      schema:
        type: array
        items:
          type: string
    Query.SubscriptionType:
      name: subscription_type
      in: query
      description: 'Filter on a specific subscription type. Permitted values: assoc_sta, sta_data_rate.'
      required: false
      schema:
        type: string
  schemas:
    ApAssociated:
      properties:
        assocId:
          description: Unique number which identifies a particular association between
            the station and Access Point.
          type: string
          x-etsi-mec-cardinality: 0..1
          x-etsi-mec-origin-type: string
        ipAddress:
          description: IPv4 or IPv6 address allocated for the Access Point.
          items:
            type: string
          minItems: 0
          type: array
          x-etsi-mec-cardinality: 0..N
          x-etsi-mec-origin-type: string
        macId:
          description: Unique identifier assigned to the Access Point (as network
            interface controller) for communications at the data link layer of a network
            segment.
          type: string
          x-etsi-mec-cardinality: '1'
          x-etsi-mec-origin-type: string
        ssid:
          description: Service Set Identifier to identify logical networks.
          items:
            type: string
          minItems: 0
          type: array
          x-etsi-mec-cardinality: 0..N
          x-etsi-mec-origin-type: String
      required:
      - macId
      type: object
      x-etsi-ref: 6.5.12
    ApIdentity:
      properties:
        ipAddress:
          description: IPv4 or IPv6 address allocated for the Access Point.
          items:
            type: string
          minItems: 0
          type: array
          x-etsi-mec-cardinality: 0..N
          x-etsi-mec-origin-type: String
        macId:
          description: Unique Identifier assigned to an Access Point (as network interface
            controller) for communications at the data link layer of a network segment.
          type: string
          x-etsi-mec-cardinality: '1'
          x-etsi-mec-origin-type: String
        ssid:
          description: Service Set Identifier to identify logical networks including
            Basic Service Set and Extended Service Set.
          items:
            type: string
          minItems: 0
          type: array
          x-etsi-mec-cardinality: 0..N
          x-etsi-mec-origin-type: String
      required:
      - macId
      type: object
      x-etsi-ref: 6.5.3
    ApInfo:
      properties:
        apId:
          allOf:
          - $ref: '#/components/schemas/ApIdentity'
          - description: Identifier(s) to uniquely specify the Access Point whose information is exposed within this data type.
          - x-etsi-mec-cardinality: '1'
          - x-etsi-mec-origin-type: ApIdentity
        apLocation:
          allOf:
          - $ref: '#/components/schemas/ApLocation'
          - description: The location on the Access Point.
          - x-etsi-mec-cardinality: 0..1
          - x-etsi-mec-origin-type: ApLocation
        apNeighbor:
          allOf:
          - $ref: '#/components/schemas/NeighborReport'
          - description: Information about neighbor Access Points.
          - x-etsi-mec-cardinality: 0..1
          - x-etsi-mec-origin-type: NeighborReport
        bssLoad:
          allOf:
          - $ref: '#/components/schemas/BssLoad'
          - description: "BSS Load attribute contains information on the current STA\
            \ population and traffic levels in the BSS as defined in IEEE\_802.11-2016\
            \ [8]."
          - x-etsi-mec-cardinality: 0..1
          - x-etsi-mec-origin-type: BssLoad
        channel:
          type: integer
          format: uint32
          description: Channel configured for the Access Point.
          x-etsi-mec-cardinality: 0..1
          x-etsi-mec-origin-type: Uint32
        extBssLoad:
          allOf:
          - $ref: '#/components/schemas/ExtBssLoad'
          - description: 'Extended BSS Load attribute contains more detailed information
            on the current STA population and traffic levels in the BSS as per ETSI
            GS MEC 002 [i.4].'
          - x-etsi-mec-cardinality: 0..1
          - x-etsi-mec-origin-type: ExtBssLoad
        timeStamp:
          allOf:
          - $ref: '#/components/schemas/TimeStamp'
          - description: Time stamp.
          - x-etsi-mec-cardinality: 0..1
          - x-etsi-mec-origin-type: TimeStamp
        wanMetrics:
          allOf:
          - $ref: '#/components/schemas/WanMetrics'
          - description: "WAN Metrics element provides information about the WAN link\
            \ connecting an IEEE 802.11 Access Node and the Internet. Transmission\
            \ characteristics such as the speed of the WAN connection to the Internet\
            \ are included in Hotspot\_2.0 Technical Specification v1.0.0 [i.3]."
          - x-etsi-mec-cardinality: 0..1
          - x-etsi-mec-origin-type: WanMetrics
        wlanCap:
          allOf:
          - $ref: '#/components/schemas/WlanCapabilities'
          - description: WLAN capabilities of Access Point.
          - x-etsi-mec-cardinality: 0..1
          - x-etsi-mec-origin-type: WlanCapabilities
      required:
      - apId
      type: object
      x-etsi-ref: 6.2.2
    ApLocation:
      properties:
        civicLocation:
          allOf:
          - $ref: '#/components/schemas/CivicLocation'
          - description: Civic Location of the AP as described in IETF RFC 4776 [7].
          - x-etsi-mec-cardinality: 0..1
          - x-etsi-mec-origin-type: CivicLocation
        geolocation:
          allOf:
          - $ref: '#/components/schemas/GeoLocation'
          - description: Geospatial Location of the AP as defined in IEEE 802.11-2016 [8].
          - x-etsi-mec-cardinality: 0..1
          - x-etsi-mec-origin-type: GeoLocation
      type: object
      x-etsi-ref: 6.5.9
    AssocStaNotification:
      properties:
        apId:
          allOf:
          - $ref: '#/components/schemas/ApIdentity'
          - description: Identifier(s) to uniquely specify the Access Point to which the client stations are associated.
          - x-etsi-mec-cardinality: '1'
          - x-etsi-mec-origin-type: ApIdentity
        notificationType:
          description: Shall be set to "AssocStaNotification".
          type: string
          x-etsi-mec-cardinality: '1'
          x-etsi-mec-origin-type: String
        staId:
          description: Identifier(s) to uniquely specify the client station(s) associated.
          items:
            $ref: '#/components/schemas/StaIdentity'
          minItems: 0
          type: array
          x-etsi-mec-cardinality: 0..N
          x-etsi-mec-origin-type: StaIdentity
        timeStamp:
          allOf:
          - $ref: '#/components/schemas/TimeStamp'
          - description: Time stamp.
          - x-etsi-mec-cardinality: 0..1
          - x-etsi-mec-origin-type: TimeStamp
      required:
      - notificationType
      - apId
      type: object
      x-etsi-ref: 6.4.2
    AssocStaSubscription:
      properties:
        _links:
          description: Hyperlink related to the resource. This shall be only included
            in the HTTP responses and in HTTP PUT requests.
          properties:
            self:
              allOf:
              - $ref: '#/components/schemas/LinkType'
              - description: URI referring to a resource
              - x-etsi-mec-cardinality: 1
              - x-etsi-mec-origin-type: LinkType
          type: object
          x-etsi-mec-cardinality: 0..1
          x-etsi-mec-origin-type: Structure (inlined)
        apId:
          allOf:
          - $ref: '#/components/schemas/ApIdentity'
          - description: Identifier(s) to uniquely specify the target Access Point
              for the subscription
          - x-etsi-mec-cardinality: '1'
          - x-etsi-mec-origin-type: ApIdentity
        callbackReference:
          description: URI selected by the service consumer to receive notifications
            on the subscribed WLAN information. This shall be included both in the
            request and in response.
          format: uri
          type: string
          x-etsi-mec-cardinality: '1'
          x-etsi-mec-origin-type: URI
        expiryDeadline:
          allOf:
          - $ref: '#/components/schemas/TimeStamp'
          - description: The expiration time of the subscription determined by the
              WLAN Access Information Service.
          - x-etsi-mec-cardinality: 0..1
          - x-etsi-mec-origin-type: TimeStamp
        subscriptionType:
          description: Shall be set to "AssocStaSubscription".
          type: string
          x-etsi-mec-cardinality: '1'
          x-etsi-mec-origin-type: String
      required:
      - subscriptionType
      - callbackReference
      - apId
      type: object
      x-etsi-ref: 6.3.2
    AssociatedStations:
      properties:
        assocId:
          description: Unique number which identifies a particular association between
            an Access Point and a station.
          type: string
          x-etsi-mec-cardinality: 0..1
          x-etsi-mec-origin-type: string
        ipAddress:
          description: IPv4 or IPv6 address allocated for the station associated with
            the Access Point.
          items:
            type: string
          minItems: 0
          type: array
          x-etsi-mec-cardinality: 0..N
          x-etsi-mec-origin-type: string
        macId:
          description: Unique identifier assigned to a station (as network interface
            controller) for communications at the data link layer of a network segment.
          type: string
          x-etsi-mec-cardinality: '1'
          x-etsi-mec-origin-type: string
      required:
      - macId
      type: object
      x-etsi-ref: 6.5.5
    BeaconReport:
      properties:
        bssId:
          description: The BSSID field indicates the BSSID of the BSS(s) for which
            a beacon report has been received.
          items:
            type: string
          minItems: 1
          type: array
          x-etsi-mec-cardinality: 1..N
          x-etsi-mec-origin-type: String
        channelId:
          description: Channel number where the beacon was received.
          type: integer
          x-etsi-mec-cardinality: '1'
          x-etsi-mec-origin-type: Integer
        measurementId:
          description: Measurement ID of the Measurement configuration applied to
            this Beacon Report.
          type: string
          x-etsi-mec-cardinality: '1'
          x-etsi-mec-origin-type: String
        reportingCondition:
          description: As in table T9-89 of IEEE 802.11-2012 [8].
          type: integer
          x-etsi-mec-cardinality: '1'
          x-etsi-mec-origin-type: Integer
        ssId:
          description: (Optional) The SSID subelement indicates the ESS(s) or IBSS(s)
            for which a beacon report is received.
          items:
            type: string
          minItems: 1
          type: array
          x-etsi-mec-cardinality: 1..N
          x-etsi-mec-origin-type: String
        staId:
          allOf:
          - $ref: '#/components/schemas/StaIdentity'
          - description: Identifier to uniquely specify the station whose information is exposed within this data type.
          - x-etsi-mec-cardinality: '1'
          - x-etsi-mec-origin-type: StaIdentity
      required:
      - staId
      - measurementId
      - channelId
      - bssId
      - ssId
      - reportingCondition
      type: object
      x-etsi-ref: 6.5.27
    BeaconRequestConfig:
      properties:
        bssId:
          description: The BSSID field indicates the BSSID of the BSS(s) for which
            a beacon report is requested. When requesting beacon reports for all BSSs
            on the channel, the BSSID field contains the wildcard BSSID.
          items:
            type: string
          minItems: 1
          type: array
          x-etsi-mec-cardinality: 1..N
          x-etsi-mec-origin-type: String
        channelId:
          description: Channel number to scan. A Channel Number of 0 indicates a request
            to make iterative measurements for all supported channels in the Operating
            Class where the measurement is permitted on the channel and the channel
            is valid for the current regulatory domain. A Channel Number of 255 indicates
            a request to make iterative measurements for all supported channels in
            the current Operating Class listed in the latest AP Channel Report received
            from the serving AP.
          type: integer
          x-etsi-mec-cardinality: '1'
          x-etsi-mec-origin-type: Integer
        measurementMode:
          description: '0 for passive.

            1 for active.

            2 for beacon table.'
          type: integer
          x-etsi-mec-cardinality: '1'
          x-etsi-mec-origin-type: Integer
        reportingCondition:
          description: As in table T9-89 of IEEE 802.11-2012 [8].
          type: integer
          x-etsi-mec-cardinality: '1'
          x-etsi-mec-origin-type: Integer
        ssId:
          description: (Optional) The SSID subelement indicates the ESS(s) or IBSS(s)
            for which a beacon report is requested.
          items:
            type: string
          minItems: 1
          type: array
          x-etsi-mec-cardinality: 1..N
          x-etsi-mec-origin-type: String
        staId:
          allOf:
          - $ref: '#/components/schemas/StaIdentity'
          - description: Identifier to uniquely specify the station whose information is exposed within this data type.
          - x-etsi-mec-cardinality: '1'
          - x-etsi-mec-origin-type: StaIdentity
      required:
      - staId
      - channelId
      - measurementMode
      - bssId
      - ssId
      - reportingCondition
      type: object
      x-etsi-ref: 6.5.25
    BssLoad:
      properties:
        availAdmCap:
          type: integer
          description: Available Admission Capacity that specifies the remaining amount
            of medium time available via explicit admission control, in units of 32
            s/s.
          x-etsi-mec-cardinality: '1'
          x-etsi-mec-origin-type: Uint16
        channelUtilization:
          type: integer
          description: "The percentage of time, linearly scaled with 255 representing\
            \ 100\_%, that the AP sensed the medium was busy, as indicated by either\
            \ the physical or virtual Carrier Sense (CS) mechanism."
          x-etsi-mec-cardinality: '1'
          x-etsi-mec-origin-type: UInt8
        staCount:
          type: integer
          description: An unsigned integer that indicates the total number of STAs
            currently associated with this BSS.
          x-etsi-mec-cardinality: '1'
          x-etsi-mec-origin-type: UInt16
      required:
      - staCount
      - channelUtilization
      - availAdmCap
      type: object
      x-etsi-ref: 6.5.7
    ChannelLoadConfig:
      properties:
        apId:
          allOf:
          - $ref: '#/components/schemas/ApIdentity'
          - description: Identifier(s) to uniquely specify the target Access Point
          - x-etsi-mec-cardinality: '1'
          - x-etsi-mec-origin-type: ApIdentity
        cChannelId:
          description: Channel number which load is reported
          type: integer
          x-etsi-mec-cardinality: '1'
          x-etsi-mec-origin-type: Integer
        channelLoad:
          description: Channel load as per IEEE 802.11-2012 [8], section 11.11.9.3
          type: integer
          x-etsi-mec-cardinality: '1'
          x-etsi-mec-origin-type: Integer
      required:
      - apId
      - cChannelId
      - channelLoad
      type: object
      x-etsi-ref: 6.5.24
    CivicLocation:
      properties:
        ca0:
          description: Language
          type: string
          x-etsi-mec-cardinality: 0..1
          x-etsi-mec-origin-type: String
        ca1:
          description: 'National subdivisions (state, canton, region,province, prefecture) '
          type: string
          x-etsi-mec-cardinality: 0..1
          x-etsi-mec-origin-type: String
        ca128:
          description: Script
          type: string
          x-etsi-mec-cardinality: 0..1
          x-etsi-mec-origin-type: String
        ca16:
          description: Leading street direction
          type: string
          x-etsi-mec-cardinality: 0..1
          x-etsi-mec-origin-type: String
        ca17:
          description: Trailing street suffix
          type: string
          x-etsi-mec-cardinality: 0..1
          x-etsi-mec-origin-type: String
        ca18:
          description: Street suffix or type