WlanInformationApi.yaml 79.7 KB
Newer Older
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548
openapi: 3.0.0
info:
  contact:
    url: https://forge.etsi.org/rep/mec/gs028-wai-api
  title: ETSI GS MEC 028 - WLAN Access Information API
  version: 2.1.1
  description: The ETSI MEC ISG MEC028 WLAN Access Information API described using OpenAPI
  license:
    name: BSD-3-Clause
    url: 'https://forge.etsi.org/legal-matters'
externalDocs:
  description: ETSI MEC028 V2.1.1 WLAN Information API
  url: 'http://www.etsi.org/deliver/etsi_gs/MEC/001_099/028/02.01.01_60/gs_mec028v020101p.pdf'
servers:
  - url: 'https://localhost/wai/v2'
tags:
- name: "wai"
paths:
  /queries/ap/ap_information:
    get:
      tags:
      - 'wai'
      summary: 'Retrieve information on existing Access Points'
      description: 'Queries information about existing WLAN Access Points'
      operationId: apInfoGET
      parameters:
        - $ref: '#/components/parameters/Query.Filter'
        - $ref: '#/components/parameters/Query.AllFields'
        - $ref: '#/components/parameters/Query.Fields'
        - $ref: '#/components/parameters/Query.ExcludeFields'
        - $ref: '#/components/parameters/Query.ExcludeDefault'
      responses:
        '200':
          description: Successful response to ap_info request
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/ApInfo'
        '400':
          $ref: '#/components/responses/400'
        '401':
          $ref: '#/components/responses/401'
        '403':
          $ref: '#/components/responses/403'
        '404':
          $ref: '#/components/responses/404'
        '406':
          $ref: '#/components/responses/406'
        '429':
          $ref: '#/components/responses/429'
  /queries/sta/sta_information:
    get:
      tags:
      - 'wai'
      summary: 'Retrieve information on existing Stations'
      description: 'Queries information about existing WLAN stations'
      operationId: staInfoGET
      parameters:
        - $ref: '#/components/parameters/Query.Filter'
        - $ref: '#/components/parameters/Query.AllFields'
        - $ref: '#/components/parameters/Query.Fields'
        - $ref: '#/components/parameters/Query.ExcludeFields'
        - $ref: '#/components/parameters/Query.ExcludeDefault'
      responses:
        '200':
          description: Successful response to sta_info request
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/StaInfo'
        '400':
          $ref: '#/components/responses/400'
        '401':
          $ref: '#/components/responses/401'
        '403':
          $ref: '#/components/responses/403'
        '404':
          $ref: '#/components/responses/404'
        '406':
          $ref: '#/components/responses/406'
        '429':
          $ref: '#/components/responses/429'
  /subscriptions:
    get:
      tags:
      - 'wai'
      summary: 'Retrieve information on subscriptions for notifications'
      description: 'Queries information on subscriptions for notifications'
      operationId: subscriptionLinkList_subscriptionsGET
      parameters:
        - $ref: '#/components/parameters/Query.SubscriptionType'
      responses:
        '200':
          description: 'Response body contains the list of links to requestors subscriptions.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SubscriptionLinkList'
              example:
                _links:
                  self:
                    href: 'http://meAppServer.example.com/wai/v2/subscriptions'
                subscription:
                  - _links:
                      self:
                        href: 'http://meAppServer.example.com/wai/v2/subscriptions/sub123'
                    callbackReference: 'http://my.callback.com/wai/assocStaSubscription/some-id'
                    subscriptionType: AssocStaSubscription
        '400':
          $ref: '#/components/responses/400'
        '401':
          $ref: '#/components/responses/401'
        '403':
          $ref: '#/components/responses/403'
        '404':
          $ref: '#/components/responses/404'
        '406':
          $ref: '#/components/responses/406'
        '429':
          $ref: '#/components/responses/429'
    post:
      tags:
      - 'wai'
      summary: 'Create a new subscription'
      description: 'Creates a new subscription to WLAN Access Information notifications'
      operationId: subscriptionsPOST
      requestBody:
        description: Subscription to be created
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/InlineSubscription'
            example:
              subscriptionType: AssocStaSubscription
              callbackReference: 'http://meAppClient.example.com/wai/v2/notifications/1'
              expiryDeadline:
                seconds: 1977836800
                nanoSeconds: 0
              apId:
                macId: 005C0A0A0A0A
                ssid: 'myNetworkSsid'
                ipAddress: 10.10.100.1
      responses:
        '201':
          description: Successful subscription response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InlineSubscription'
              example:
                subscriptionType: AssocStaSubscription
                callbackReference: 'http://meAppClient.example.com/wai/v2/notifications/1'
                _links:
                  self:
                    href: 'http://meAppServer.example.com/wai/v2/subscriptions/sub123'
                expiryDeadline:
                  seconds: 1977836800
                  nanoSeconds: 0
                apId:
                  macId: 005C0A0A0A0A
                  ssid: 'myNetworkSsid'
                  ipAddress: 10.10.100.1
        '400':
          $ref: '#/components/responses/400'
        '401':
          $ref: '#/components/responses/401'
        '403':
          $ref: '#/components/responses/403'
        '404':
          $ref: '#/components/responses/404'
        '406':
          $ref: '#/components/responses/406'
        '415':
          $ref: '#/components/responses/415'
        '422':
          $ref: '#/components/responses/422'
        '429':
          $ref: '#/components/responses/429'
      callbacks:
        notification:
          '{$request.body#/callbackReference}':
            post:
              summary: 'Callback POST used to send a notification'
              description: 'Notification from WAIS, content based on subscription type'
              operationId: notificationPOST
              requestBody:
                description: Subscription notification
                required: true
                content:
                  application/json:
                    schema:
                      $ref: '#/components/schemas/InlineNotification'
                    example:
                      notificationType: AssocStaNotification
                      timeStamp:
                        seconds: 1977836800
                        nanoseconds: 0
                      apId:
                        macId: 005C0A0A0A0A
                        ssid: 'myNetworkSsid'
                        ipAddress: 10.10.100.1
                      staId:
                        macId: 005C01111111
                        ssid:
                        - 'myNetworkSsid'
                        - 'myOtherNetworkSsid'
                        aid: '1122'
                        ipAddress: 10.10.1.255
              responses:
                '204':
                  $ref: '#/components/responses/204'
  '/subscriptions/{subscriptionId}':
    get:
      tags:
      - 'wai'
      summary: 'Retrieve information on current specific subscription'
      description: 'Queries information about an existing subscription, identified by its self-referring URI returned on creation (initial POST)'
      operationId: subscriptionsGET
      parameters:
        - $ref: '#/components/parameters/Path.subscrId'
      responses:
        '200':
          description: Subscription information regarding subscription notifications
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InlineSubscription'
              example:
                subscriptionType: AssocStaSubscription
                callbackReference: 'http://meAppClient.example.com/wai/v2/notifications/1'
                _links:
                  self:
                    href: 'http://meAppServer.example.com/wai/v2/subscriptions/sub123'
                expiryDeadline:
                  seconds: 1977836800
                  nanoSeconds: 0
                apId:
                  macId: 005C0A0A0A0A
                  ssid: 'myNetworkSsid'
                  ipAddress: 10.10.100.1
        '400':
          $ref: '#/components/responses/400'
        '401':
          $ref: '#/components/responses/401'
        '403':
          $ref: '#/components/responses/403'
        '404':
          $ref: '#/components/responses/404'
        '406':
          $ref: '#/components/responses/406'
        '429':
          $ref: '#/components/responses/429'
    put:
      tags:
      - 'wai'
      summary: 'Modify an existing subscription'
      description: 'Updates an existing subscription, identified by its self-referring URI returned on creation (initial POST)'
      operationId: subscriptionsPUT
      requestBody:
        description: Subscription to be modified
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/InlineSubscription'
            example:
              subscriptionType: AssocStaSubscription
              callbackReference: 'http://meAppClient.example.com/wai/v2/notifications/1'
              _links:
                self:
                  href: 'http://meAppServer.example.com/wai/v2/subscriptions/sub123'
              expiryDeadline:
                seconds: 1977836800
                nanoSeconds: 0
              apId:
                macId: 005C0A0A0A0A
                ssid: 'myNetworkSsid'
                ipAddress: 10.10.100.1
      parameters:
        - $ref: '#/components/parameters/Path.subscrId'
      responses:
        '200':
          description: Successful subscription modification
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InlineSubscription'
              example:
                _links:
                  self:
                    href: 'http://[hostIP]/sbox-xyz123/wai/v2/subscriptions/sub123'
                callbackReference: 'http://my.callback.com/wai/some-id'
                apId:
                  macId: 005C0A0A0A0A
        '400':
          $ref: '#/components/responses/400'
        '401':
          $ref: '#/components/responses/401'
        '403':
          $ref: '#/components/responses/403'
        '404':
          $ref: '#/components/responses/404'
        '406':
          $ref: '#/components/responses/406'
        '412':
          $ref: '#/components/responses/412'
        '422':
          $ref: '#/components/responses/422'
        '429':
          $ref: '#/components/responses/429'
    delete:
      tags:
      - 'wai'
      summary: 'Cancel an existing subscription'
      description: 'Cancels an existing subscription, identified by its self-referring URI returned on creation (initial POST)'
      operationId: subscriptionsDELETE
      parameters:
        - $ref: '#/components/parameters/Path.subscrId'
      responses:
        '204':
          $ref: '#/components/responses/204'
        '401':
          $ref: '#/components/responses/401'
        '403':
          $ref: '#/components/responses/403'
        '404':
          $ref: '#/components/responses/404'
        '429':
          $ref: '#/components/responses/429'
components:
  responses:
    200:
      description: OK
    204:
      description: No Content
    400:
      description: 'Bad Request : used to indicate that incorrect parameters were passed to the request.'
      content:
        application/problem+json:
          schema:
            $ref: '#/components/schemas/ProblemDetails'
    401:
      description: 'Unauthorized :  used when the client did not submit credentials.'
      content:
        application/problem+json:
          schema:
            $ref: '#/components/schemas/ProblemDetails'
    403:
      description: 'Forbidden :  operation is not allowed given the current status of the resource.'
      content:
        application/problem+json:
          schema:
            $ref: '#/components/schemas/ProblemDetails'
    404:
      description: 'Not Found :  used when a client provided a URI that cannot be mapped to a valid resource URI.'
      content:
        application/problem+json:
          schema:
            $ref: '#/components/schemas/ProblemDetails'
    406:
      description: 'Not Acceptable : used to indicate that the server cannot provide the any of the content formats supported by the client.'
      content:
        application/problem+json:
          schema:
            $ref: '#/components/schemas/ProblemDetails'
    412:
      description: 'Precondition failed :  used when a condition has failed during conditional requests, e.g. when
        using ETags to avoid write conflicts when using PUT'
      content:
        application/problem+json:
          schema:
            $ref: '#/components/schemas/ProblemDetails'
    415:
      description: 'Unsupported Media Type :  used to indicate that the server or the client does not support the content type of the entity body.'
      content:
        application/problem+json:
          schema:
            $ref: '#/components/schemas/ProblemDetails'
    422:
      description: 'Unprocessable Entity : used to indicate that the server understands the content type of the request entity and that the
        syntax of the request entity is correct but that the server is unable to process the contained instructions. This error condition can occur if an
        JSON request body is syntactically correct but semantically incorrect, for example if the target area for the request is considered too large. This
        error condition can also occur if the capabilities required by the request are not supported.'
      content:
        application/problem+json:
          schema:
            $ref: '#/components/schemas/ProblemDetails'
          example:
            application/problem+json:
              type: 'https://meAppServer.example.com/wai/v2/probs/too-many targets'
              title: Too many targets
              status: '422'
              detail: The target area for the request is considered too large
              instance: /meAppClient.example.com/77777/msgs/abc
    429:
      description: 'Too Many Requests : used when a rate limiter has triggered.'
      content:
        application/problem+json:
          schema:
            $ref: '#/components/schemas/ProblemDetails'
  parameters:
    Path.subscrId:
      name: subscriptionId
      in: path
      description: 'Subscription Id, specifically the "self" returned in the subscription request'
      required: true
      schema:
        type: string
        format: uri
    Query.Filter:
      name: filter
      in: query
      description: Attribute-based filtering expression according to clause 6.19 of ETSI GS MEC 009. .
      required: false
      schema:
        type: string
    Query.AllFields:
      name: all_fields
      in: query
      description: Include all complex attributes in the response. See clause 6.18 of ETSI GS MEC 009 for details.
      required: false
      schema:
        type: string
    Query.Fields:
      name: fields
      in: query
      description: Complex attributes to be included into the response. See clause 6.18 of ETSI GS MEC 009 for details.
      required: false
      schema:
        type: array
        items:
          type: string
    Query.ExcludeFields:
      name: exclude_fields
      in: query
      description: Complex attributes to be excluded from the response. See clause 6.18 of ETSI GS MEC 009 for details.
      required: false
      schema:
        type: array
        items:
          type: string
    Query.ExcludeDefault:
      name: exclude_default
      in: query
      description: 'Indicates to exclude the following complex attributes from the response. See clause 6.18 of ETSI GS MEC 009 for details.
        The following attributes shall be excluded from the structure in the response body if this parameter is provided, or none of the parameters
        "all_fields", "fields", "exclude_fields", "exclude_default" are provided: Not applicable'
      required: false
      schema:
        type: array
        items:
          type: string
    Query.SubscriptionType:
      name: subscription_type
      in: query
      description: 'Filter on a specific subscription type. Permitted values: assoc_sta, sta_data_rate.'
      required: false
      schema:
        type: string
  schemas:
    ApAssociated:
      properties:
        assocId:
          description: Unique number which identifies a particular association between the station and Access Point.
          type: string
          x-etsi-mec-cardinality: 0..1
          x-etsi-mec-origin-type: string
        ipAddress:
          description: IPv4 or IPv6 address allocated for the Access Point.
          items:
            type: string
          minItems: 0
          type: array
          x-etsi-mec-cardinality: 0..N
          x-etsi-mec-origin-type: string
        macId:
          description: Unique identifier assigned to the Access Point (as network interface controller) for communications at the data link layer of a network segment.
          type: string
          x-etsi-mec-cardinality: '1'
          x-etsi-mec-origin-type: string
        ssid:
          description: Service Set Identifier to identify logical networks.
          items:
            type: string
          minItems: 0
          type: array
          x-etsi-mec-cardinality: 0..N
          x-etsi-mec-origin-type: String
      required:
      - macId
      type: object
      x-etsi-ref: 6.5.12
    ApIdentity:
      properties:
        ipAddress:
          description: IPv4 or IPv6 address allocated for the Access Point.
          items:
            type: string
          minItems: 0
          type: array
          x-etsi-mec-cardinality: 0..N
          x-etsi-mec-origin-type: String
        macId:
          description: Unique Identifier assigned to an Access Point (as network interface controller) for communications at the data link layer of a network segment.
          type: string
          x-etsi-mec-cardinality: '1'
          x-etsi-mec-origin-type: String
        ssid:
          description: Service Set Identifier to identify logical networks including Basic Service Set and Extended Service Set.
          items:
            type: string
          minItems: 0
          type: array
          x-etsi-mec-cardinality: 0..N
          x-etsi-mec-origin-type: String
      required:
      - macId
      type: object
      x-etsi-ref: 6.5.3
    ApInfo:
      properties:
        apId:
          # description': Identifier(s) to uniquely specify the Access Point whose information is exposed within this data type.
          # x-etsi-mec-cardinality': '1'
          # x-etsi-mec-origin-type': ApIdentity
          $ref: '#/components/schemas/ApIdentity'
        apLocation:
          # description': The location on the Access Point.
          # x-etsi-mec-cardinality': 0..1
          # x-etsi-mec-origin-type': ApLocation
          $ref: '#/components/schemas/ApLocation'
        apNeighbor:
          # description': Information about neighbor Access Points.
          # x-etsi-mec-cardinality': 0..1
          # x-etsi-mec-origin-type': NeighborReport
          $ref: '#/components/schemas/NeighborReport'
        bssLoad:
          # description': BSS Load attribute contains information on the current STA population and traffic levels in the BSS as defined in IEEE 802.11-2016 [8].
          # x-etsi-mec-cardinality': 0..1
          # x-etsi-mec-origin-type': BssLoad
          $ref: '#/components/schemas/BssLoad'
        channel:
          description: Channel configured for the Access Point.
Michel Roy's avatar
Michel Roy committed
549
          format: uint32
550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788
          type: integer
          x-etsi-mec-cardinality: 0..1
          x-etsi-mec-origin-type: Uint32
        extBssLoad:
          # description': Extended BSS Load attribute contains more detailed information on the current STA population and traffic levels in the BSS as per ETSI GS MEC 002 [i.4].
          # x-etsi-mec-cardinality': 0..1
          # x-etsi-mec-origin-type': ExtBssLoad
          $ref: '#/components/schemas/ExtBssLoad'
        timeStamp:
          # description': Time stamp.
          # x-etsi-mec-cardinality': 0..1
          # x-etsi-mec-origin-type': TimeStamp
          $ref: '#/components/schemas/TimeStamp'
        wanMetrics:
          # description': WAN Metrics element provides information about the WAN link connecting an IEEE 802.11 Access Node and the Internet. Transmission characteristics such as the speed of the WAN connection to the Internet are included in Hotspot 2.0 Technical Specification v1.0.0 [i.3].
          # x-etsi-mec-cardinality': 0..1
          # x-etsi-mec-origin-type': WanMetrics
          $ref: '#/components/schemas/WanMetrics'
        wlanCap:
          # description': WLAN capabilities of Access Point.
          # x-etsi-mec-cardinality': 0..1
          # x-etsi-mec-origin-type': WlanCapabilities
          $ref: '#/components/schemas/WlanCapabilities'
      required:
      - apId
      type: object
      x-etsi-ref: 6.2.2
    ApLocation:
      properties:
        civicLocation:
          # description': Civic Location of the AP as described in IETF RFC 4776 [7].
          # x-etsi-mec-cardinality': 0..1
          # x-etsi-mec-origin-type': CivicLocation
          $ref: '#/components/schemas/CivicLocation'
        geolocation:
          # description': Geospatial Location of the AP as defined in IEEE 802.11-2016 [8].
          # x-etsi-mec-cardinality': 0..1
          # x-etsi-mec-origin-type': GeoLocation
          $ref: '#/components/schemas/GeoLocation'
      type: object
      x-etsi-ref: 6.5.9
    AssocStaNotification:
      properties:
        apId:
          # description': Identifier(s) to uniquely specify the Access Point to which the client stations are associated.
          # x-etsi-mec-cardinality': '1'
          # x-etsi-mec-origin-type': ApIdentity
          $ref: '#/components/schemas/ApIdentity'
        notificationType:
          description: Shall be set to "AssocStaNotification".
          type: string
          x-etsi-mec-cardinality: '1'
          x-etsi-mec-origin-type: String
        staId:
          description: Identifier(s) to uniquely specify the client station(s) associated.
          items:
            $ref: '#/components/schemas/StaIdentity'
          minItems: 0
          type: array
          x-etsi-mec-cardinality: 0..N
          x-etsi-mec-origin-type: StaIdentity
        timeStamp:
          # description': Time stamp.
          # x-etsi-mec-cardinality': 0..1
          # x-etsi-mec-origin-type': TimeStamp
          $ref: '#/components/schemas/TimeStamp'
      required:
      - notificationType
      - apId
      type: object
      x-etsi-ref: 6.4.2
    AssocStaSubscription:
      properties:
        _links:
          description: Hyperlink related to the resource. This shall be only included in the HTTP responses and in HTTP PUT requests.
          properties:
            self:
              # description': Self referring URI. The URI shall be unique within the WLAN information API as it acts as an ID for the subscription.
              # x-etsi-mec-cardinality': '1'
              # x-etsi-mec-origin-type': LinkType
              $ref: '#/components/schemas/LinkType'
          required:
          - self
          type: object
          x-etsi-mec-cardinality: 0..1
          x-etsi-mec-origin-type: Structure (inlined)
        apId:
          # description': Identifier(s) to uniquely specify the target Access Point for the subscription
          # x-etsi-mec-cardinality': '1'
          # x-etsi-mec-origin-type': ApIdentity
          $ref: '#/components/schemas/ApIdentity'
        callbackReference:
          description: URI selected by the service consumer to receive notifications on the subscribed WLAN information. This shall be included both in the request and in response.
          format: uri
          type: string
          x-etsi-mec-cardinality: '1'
          x-etsi-mec-origin-type: URI
        expiryDeadline:
          # description': The expiration time of the subscription determined by the WLAN Access Information Service.
          # x-etsi-mec-cardinality': 0..1
          # x-etsi-mec-origin-type': TimeStamp
          $ref: '#/components/schemas/TimeStamp'
        subscriptionType:
          description: Shall be set to "AssocStaSubscription".
          type: string
          x-etsi-mec-cardinality: '1'
          x-etsi-mec-origin-type: String
      required:
      - subscriptionType
      - callbackReference
      - apId
      type: object
      x-etsi-ref: 6.3.2
    AssociatedStations:
      properties:
        assocId:
          description: Unique number which identifies a particular association between an Access Point and a station.
          type: string
          x-etsi-mec-cardinality: 0..1
          x-etsi-mec-origin-type: string
        ipAddress:
          description: IPv4 or IPv6 address allocated for the station associated with the Access Point.
          items:
            type: string
          minItems: 0
          type: array
          x-etsi-mec-cardinality: 0..N
          x-etsi-mec-origin-type: string
        macId:
          description: Unique identifier assigned to a station (as network interface controller) for communications at the data link layer of a network segment.
          type: string
          x-etsi-mec-cardinality: '1'
          x-etsi-mec-origin-type: string
      required:
      - macId
      type: object
      x-etsi-ref: 6.5.5
    BeaconReport:
      properties:
        bssId:
          description: The BSSID field indicates the BSSID of the BSS(s) for which a beacon report has been received.
          items:
            type: string
          minItems: 1
          type: array
          x-etsi-mec-cardinality: 1..N
          x-etsi-mec-origin-type: String
        channelId:
          description: Channel number where the beacon was received.
          type: integer
          x-etsi-mec-cardinality: '1'
          x-etsi-mec-origin-type: Integer
        measurementId:
          description: Measurement ID of the Measurement configuration applied to this Beacon Report.
          type: string
          x-etsi-mec-cardinality: '1'
          x-etsi-mec-origin-type: String
        reportingCondition:
          description: As in table T9-89 of IEEE 802.11-2012 [8].
          type: integer
          x-etsi-mec-cardinality: '1'
          x-etsi-mec-origin-type: Integer
        ssId:
          description: (Optional) The SSID subelement indicates the ESS(s) or IBSS(s) for which a beacon report is received.
          items:
            type: string
          minItems: 1
          type: array
          x-etsi-mec-cardinality: 1..N
          x-etsi-mec-origin-type: String
        staId:
          # description': Identifier to uniquely specify the station whose information is exposed within this data type.
          # x-etsi-mec-cardinality': '1'
          # x-etsi-mec-origin-type': StaIdentity
          $ref: '#/components/schemas/StaIdentity'
      required:
      - staId
      - measurementId
      - channelId
      - bssId
      - ssId
      - reportingCondition
      type: object
      x-etsi-ref: 6.5.27
    BeaconRequestConfig:
      properties:
        bssId:
          description: The BSSID field indicates the BSSID of the BSS(s) for which a beacon report is requested. When requesting beacon reports for all BSSs on the channel, the BSSID field contains the wildcard BSSID.
          items:
            type: string
          minItems: 1
          type: array
          x-etsi-mec-cardinality: 1..N
          x-etsi-mec-origin-type: String
        channelId:
          description: Channel number to scan. A Channel Number of 0 indicates a request to make iterative measurements for all supported channels in the Operating Class where the measurement is permitted on the channel and the channel is valid for the current regulatory domain. A Channel Number of 255 indicates a request to make iterative measurements for all supported channels in the current Operating Class listed in the latest AP Channel Report received from the serving AP.
          type: integer
          x-etsi-mec-cardinality: '1'
          x-etsi-mec-origin-type: Integer
        measurementMode:
          description: '0 for passive.

            1 for active.

            2 for beacon table.'
          type: integer
          x-etsi-mec-cardinality: '1'
          x-etsi-mec-origin-type: Integer
        reportingCondition:
          description: As in table T9-89 of IEEE 802.11-2012 [8].
          type: integer
          x-etsi-mec-cardinality: '1'
          x-etsi-mec-origin-type: Integer
        ssId:
          description: (Optional) The SSID subelement indicates the ESS(s) or IBSS(s) for which a beacon report is requested.
          items:
            type: string
          minItems: 1
          type: array
          x-etsi-mec-cardinality: 1..N
          x-etsi-mec-origin-type: String
        staId:
          # description': Identifier to uniquely specify the station whose information is exposed within this data type.
          # x-etsi-mec-cardinality': '1'
          # x-etsi-mec-origin-type': StaIdentity
          $ref: '#/components/schemas/StaIdentity'
      required:
      - staId
      - channelId
      - measurementMode
      - bssId
      - ssId
      - reportingCondition
      type: object
      x-etsi-ref: 6.5.25
    BssLoad:
      properties:
        availAdmCap:
          description: Available Admission Capacity that specifies the remaining amount of medium time available via explicit admission control, in units of 32 s/s.
Michel Roy's avatar
Michel Roy committed
789
          format: uint16
790 791 792 793 794
          type: integer
          x-etsi-mec-cardinality: '1'
          x-etsi-mec-origin-type: Uint16
        channelUtilization:
          description: "The percentage of time, linearly scaled with 255 representing 100\_%, that the AP sensed the medium was busy, as indicated by either the physical or virtual Carrier Sense (CS) mechanism."
Michel Roy's avatar
Michel Roy committed
795
          format: uint8
796 797 798 799 800
          type: integer
          x-etsi-mec-cardinality: '1'
          x-etsi-mec-origin-type: UInt8
        staCount:
          description: An unsigned integer that indicates the total number of STAs currently associated with this BSS.
Michel Roy's avatar
Michel Roy committed
801
          format: uint16
802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 876 877 878 879 880 881 882 883 884 885 886 887 888 889 890 891 892 893 894 895 896 897 898 899 900 901 902 903 904 905 906 907 908 909 910 911 912 913 914 915 916 917 918 919 920 921 922 923 924 925 926 927 928 929 930 931 932 933 934 935 936 937 938 939 940 941 942 943 944 945 946 947 948 949 950 951 952 953 954 955 956 957 958 959 960 961 962 963 964 965 966 967 968 969 970 971 972 973 974 975 976 977 978 979 980 981 982 983 984 985 986 987 988 989 990 991 992 993 994 995 996 997 998 999 1000 1001 1002 1003 1004 1005 1006 1007 1008
          type: integer
          x-etsi-mec-cardinality: '1'
          x-etsi-mec-origin-type: UInt16
      required:
      - staCount
      - channelUtilization
      - availAdmCap
      type: object
      x-etsi-ref: 6.5.7
    ChannelLoadConfig:
      properties:
        apId:
          # description': Identifier(s) to uniquely specify the target Access Point
          # x-etsi-mec-cardinality': '1'
          # x-etsi-mec-origin-type': ApIdentity
          $ref: '#/components/schemas/ApIdentity'
        cChannelId:
          description: Channel number which load is reported
          type: integer
          x-etsi-mec-cardinality: '1'
          x-etsi-mec-origin-type: Integer
        channelLoad:
          description: Channel load as per IEEE 802.11-2012 [8], section 11.11.9.3
          type: integer
          x-etsi-mec-cardinality: '1'
          x-etsi-mec-origin-type: Integer
      required:
      - apId
      - cChannelId
      - channelLoad
      type: object
      x-etsi-ref: 6.5.24
    CivicLocation:
      properties:
        ca0:
          description: Language
          type: string
          x-etsi-mec-cardinality: 0..1
          x-etsi-mec-origin-type: String
        ca1:
          description: 'National subdivisions (state, canton, region,province, prefecture) '
          type: string
          x-etsi-mec-cardinality: 0..1
          x-etsi-mec-origin-type: String
        ca128:
          description: Script
          type: string
          x-etsi-mec-cardinality: 0..1
          x-etsi-mec-origin-type: String
        ca16:
          description: Leading street direction
          type: string
          x-etsi-mec-cardinality: 0..1
          x-etsi-mec-origin-type: String
        ca17:
          description: Trailing street suffix
          type: string
          x-etsi-mec-cardinality: 0..1
          x-etsi-mec-origin-type: String
        ca18:
          description: Street suffix or type
          type: string
          x-etsi-mec-cardinality: 0..1
          x-etsi-mec-origin-type: String
        ca19:
          description: House number
          type: string
          x-etsi-mec-cardinality: 0..1
          x-etsi-mec-origin-type: String
        ca2:
          description: County, parish, gun (JP), district (IN)
          type: string
          x-etsi-mec-cardinality: 0..1
          x-etsi-mec-origin-type: String
        ca20:
          description: House number suffix
          type: string
          x-etsi-mec-cardinality: 0..1
          x-etsi-mec-origin-type: String
        ca21:
          description: Landmark of vanity address
          type: string
          x-etsi-mec-cardinality: 0..1
          x-etsi-mec-origin-type: String
        ca22:
          description: Additional location information
          type: string
          x-etsi-mec-cardinality: 0..1
          x-etsi-mec-origin-type: String
        ca23:
          description: Name (residence and office occupant)
          type: string
          x-etsi-mec-cardinality: 0..1
          x-etsi-mec-origin-type: String
        ca24:
          description: Postal/zip code
          type: string
          x-etsi-mec-cardinality: 0..1
          x-etsi-mec-origin-type: String
        ca25:
          description: Building (structure)
          type: string
          x-etsi-mec-cardinality: 0..1
          x-etsi-mec-origin-type: String
        ca26:
          description: Unit (apartment/suite)
          type: string
          x-etsi-mec-cardinality: 0..1
          x-etsi-mec-origin-type: String
        ca27:
          description: Floor
          type: string
          x-etsi-mec-cardinality: 0..1
          x-etsi-mec-origin-type: String
        ca28:
          description: Room
          type: string
          x-etsi-mec-cardinality: 0..1
          x-etsi-mec-origin-type: String
        ca29:
          description: Type of place
          type: string
          x-etsi-mec-cardinality: 0..1
          x-etsi-mec-origin-type: String
        ca3:
          description: City, township, shi (JP)
          type: string
          x-etsi-mec-cardinality: 0..1
          x-etsi-mec-origin-type: String
        ca30:
          description: Postal community name
          type: string
          x-etsi-mec-cardinality: 0..1
          x-etsi-mec-origin-type: String
        ca31:
          description: Post office box
          type: string
          x-etsi-mec-cardinality: 0..1
          x-etsi-mec-origin-type: String
        ca32:
          description: Additional code
          type: string
          x-etsi-mec-cardinality: 0..1
          x-etsi-mec-origin-type: String
        ca33:
          description: Seat (desk.cubicle, workstation)
          type: string
          x-etsi-mec-cardinality: 0..1
          x-etsi-mec-origin-type: String
        ca34:
          description: Primary road name
          type: string
          x-etsi-mec-cardinality: 0..1
          x-etsi-mec-origin-type: String
        ca35:
          description: Road section
          type: string
          x-etsi-mec-cardinality: 0..1
          x-etsi-mec-origin-type: String
        ca36:
          description: Branch road name
          type: string
          x-etsi-mec-cardinality: 0..1
          x-etsi-mec-origin-type: String
        ca37:
          description: Sub-branch road name
          type: string
          x-etsi-mec-cardinality: 0..1
          x-etsi-mec-origin-type: String
        ca38:
          description: Street name pre-modifier
          type: string
          x-etsi-mec-cardinality: 0..1
          x-etsi-mec-origin-type: String
        ca39:
          description: Street name post-modifier
          type: string
          x-etsi-mec-cardinality: 0..1
          x-etsi-mec-origin-type: String
        ca4:
          description: City division, borough, city district, ward, chou (JP)
          type: string
          x-etsi-mec-cardinality: 0..1
          x-etsi-mec-origin-type: String
        ca5:
          description: Neighborhood, block
          type: string
          x-etsi-mec-cardinality: 0..1
          x-etsi-mec-origin-type: String
        ca6:
          description: 'Group of streets below the neighborhood level '
          type: string
          x-etsi-mec-cardinality: 0..1
          x-etsi-mec-origin-type: String
        country:
          description: The two-letter ISO 3166 [i.9] country code in capital ASCII letters, e.g. DE or US, as per ISO 3166 [i.9]
          type: string
          x-etsi-mec-cardinality: '1'
          x-etsi-mec-origin-type: String
      required:
      - country
      type: object
      x-etsi-ref: 6.5.20
    DmgCapabilities:
      properties:
        ExtScMcsCap:
          description: Extended SC MCS capabilities as defined in draft IEEE P802.11/D4.0 [i.11]
Michel Roy's avatar
Michel Roy committed
1009
          format: uint8
1010 1011 1012 1013 1014
          type: integer
          x-etsi-mec-cardinality: '1'
          x-etsi-mec-origin-type: Uint8
        dmgApOrPcpCapInfo:
          description: DMG AP or PCP capabilities information as defined in draft IEEE P802.11/D4.0 [i.11]
Michel Roy's avatar
Michel Roy committed
1015
          format: uint16
1016 1017 1018 1019 1020
          type: integer
          x-etsi-mec-cardinality: '1'
          x-etsi-mec-origin-type: Uint16
        dmgStaBeamTrackTimeLimit:
          description: DMG station beam tracking time limit as defined in draft IEEE P802.11/D4.0 [i.11]
Michel Roy's avatar
Michel Roy committed
1021
          format: uint16
1022 1023 1024 1025 1026 1027 1028 1029 1030 1031 1032
          type: integer
          x-etsi-mec-cardinality: '1'
          x-etsi-mec-origin-type: Uint16
        dmgStaCapInfo:
          description: DMG station capabilities information as defined in draft IEEE P802.11/D4.0 [i.11]
          format: int64
          type: integer
          x-etsi-mec-cardinality: '1'
          x-etsi-mec-origin-type: Uint64
        maxNrBasicAmsduSubframes:
          description: Number of basic A-MSDU subframes in A-MSDU as defined in draft IEEE P802.11/D4.0 [i.11]
Michel Roy's avatar
Michel Roy committed
1033
          format: uint8
1034 1035 1036 1037 1038
          type: integer
          x-etsi-mec-cardinality: '1'
          x-etsi-mec-origin-type: Uint8
        maxNrShortAmsduSubframes:
          description: Number of short A-MSDU subframes in A-MSDU as defined in draft IEEE P802.11/D4.0 [i.11]
Michel Roy's avatar
Michel Roy committed
1039
          format: uint8
1040 1041 1042 1043 1044
          type: integer
          x-etsi-mec-cardinality: '1'
          x-etsi-mec-origin-type: Uint8
        sarCap:
          description: SAR capabilities as defined in draft IEEE P802.11/D4.0 [i.11]
Michel Roy's avatar
Michel Roy committed
1045
          format: uint8
1046 1047 1048 1049 1050
          type: integer
          x-etsi-mec-cardinality: '1'
          x-etsi-mec-origin-type: Uint8
        tddCap:
          description: TDD capabilities as defined in draft IEEE P802.11/D4.0 [i.11]
Michel Roy's avatar
Michel Roy committed
1051
          format: uint16
1052 1053 1054 1055 1056 1057 1058 1059 1060 1061 1062 1063 1064 1065 1066 1067 1068 1069
          type: integer
          x-etsi-mec-cardinality: '1'
          x-etsi-mec-origin-type: Uint16
      required:
      - dmgStaCapInfo
      - dmgApOrPcpCapInfo
      - dmgStaBeamTrackTimeLimit
      - ExtScMcsCap
      - maxNrBasicAmsduSubframes
      - maxNrShortAmsduSubframes
      - tddCap
      - sarCap
      type: object
      x-etsi-ref: 6.5.17
    EdmgCapabilities:
      properties:
        ampduParameters:
          description: A-MPDU parameters as defined in draft IEEE P802.11/D4.0 [i.11]
Michel Roy's avatar
Michel Roy committed
1070
          format: uint8
1071 1072 1073 1074 1075
          type: integer
          x-etsi-mec-cardinality: '1'
          x-etsi-mec-origin-type: Uint8
        reserved:
          description: ''
Michel Roy's avatar
Michel Roy committed
1076
          format: uint8
1077 1078 1079 1080 1081
          type: integer
          x-etsi-mec-cardinality: 0..1
          x-etsi-mec-origin-type: Uint8
        supportedMcs:
          description: Supported MCS as defined in draft IEEE P802.11/D4.0 [i.11]
Michel Roy's avatar
Michel Roy committed
1082
          format: uint32
1083 1084 1085 1086 1087
          type: integer
          x-etsi-mec-cardinality: '1'
          x-etsi-mec-origin-type: Uint32
        trnParameters:
          description: Training parameters as defined in draft IEEE P802.11/D4.0 [i.11]
Michel Roy's avatar
Michel Roy committed
1088
          format: uint16
1089 1090 1091 1092 1093 1094 1095 1096 1097 1098 1099 1100 1101
          type: integer
          x-etsi-mec-cardinality: '1'
          x-etsi-mec-origin-type: Uint16
      required:
      - ampduParameters
      - trnParameters
      - supportedMcs
      type: object
      x-etsi-ref: 6.5.18
    ExtBssLoad:
      properties:
        muMimoStaCount:
          description: Indicates the total number of STAs currently associated with this BSS that have a 1 in the MU Beamformee Capable field of their VHT Capabilities element.
Michel Roy's avatar
Michel Roy committed
1102
          format: uint16
1103 1104 1105 1106 1107
          type: integer
          x-etsi-mec-cardinality: '1'
          x-etsi-mec-origin-type: UInt16
        obsSec20MhzUtil:
          description: Observable loading on each of the secondary 20 MHz channel.
Michel Roy's avatar
Michel Roy committed
1108
          format: uint8
1109 1110 1111 1112 1113
          type: integer
          x-etsi-mec-cardinality: '1'
          x-etsi-mec-origin-type: Uint8
        obsSec40MhzUtil:
          description: Observable loading on each of the secondary 40 MHz channel.
Michel Roy's avatar
Michel Roy committed
1114
          format: uint8
1115 1116 1117 1118 1119
          type: integer
          x-etsi-mec-cardinality: '1'
          x-etsi-mec-origin-type: Uint8
        obsSec80MhzUtil:
          description: Observable loading on each of the secondary 80 MHz channel.
Michel Roy's avatar
Michel Roy committed
1120
          format: uint8
1121 1122 1123 1124 1125
          type: integer
          x-etsi-mec-cardinality: '1'
          x-etsi-mec-origin-type: Uint8
        spatStreamUnderUtil:
          description: "The percentage of time, linearly scaled with 255 representing 100\_%, that the AP has underutilized spatial domain resources for given busy time of the medium."
Michel Roy's avatar
Michel Roy committed
1126
          format: uint8
1127 1128 1129 1130 1131 1132 1133 1134 1135 1136 1137 1138 1139 1140 1141
          type: integer
          x-etsi-mec-cardinality: '1'
          x-etsi-mec-origin-type: UInt8
      required:
      - muMimoStaCount
      - spatStreamUnderUtil
      - obsSec20MhzUtil
      - obsSec40MhzUtil
      - obsSec80MhzUtil
      type: object
      x-etsi-ref: 6.5.8
    GeoLocation:
      properties:
        altitude:
          description: "The altitude value of location as defined in IETF RFC\_6225 [6]"
Michel Roy's avatar
Michel Roy committed
1142
          format: uint32
1143 1144 1145 1146 1147
          type: integer
          x-etsi-mec-cardinality: 0..1
          x-etsi-mec-origin-type: Uint32
        altitudeType:
          description: The type description for altitude information e.g. floors or meters as defined in IETF RFC 6225 [6]
Michel Roy's avatar
Michel Roy committed
1148
          format: uint8
1149 1150 1151 1152 1153
          type: integer
          x-etsi-mec-cardinality: 0..1
          x-etsi-mec-origin-type: Uint8
        altitudeUncertainty:
          description: The uncertainty for altitude information as defined in IETF RFC 6225 [6]
Michel Roy's avatar
Michel Roy committed
1154
          format: uint8
1155 1156 1157 1158 1159
          type: integer
          x-etsi-mec-cardinality: 0..1
          x-etsi-mec-origin-type: Uint8
        datum:
          description: The datum value to express how coordinates are organized and related to real world as defined in IETF RFC 6225 [6]
Michel Roy's avatar
Michel Roy committed
1160
          format: uint8
1161 1162 1163 1164 1165 1166 1167 1168 1169 1170 1171
          type: integer
          x-etsi-mec-cardinality: '1'
          x-etsi-mec-origin-type: Uint8
        lat:
          description: "The latitude value of location as defined in IETF RFC\_6225 [6]"
          format: int64
          type: integer
          x-etsi-mec-cardinality: '1'
          x-etsi-mec-origin-type: Uint64
        latUncertainty:
          description: The uncertainty for Latitude information as defined in IETF RFC 6225 [6]
Michel Roy's avatar
Michel Roy committed
1172
          format: uint8
1173 1174 1175 1176 1177 1178 1179 1180 1181 1182 1183
          type: integer
          x-etsi-mec-cardinality: '1'
          x-etsi-mec-origin-type: Uint8
        long:
          description: "The longitude value of location as defined in IETF RFC\_6225 [6]"
          format: int64
          type: integer
          x-etsi-mec-cardinality: '1'
          x-etsi-mec-origin-type: Uint64
        longUncertainty:
          description: The uncertainty for Longitude information as defined in IETF RFC 6225 [6]
Michel Roy's avatar
Michel Roy committed
1184
          format: uint8
1185 1186 1187 1188 1189 1190 1191 1192 1193 1194 1195 1196 1197 1198 1199
          type: integer
          x-etsi-mec-cardinality: '1'
          x-etsi-mec-origin-type: Uint8
      required:
      - latUncertainty
      - lat
      - longUncertainty
      - long
      - datum
      type: object
      x-etsi-ref: 6.5.19
    HeCapabilities:
      properties:
        heMacCapInfo:
          description: MAC capabilities of an Access Point.
Michel Roy's avatar
Michel Roy committed
1200
          format: uint8
1201 1202 1203 1204 1205
          type: integer
          x-etsi-mec-cardinality: '1'
          x-etsi-mec-origin-type: Uint8
        hePhyCapinfo:
          description: PHY capabilities of an Access Point.
Michel Roy's avatar
Michel Roy committed
1206
          format: uint8
1207 1208 1209 1210 1211 1212 1213 1214 1215 1216
          type: integer
          x-etsi-mec-cardinality: '1'
          x-etsi-mec-origin-type: Uint8
        ppeThresholds:
          description: PPE Threshold determines the nominal packet padding value for a HE PPDU.
          type: integer
          x-etsi-mec-cardinality: 0..1
          x-etsi-mec-origin-type: not defined
        supportedHeMcsNssSet:
          description: Supported MCS and NSS Set.
Michel Roy's avatar
Michel Roy committed
1217
          format: uint8
1218 1219 1220 1221 1222 1223 1224 1225 1226 1227 1228 1229 1230
          type: integer
          x-etsi-mec-cardinality: '1'
          x-etsi-mec-origin-type: Uint8
      required:
      - heMacCapInfo
      - hePhyCapinfo
      - supportedHeMcsNssSet
      type: object
      x-etsi-ref: 6.5.16
    HtCapabilities:
      properties:
        ampduParameters:
          description: A-MPDU parameters as defined in IEEE 802.11-2016 [8].
Michel Roy's avatar
Michel Roy committed
1231
          format: uint8
1232 1233 1234 1235 1236
          type: integer
          x-etsi-mec-cardinality: '1'
          x-etsi-mec-origin-type: UInt8
        aselCap:
          description: ASEL capabilities as defined in IEEE 802.11-2016 [8].
Michel Roy's avatar
Michel Roy committed
1237
          format: uint8
1238 1239 1240 1241 1242
          type: integer
          x-etsi-mec-cardinality: '1'
          x-etsi-mec-origin-type: UInt8
        htCapabilityInfo:
          description: HT Capability Information as defined in IEEE 802.11-2016 [8].
Michel Roy's avatar
Michel Roy committed
1243
          format: uint16
1244 1245 1246 1247 1248
          type: integer
          x-etsi-mec-cardinality: '1'
          x-etsi-mec-origin-type: UInt16
        htExtendedCap:
          description: Extended HT Capabilities as defined in IEEE 802.11-2016 [8].
Michel Roy's avatar
Michel Roy committed
1249
          format: uint16
1250 1251 1252 1253 1254
          type: integer
          x-etsi-mec-cardinality: '1'
          x-etsi-mec-origin-type: UInt16
        supportedMcsSet:
          description: Supported MCS set as defined in IEEE 802.11-2016 [8].
Michel Roy's avatar
Michel Roy committed
1255
          format: uint128
1256 1257 1258 1259 1260
          type: integer
          x-etsi-mec-cardinality: '1'
          x-etsi-mec-origin-type: Uint128
        txBeamFormCap:
          description: Transmit Beamforming Capabilities as defined in IEEE 802.11-2016 [8].
Michel Roy's avatar
Michel Roy committed
1261
          format: uint32
1262 1263 1264 1265 1266 1267 1268 1269 1270 1271 1272
          type: integer
          x-etsi-mec-cardinality: '1'
          x-etsi-mec-origin-type: UInt32
      required:
      - htCapabilityInfo
      - ampduParameters
      - supportedMcsSet
      - htExtendedCap
      - txBeamFormCap
      - aselCap
      type: object
Michel Roy's avatar
Michel Roy committed
1273
      x-etsi-ref: 6.5.14
1274 1275 1276 1277 1278 1279 1280 1281 1282 1283 1284 1285 1286 1287 1288 1289 1290 1291 1292 1293 1294 1295 1296 1297 1298 1299 1300 1301 1302 1303 1304 1305 1306 1307 1308 1309 1310 1311 1312 1313 1314 1315 1316 1317 1318 1319 1320 1321 1322 1323 1324 1325 1326 1327 1328 1329 1330 1331 1332 1333 1334 1335 1336 1337 1338 1339 1340 1341 1342 1343 1344
    InlineNotification:
      oneOf:
        - $ref: '#/components/schemas/AssocStaNotification'
        - $ref: '#/components/schemas/StaDataRateNotification'
      discriminator:
        propertyName: notificationType
    InlineSubscription:
      oneOf:
        - $ref: '#/components/schemas/AssocStaSubscription'
        - $ref: '#/components/schemas/StaDataRateSubscription'
      discriminator:
        propertyName: subscriptionType
    LinkType:
      properties:
        href:
          description: URI referring to a resource
          type: string
          x-etsi-mec-cardinality: '1'
          x-etsi-mec-origin-type: String
      required:
      - href
      type: object
      x-etsi-ref: 6.5.23
    MeasurementConfig:
      properties:
        beaconRequest:
          # description': Configuration related to Beacon Request.
          # x-etsi-mec-cardinality': 0..1
          # x-etsi-mec-origin-type': BeaconRequestConfig
          $ref: '#/components/schemas/BeaconRequestConfig'
        channelLoad:
          # description': Configuration related to the Channel Load.
          # x-etsi-mec-cardinality': 0..1
          # x-etsi-mec-origin-type': ChannelLoadConfig
          $ref: '#/components/schemas/ChannelLoadConfig'
        measurementDuration:
          description: Duration of the measurement, shall be lower than Maximum Measurement Duration in TU as defined in section 11.11.4 of IEEE 802.11 [8].
          type: integer
          x-etsi-mec-cardinality: '1'
          x-etsi-mec-origin-type: Integer
        measurementId:
          description: Identifier of this measurement configuration.
          type: string
          x-etsi-mec-cardinality: '1'
          x-etsi-mec-origin-type: String
        randomnInterval:
          description: "Random interval to be used for starting the measurement. In units of TU as specifed in section\_11.11.3 of IEEE 802.11 [8]."
          type: integer
          x-etsi-mec-cardinality: '1'
          x-etsi-mec-origin-type: Integer
        staStatistics:
          # description': Configuration related to the statistics provided by STAs.
          # x-etsi-mec-cardinality': 0..1
          # x-etsi-mec-origin-type': StaStatisticsConfig
          $ref: '#/components/schemas/StaStatisticsConfig'
      required:
      - measurementId
      - measurementDuration
      - randomnInterval
      type: object
      x-etsi-notes: "NOTE:\tThis element enables the configuration of the channelLoad, beaconRequest and staStatistics in a single resource data type, although only one of each measurement. Multiple measurement configurations of each kind are not allowed."
      x-etsi-ref: 6.2.4
    NeighborReport:
      properties:
        bssid:
          description: BSS Id of the Access Point that is being reported.
          type: string
          x-etsi-mec-cardinality: '1'
          x-etsi-mec-origin-type: String
        bssidInfo:
          description: Additional information related to Access Point that is being reported such as AP reachability, security, key scope, Mobility Domain, HT/VHT capability and Fine Time Measurements.
Michel Roy's avatar
Michel Roy committed
1345
          format: uint32
1346 1347 1348 1349 1350
          type: integer
          x-etsi-mec-cardinality: '1'
          x-etsi-mec-origin-type: UInt32
        channel:
          description: The channel currently used by this Access Point.
Michel Roy's avatar
Michel Roy committed
1351
          format: uint8
1352 1353 1354 1355 1356
          type: integer
          x-etsi-mec-cardinality: '1'
          x-etsi-mec-origin-type: Uint8
        operatingClass:
          description: The channel set of the AP indicated by this BSSID.
Michel Roy's avatar
Michel Roy committed
1357
          format: uint8
1358 1359 1360 1361 1362
          type: integer
          x-etsi-mec-cardinality: '1'
          x-etsi-mec-origin-type: Uint8
        phyType:
          description: PHY type of the AP indicated by this BSSID. It is an integer value coded according to the value of the dot11PHYType.
Michel Roy's avatar
Michel Roy committed
1363
          format: uint8
1364 1365 1366 1367 1368 1369 1370 1371 1372 1373 1374 1375 1376 1377 1378 1379 1380 1381 1382 1383 1384 1385 1386 1387 1388 1389
          type: integer
          x-etsi-mec-cardinality: '1'
          x-etsi-mec-origin-type: Uint8
      required:
      - bssid
      - bssidInfo
      - operatingClass
      - channel
      - phyType
      type: object
      x-etsi-ref: 6.5.10
    ProblemDetails:
      properties:
        detail:
          description: A human-readable explanation specific to this occurrence of the problem
          type: string
          x-etsi-mec-cardinality: 0..1
          x-etsi-mec-origin-type: String
        instance:
          description: A URI reference that identifies the specific occurrence of the problem
          format: uri
          type: string
          x-etsi-mec-cardinality: 0..1
          x-etsi-mec-origin-type: URI
        status:
          description: The HTTP status code for this occurrence of the problem
Michel Roy's avatar
Michel Roy committed
1390
          format: uint32
1391 1392 1393 1394 1395 1396 1397 1398 1399 1400 1401 1402 1403 1404 1405 1406 1407 1408 1409
          type: integer
          x-etsi-mec-cardinality: 0..1
          x-etsi-mec-origin-type: Uint32
        title:
          description: A short, human-readable summary of the problem type
          type: string
          x-etsi-mec-cardinality: 0..1
          x-etsi-mec-origin-type: String
        type:
          description: A URI reference according to IETF RFC 3986 that identifies the problem type
          format: uri
          type: string
          x-etsi-mec-cardinality: 0..1
          x-etsi-mec-origin-type: URI
      type: object
    Rssi:
      properties:
        rssi:
          description: The Received Signal Strength Indicator from a station
Michel Roy's avatar
Michel Roy committed
1410
          format: uint8
1411 1412 1413 1414 1415 1416 1417 1418 1419 1420 1421 1422 1423 1424 1425 1426
          type: integer
          x-etsi-mec-cardinality: '1'
          x-etsi-mec-origin-type: Uint8
      required:
      - rssi
      type: object
      x-etsi-ref: 6.5.21
    StaDataRate:
      properties:
        staId:
          # description': Identifier(s) to uniquely specify the client station(s) associated.
          # x-etsi-mec-cardinality': 0..1
          # x-etsi-mec-origin-type': StaIdentity
          $ref: '#/components/schemas/StaIdentity'
        staLastDataDownlinkRate:
          description: The data transmit rate in kbps that was most recently used for transmission of data PPDUs from the access point to the station.
Michel Roy's avatar
Michel Roy committed
1427
          format: uint32
1428 1429 1430 1431 1432
          type: integer
          x-etsi-mec-cardinality: 0..1
          x-etsi-mec-origin-type: Uint32
        staLastDataUplinkRate:
          description: The data transmit rate in Kbps that was most recently used for transmission of data PPDUs from the associated station to the access point.
Michel Roy's avatar
Michel Roy committed
1433
          format: uint32
1434 1435 1436 1437 1438 1439 1440 1441 1442 1443 1444 1445 1446 1447 1448 1449 1450 1451 1452 1453 1454 1455 1456 1457 1458 1459 1460 1461 1462 1463 1464 1465 1466 1467 1468 1469 1470 1471 1472 1473 1474 1475 1476 1477 1478 1479 1480 1481 1482 1483 1484 1485 1486 1487 1488 1489 1490 1491 1492 1493 1494 1495 1496 1497 1498 1499 1500 1501 1502 1503 1504 1505 1506 1507 1508 1509 1510 1511 1512 1513 1514 1515 1516 1517 1518 1519 1520 1521 1522 1523 1524 1525 1526 1527 1528 1529 1530 1531 1532 1533 1534 1535 1536 1537 1538 1539 1540 1541 1542 1543 1544 1545 1546 1547 1548 1549 1550 1551 1552 1553
          type: integer
          x-etsi-mec-cardinality: 0..1
          x-etsi-mec-origin-type: Uint32
      type: object
      x-etsi-ref: 6.5.22
    StaDataRateNotification:
      properties:
        notificationType:
          description: Shall be set to "StaDataRateNotification".
          type: string
          x-etsi-mec-cardinality: '1'
          x-etsi-mec-origin-type: String
        staDataRate:
          description: Data rates of a client station.
          items:
            $ref: '#/components/schemas/StaDataRate'
          minItems: 0
          type: array
          x-etsi-mec-cardinality: 0..N
          x-etsi-mec-origin-type: StaDataRate
        timeStamp:
          # description': Time stamp.
          # x-etsi-mec-cardinality': 0..1
          # x-etsi-mec-origin-type': TimeStamp
          $ref: '#/components/schemas/TimeStamp'
      required:
      - notificationType
      type: object
      x-etsi-ref: 6.4.3
    StaDataRateSubscription:
      properties:
        _links:
          description: Hyperlink related to the resource. This shall be only included in the HTTP responses and in HTTP PUT requests.
          properties:
            self:
              # description': Self referring URI. The URI shall be unique within the WLAN Access Information API as it acts as an ID for the subscription.
              # x-etsi-mec-cardinality': '1'
              # x-etsi-mec-origin-type': LinkType
              $ref: '#/components/schemas/LinkType'
          required:
          - self
          type: object
          x-etsi-mec-cardinality: 0..1
          x-etsi-mec-origin-type: Structure (inlined)
        callbackReference:
          description: URI selected by the service consumer to receive notifications on the subscribed WLAN Access Information Service. This shall be included both in the request and in response.
          format: uri
          type: string
          x-etsi-mec-cardinality: '1'
          x-etsi-mec-origin-type: URI
        expiryDeadline:
          # description': The expiration time of the subscription determined by the WLAN Access Information Service.
          # x-etsi-mec-cardinality': 0..1
          # x-etsi-mec-origin-type': TimeStamp
          $ref: '#/components/schemas/TimeStamp'
        staId:
          description: Identifier(s) to uniquely specify the target client station(s) for the subscription
          items:
            $ref: '#/components/schemas/StaIdentity'
          minItems: 1
          type: array
          x-etsi-mec-cardinality: 1..N
          x-etsi-mec-origin-type: StaIdentity
        subscriptionType:
          description: Shall be set to "StaDataRateSubscription".
          type: string
          x-etsi-mec-cardinality: '1'
          x-etsi-mec-origin-type: String
      required:
      - subscriptionType
      - callbackReference
      - staId
      type: object
      x-etsi-ref: 6.3.3
    StaIdentity:
      properties:
        aid:
          description: 'Number which identifies a particular association between a station and an Access Point '
          type: string
          x-etsi-mec-cardinality: 0..1
          x-etsi-mec-origin-type: String
        ipAddress:
          description: IPv4 or IPv6 address allocated for the station.
          items:
            type: string
          minItems: 0
          type: array
          x-etsi-mec-cardinality: 0..N
          x-etsi-mec-origin-type: String
        macId:
          description: Unique identifier assigned to station (as network interface controller) for communications at the data link layer of a network segment.
          type: string
          x-etsi-mec-cardinality: '1'
          x-etsi-mec-origin-type: String
        ssid:
          description: Service Set Identifier to identify logical networks.
          items:
            type: string
          minItems: 0
          type: array
          x-etsi-mec-cardinality: 0..N
          x-etsi-mec-origin-type: String
      required:
      - macId
      type: object
      x-etsi-ref: 6.5.11
    StaInfo:
      properties:
        apAssociated:
          # description': Information about the Access Point that this Client Station is associated to.
          # x-etsi-mec-cardinality': 0..1
          # x-etsi-mec-origin-type': ApAssociated
          $ref: '#/components/schemas/ApAssociated'
        beaconReport:
          # description': Beacon Report as defined in Wi-Fi Agile Multiband Specification [9].
          # x-etsi-mec-cardinality': 0..1
          # x-etsi-mec-origin-type': BeaconReport
          $ref: '#/components/schemas/BeaconReport'
        channel:
          description: Channel currently used by the station.
Michel Roy's avatar
Michel Roy committed
1554
          format: uint32
1555 1556 1557 1558 1559 1560 1561 1562 1563 1564 1565 1566 1567 1568 1569 1570 1571 1572 1573 1574 1575 1576 1577 1578 1579 1580 1581 1582 1583 1584 1585 1586 1587 1588 1589 1590
          type: integer
          x-etsi-mec-cardinality: 0..1
          x-etsi-mec-origin-type: Uint32
        rssi:
          # description': Receive Signal Strength Indicator.
          # x-etsi-mec-cardinality': 0..1
          # x-etsi-mec-origin-type': Rssi
          $ref: '#/components/schemas/Rssi'
        staDataRate:
          # description': Station Data Rate as defined in IEEE 802.11-2016 [8].
          # x-etsi-mec-cardinality': 0..1
          # x-etsi-mec-origin-type': StaDataRate
          $ref: '#/components/schemas/StaDataRate'
        staId:
          # description': 0 to N identifiers to uniquely specify the station whose information is exposed within this data type.
          # x-etsi-mec-cardinality': '1'
          # x-etsi-mec-origin-type': StaIdentity
          $ref: '#/components/schemas/StaIdentity'
        staStatistics:
          # description': Statistics as defined in IEEE 802.11-2016 [8] for the client station collected over measurement duration.
          # x-etsi-mec-cardinality': 0..1
          # x-etsi-mec-origin-type': StaStatistics
          $ref: '#/components/schemas/StaStatistics'
        timeStamp:
          # description': Time stamp.
          # x-etsi-mec-cardinality': 0..1
          # x-etsi-mec-origin-type': TimeStamp
          $ref: '#/components/schemas/TimeStamp'
      required:
      - staId
      type: object
      x-etsi-ref: 6.2.3
    StaStatistics:
      properties:
        groupIdentity:
          description: Indicates the requested statistics group describing the Statistics Group Data according to table 9-114 of IEEE 802.11-2016 [8].
Michel Roy's avatar
Michel Roy committed
1591
          format: uint8
1592 1593 1594 1595 1596
          type: integer
          x-etsi-mec-cardinality: '1'
          x-etsi-mec-origin-type: UInt8
        md:
          description: Measurement Duration.
Michel Roy's avatar
Michel Roy committed
1597
          format: uint16
1598 1599 1600 1601 1602 1603 1604 1605 1606 1607 1608 1609 1610 1611 1612 1613 1614 1615 1616 1617 1618 1619 1620 1621 1622 1623 1624 1625 1626 1627 1628 1629 1630 1631 1632 1633 1634 1635 1636 1637 1638 1639 1640 1641 1642 1643 1644 1645 1646 1647 1648 1649
          type: integer
          x-etsi-mec-cardinality: '1'
          x-etsi-mec-origin-type: UInt16
        statisticsGroupData:
          $ref: '#/components/schemas/StatisticsGroupData'
          description: "Statistics Group Data as defined in Annex C of IEEE 802.112016\_[8]."
          x-etsi-mec-cardinality: '1'
          x-etsi-mec-origin-type: not specified
      required:
      - md
      - groupIdentity
      - statisticsGroupData
      type: object
      x-etsi-ref: 6.5.13
    StaStatisticsConfig:
      properties:
        groupIdentity:
          description: As per table T 9-114 of IEEE 802.11-2012 [8].
          type: integer
          x-etsi-mec-cardinality: '1'
          x-etsi-mec-origin-type: Integer
        staId:
          # description': Identifier to uniquely specify the station whose information is exposed within this data type.
          # x-etsi-mec-cardinality': '1'
          # x-etsi-mec-origin-type': StaIdentity
          $ref: '#/components/schemas/StaIdentity'
        triggerCondition:
          # description': As per Figure 9-161 of IEEE 802.11. This bitmap defines what are the metrics returned by the STA Statistics Report.
          # x-etsi-mec-cardinality': '1'
          # x-etsi-mec-origin-type': 16bits bitmap
          type: integer
        triggerTimeout:
          description: The Trigger Timeout field contains a value in units of 100 TUs during which a measuring STA does not generate further triggered STA Statistics Reports after a trigger condition has been met.
          type: integer
          x-etsi-mec-cardinality: '1'
          x-etsi-mec-origin-type: Integer
        triggeredReport:
          # description': Yes, use triggered report.
          # x-etsi-mec-cardinality': '1'
          # x-etsi-mec-origin-type': Bool
          type: boolean
      required:
      - staId
      - groupIdentity
      - triggeredReport
      - triggerTimeout
      - triggerCondition
      type: object
      x-etsi-ref: 6.5.26
    StatisticsGroupData:
      properties:
        dot11AMPDUDelimiterCRCErrorCount:
Michel Roy's avatar
Michel Roy committed
1650
          format: uint32
1651 1652 1653 1654
          type: integer
          x-etsi-mec-cardinality: 0..1
          x-etsi-mec-origin-type: Uint32
        dot11AMPDUReceivedCount:
Michel Roy's avatar
Michel Roy committed
1655
          format: uint32
1656 1657 1658 1659
          type: integer
          x-etsi-mec-cardinality: 0..1
          x-etsi-mec-origin-type: Uint32
        dot11AMSDUAckFailureCount:
Michel Roy's avatar
Michel Roy committed
1660
          format: uint32
1661 1662 1663 1664
          type: integer
          x-etsi-mec-cardinality: 0..1
          x-etsi-mec-origin-type: Uint32
        dot11AckFailureCount:
Michel Roy's avatar
Michel Roy committed
1665
          format: uint32
1666 1667 1668 1669
          type: integer
          x-etsi-mec-cardinality: 0..1
          x-etsi-mec-origin-type: Uint32
        dot11BeamformingFrameCount:
Michel Roy's avatar
Michel Roy committed
1670
          format: uint32
1671 1672 1673 1674
          type: integer
          x-etsi-mec-cardinality: 0..1
          x-etsi-mec-origin-type: Uint32
        dot11ChannelWidthSwitchCount:
Michel Roy's avatar
Michel Roy committed
1675
          format: uint32
1676 1677 1678 1679
          type: integer
          x-etsi-mec-cardinality: 0..1
          x-etsi-mec-origin-type: Uint32
        dot11DualCTSFailureCount:
Michel Roy's avatar
Michel Roy committed
1680
          format: uint32
1681 1682 1683 1684
          type: integer
          x-etsi-mec-cardinality: 0..1
          x-etsi-mec-origin-type: Uint32
        dot11DualCTSSuccessCount:
Michel Roy's avatar
Michel Roy committed
1685
          format: uint32
1686 1687 1688 1689
          type: integer
          x-etsi-mec-cardinality: 0..1
          x-etsi-mec-origin-type: Uint32
        dot11ExplicitBARFailureCount:
Michel Roy's avatar
Michel Roy committed
1690
          format: uint32
1691 1692 1693 1694
          type: integer
          x-etsi-mec-cardinality: 0..1
          x-etsi-mec-origin-type: Uint32
        dot11FCSErrorCount:
Michel Roy's avatar
Michel Roy committed
1695
          format: uint32
1696 1697 1698 1699
          type: integer
          x-etsi-mec-cardinality: 0..1
          x-etsi-mec-origin-type: Uint32
        dot11FailedAMSDUCount:
Michel Roy's avatar
Michel Roy committed
1700
          format: uint32
1701 1702 1703 1704
          type: integer
          x-etsi-mec-cardinality: 0..1
          x-etsi-mec-origin-type: Uint32
        dot11FailedCount:
Michel Roy's avatar
Michel Roy committed
1705
          format: uint32
1706 1707 1708 1709
          type: integer
          x-etsi-mec-cardinality: 0..1
          x-etsi-mec-origin-type: Uint32
        dot11FortyMHzFrameReceivedCount:
Michel Roy's avatar
Michel Roy committed
1710
          format: uint32
1711 1712 1713 1714
          type: integer
          x-etsi-mec-cardinality: 0..1
          x-etsi-mec-origin-type: Uint32
        dot11FortyMHzFrameTransmittedCount:
Michel Roy's avatar
Michel Roy committed
1715
          format: uint32
1716 1717 1718 1719
          type: integer
          x-etsi-mec-cardinality: 0..1
          x-etsi-mec-origin-type: Uint32
        dot11FrameDuplicateCount:
Michel Roy's avatar
Michel Roy committed
1720
          format: uint32
1721 1722 1723 1724
          type: integer
          x-etsi-mec-cardinality: 0..1
          x-etsi-mec-origin-type: Uint32
        dot11GrantedRDGUnusedCount:
Michel Roy's avatar
Michel Roy committed
1725
          format: uint32
1726 1727 1728 1729
          type: integer
          x-etsi-mec-cardinality: 0..1
          x-etsi-mec-origin-type: Uint32
        dot11GrantedRDGUsedCount:
Michel Roy's avatar
Michel Roy committed
1730
          format: uint32
1731 1732 1733 1734
          type: integer
          x-etsi-mec-cardinality: 0..1
          x-etsi-mec-origin-type: Uint32
        dot11GroupReceivedFrameCount:
Michel Roy's avatar
Michel Roy committed
1735
          format: uint32
1736 1737 1738 1739
          type: integer
          x-etsi-mec-cardinality: 0..1
          x-etsi-mec-origin-type: Uint32
        dot11GroupTransmittedFrameCount:
Michel Roy's avatar
Michel Roy committed
1740
          format: uint32
1741 1742 1743 1744
          type: integer
          x-etsi-mec-cardinality: 0..1
          x-etsi-mec-origin-type: Uint32
        dot11ImplicitBARFailureCount:
Michel Roy's avatar
Michel Roy committed
1745
          format: uint32
1746 1747 1748 1749
          type: integer
          x-etsi-mec-cardinality: 0..1
          x-etsi-mec-origin-type: Uint32
        dot11MPDUInReceivedAMPDUCount:
Michel Roy's avatar
Michel Roy committed
1750
          format: uint32
1751 1752 1753 1754
          type: integer
          x-etsi-mec-cardinality: 0..1
          x-etsi-mec-origin-type: Uint32
        dot11MultipleRetryAMSDUCount:
Michel Roy's avatar
Michel Roy committed
1755
          format: uint32
1756 1757 1758 1759
          type: integer
          x-etsi-mec-cardinality: 0..1
          x-etsi-mec-origin-type: Uint32
        dot11MultipleRetryCount:
Michel Roy's avatar
Michel Roy committed
1760
          format: uint32
1761 1762 1763 1764
          type: integer
          x-etsi-mec-cardinality: 0..1
          x-etsi-mec-origin-type: Uint32
        dot11PSMPUTTGrantDuration:
Michel Roy's avatar
Michel Roy committed
1765
          format: uint32
1766 1767 1768 1769
          type: integer
          x-etsi-mec-cardinality: 0..1
          x-etsi-mec-origin-type: Uint32
        dot11PSMPUTTUsedDuration:
Michel Roy's avatar
Michel Roy committed
1770
          format: uint32
1771 1772 1773 1774
          type: integer
          x-etsi-mec-cardinality: 0..1
          x-etsi-mec-origin-type: Uint32
        dot11QosAckFailureCount:
Michel Roy's avatar
Michel Roy committed
1775
          format: uint32
1776 1777 1778 1779
          type: integer
          x-etsi-mec-cardinality: 0..1
          x-etsi-mec-origin-type: Uint32
        dot11QosDiscardedFrameCount:
Michel Roy's avatar
Michel Roy committed
1780
          format: uint32
1781 1782 1783 1784
          type: integer
          x-etsi-mec-cardinality: 0..1
          x-etsi-mec-origin-type: Uint32
        dot11QosFailedCount:
Michel Roy's avatar
Michel Roy committed
1785
          format: uint32
1786 1787 1788 1789
          type: integer
          x-etsi-mec-cardinality: 0..1
          x-etsi-mec-origin-type: Uint32
        dot11QosFrameDuplicateCount:
Michel Roy's avatar
Michel Roy committed
1790
          format: uint32
1791 1792 1793 1794
          type: integer
          x-etsi-mec-cardinality: 0..1
          x-etsi-mec-origin-type: Uint32
        dot11QosMPDUsReceivedCount:
Michel Roy's avatar
Michel Roy committed
1795
          format: uint32
1796 1797 1798 1799
          type: integer
          x-etsi-mec-cardinality: 0..1
          x-etsi-mec-origin-type: Uint32
        dot11QosMultipleRetryCount:
Michel Roy's avatar
Michel Roy committed
1800
          format: uint32
1801 1802 1803 1804
          type: integer
          x-etsi-mec-cardinality: 0..1
          x-etsi-mec-origin-type: Uint32
        dot11QosRTSFailureCount:
Michel Roy's avatar
Michel Roy committed
1805
          format: uint32
1806 1807 1808 1809
          type: integer
          x-etsi-mec-cardinality: 0..1
          x-etsi-mec-origin-type: Uint32
        dot11QosRTSSuccessCount:
Michel Roy's avatar
Michel Roy committed
1810
          format: uint32
1811 1812 1813 1814
          type: integer
          x-etsi-mec-cardinality: 0..1
          x-etsi-mec-origin-type: Uint32
        dot11QosReceivedFragmentCount:
Michel Roy's avatar
Michel Roy committed
1815
          format: uint32
1816 1817 1818 1819
          type: integer
          x-etsi-mec-cardinality: 0..1
          x-etsi-mec-origin-type: Uint32
        dot11QosRetriesReceivedCount:
Michel Roy's avatar
Michel Roy committed
1820
          format: uint32
1821 1822 1823 1824
          type: integer
          x-etsi-mec-cardinality: 0..1
          x-etsi-mec-origin-type: Uint32
        dot11QosRetryCount:
Michel Roy's avatar
Michel Roy committed
1825
          format: uint32
1826 1827 1828 1829
          type: integer
          x-etsi-mec-cardinality: 0..1
          x-etsi-mec-origin-type: Uint32
        dot11QosTransmittedFragmentCount:
Michel Roy's avatar
Michel Roy committed
1830
          format: uint32
1831 1832 1833 1834
          type: integer
          x-etsi-mec-cardinality: 0..1
          x-etsi-mec-origin-type: Uint32
        dot11QosTransmittedFrameCount:
Michel Roy's avatar
Michel Roy committed
1835
          format: uint32
1836 1837 1838 1839
          type: integer
          x-etsi-mec-cardinality: 0..1
          x-etsi-mec-origin-type: Uint32
        dot11RSNAStatsBIPMICErrors:
Michel Roy's avatar
Michel Roy committed
1840
          format: uint32
1841 1842 1843 1844
          type: integer
          x-etsi-mec-cardinality: 0..1
          x-etsi-mec-origin-type: Uint32
        dot11RSNAStatsCCMPDecryptErrors:
Michel Roy's avatar
Michel Roy committed
1845
          format: uint32
1846 1847 1848 1849
          type: integer
          x-etsi-mec-cardinality: 0..1
          x-etsi-mec-origin-type: Uint32
        dot11RSNAStatsCCMPReplays:
Michel Roy's avatar
Michel Roy committed
1850
          format: uint32
1851 1852 1853 1854
          type: integer
          x-etsi-mec-cardinality: 0..1
          x-etsi-mec-origin-type: Uint32
        dot11RSNAStatsCMACReplays:
Michel Roy's avatar
Michel Roy committed
1855
          format: uint32
1856 1857 1858 1859
          type: integer
          x-etsi-mec-cardinality: 0..1
          x-etsi-mec-origin-type: Uint32
        dot11RSNAStatsRobustMgmtCCMPReplays:
Michel Roy's avatar
Michel Roy committed
1860
          format: uint32
1861 1862 1863 1864
          type: integer
          x-etsi-mec-cardinality: 0..1
          x-etsi-mec-origin-type: Uint32
        dot11RSNAStatsTKIPICVErrors:
Michel Roy's avatar
Michel Roy committed
1865
          format: uint32
1866 1867 1868 1869
          type: integer
          x-etsi-mec-cardinality: 0..1
          x-etsi-mec-origin-type: Uint32
        dot11RSNAStatsTKIPReplays:
Michel Roy's avatar
Michel Roy committed
1870
          format: uint32
1871 1872 1873 1874
          type: integer
          x-etsi-mec-cardinality: 0..1
          x-etsi-mec-origin-type: Uint32
        dot11RTSFailureCount:
Michel Roy's avatar
Michel Roy committed
1875
          format: uint32
1876 1877 1878 1879
          type: integer
          x-etsi-mec-cardinality: 0..1
          x-etsi-mec-origin-type: Uint32
        dot11RTSLSIGFailureCount:
Michel Roy's avatar
Michel Roy committed
1880
          format: uint32
1881 1882 1883 1884
          type: integer
          x-etsi-mec-cardinality: 0..1
          x-etsi-mec-origin-type: Uint32
        dot11RTSLSIGSuccessCount:
Michel Roy's avatar
Michel Roy committed
1885
          format: uint32
1886 1887 1888 1889
          type: integer
          x-etsi-mec-cardinality: 0..1
          x-etsi-mec-origin-type: Uint32
        dot11RTSSuccessCount:
Michel Roy's avatar
Michel Roy committed
1890
          format: uint32
1891 1892 1893 1894
          type: integer
          x-etsi-mec-cardinality: 0..1
          x-etsi-mec-origin-type: Uint32
        dot11ReceivedAMSDUCount:
Michel Roy's avatar
Michel Roy committed
1895
          format: uint32
1896 1897 1898 1899
          type: integer
          x-etsi-mec-cardinality: 0..1
          x-etsi-mec-origin-type: Uint32
        dot11ReceivedFragmentCount:
Michel Roy's avatar
Michel Roy committed
1900
          format: uint32
1901 1902 1903 1904 1905 1906 1907 1908 1909 1910 1911 1912 1913 1914
          type: integer
          x-etsi-mec-cardinality: 0..1
          x-etsi-mec-origin-type: Uint32
        dot11ReceivedOctetsInAMPDUCount:
          format: int64
          type: integer
          x-etsi-mec-cardinality: 0..1
          x-etsi-mec-origin-type: Uint64
        dot11ReceivedOctetsInAMSDUCount:
          format: int64
          type: integer
          x-etsi-mec-cardinality: 0..1
          x-etsi-mec-origin-type: Uint64
        dot11RetryAMSDUCount:
Michel Roy's avatar
Michel Roy committed
1915
          format: uint32
1916 1917 1918 1919
          type: integer
          x-etsi-mec-cardinality: 0..1
          x-etsi-mec-origin-type: Uint32
        dot11RetryCount:
Michel Roy's avatar
Michel Roy committed
1920
          format: uint32
1921 1922 1923 1924
          type: integer
          x-etsi-mec-cardinality: 0..1
          x-etsi-mec-origin-type: Uint32
        dot11STAStatisticsAPAverageAccessDelay:
Michel Roy's avatar
Michel Roy committed
1925
          format: uint8
1926 1927 1928 1929
          type: integer
          x-etsi-mec-cardinality: 0..1
          x-etsi-mec-origin-type: Uint8
        dot11STAStatisticsAverageAccessDelayBackGround:
Michel Roy's avatar
Michel Roy committed
1930
          format: uint8
1931 1932 1933 1934
          type: integer
          x-etsi-mec-cardinality: 0..1
          x-etsi-mec-origin-type: Uint8
        dot11STAStatisticsAverageAccessDelayBestEffort:
Michel Roy's avatar
Michel Roy committed
1935
          format: uint8
1936 1937 1938 1939
          type: integer
          x-etsi-mec-cardinality: 0..1
          x-etsi-mec-origin-type: Uint8
        dot11STAStatisticsAverageAccessDelayVideo:
Michel Roy's avatar
Michel Roy committed
1940
          format: uint8
1941 1942 1943 1944
          type: integer
          x-etsi-mec-cardinality: 0..1
          x-etsi-mec-origin-type: Uint8
        dot11STAStatisticsAverageAccessDelayVoice:
Michel Roy's avatar
Michel Roy committed
1945
          format: uint8
1946 1947 1948 1949
          type: integer
          x-etsi-mec-cardinality: 0..1
          x-etsi-mec-origin-type: Uint8
        dot11STAStatisticsChannelUtilization:
Michel Roy's avatar
Michel Roy committed
1950
          format: uint8
1951 1952 1953 1954
          type: integer
          x-etsi-mec-cardinality: 0..1
          x-etsi-mec-origin-type: Uint8
        dot11STAStatisticsStationCount:
Michel Roy's avatar
Michel Roy committed
1955
          format: uint8
1956 1957 1958 1959
          type: integer
          x-etsi-mec-cardinality: 0..1
          x-etsi-mec-origin-type: Uint8
        dot11STBCCTSFailureCount:
Michel Roy's avatar
Michel Roy committed
1960
          format: uint32
1961 1962 1963 1964
          type: integer
          x-etsi-mec-cardinality: 0..1
          x-etsi-mec-origin-type: Uint32
        dot11STBCCTSSuccessCount:
Michel Roy's avatar
Michel Roy committed
1965
          format: uint32
1966 1967 1968 1969
          type: integer
          x-etsi-mec-cardinality: 0..1
          x-etsi-mec-origin-type: Uint32
        dot11TransmittedAMPDUCount:
Michel Roy's avatar
Michel Roy committed
1970
          format: uint32
1971 1972 1973 1974
          type: integer
          x-etsi-mec-cardinality: 0..1
          x-etsi-mec-origin-type: Uint32
        dot11TransmittedAMSDUCount:
Michel Roy's avatar
Michel Roy committed
1975
          format: uint32
1976 1977 1978 1979
          type: integer
          x-etsi-mec-cardinality: 0..1
          x-etsi-mec-origin-type: Uint32
        dot11TransmittedFragmentCount:
Michel Roy's avatar
Michel Roy committed
1980
          format: uint32
1981 1982 1983 1984
          type: integer
          x-etsi-mec-cardinality: 0..1
          x-etsi-mec-origin-type: Uint32
        dot11TransmittedFrameCount:
Michel Roy's avatar
Michel Roy committed
1985
          format: uint32
1986 1987 1988 1989
          type: integer
          x-etsi-mec-cardinality: 0..1
          x-etsi-mec-origin-type: Uint32
        dot11TransmittedFramesInGrantedRDGCount:
Michel Roy's avatar
Michel Roy committed
1990
          format: uint32
1991 1992 1993 1994
          type: integer
          x-etsi-mec-cardinality: 0..1
          x-etsi-mec-origin-type: Uint32
        dot11TransmittedMPDUsInAMPDUCount:
Michel Roy's avatar
Michel Roy committed
1995
          format: uint32
1996 1997 1998 1999 2000 2001 2002 2003 2004
          type: integer
          x-etsi-mec-cardinality: 0..1
          x-etsi-mec-origin-type: Uint32
        dot11TransmittedOctetsInAMPDUCount:
          format: int64
          type: integer
          x-etsi-mec-cardinality: 0..1
          x-etsi-mec-origin-type: Uint64
        dot11TransmittedOctetsInAMSDUCount:
Michel Roy's avatar
Michel Roy committed
2005
          format: uint32
2006 2007 2008 2009
          type: integer
          x-etsi-mec-cardinality: 0..1
          x-etsi-mec-origin-type: Uint32
        dot11TransmittedOctetsInGrantedRDGCount:
Michel Roy's avatar
Michel Roy committed
2010
          format: uint32
2011 2012 2013 2014
          type: integer
          x-etsi-mec-cardinality: 0..1
          x-etsi-mec-origin-type: Uint32
        dot11TwentyMHzFrameReceivedCount:
Michel Roy's avatar
Michel Roy committed
2015
          format: uint32
2016 2017 2018 2019
          type: integer
          x-etsi-mec-cardinality: 0..1
          x-etsi-mec-origin-type: Uint32
        dot11TwentyMHzFrameTransmittedCount:
Michel Roy's avatar
Michel Roy committed
2020
          format: uint32
2021 2022 2023 2024
          type: integer
          x-etsi-mec-cardinality: 0..1
          x-etsi-mec-origin-type: Uint32
        dot11nonSTBCCTSFailureCount:
Michel Roy's avatar
Michel Roy committed
2025
          format: uint32
2026 2027 2028 2029
          type: integer
          x-etsi-mec-cardinality: 0..1
          x-etsi-mec-origin-type: Uint32
        dot11nonSTBCCTSSuccessCount:
Michel Roy's avatar
Michel Roy committed
2030
          format: uint32
2031 2032 2033 2034 2035 2036 2037 2038 2039 2040 2041 2042 2043 2044 2045 2046 2047 2048 2049 2050 2051 2052 2053 2054 2055 2056 2057 2058 2059 2060 2061 2062 2063
          type: integer
          x-etsi-mec-cardinality: 0..1
          x-etsi-mec-origin-type: Uint32
      type: object
    SubscriptionLinkList:
      properties:
        _links:
          description: Hyperlink related to the resource. This shall be only included in the HTTP responses and in HTTP PUT requests.
          properties:
            self:
              $ref: '#/components/schemas/LinkType'
          type: object
          x-etsi-mec-cardinality: 0..1
          x-etsi-mec-origin-type: Structure (inlined)
        assocStaSubscription:
          items:
            $ref: '#/components/schemas/AssocStaSubscription'
          type: array
          x-etsi-mec-cardinality: 0..N
          x-etsi-mec-origin-type: AssocStaSubscription
        staDataRateSubscription:
          items:
            $ref: '#/components/schemas/StaDataRateSubscription'
          type: array
          x-etsi-mec-cardinality: 0..N
          x-etsi-mec-origin-type: StaDataRateSubscription
      required:
      - _links
      type: object
    TimeStamp:
      properties:
        nanoSeconds:
          description: The nanoseconds part of the time. Time is defined as Unix-time since January 1, 1970, 00:00:00 UTC.
Michel Roy's avatar
Michel Roy committed
2064
          format: uint32
2065 2066 2067 2068 2069
          type: integer
          x-etsi-mec-cardinality: '1'
          x-etsi-mec-origin-type: Uint32
        seconds:
          description: The seconds part of the time. Time is defined as Unixtime since January 1, 1970, 00:00:00 UTC.
Michel Roy's avatar
Michel Roy committed
2070
          format: uint32
2071 2072 2073 2074 2075 2076 2077 2078 2079 2080 2081 2082
          type: integer
          x-etsi-mec-cardinality: '1'
          x-etsi-mec-origin-type: Uint32
      required:
      - seconds
      - nanoSeconds
      type: object
      x-etsi-ref: 6.5.2
    VhtCapabilities:
      properties:
        vhtCapInfo:
          description: VHT capabilities Info as defined in IEEE 802.11-2016 [8].
Michel Roy's avatar
Michel Roy committed
2083
          format: uint32
2084 2085 2086 2087 2088 2089 2090 2091 2092 2093 2094 2095 2096 2097 2098 2099 2100 2101
          type: integer
          x-etsi-mec-cardinality: '1'
          x-etsi-mec-origin-type: UInt32
        vhtMcsNss:
          description: Supported VHT-MCS and NSS Set as defined in IEEE 802.11-2016 [8].
          format: int64
          type: integer
          x-etsi-mec-cardinality: '1'
          x-etsi-mec-origin-type: UInt64
      required:
      - vhtCapInfo
      - vhtMcsNss
      type: object
      x-etsi-ref: 6.5.15
    WanMetrics:
      properties:
        downlinkLoad:
          description: 1-octet positive integer representing the current percentage loading of the downlink WAN connection, scaled linearly with 255 representing 100 %, as measured over an interval the duration of which is reported in Load Measurement Duration. In cases where the downlink load is unknown to the AP, the value is set to zero.
Michel Roy's avatar
Michel Roy committed
2102
          format: uint8
2103 2104 2105 2106 2107
          type: integer
          x-etsi-mec-cardinality: '1'
          x-etsi-mec-origin-type: UInt8
        downlinkSpeed:
          description: 4-octet positive integer whose value is an estimate of the WAN Backhaul link current downlink speed in kilobits per second.
Michel Roy's avatar
Michel Roy committed
2108
          format: uint32
2109 2110 2111 2112 2113
          type: integer
          x-etsi-mec-cardinality: '1'
          x-etsi-mec-origin-type: Uint32
        lmd:
          description: The LMD (Load Measurement Duration) field is a 2-octet positive integer representing the duration over which the Downlink Load and Uplink Load have been measured, in tenths of a second. When the actual load measurement duration is greater than the maximum value, the maximum value will be reported. The value of the LMD field is set to 0 when neither the uplink nor downlink load can be computed. When the uplink and downlink loads are computed over different intervals, the maximum interval is reported.
Michel Roy's avatar
Michel Roy committed
2114
          format: uint16
2115 2116 2117 2118 2119
          type: integer
          x-etsi-mec-cardinality: '1'
          x-etsi-mec-origin-type: Uint16
        uplinkLoad:
          description: 1-octet positive integer representing the current percentage loading of the uplink WAN connection, scaled linearly with 255 representing 100 %, as measured over an interval, the duration of which is reported in Load Measurement Duration. In cases where the uplink load is unknown to the AP, the value is set to zero.
Michel Roy's avatar
Michel Roy committed
2120
          format: uint8
2121 2122 2123 2124 2125
          type: integer
          x-etsi-mec-cardinality: '1'
          x-etsi-mec-origin-type: Uint8
        uplinkSpeed:
          description: 4-octet positive integer whose value is an estimate of the WAN Backhaul link's current uplink speed in kilobits per second.
Michel Roy's avatar
Michel Roy committed
2126
          format: uint32
2127 2128 2129 2130 2131
          type: integer
          x-etsi-mec-cardinality: '1'
          x-etsi-mec-origin-type: UInt32
        wanInfo:
          description: Info about WAN link status, link symmetricity and capacity currently used.
Michel Roy's avatar
Michel Roy committed
2132
          format: uint8
2133 2134 2135 2136 2137 2138 2139 2140 2141 2142 2143 2144 2145 2146 2147 2148 2149 2150 2151 2152 2153 2154 2155 2156 2157 2158 2159 2160 2161 2162 2163 2164 2165 2166 2167 2168 2169 2170 2171 2172 2173
          type: integer
          x-etsi-mec-cardinality: '1'
          x-etsi-mec-origin-type: Uint8
      required:
      - wanInfo
      - downlinkSpeed
      - uplinkSpeed
      - downlinkLoad
      - uplinkLoad
      - lmd
      type: object
      x-etsi-ref: 6.5.6
    WlanCapabilities:
      properties:
        dmg:
          # description': Information about Access Point DMG capabilities as defined in IEEE 802.11-2016 [8].
          # x-etsi-mec-cardinality': 0..1
          # x-etsi-mec-origin-type': DmgCapabilities
          $ref: '#/components/schemas/DmgCapabilities'
        edmg:
          # description': Information about Access Point EDMG capabilities as defined in draft IEEE P802.11/D4.0 [i.11].
          # x-etsi-mec-cardinality': 0..1
          # x-etsi-mec-origin-type': EdmgCapabilities
          $ref: '#/components/schemas/EdmgCapabilities'
        he:
          # description': Information about Access Point HE capabilities as defined in FFS.
          # x-etsi-mec-cardinality': 0..1
          # x-etsi-mec-origin-type': HeCapabilities
          $ref: '#/components/schemas/HeCapabilities'
        ht:
          # description': Information about Access Point HT capabilities as defined in IEEE 802.11-2016 [8].
          # x-etsi-mec-cardinality': 0..1
          # x-etsi-mec-origin-type': HtCapabilities
          $ref: '#/components/schemas/HtCapabilities'
        vht:
          # description': Information about Access Point VHT capabilities as defined in IEEE 802.11-2016 [8].
          # x-etsi-mec-cardinality': 0..1
          # x-etsi-mec-origin-type': VhtCapabilities
          $ref: '#/components/schemas/VhtCapabilities'
      type: object
      x-etsi-ref: 6.5.4