WlanInformationApi.yaml 112 KB
Newer Older
Michel Roy's avatar
Michel Roy committed
            Probe Response frame being reported was received.
          format: uint32
          type: integer
          x-etsi-mec-cardinality: 0..1
          x-etsi-mec-origin-type: Uint32
        rcpi:
          description: "RCPI indicates the received channel power of the Beacon, Measurement Pilot, or Probe Response frame, which is a logarithmic function of the received signal power, as defined in section\_9.4.2.38 of IEEE 802.11-2016 [8]."
          format: uint8
          type: integer
          x-etsi-mec-cardinality: 0..1
          x-etsi-mec-origin-type: Uint8
        reportedFrameInfo:
          $ref: '#/components/schemas/ReportedBeaconFrameInfo'
        rsni:
          description: "RSNI indicates the received signal-to-noise indication for the Beacon, Measurement Pilot, or Probe Response frame, as described in section\_9.4.2.41 of IEEE 802.11-2016 [8]."
          format: uint8
          type: integer
          x-etsi-mec-cardinality: 0..1
          x-etsi-mec-origin-type: Uint8
        ssid:
          description: >-
            The SSID subelement indicates the ESS or IBSS for which a beacon
            report is received.
          type: string
          x-etsi-mec-cardinality: 0..1
          x-etsi-mec-origin-type: String
        staId:
          $ref: '#/components/schemas/StaIdentity'
      required:
Michel Roy's avatar
Michel Roy committed
        - measurementId
        - operatingClass
        - channel
        - reportedFrameInfo
        - bssid
      type: object
      x-etsi-ref: 6.5.27
Michel Roy's avatar
Michel Roy committed
    BeaconReportingConfig:
      properties:
        reportingCondition:
          description: >-
            Reporting condition for the Beacon Report as per Table 9-89 of IEEE
            802.11-2016 [8]:

            0 = Report to be issued after each measurement.

            1 = measured RCPI level is greater than the threshold.

            2 = measured RCPI level is less than the threshold.

            3 = measured RSNI level is greater than the threshold.

            4 = measured RSNI level is less than the threshold.

            5 = measured RCPI level is greater than a threshold defined by an
            offset from the serving AP's reference RCPI.

            6 = measured RCPI level is less than a threshold defined by an
            offset from the serving AP's reference RCPI.

            7 = measured RSNI level is greater than a threshold defined by an
            offset from the serving AP's reference RSNI.

            8 = measured RSNI level is less than a threshold defined by an
            offset from the serving AP's reference RSNI.

            9 = measured RCPI level is in a range bound by the serving AP's
            reference RCPI and an offset from the serving AP's reference RCPI.

            10 = measured RSNI level is in a range bound by the serving AP's
            reference RSNI and an offset from the serving AP's reference RSNI.
          format: uint8
          type: integer
          x-etsi-mec-cardinality: '1'
          x-etsi-mec-origin-type: Uint8
        threshold:
          description: "The threshold subfield contains either the threshold value or the offset value to be used for conditional reporting.\n\nFor reportingCondition subfield with values 1 and 2, the threshold value is a logarithmic function of the received signal power, as defined in section\_9.4.2.38 of IEEE 802.11-2016 [8].\n\nFor reportingCondition subfield values 3 and 4, the threshold value is a logarithmic function of the signal-to-noise ratio, as described in section\_9.4.2.41 of IEEE 802.11-2016 [8].\n\nFor reportingCondition subfield values 5 to 10, the offset value is an 8-bit 2s complement integer in units of 0,5 dBm. The indicated reporting condition applies individually to each measured Beacon, Measurement Pilot, or Probe Response frame."
          format: uint8
          type: integer
          x-etsi-mec-cardinality: '1'
          x-etsi-mec-origin-type: Uint8
      required:
        - reportingCondition
        - threshold
      type: object
      x-etsi-ref: 6.5.28
    BeaconRequestConfig:
      properties:
Michel Roy's avatar
Michel Roy committed
        beaconReportingConf:
          $ref: '#/components/schemas/BeaconReportingConfig'
        bssid:
          description: >-
            The BSSID field indicates the BSS for which a beacon report is
            requested. If absent, the requested beacon reports should include
            all BSSs on the channel.
          type: string
          x-etsi-mec-cardinality: 0..1
          x-etsi-mec-origin-type: String
        channelId:
Michel Roy's avatar
Michel Roy committed
          description: "Channel number to scan. A Channel Number of 0 indicates a request to make iterative measurements for all supported channels in the Operating Class where the measurement is permitted on the channel and the channel is valid for the current regulatory domain. A\_Channel Number of 255 indicates a request to make iterative measurements for all supported channels in the current Operating Class listed in the latest AP Channel Report received from the serving AP."
          format: uint8
          type: integer
          x-etsi-mec-cardinality: '1'
Michel Roy's avatar
Michel Roy committed
          x-etsi-mec-origin-type: Uint8
        measurementMode:
Michel Roy's avatar
Michel Roy committed
          description: |-
            0 for passive.
            1 for active.
Michel Roy's avatar
Michel Roy committed
            2 for beacon table.
          format: uint8
          type: integer
          x-etsi-mec-cardinality: '1'
Michel Roy's avatar
Michel Roy committed
          x-etsi-mec-origin-type: Uint8
        operatingClass:
          description: "Operating Class field indicates an operating class value as defined in Annex E within IEEE\_802.112016\_[8]."
          format: uint8
          type: integer
          x-etsi-mec-cardinality: '1'
Michel Roy's avatar
Michel Roy committed
          x-etsi-mec-origin-type: Uint8
        ssid:
          description: >-
            The SSID subelement indicates the ESS or IBSS for which a beacon
            report is requested.
          type: string
          x-etsi-mec-cardinality: 0..1
          x-etsi-mec-origin-type: String
      required:
Michel Roy's avatar
Michel Roy committed
        - operatingClass
        - channelId
        - measurementMode
        - beaconReportingConf
      type: object
      x-etsi-ref: 6.5.25
Michel Roy's avatar
Michel Roy committed
    BssCapabilities:
      properties:
        apsd:
          description: APSD Option implemented
          type: boolean
          x-etsi-mec-cardinality: '1'
          x-etsi-mec-origin-type: Boolean
        delayedBACK:
          description: Delayed Block Ack Option implemented
          type: boolean
          x-etsi-mec-cardinality: '1'
          x-etsi-mec-origin-type: Boolean
        immediateBACK:
          description: Immediate Block Ack Option implemented
          type: boolean
          x-etsi-mec-cardinality: '1'
          x-etsi-mec-origin-type: Boolean
        qos:
          description: QoS Option implemented
          type: boolean
          x-etsi-mec-cardinality: '1'
          x-etsi-mec-origin-type: Boolean
        radioMeasurements:
          description: Radio Measurement Activated
          type: boolean
          x-etsi-mec-cardinality: '1'
          x-etsi-mec-origin-type: Boolean
        spectrumManagement:
          description: Spectrum Management required
          type: boolean
          x-etsi-mec-cardinality: '1'
          x-etsi-mec-origin-type: Boolean
      required:
        - spectrumManagement
        - qos
        - apsd
        - radioMeasurements
        - delayedBACK
        - immediateBACK
      type: object
      x-etsi-ref: 6.5.31
    BssLoad:
      properties:
        availAdmCap:
Michel Roy's avatar
Michel Roy committed
          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
          format: uint16
          type: integer
          x-etsi-mec-cardinality: '1'
          x-etsi-mec-origin-type: Uint16
        channelUtilization:
          description: "The percentage of time, linearly scaled with 255 representing 100\_%, that the AP sensed the medium was busy, as indicated by either the physical or virtual Carrier Sense (CS) mechanism."
Michel Roy's avatar
Michel Roy committed
          format: uint8
          type: integer
          x-etsi-mec-cardinality: '1'
          x-etsi-mec-origin-type: UInt8
        staCount:
Michel Roy's avatar
Michel Roy committed
          description: >-
            An unsigned integer that indicates the total number of STAs
            currently associated with this BSS.
Michel Roy's avatar
Michel Roy committed
          format: uint16
          type: integer
          x-etsi-mec-cardinality: '1'
          x-etsi-mec-origin-type: UInt16
      required:
Michel Roy's avatar
Michel Roy committed
        - staCount
        - channelUtilization
        - availAdmCap
      type: object
      x-etsi-ref: 6.5.7
Michel Roy's avatar
Michel Roy committed
    BssidInfo:
      properties:
Michel Roy's avatar
Michel Roy committed
        apReachability:
          description: >-
            The apReachability field indicates whether the AP identified by this
            BSSID is reachable by the STA that requested the neighbor report.
            Valid values:

            0 = reserved

            1 = not reachable

            2 = unknown

            3 = reachable.
          format: uint8
          type: integer
          x-etsi-mec-cardinality: '1'
Michel Roy's avatar
Michel Roy committed
          x-etsi-mec-origin-type: Uint8
        capabilities:
          $ref: '#/components/schemas/BssCapabilities'
        ftm:
          description: >-
            True indicates the AP represented by this BSSID is an AP that has
            set the Fine Timing Measurement Responder field of the Extended
            Capabilities element to 1.


            False indicates either that the reporting AP has
            dot11FineTimingMsmtRespActivated equal to false, or the reported AP
            has not set the Fine Timing Measurement Responder field of the
            Extended Capabilities element to 1 or that the Fine Timing
            Measurement Responder field of the reported AP is not available to
            the reporting AP at this time.
          type: boolean
          x-etsi-mec-cardinality: '1'
          x-etsi-mec-origin-type: Boolean
        highThroughput:
          description: >-
            True indicates that the AP represented by this BSSID is an HT AP
            including the HT Capabilities element in its Beacons, and that the
            contents of that HT Capabilities element are identical to the HT
            Capabilities element advertised by the AP sending the report.
          type: boolean
          x-etsi-mec-cardinality: '1'
          x-etsi-mec-origin-type: Boolean
        mobilityDomain:
          description: >-
            True indicates the AP represented by this BSSID is including an MDE
            in its Beacon frames and that the contents of that MDE are identical
            to the MDE advertised by the AP sending the report.
          type: boolean
          x-etsi-mec-cardinality: '1'
          x-etsi-mec-origin-type: Boolean
        security:
          description: >-
            True indicates the AP identified by this BSSID supports the same
            security provisioning as used by the STA in its current association.


            False indicates either that the AP does not support the same
            security provisioning or that the security information is not
            available at this time.
          type: boolean
          x-etsi-mec-cardinality: '1'
          x-etsi-mec-origin-type: Boolean
        veryHighThroughput:
          description: >-
            True indicates that the AP represented by this BSSID is a VHT AP and
            that the VHT Capabilities element, if included as a subelement in
            the report, is identical in content to the VHT Capabilities element
            included in the AP's Beacon.
          type: boolean
          x-etsi-mec-cardinality: '1'
          x-etsi-mec-origin-type: Boolean
      required:
        - apReachability
        - security
        - capabilities
        - mobilityDomain
        - highThroughput
        - veryHighThroughput
        - ftm
      type: object
      x-etsi-ref: 6.5.30
    ChannelLoad:
      properties:
        channel:
          description: >-
            Channel number indicates the channel number for which the
            measurement report applies.
          format: uint8
          type: integer
          x-etsi-mec-cardinality: '1'
          x-etsi-mec-origin-type: Uint8
        channelLoad:
Michel Roy's avatar
Michel Roy committed
          description: "Proportion of measurement duration for which the measuring STA determined the channel to be busy, as a percentage of time, linearly scaled with 255 representing 100\_%."
          format: uint8
          type: integer
          x-etsi-mec-cardinality: '1'
          x-etsi-mec-origin-type: Uint8
        measurementDuration:
          description: >-
            Duration over which the Channel Load report was measured, in units
            of TUs of 1 024 µs.
          format: uint8
          type: integer
          x-etsi-mec-cardinality: '1'
          x-etsi-mec-origin-type: Uint8
        measurementId:
          description: >-
            Measurement ID of the Measurement configuration applied to this
            Channel Load Report.
          type: string
          x-etsi-mec-cardinality: '1'
          x-etsi-mec-origin-type: String
        operatingClass:
          description: >-
            Operating Class field indicates an operating class value as defined
            in Annex E within IEEE 802.11-2016 [8].
          format: uint8
          type: integer
          x-etsi-mec-cardinality: '1'
          x-etsi-mec-origin-type: Uint8
        staId:
          $ref: '#/components/schemas/StaIdentity'
      required:
        - measurementId
        - operatingClass
        - channel
        - measurementDuration
        - channelLoad
      type: object
      x-etsi-ref: 6.5.39
    ChannelLoadConfig:
      properties:
        channel:
          description: Channel for which the channel load report is requested.
          type: integer
          x-etsi-mec-cardinality: '1'
          x-etsi-mec-origin-type: Integer
Michel Roy's avatar
Michel Roy committed
        operatingClass:
          description: >-
            Operating Class field indicates an operating class value as defined
            in Annex E within IEEE 802.11-2016 [8].
          format: uint8
          type: integer
          x-etsi-mec-cardinality: '1'
          x-etsi-mec-origin-type: Uint8
        reportingCondition:
          description: >-
            Reporting condition for the Beacon Report as per Table 9-153 of IEEE
            802.11-2016 [8]:

            0 = Report to be issued after each measurement.

            1 = Report to be issued when Channel Load is greater than or equal
            to the threshold.

            2 = Report to be issued when Channel Load is less than or equal to
            the threshold.


            If this optional field is not provided, channel load report should
            be issued after each measurement (reportingCondition = 0).
          format: uint8
          type: integer
          x-etsi-mec-cardinality: 0..1
          x-etsi-mec-origin-type: Uint8
        threshold:
          description: >-
            Channel Load reference value for threshold reporting. This field
            shall be provided for reportingCondition values 1 and 2.
          format: uint8
          type: integer
          x-etsi-mec-cardinality: 0..1
          x-etsi-mec-origin-type: Uint8
      required:
Michel Roy's avatar
Michel Roy committed
        - operatingClass
        - channel
      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:
Michel Roy's avatar
Michel Roy committed
          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:
Michel Roy's avatar
Michel Roy committed
          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:
Michel Roy's avatar
Michel Roy committed
          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:
Michel Roy's avatar
Michel Roy committed
          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:
Michel Roy's avatar
Michel Roy committed
          description: 'City division, borough, city district, ward, chou (JP)'
          type: string
          x-etsi-mec-cardinality: 0..1
          x-etsi-mec-origin-type: String
        ca5:
Michel Roy's avatar
Michel Roy committed
          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:
Michel Roy's avatar
Michel Roy committed
          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:
Michel Roy's avatar
Michel Roy committed
        - country
      type: object
      x-etsi-ref: 6.5.20
    DmgCapabilities:
      properties:
        ExtScMcsCap:
Michel Roy's avatar
Michel Roy committed
          description: "Extended SC MCS capabilities as defined in IEEE\_802.11-2016 [8]."
Michel Roy's avatar
Michel Roy committed
          format: uint8
          type: integer
          x-etsi-mec-cardinality: '1'
          x-etsi-mec-origin-type: Uint8
        dmgApOrPcpCapInfo:
Michel Roy's avatar
Michel Roy committed
          description: >-
            DMG AP or PCP capabilities information as defined in IEEE
            802.11-2016 [8].
Michel Roy's avatar
Michel Roy committed
          format: uint16
          type: integer
          x-etsi-mec-cardinality: '1'
          x-etsi-mec-origin-type: Uint16
        dmgStaBeamTrackTimeLimit:
Michel Roy's avatar
Michel Roy committed
          description: "DMG station beam tracking time limit as defined in IEEE\_802.11-2016 [8]. "
Michel Roy's avatar
Michel Roy committed
          format: uint16
          type: integer
          x-etsi-mec-cardinality: '1'
          x-etsi-mec-origin-type: Uint16
        dmgStaCapInfo:
Michel Roy's avatar
Michel Roy committed
          description: "DMG station capabilities information as defined in IEEE\_802.11-2016 [8]. "
          format: uint64
          type: integer
          x-etsi-mec-cardinality: '1'
          x-etsi-mec-origin-type: Uint64
        maxNrBasicAmsduSubframes:
Michel Roy's avatar
Michel Roy committed
          description: >-
            Number of basic A-MSDU subframes in A-MSDU as defined in IEEE
            802.11-2016 [8].
Michel Roy's avatar
Michel Roy committed
          format: uint8
          type: integer
          x-etsi-mec-cardinality: '1'
          x-etsi-mec-origin-type: Uint8
        maxNrShortAmsduSubframes:
Michel Roy's avatar
Michel Roy committed
          description: >-
            Number of short A-MSDU subframes in A-MSDU as defined in IEEE
            802.11-2016 [8].
Michel Roy's avatar
Michel Roy committed
          format: uint8
          type: integer
          x-etsi-mec-cardinality: '1'
          x-etsi-mec-origin-type: Uint8
      required:
Michel Roy's avatar
Michel Roy committed
        - dmgStaCapInfo
        - dmgApOrPcpCapInfo
        - dmgStaBeamTrackTimeLimit
        - ExtScMcsCap
        - maxNrBasicAmsduSubframes
        - maxNrShortAmsduSubframes
      type: object
      x-etsi-ref: 6.5.17
    EdmgCapabilities:
      properties:
        ampduParameters:
Michel Roy's avatar
Michel Roy committed
          description: 'A-MPDU parameters as defined in draft IEEE P802.11ay [i.11]'
Michel Roy's avatar
Michel Roy committed
          format: uint8
          type: integer
          x-etsi-mec-cardinality: '1'
          x-etsi-mec-origin-type: Uint8
        supportedMcs:
Michel Roy's avatar
Michel Roy committed
          description: 'Supported MCS as defined in draft IEEE P802.11ay [i.11]'
Michel Roy's avatar
Michel Roy committed
          format: uint32
          type: integer
          x-etsi-mec-cardinality: '1'
          x-etsi-mec-origin-type: Uint32
        trnParameters:
Michel Roy's avatar
Michel Roy committed
          description: 'Training parameters as defined in draft IEEE P802.11ay [i.11]'
Michel Roy's avatar
Michel Roy committed
          format: uint16
          type: integer
          x-etsi-mec-cardinality: '1'
          x-etsi-mec-origin-type: Uint16
      required:
Michel Roy's avatar
Michel Roy committed
        - ampduParameters
        - trnParameters
        - supportedMcs
      type: object
      x-etsi-ref: 6.5.18
Michel Roy's avatar
Michel Roy committed
    ExpiryNotification:
      properties:
        _links:
          description: Hyperlink related to the resource.
          properties:
            subscription:
              $ref: '#/components/schemas/LinkType'
          required:
            - subscription
          type: object
          x-etsi-mec-cardinality: '1'
          x-etsi-mec-origin-type: Structure (inlined)
        expiryDeadline:
          $ref: '#/components/schemas/TimeStamp'
        notificationType:
          description: Shall be set to "ExpiryNotification".
          type: string
          x-etsi-mec-cardinality: '1'
          x-etsi-mec-origin-type: String
      required:
        - notificationType
        - _links
        - expiryDeadline
      type: object
      x-etsi-ref: 6.4.4
    ExtBssLoad:
      properties:
        muMimoStaCount:
Michel Roy's avatar
Michel Roy committed
          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
          format: uint16
          type: integer
          x-etsi-mec-cardinality: '1'
          x-etsi-mec-origin-type: UInt16
        obsSec20MhzUtil:
          description: Observable loading on each of the secondary 20 MHz channel.
Michel Roy's avatar
Michel Roy committed
          format: uint8
          type: integer
          x-etsi-mec-cardinality: '1'
          x-etsi-mec-origin-type: Uint8
        obsSec40MhzUtil:
          description: Observable loading on each of the secondary 40 MHz channel.
Michel Roy's avatar
Michel Roy committed
          format: uint8
          type: integer
          x-etsi-mec-cardinality: '1'
          x-etsi-mec-origin-type: Uint8
        obsSec80MhzUtil:
          description: Observable loading on each of the secondary 80 MHz channel.
Michel Roy's avatar
Michel Roy committed
          format: uint8
          type: integer
          x-etsi-mec-cardinality: '1'
          x-etsi-mec-origin-type: Uint8
        spatStreamUnderUtil:
          description: "The percentage of time, linearly scaled with 255 representing 100\_%, that the AP has underutilized spatial domain resources for given busy time of the medium."
Michel Roy's avatar
Michel Roy committed
          format: uint8
          type: integer
          x-etsi-mec-cardinality: '1'
          x-etsi-mec-origin-type: UInt8
      required:
Michel Roy's avatar
Michel Roy committed
        - 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
          format: uint32
          type: integer
          x-etsi-mec-cardinality: 0..1
          x-etsi-mec-origin-type: Uint32
        altitudeType:
Michel Roy's avatar
Michel Roy committed
          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
          format: uint8
          type: integer
          x-etsi-mec-cardinality: 0..1
          x-etsi-mec-origin-type: Uint8
        altitudeUncertainty:
Michel Roy's avatar
Michel Roy committed
          description: >-
            The uncertainty for altitude information as defined in IETF RFC 6225
            [6]
Michel Roy's avatar
Michel Roy committed
          format: uint8
          type: integer
          x-etsi-mec-cardinality: 0..1
          x-etsi-mec-origin-type: Uint8
        datum:
Michel Roy's avatar
Michel Roy committed
          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
          format: uint8
          type: integer
          x-etsi-mec-cardinality: '1'
          x-etsi-mec-origin-type: Uint8
        lat:
          description: "The latitude value of location as defined in IETF RFC\_6225 [6]"
Michel Roy's avatar
Michel Roy committed
          format: uint64
          type: integer
          x-etsi-mec-cardinality: '1'
          x-etsi-mec-origin-type: Uint64
        latUncertainty:
Michel Roy's avatar
Michel Roy committed
          description: >-
            The uncertainty for Latitude information as defined in IETF RFC 6225
            [6]
Michel Roy's avatar
Michel Roy committed
          format: uint8
          type: integer
          x-etsi-mec-cardinality: '1'
          x-etsi-mec-origin-type: Uint8
        long:
          description: "The longitude value of location as defined in IETF RFC\_6225 [6]"
Michel Roy's avatar
Michel Roy committed
          format: uint64
          type: integer
          x-etsi-mec-cardinality: '1'
          x-etsi-mec-origin-type: Uint64
        longUncertainty:
Michel Roy's avatar
Michel Roy committed
          description: >-
            The uncertainty for Longitude information as defined in IETF RFC
            6225 [6]
Michel Roy's avatar
Michel Roy committed
          format: uint8
          type: integer
          x-etsi-mec-cardinality: '1'
          x-etsi-mec-origin-type: Uint8
      required:
Michel Roy's avatar
Michel Roy committed
        - 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
          format: uint8
          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
          format: uint8
          type: integer
          x-etsi-mec-cardinality: '1'
          x-etsi-mec-origin-type: Uint8
        supportedHeMcsNssSet:
          description: Supported MCS and NSS Set.
Michel Roy's avatar
Michel Roy committed
          format: uint8
          type: integer
          x-etsi-mec-cardinality: '1'
          x-etsi-mec-origin-type: Uint8
      required:
Michel Roy's avatar
Michel Roy committed
        - heMacCapInfo
        - hePhyCapinfo
        - supportedHeMcsNssSet
      type: object
      x-etsi-ref: 6.5.16
    HtCapabilities:
      properties:
        ampduParameters:
Michel Roy's avatar
Michel Roy committed
          description: 'A-MPDU parameters as defined in IEEE 802.11-2016 [8].'
Michel Roy's avatar
Michel Roy committed
          format: uint8
          type: integer
          x-etsi-mec-cardinality: '1'
          x-etsi-mec-origin-type: UInt8
        aselCap:
Michel Roy's avatar
Michel Roy committed
          description: 'ASEL capabilities as defined in IEEE 802.11-2016 [8].'
Michel Roy's avatar
Michel Roy committed
          format: uint8
          type: integer
          x-etsi-mec-cardinality: '1'
          x-etsi-mec-origin-type: UInt8
        htCapabilityInfo:
Michel Roy's avatar
Michel Roy committed
          description: 'HT Capability Information as defined in IEEE 802.11-2016 [8].'
Michel Roy's avatar
Michel Roy committed
          format: uint16
          type: integer
          x-etsi-mec-cardinality: '1'
          x-etsi-mec-origin-type: UInt16
        htExtendedCap:
Michel Roy's avatar
Michel Roy committed
          description: 'Extended HT Capabilities as defined in IEEE 802.11-2016 [8].'
Michel Roy's avatar
Michel Roy committed
          format: uint16
          type: integer
          x-etsi-mec-cardinality: '1'
          x-etsi-mec-origin-type: UInt16
        supportedMcsSet:
Michel Roy's avatar
Michel Roy committed
          description: 'Supported MCS set as defined in IEEE 802.11-2016 [8].'
Michel Roy's avatar
Michel Roy committed
          format: uint128
          type: integer
          x-etsi-mec-cardinality: '1'
          x-etsi-mec-origin-type: Uint128
        txBeamFormCap:
Michel Roy's avatar
Michel Roy committed
          description: >-
            Transmit Beamforming Capabilities as defined in IEEE 802.11-2016
            [8].
Michel Roy's avatar
Michel Roy committed
          format: uint32
          type: integer
          x-etsi-mec-cardinality: '1'
          x-etsi-mec-origin-type: UInt32
      required:
Michel Roy's avatar
Michel Roy committed
        - htCapabilityInfo
        - ampduParameters
        - supportedMcsSet
        - htExtendedCap
        - txBeamFormCap
        - aselCap
      type: object
Michel Roy's avatar
Michel Roy committed
      x-etsi-ref: 6.5.14
    InlineNotification:
Michel Roy's avatar
Michel Roy committed
      discriminator:
        propertyName: notificationType
      oneOf:
        - $ref: '#/components/schemas/AssocStaNotification'
        - $ref: '#/components/schemas/StaDataRateNotification'
Michel Roy's avatar
Michel Roy committed
        - $ref: '#/components/schemas/MeasurementReportNotification'
    InlineSubscription:
Michel Roy's avatar
Michel Roy committed
      discriminator:
        propertyName: subscriptionType
      oneOf:
        - $ref: '#/components/schemas/AssocStaSubscription'
        - $ref: '#/components/schemas/StaDataRateSubscription'
Michel Roy's avatar
Michel Roy committed
        - $ref: '#/components/schemas/MeasurementReportSubscription'
    LinkType:
      properties:
        href:
          type: string
      required:
Michel Roy's avatar
Michel Roy committed
        - href
      type: object
      x-etsi-ref: 6.5.23
    MeasurementConfig:
      properties:
Michel Roy's avatar
Michel Roy committed
        _links:
          description: Hyperlink related to the resource.
          properties:
            self:
              $ref: '#/components/schemas/LinkType'
          required:
            - self
          type: object
          x-etsi-mec-cardinality: 0..1
          x-etsi-mec-origin-type: Structure (inlined)
        measurementId:
Michel Roy's avatar
Michel Roy committed
          description: >-
            Unique identifier allocated by the service consumer to identify
            measurement reports (within sta_information query), associated with
            this measurement configuration.
          type: string
          x-etsi-mec-cardinality: '1'
          x-etsi-mec-origin-type: String
Michel Roy's avatar
Michel Roy committed
        measurementInfo:
          $ref: '#/components/schemas/MeasurementInfo'
        staId:
          description: >-
            Identifier(s) to uniquely specify the target client station(s) for
            the measurement configuration.
          items:
            $ref: '#/components/schemas/StaIdentity'
          minItems: 1
          type: array
          x-etsi-mec-cardinality: 1..N
          x-etsi-mec-origin-type: StaIdentity
      required:
Michel Roy's avatar
Michel Roy committed
        - staId
        - measurementId
        - measurementInfo
      type: object
      x-etsi-ref: 6.2.4
Michel Roy's avatar
Michel Roy committed
    MeasurementConfigLinkList:
      properties:
Michel Roy's avatar
Michel Roy committed
        _links:
          description: Hyperlink related to the resource.
          properties:
            self:
              $ref: '#/components/schemas/LinkType'
          required:
            - self
          type: object
          x-etsi-mec-cardinality: '1'
Michel Roy's avatar
Michel Roy committed
          x-etsi-mec-origin-type: Structure (inlined)
        measurementConfig:
          description: ''
          items:
            properties:
              href:
                description: The URI referring to a measurement configuration.
                format: uri
                type: string
                x-etsi-mec-cardinality: '1'
                x-etsi-mec-origin-type: URI
              measurementId:
                description: >-
                  Unique identifier allocated by the service consumer to
                  identify measurement reports associated with this measurement
                  configuration.
                type: string
                x-etsi-mec-cardinality: '1'
                x-etsi-mec-origin-type: String
            required:
              - href
              - measurementId
            type: object
          type: array
          x-etsi-mec-cardinality: 0..N
          x-etsi-mec-origin-type: Structure (inlined)
      required:
Michel Roy's avatar
Michel Roy committed
        - _links
      type: object
Michel Roy's avatar
Michel Roy committed
      x-etsi-ref: 6.2.5
    MeasurementInfo:
      properties:
Michel Roy's avatar
Michel Roy committed
        beaconRequestConf:
          $ref: '#/components/schemas/BeaconRequestConfig'
        channelLoadConf:
          $ref: '#/components/schemas/ChannelLoadConfig'
        measurementDuration:
          description: "Duration of the measurement in Time Units (TUs) of 1\_024 µs, as defined in section 11.11.4 of IEEE\_802.11-2016 [8]. If not provided, the underlying system may utilize a default configuration that will be indicated in resulting measurement reports."
          format: uint16
          type: integer
          x-etsi-mec-cardinality: 0..1
Michel Roy's avatar
Michel Roy committed
          x-etsi-mec-origin-type: Uint16
        neighborReportConf:
          $ref: '#/components/schemas/NeighborReportConfig'
        randomInterval:
          description: "Random interval to be used for starting the measurement in TUs of 1\_024 µs, as specified in section\_11.11.3 of IEEE 802.11-2016 [8]. If not provided, the underlying system may utilize a default configuration that will be indicated in resulting measurement reports."
          format: uint16
          type: integer
Michel Roy's avatar
Michel Roy committed
          x-etsi-mec-cardinality: 0..1
          x-etsi-mec-origin-type: Uint16
        staStatisticsConf:
          $ref: '#/components/schemas/StaStatisticsConfig'
      type: object
Michel Roy's avatar
Michel Roy committed
      x-etsi-notes: "NOTE 1:\tOnly one of channelLoadConf, beaconRequestConf, staStatisticsConf or neighborReportConf is allowed in a MeasurementInfo instance.\nNOTE 2:\tAs per IEEE 802.11-2016 [8], measurementDuration and randomInterval apply to channelLoad, beaconRequest, staStatistics, and neighborReport configurations."
      x-etsi-ref: 6.5.41
    MeasurementReportNotification:
      properties:
Michel Roy's avatar
Michel Roy committed
        beaconReport:
          description: 'Beacon Report as defined in IEEE 802.11-2016 [8].'
          items:
            $ref: '#/components/schemas/BeaconReport'
          minItems: 0
          type: array
          x-etsi-mec-cardinality: 0..N
          x-etsi-mec-origin-type: BeaconReport
        channelLoad:
          description: >-
            Channel Load reports as seen by the station as defined in IEEE
            802.11-2016 [8].
          items:
            $ref: '#/components/schemas/ChannelLoad'
          minItems: 0
          type: array
          x-etsi-mec-cardinality: 0..N
          x-etsi-mec-origin-type: ChannelLoad
        neighborReport:
          description: "Neighbor Report providing information about neighbor Access Points seen by the station as defined in IEEE\_802.112016 [8]."
          items:
            $ref: '#/components/schemas/NeighborReport'
          minItems: 0