WlanInformationApi.yaml 112 KB
Newer Older
Michel Roy's avatar
Michel Roy committed
          type: array
          x-etsi-mec-cardinality: 0..N
          x-etsi-mec-origin-type: NeighborReport
        notificationType:
Michel Roy's avatar
Michel Roy committed
          description: Shall be set to "MeasurementReportNotification".
          type: string
          x-etsi-mec-cardinality: '1'
          x-etsi-mec-origin-type: String
Michel Roy's avatar
Michel Roy committed
        staStatistics:
          description: 'STA Statistics Report as defined in IEEE 802.11-2016 [8].'
          items:
Michel Roy's avatar
Michel Roy committed
            $ref: '#/components/schemas/StaStatistics'
          minItems: 0
          type: array
          x-etsi-mec-cardinality: 0..N
Michel Roy's avatar
Michel Roy committed
          x-etsi-mec-origin-type: StaStatistics
        timeStamp:
          $ref: '#/components/schemas/TimeStamp'
      required:
Michel Roy's avatar
Michel Roy committed
        - notificationType
      type: object
Michel Roy's avatar
Michel Roy committed
      x-etsi-notes: "NOTE 1:\tEach MeasurementReportNotification shall include a single measurement report type (channelLoad, beaconRequest, etc.), based on the MeasurementReportSubscription.\nNOTE 2:\tA single MeasurementReportNotification may include multiple measurement reports (of the same type), if the MeasurementReportSubscription configured the measurement report for several client stations and multiple reports are available to WAIS."
      x-etsi-ref: 6.4.5
    MeasurementReportSubscription:
      properties:
        _links:
Michel Roy's avatar
Michel Roy committed
          description: >-
            Hyperlink related to the resource. This shall be only included in
            the HTTP responses and in HTTP PUT requests.
          properties:
            self:
              $ref: '#/components/schemas/LinkType'
          required:
Michel Roy's avatar
Michel Roy committed
            - self
          type: object
          x-etsi-mec-cardinality: 0..1
          x-etsi-mec-origin-type: Structure (inlined)
        callbackReference:
          type: string
        expiryDeadline:
          $ref: '#/components/schemas/TimeStamp'
Michel Roy's avatar
Michel Roy committed
        measurementId:
          description: >-
            Unique identifier allocated by the service consumer to identify
            measurement reports associated with this measurement subscription.
          type: string
          x-etsi-mec-cardinality: '1'
          x-etsi-mec-origin-type: String
        measurementInfo:
          $ref: '#/components/schemas/MeasurementInfo'
        requestTestNotification:
          description: >-
            Set to TRUE by the service consumer to request a test notification
            on the callbackReference URI to determine if it is reachable by the
            WAIS for notifications.
          type: boolean
          x-etsi-mec-cardinality: 0..1
          x-etsi-mec-origin-type: Boolean
        staId:
Michel Roy's avatar
Michel Roy committed
          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:
Michel Roy's avatar
Michel Roy committed
          description: Shall be set to "MeasurementReportSubscription".
          type: string
          x-etsi-mec-cardinality: '1'
          x-etsi-mec-origin-type: String
Michel Roy's avatar
Michel Roy committed
        websockNotifConfig:
          $ref: '#/components/schemas/WebsockNotifConfig'
      required:
Michel Roy's avatar
Michel Roy committed
        - subscriptionType
        - staId
        - measurementId
        - measurementInfo
      type: object
Michel Roy's avatar
Michel Roy committed
      x-etsi-notes: "NOTE:\tAt least one of callbackReference and websockNotifConfig shall be provided by the service consumer. If both are provided, it is up to WAIS to select the method to be used for notifications and to return only that method in the response."
      x-etsi-ref: 6.3.5
    NeighborReport:
      properties:
Michel Roy's avatar
Michel Roy committed
        bssTransitionCandidatePreference:
          description: "Relative value indicating the preferred ordering for this BSS as a transition candidate for roaming. 255 indicating the most preferred candidate and 1 indicating the least preferred candidate, as defined in Table 9-152 within IEEE\_802.112016\_[8]."
          format: uint8
          type: integer
          x-etsi-mec-cardinality: 0..1
Michel Roy's avatar
Michel Roy committed
          x-etsi-mec-origin-type: Uint8
        bssid:
          description: BSSID (MAC address) of the Access Point that is being reported.
          type: string
          x-etsi-mec-cardinality: '1'
          x-etsi-mec-origin-type: String
Michel Roy's avatar
Michel Roy committed
        bssidInfo:
          $ref: '#/components/schemas/BssidInfo'
        channel:
Michel Roy's avatar
Michel Roy committed
          description: >-
            Channel field indicates a channel number, which is interpreted in
            the context of the indicated operating class. Channel numbers are
            defined in Annex E within IEEE 802.11-2016 [8].
Michel Roy's avatar
Michel Roy committed
          format: uint8
          type: integer
          x-etsi-mec-cardinality: '1'
Michel Roy's avatar
Michel Roy committed
          x-etsi-mec-origin-type: Uint8
        measurementId:
          description: >-
            Measurement ID of the Measurement configuration applied to this
            Neighbor Report.
          type: string
          x-etsi-mec-cardinality: '1'
Michel Roy's avatar
Michel Roy committed
          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'
Michel Roy's avatar
Michel Roy committed
          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, Annex\_C within IEEE 802.11-2016 [8].\n2 = dsss\n4 = ofdm\n5 = hrdsss\n6 = erp\n7 = ht\n8 = dmg\n9 = vht\n10 = tvht"
          format: uint8
          type: integer
          x-etsi-mec-cardinality: '1'
Michel Roy's avatar
Michel Roy committed
          x-etsi-mec-origin-type: Uint8
        staId:
          $ref: '#/components/schemas/StaIdentity'
      required:
Michel Roy's avatar
Michel Roy committed
        - measurementId
        - bssid
        - bssidInfo
        - operatingClass
        - channel
        - phyType
      type: object
Michel Roy's avatar
Michel Roy committed
      x-etsi-ref: 6.5.10
    NeighborReportConfig:
      properties:
Michel Roy's avatar
Michel Roy committed
        bssid:
          description: >-
            BSSID of the neighbor AP which information is intended to obtain. If
            no specific BSSID is given, the information will be provided for all
            APs matching the ssid criteria.
          type: string
          x-etsi-mec-cardinality: 0..1
Michel Roy's avatar
Michel Roy committed
          x-etsi-mec-origin-type: String
        ssid:
          description: >-
            The SSID field is optionally present. If present, it contains an
            SSID element. The presence of an SSID element in a Neighbor Report
            indicates a request for a neighbor list for the specified SSID in
            the SSID Element. The absence of an SSID element indicates neighbor
            report for the current ESS.
          type: string
          x-etsi-mec-cardinality: 0..1
Michel Roy's avatar
Michel Roy committed
          x-etsi-mec-origin-type: String
      type: object
      x-etsi-notes: "NOTE:\tBoth SSID and BSSID are optional configuration parameters. BSSID is valid when a SSID setting is provided, otherwise ignored. If SSID is not included, the neighbor report will be generated for the SSID (i.e.\_current ESS) that the station is associated."
      x-etsi-ref: 6.5.32
    OBssLoad:
      properties:
        allocatedTrafficSelfMean:
          description: "Mean of allocated traffic from this AP (BSS) in units of 32\_µs per second."
          format: uint16
          type: integer
Michel Roy's avatar
Michel Roy committed
          x-etsi-mec-cardinality: '1'
          x-etsi-mec-origin-type: Uint16
        allocatedTrafficSelfStdDev:
          description: >-
            Standard deviation from the mean of allocation traffic from this BSS
            in units of 32 µs per second.
          format: uint16
          type: integer
          x-etsi-mec-cardinality: 0..1
Michel Roy's avatar
Michel Roy committed
          x-etsi-mec-origin-type: Uint16
        allocatedTrafficShareMean:
          description: >-
            Mean of the sum of allocated traffic from other APs on the
            overlapping channel in unit of 32 µs per second.
          format: uint16
          type: integer
Michel Roy's avatar
Michel Roy committed
          x-etsi-mec-cardinality: '1'
          x-etsi-mec-origin-type: Uint16
        allocatedTrafficShareStdDev:
          description: >-
            Standard deviation from the mean of the sum of allocated traffic
            from other APs on the overlapping channel in unit of 32 µs per
            second.
          format: uint16
          type: integer
          x-etsi-mec-cardinality: 0..1
Michel Roy's avatar
Michel Roy committed
          x-etsi-mec-origin-type: Uint16
        overlap:
          description: >-
            Indicates the number of other APs that are sharing the same channel
            as the reporting AP.
          format: uint8
          type: integer
          x-etsi-mec-cardinality: 0..1
Michel Roy's avatar
Michel Roy committed
          x-etsi-mec-origin-type: Uint8
      required:
        - allocatedTrafficSelfMean
        - allocatedTrafficShareMean
      type: object
      x-etsi-ref: 6.5.40
    ProblemDetails:
      properties:
        detail:
          description: >-
            A human-readable explanation specific to this occurrence of the
            problem
          type: string
          x-etsi-mec-cardinality: 0..1
Michel Roy's avatar
Michel Roy committed
          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
Michel Roy's avatar
Michel Roy committed
          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
          format: uint32
          type: integer
          x-etsi-mec-cardinality: 0..1
          x-etsi-mec-origin-type: Uint32
Michel Roy's avatar
Michel Roy committed
        title:
          description: 'A short, human-readable summary of the problem type'
          type: string
          x-etsi-mec-cardinality: 0..1
Michel Roy's avatar
Michel Roy committed
          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
Michel Roy's avatar
Michel Roy committed
          x-etsi-mec-origin-type: URI
      type: object
    ReportedBeaconFrameInfo:
      properties:
        frameType:
          description: |-
            A value of 0 indicates a Beacon or Probe Response.
            A value of 1 indicates a Measurement Pilot frame.
          format: uint8
          type: integer
Michel Roy's avatar
Michel Roy committed
          x-etsi-mec-cardinality: '1'
          x-etsi-mec-origin-type: Uint8
        phyType:
          description: Value between 0 and 127 coded according to dot11PHYType.
          format: uint8
          type: integer
Michel Roy's avatar
Michel Roy committed
          x-etsi-mec-cardinality: '1'
          x-etsi-mec-origin-type: Uint8
      required:
        - phyType
        - frameType
      type: object
      x-etsi-ref: 6.5.29
    ReportingReasonQoSCounters:
      properties:
        qosAckFailure:
          description: dot11QoSAckFailure
          type: boolean
          x-etsi-mec-cardinality: '1'
          x-etsi-mec-origin-type: Boolean
        qosDiscarded:
          description: dot11QoSDiscarded
          type: boolean
          x-etsi-mec-cardinality: '1'
          x-etsi-mec-origin-type: Boolean
        qosFailed:
          description: 'dot11QoSFailed '
          type: boolean
          x-etsi-mec-cardinality: '1'
          x-etsi-mec-origin-type: Boolean
        qosFrameDuplicate:
          description: dot11QoSFrameDuplicate
          type: boolean
          x-etsi-mec-cardinality: '1'
          x-etsi-mec-origin-type: Boolean
        qosMultipleRetry:
          description: dot11QoSMultipleRetry
          type: boolean
          x-etsi-mec-cardinality: '1'
          x-etsi-mec-origin-type: Boolean
        qosRetry:
          description: dot11QoSRetry
          type: boolean
          x-etsi-mec-cardinality: '1'
          x-etsi-mec-origin-type: Boolean
        qosRtsFailure:
          description: dot11QoSRTSFailure
          type: boolean
          x-etsi-mec-cardinality: '1'
          x-etsi-mec-origin-type: Boolean
      required:
        - qosFailed
        - qosRetry
        - qosMultipleRetry
        - qosFrameDuplicate
        - qosRtsFailure
        - qosAckFailure
        - qosDiscarded
      type: object
      x-etsi-ref: 6.5.38
    ReportingReasonStaCounters:
      properties:
        ackFailure:
          description: dot11AckFailure
          type: boolean
          x-etsi-mec-cardinality: '1'
          x-etsi-mec-origin-type: Boolean
        failed:
          description: dot11Failed
          type: boolean
          x-etsi-mec-cardinality: '1'
          x-etsi-mec-origin-type: Boolean
        fcsError:
          description: 'dot11FCSError '
          type: boolean
          x-etsi-mec-cardinality: '1'
          x-etsi-mec-origin-type: Boolean
        frameDuplicate:
          description: 'dot11FrameDuplicate '
          type: boolean
          x-etsi-mec-cardinality: '1'
          x-etsi-mec-origin-type: Boolean
        multipleRetry:
          description: dot11MultipleRetry
          type: boolean
          x-etsi-mec-cardinality: '1'
          x-etsi-mec-origin-type: Boolean
        retry:
          description: dot11Retry
          type: boolean
          x-etsi-mec-cardinality: '1'
          x-etsi-mec-origin-type: Boolean
        rtsFailure:
          description: dot11RTSFailure
          type: boolean
          x-etsi-mec-cardinality: '1'
          x-etsi-mec-origin-type: Boolean
      required:
        - failed
        - fcsError
        - multipleRetry
        - frameDuplicate
        - rtsFailure
        - ackFailure
        - retry
      type: object
      x-etsi-ref: 6.5.37
    Rssi:
      properties:
        rssi:
          description: The Received Signal Strength Indicator from a station
          format: uint8
          type: integer
Michel Roy's avatar
Michel Roy committed
          x-etsi-mec-cardinality: '1'
          x-etsi-mec-origin-type: Uint8
      required:
        - rssi
      type: object
      x-etsi-ref: 6.5.21
    STACounterTriggerCondition:
      properties:
        ackFailureCountThreshold:
          description: Configure and set threshold for dot11AckFailureCount trigger
Michel Roy's avatar
Michel Roy committed
          format: uint32
          type: integer
          x-etsi-mec-cardinality: 0..1
          x-etsi-mec-origin-type: Uint32
Michel Roy's avatar
Michel Roy committed
        failedCountThreshold:
          description: Configure and set threshold for dot11FailedCount trigger
Michel Roy's avatar
Michel Roy committed
          format: uint32
          type: integer
          x-etsi-mec-cardinality: 0..1
          x-etsi-mec-origin-type: Uint32
Michel Roy's avatar
Michel Roy committed
        fcsErrorCountThreshold:
          description: Configure and set threshold for dot11FCSErrorCount trigger
Michel Roy's avatar
Michel Roy committed
          format: uint32
          type: integer
          x-etsi-mec-cardinality: 0..1
          x-etsi-mec-origin-type: Uint32
Michel Roy's avatar
Michel Roy committed
        frameDuplicateCountThreshold:
          description: Configure and set threshold for dot11FrameDuplicateCount trigger
Michel Roy's avatar
Michel Roy committed
          format: uint32
          type: integer
          x-etsi-mec-cardinality: 0..1
          x-etsi-mec-origin-type: Uint32
Michel Roy's avatar
Michel Roy committed
        multipleRetryCountThreshold:
          description: Configure and set threshold for dot11MultipleRetryCount trigger
Michel Roy's avatar
Michel Roy committed
          format: uint32
          type: integer
          x-etsi-mec-cardinality: 0..1
          x-etsi-mec-origin-type: Uint32
Michel Roy's avatar
Michel Roy committed
        retryCountThreshold:
          description: Configure and set threshold for dot11RetryCount trigger
Michel Roy's avatar
Michel Roy committed
          format: uint32
          type: integer
          x-etsi-mec-cardinality: 0..1
          x-etsi-mec-origin-type: Uint32
Michel Roy's avatar
Michel Roy committed
        rtsFailureCountThreshold:
          description: Configure and set threshold for dot11RTSFailureCount trigger
Michel Roy's avatar
Michel Roy committed
          format: uint32
          type: integer
          x-etsi-mec-cardinality: 0..1
          x-etsi-mec-origin-type: Uint32
Michel Roy's avatar
Michel Roy committed
      type: object
      x-etsi-ref: 6.5.33
    StaDataRate:
      properties:
        staId:
          $ref: '#/components/schemas/StaIdentity'
        staLastDataDownlinkRate:
          description: >-
            The data transmit rate in kbps that was most recently used for
            transmission of data PPDUs from the access point to the station.
Michel Roy's avatar
Michel Roy committed
          format: uint32
          type: integer
          x-etsi-mec-cardinality: 0..1
          x-etsi-mec-origin-type: Uint32
Michel Roy's avatar
Michel Roy committed
        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
          format: uint32
          type: integer
          x-etsi-mec-cardinality: 0..1
          x-etsi-mec-origin-type: Uint32
Michel Roy's avatar
Michel Roy committed
      type: object
      x-etsi-notes: "NOTE:\tStaDataRate shall include at least one instance of either downlink rate or uplink rate and may include both.\n If this report is contained within a data type that provides the station's identifier, staId field may be omitted"
      x-etsi-ref: 6.5.22
    StaDataRateNotification:
      properties:
        notificationType:
          description: Shall be set to "StaDataRateNotification".
          type: string
          x-etsi-mec-cardinality: '1'
          x-etsi-mec-origin-type: String
        staDataRate:
          description: Data rates of a client station.
          items:
            $ref: '#/components/schemas/StaDataRate'
          minItems: 0
          type: array
          x-etsi-mec-cardinality: 0..N
          x-etsi-mec-origin-type: StaDataRate
        timeStamp:
          $ref: '#/components/schemas/TimeStamp'
      required:
        - notificationType
      type: object
      x-etsi-ref: 6.4.3
    StaDataRateSubscription:
      properties:
        _links:
          description: >-
            Hyperlink related to the resource. This shall be only included in
            the HTTP responses and in HTTP PUT requests.
          properties:
            self:
              $ref: '#/components/schemas/LinkType'
          required:
            - self
          type: object
          x-etsi-mec-cardinality: 0..1
Michel Roy's avatar
Michel Roy committed
          x-etsi-mec-origin-type: Structure (inlined)
        callbackReference:
          type: string
        expiryDeadline:
          $ref: '#/components/schemas/TimeStamp'
        notificationEvent:
          description: Set for trigger-based event notification reporting.
          properties:
            downlinkRateThreshold:
              description: Downlink data rate threshold for StaDataRate reporting.
              format: uint32
              type: integer
              x-etsi-mec-cardinality: 0..1
              x-etsi-mec-origin-type: Uint32
            trigger:
              description: >-
                Trigger event for the notification:

                1 = Notification issued when the STA's downlink data rate is
                greater than or equal to the downlink threshold.

                2 = Notification issued when the STA's downlink data rate is
                less than or equal to the downlink threshold.

                3 = Notification issued when the STA's uplink data rate is
                greater than or equal to the uplink threshold.

                4 = Notification issued when the STA's uplink data rate is less
                than or equal to the uplink threshold.

                5 = Notification issued when the STA's downlink and uplink data
                rate is greater than or equal to their thresholds.

                6 = Notification issued when the STA's downlink and uplink data
                rate is less than or equal to their thresholds.

                7 = Notification issued when the STA's downlink or uplink data
                rate is greater than or equal to their thresholds.

                8 = Notification issued when the STA's downlink or uplink data
                rate is less than or equal to their thresholds.
              enum:
                - 1
                - 2
                - 3
                - 4
                - 5
                - 6
                - 7
                - 8
              type: integer
              x-etsi-mec-cardinality: '1'
              x-etsi-mec-origin-type: Enum (inline)
            uplinkRateThreshold:
              description: Uplink data rate threshold for StaDataRate reporting.
              format: uint32
              type: integer
              x-etsi-mec-cardinality: 0..1
              x-etsi-mec-origin-type: Uint32
          required:
            - trigger
          type: object
          x-etsi-mec-cardinality: 0..1
Michel Roy's avatar
Michel Roy committed
          x-etsi-mec-origin-type: Structure (inline)
        notificationPeriod:
          description: |-
            Set for periodic notification reporting.
            Value indicates the notification period in seconds.
          format: uint8
          type: integer
          x-etsi-mec-cardinality: 0..1
Michel Roy's avatar
Michel Roy committed
          x-etsi-mec-origin-type: Uint8
        requestTestNotification:
          description: >-
            Set to TRUE by the service consumer to request a test notification
            on the callbackReference URI to determine if it is reachable by the
            WAIS for notifications.
          type: boolean
          x-etsi-mec-cardinality: 0..1
Michel Roy's avatar
Michel Roy committed
          x-etsi-mec-origin-type: Boolean
        staId:
          description: >-
            Identifier(s) to uniquely specify the target client station(s) for
            the subscription.
          items:
            $ref: '#/components/schemas/StaIdentity'
          minItems: 1
          type: array
          x-etsi-mec-cardinality: 1..N
          x-etsi-mec-origin-type: StaIdentity
        subscriptionType:
          description: Shall be set to "StaDataRateSubscription".
          type: string
          x-etsi-mec-cardinality: '1'
          x-etsi-mec-origin-type: String
        websockNotifConfig:
          $ref: '#/components/schemas/WebsockNotifConfig'
      required:
        - subscriptionType
        - staId
      type: object
      x-etsi-notes: "NOTE 1:\tAt least one of callbackReference and websockNotifConfig shall be provided by the service consumer. If both are provided, it is up to WAIS to select the method to be used for notifications and to return only that method in the response.\nNOTE 2:\tStaDataRateSubscription shall include either notificationPeriod or notificationEvent.\nNOTE 3:\tIf both notificationPeriod and notificationEvent attributes are set, notifications are issued periodically when the trigger threshold is satisfied."
      x-etsi-ref: 6.3.3
    StaIdentity:
      properties:
        aid:
          description: >-
            Number which identifies a particular association between a station
            and an Access Point
          type: string
          x-etsi-mec-cardinality: 0..1
Michel Roy's avatar
Michel Roy committed
          x-etsi-mec-origin-type: String
        ipAddress:
          description: IPv4 or IPv6 address(es) allocated for the station.
          items:
            type: string
          minItems: 0
          type: array
          x-etsi-mec-cardinality: 0..N
          x-etsi-mec-origin-type: String
        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(s) 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:
          $ref: '#/components/schemas/ApAssociated'
        beaconReport:
          description: 'Beacon Report as defined in IEEE 802.11-2016 [8]. '
          items:
            $ref: '#/components/schemas/BeaconReport'
          minItems: 0
          type: array
          x-etsi-mec-cardinality: 0..N
          x-etsi-mec-origin-type: BeaconReport
        channel:
          description: >-
            Channel currently used by the station to connect with its associated
            Access Point.
Michel Roy's avatar
Michel Roy committed
          format: uint32
          type: integer
          x-etsi-mec-cardinality: 0..1
          x-etsi-mec-origin-type: Uint32
Michel Roy's avatar
Michel Roy committed
        channelLoad:
          description: "Channel Load reports as seen by the station as defined IEEE\_802.11-2016 [8]. Channel Load reports may be configured for any channel, including the station's current channel for association."
          items:
            $ref: '#/components/schemas/ChannelLoad'
          minItems: 0
          type: array
          x-etsi-mec-cardinality: 0..N
          x-etsi-mec-origin-type: ChannelLoad
        neighborReport:
          description: >-
            Information about neighbor Access Points seen by the station as
            defined IEEE 802.11-2016 [8].
          items:
            $ref: '#/components/schemas/NeighborReport'
          minItems: 0
          type: array
          x-etsi-mec-cardinality: 0..N
          x-etsi-mec-origin-type: NeighborReport
        rssi:
          $ref: '#/components/schemas/Rssi'
        staDataRate:
          $ref: '#/components/schemas/StaDataRate'
        staId:
          $ref: '#/components/schemas/StaIdentity'
        staStatistics:
          description: >-
            Statistics as defined in IEEE 802.11-2016 [8] for the client station
            collected over measurement duration.
          items:
            $ref: '#/components/schemas/StaStatistics'
          minItems: 0
          type: array
          x-etsi-mec-cardinality: 0..N
          x-etsi-mec-origin-type: StaStatistics
        timeStamp:
          $ref: '#/components/schemas/TimeStamp'
      required:
        - staId
      type: object
      x-etsi-ref: 6.2.3
    StaStatistics:
      properties:
        group2to9Data:
          $ref: '#/components/schemas/StaStatisticsGroup2to9Data'
        groupIdentity:
          description: "Indicates the requested statistics group describing the Statistics Group Data according to Table 9-114 of IEEE\_802.11-2016 [8].\nDepending on group identity, one and only one of the STA Statistics Group Data will be present."
          format: uint8
          type: integer
Michel Roy's avatar
Michel Roy committed
          x-etsi-mec-cardinality: '1'
          x-etsi-mec-origin-type: UInt8
        groupOneData:
          $ref: '#/components/schemas/StaStatisticsGroupOneData'
        groupZeroData:
          $ref: '#/components/schemas/StaStatisticsGroupZeroData'
        measurementDuration:
          description: >-
            Duration over which the Statistics Group Data was measured in time
            units of 1 024 µs. Duration equal to zero indicates a report of
            current values.
          format: uint16
          type: integer
          x-etsi-mec-cardinality: '1'
          x-etsi-mec-origin-type: UInt16
        measurementId:
          description: >-
            Measurement ID of the Measurement configuration applied to this STA
            Statistics Report.
          type: string
          x-etsi-mec-cardinality: '1'
          x-etsi-mec-origin-type: String
        staId:
          $ref: '#/components/schemas/StaIdentity'
      required:
        - measurementId
        - measurementDuration
        - groupIdentity
      type: object
      x-etsi-ref: 6.5.13
    StaStatisticsConfig:
      properties:
        groupIdentity:
          description: 'As per Table 9-92 of IEEE 802.11-2016 [8].'
          format: uint8
          type: integer
          x-etsi-mec-cardinality: '1'
          x-etsi-mec-origin-type: Uint8
        measurementCount:
          description: >-
            Valid if triggeredReport = true.

            Specifies the number of MAC service data units or protocol data
            units to determine if the trigger conditions are met.
Michel Roy's avatar
Michel Roy committed
          format: uint32
          type: integer
          x-etsi-mec-cardinality: 0..1
          x-etsi-mec-origin-type: Uint32
Michel Roy's avatar
Michel Roy committed
        triggerCondition:
          $ref: '#/components/schemas/STACounterTriggerCondition'
        triggerTimeout:
          description: >-
            Valid if triggeredReport = true.

            The Trigger Timeout field contains a value in units of 100
            time-units of 1 024 µs during which a measuring STA does not
            generate further triggered STA Statistics Reports after a trigger
            condition has been met.
          format: uint16
          type: integer
          x-etsi-mec-cardinality: 0..1
Michel Roy's avatar
Michel Roy committed
          x-etsi-mec-origin-type: Uint16
        triggeredReport:
          description: 'True = triggered reporting, otherwise duration.'
          type: boolean
          x-etsi-mec-cardinality: '1'
          x-etsi-mec-origin-type: Boolean
      required:
        - groupIdentity
        - triggeredReport
      type: object
      x-etsi-ref: 6.5.26
    StaStatisticsGroup2to9Data:
      properties:
        qosAckFailureCount:
          description: dot11QosAckFailureCount counter
Michel Roy's avatar
Michel Roy committed
          format: uint32
          type: integer
Michel Roy's avatar
Michel Roy committed
          x-etsi-mec-cardinality: '1'
          x-etsi-mec-origin-type: Uint32
Michel Roy's avatar
Michel Roy committed
        qosDiscardedFrameCount:
          description: dot11QosDiscardedFrameCount counter
Michel Roy's avatar
Michel Roy committed
          format: uint32
          type: integer
Michel Roy's avatar
Michel Roy committed
          x-etsi-mec-cardinality: '1'
          x-etsi-mec-origin-type: Uint32
Michel Roy's avatar
Michel Roy committed
        qosFailedCount:
          description: dot11QosFailedCount counter
Michel Roy's avatar
Michel Roy committed
          format: uint32
          type: integer
Michel Roy's avatar
Michel Roy committed
          x-etsi-mec-cardinality: '1'
          x-etsi-mec-origin-type: Uint32
Michel Roy's avatar
Michel Roy committed
        qosFrameDuplicateCount:
          description: dot11QosFrameDuplicateCount counter
Michel Roy's avatar
Michel Roy committed
          format: uint32
          type: integer
Michel Roy's avatar
Michel Roy committed
          x-etsi-mec-cardinality: '1'
          x-etsi-mec-origin-type: Uint32
Michel Roy's avatar
Michel Roy committed
        qosMPDUsReceivedCount:
          description: dot11QosMPDUsReceivedCount counter
Michel Roy's avatar
Michel Roy committed
          format: uint32
          type: integer
Michel Roy's avatar
Michel Roy committed
          x-etsi-mec-cardinality: '1'
          x-etsi-mec-origin-type: Uint32
Michel Roy's avatar
Michel Roy committed
        qosMultipleRetryCount:
          description: dot11QosMultipleRetryCount counter
Michel Roy's avatar
Michel Roy committed
          format: uint32
          type: integer
Michel Roy's avatar
Michel Roy committed
          x-etsi-mec-cardinality: '1'
          x-etsi-mec-origin-type: Uint32
Michel Roy's avatar
Michel Roy committed
        qosRTSFailureCount:
          description: dot11QosRTSFailureCount counter
Michel Roy's avatar
Michel Roy committed
          format: uint32
          type: integer
Michel Roy's avatar
Michel Roy committed
          x-etsi-mec-cardinality: '1'
          x-etsi-mec-origin-type: Uint32
Michel Roy's avatar
Michel Roy committed
        qosRTSSuccessCount:
          description: dot11QosRTSSuccessCount counter
Michel Roy's avatar
Michel Roy committed
          format: uint32
          type: integer
Michel Roy's avatar
Michel Roy committed
          x-etsi-mec-cardinality: '1'
          x-etsi-mec-origin-type: Uint32
Michel Roy's avatar
Michel Roy committed
        qosReceivedFragmentCount:
          description: dot11QosReceivedFragmentCount counter
Michel Roy's avatar
Michel Roy committed
          format: uint32
          type: integer
Michel Roy's avatar
Michel Roy committed
          x-etsi-mec-cardinality: '1'
          x-etsi-mec-origin-type: Uint32
Michel Roy's avatar
Michel Roy committed
        qosRetriesReceivedCount:
          description: dot11QosRetriesReceivedCount counter
Michel Roy's avatar
Michel Roy committed
          format: uint32
          type: integer
Michel Roy's avatar
Michel Roy committed
          x-etsi-mec-cardinality: '1'
          x-etsi-mec-origin-type: Uint32
Michel Roy's avatar
Michel Roy committed
        qosRetryCount:
          description: dot11QosRetryCount counter
Michel Roy's avatar
Michel Roy committed
          format: uint32
          type: integer
Michel Roy's avatar
Michel Roy committed
          x-etsi-mec-cardinality: '1'
          x-etsi-mec-origin-type: Uint32
Michel Roy's avatar
Michel Roy committed
        qosTransmittedFragmentCount:
          description: dot11QosTransmittedFragmentCount counter
Michel Roy's avatar
Michel Roy committed
          format: uint32
          type: integer
Michel Roy's avatar
Michel Roy committed
          x-etsi-mec-cardinality: '1'
          x-etsi-mec-origin-type: Uint32
Michel Roy's avatar
Michel Roy committed
        qosTransmittedFrameCount:
          description: dot11QosTransmittedFrameCount counter
Michel Roy's avatar
Michel Roy committed
          format: uint32
          type: integer
Michel Roy's avatar
Michel Roy committed
          x-etsi-mec-cardinality: '1'
          x-etsi-mec-origin-type: Uint32
Michel Roy's avatar
Michel Roy committed
        reportingReasonQoSCounters:
          $ref: '#/components/schemas/ReportingReasonQoSCounters'
      required:
        - qosTransmittedFragmentCount
        - qosFailedCount
        - qosRetryCount
        - qosMultipleRetryCount
        - qosFrameDuplicateCount
        - qosRTSSuccessCount
        - qosRTSFailureCount
        - qosAckFailureCount
        - qosReceivedFragmentCount
        - qosTransmittedFrameCount
        - qosDiscardedFrameCount
        - qosMPDUsReceivedCount
        - qosRetriesReceivedCount
      type: object
      x-etsi-ref: 6.5.36
    StaStatisticsGroupOneData:
      properties:
        ackFailureCount:
          description: dot11AckFailureCount counter
Michel Roy's avatar
Michel Roy committed
          format: uint32
          type: integer
Michel Roy's avatar
Michel Roy committed
          x-etsi-mec-cardinality: '1'
          x-etsi-mec-origin-type: Uint32
Michel Roy's avatar
Michel Roy committed
        frameDuplicateCount:
          description: dot11FrameDuplicateCount counter
Michel Roy's avatar
Michel Roy committed
          format: uint32
          type: integer
Michel Roy's avatar
Michel Roy committed
          x-etsi-mec-cardinality: '1'
          x-etsi-mec-origin-type: Uint32
Michel Roy's avatar
Michel Roy committed
        multipleRetryCount:
          description: dot11MultipleRetryCount counter
Michel Roy's avatar
Michel Roy committed
          format: uint32
          type: integer
Michel Roy's avatar
Michel Roy committed
          x-etsi-mec-cardinality: '1'
          x-etsi-mec-origin-type: Uint32
Michel Roy's avatar
Michel Roy committed
        reportingReasonStaCounters:
          $ref: '#/components/schemas/ReportingReasonStaCounters'
        retryCount:
          description: dot11RetryCount counter
Michel Roy's avatar
Michel Roy committed
          format: uint32
          type: integer
Michel Roy's avatar
Michel Roy committed
          x-etsi-mec-cardinality: '1'
          x-etsi-mec-origin-type: Uint32
Michel Roy's avatar
Michel Roy committed
        rtsFailureCount:
          description: dot11RTSFailureCount counter
Michel Roy's avatar
Michel Roy committed
          format: uint32
          type: integer
Michel Roy's avatar
Michel Roy committed
          x-etsi-mec-cardinality: '1'
          x-etsi-mec-origin-type: Uint32
Michel Roy's avatar
Michel Roy committed
        rtsSuccessCount:
          description: dot11RTSSuccessCount counter
Michel Roy's avatar
Michel Roy committed
          format: uint32
          type: integer
Michel Roy's avatar
Michel Roy committed
          x-etsi-mec-cardinality: '1'
          x-etsi-mec-origin-type: Uint32
Michel Roy's avatar
Michel Roy committed
      required:
        - retryCount
        - multipleRetryCount
        - frameDuplicateCount
        - rtsSuccessCount
        - rtsFailureCount
        - ackFailureCount
      type: object
      x-etsi-ref: 6.5.35
    StaStatisticsGroupZeroData:
      properties:
        failedCount:
          description: dot11FailedCount counter
Michel Roy's avatar
Michel Roy committed
          format: uint32
          type: integer
Michel Roy's avatar
Michel Roy committed
          x-etsi-mec-cardinality: '1'
          x-etsi-mec-origin-type: Uint32
Michel Roy's avatar
Michel Roy committed
        fcsErrorCount:
          description: dot11FCSErrorCount counter
Michel Roy's avatar
Michel Roy committed
          format: uint32
          type: integer
Michel Roy's avatar
Michel Roy committed
          x-etsi-mec-cardinality: '1'
          x-etsi-mec-origin-type: Uint32
Michel Roy's avatar
Michel Roy committed
        groupReceivedFrameCount:
          description: dot11GroupReceivedFrameCount counter
Michel Roy's avatar
Michel Roy committed
          format: uint32
          type: integer
Michel Roy's avatar
Michel Roy committed
          x-etsi-mec-cardinality: '1'
          x-etsi-mec-origin-type: Uint32
Michel Roy's avatar
Michel Roy committed
        groupTransmittedFrameCount:
          description: dot11GroupTransmittedFrameCount counter
Michel Roy's avatar
Michel Roy committed
          format: uint32
          type: integer
Michel Roy's avatar
Michel Roy committed
          x-etsi-mec-cardinality: '1'
          x-etsi-mec-origin-type: Uint32
Michel Roy's avatar
Michel Roy committed
        receivedFragmentCount:
          description: dot11ReceivedFragmentCount counter
Michel Roy's avatar
Michel Roy committed
          format: uint32
          type: integer
Michel Roy's avatar
Michel Roy committed
          x-etsi-mec-cardinality: '1'
          x-etsi-mec-origin-type: Uint32
Michel Roy's avatar
Michel Roy committed
        reportingReasonStaCounters:
          $ref: '#/components/schemas/ReportingReasonStaCounters'
        transmittedFragmentCount:
          description: dot11TransmittedFragmentCount counter
Michel Roy's avatar
Michel Roy committed
          format: uint32
          type: integer
Michel Roy's avatar
Michel Roy committed
          x-etsi-mec-cardinality: '1'
          x-etsi-mec-origin-type: Uint32
Michel Roy's avatar
Michel Roy committed
        transmittedFrameCount:
          description: dot11TransmittedFrameCount counter
Michel Roy's avatar
Michel Roy committed
          format: uint32
          type: integer
Michel Roy's avatar
Michel Roy committed
          x-etsi-mec-cardinality: '1'
          x-etsi-mec-origin-type: Uint32
Michel Roy's avatar
Michel Roy committed
      required:
        - transmittedFragmentCount
        - groupTransmittedFrameCount
        - failedCount
        - receivedFragmentCount
        - groupReceivedFrameCount
        - fcsErrorCount
        - transmittedFrameCount
      type: object
Michel Roy's avatar
Michel Roy committed
      x-etsi-ref: 6.5.34
    SubscriptionLinkList:
      properties:
        _links:
Michel Roy's avatar
Michel Roy committed
          description: List of hyperlinks related to the resource.
          properties:
            self:
              $ref: '#/components/schemas/LinkType'
Michel Roy's avatar
Michel Roy committed
          required:
            - self
          type: object
Michel Roy's avatar
Michel Roy committed
          x-etsi-mec-cardinality: '1'
          x-etsi-mec-origin-type: Structure (inlined)
Michel Roy's avatar
Michel Roy committed
        subscription:
          description: ''
          items:
Michel Roy's avatar
Michel Roy committed
            minItems: 0
            properties:
              href:
                description: The URI referring to the subscription.
                format: uri
                type: string
                x-etsi-mec-cardinality: '1'
                x-etsi-mec-origin-type: URI
              subscriptionType:
                description: >-
                  Type of the subscription. The string shall be set according to
                  the "subscriptionType" attribute of the associated
                  subscription data type defined in 6.3.2, 6.3.3. and 6.3.5:

                  “AssocStaSubscription”

                  “StaDataRateSubscription”

                  “MeasurementReportSubscription”
                type: string
                x-etsi-mec-cardinality: '1'
                x-etsi-mec-origin-type: String
            required:
              - href
              - subscriptionType
            type: object