WlanInformationApi.yaml 113 KB
Newer Older
      - type: object
        properties:
          beaconReport:
            type: array
            items:
              $ref: '#/components/schemas/BeaconReport'
            description: Beacon Report as defined in IEEE 802.11-2016.
          channelLoad:
            type: array
            items:
              $ref: '#/components/schemas/ChannelLoad'
            description: Channel Load reports as seen by the station as defined in IEEE 802.11-2016.
          neighborReport:
            type: array
            items:
              $ref: '#/components/schemas/NeighborReport'
            description: Neighbor Report providing information about neighbor Access Points seen by the station as defined in IEEE 802.112016.
          staStatistics:
            type: array
            items:
              $ref: '#/components/schemas/StaStatistics'
            description: STA Statistics Report as defined in IEEE 802.11-2016.
          timeStamp:
            $ref: '#/components/schemas/TimeStamp'
Michel Roy's avatar
Michel Roy committed
    MeasurementReportSubscription:
      title: MeasurementReportSubscription
      allOf:
      - $ref: '#/components/schemas/InlineSubscription'
      - required:
Michel Roy's avatar
Michel Roy committed
        - measurementId
        - measurementInfo
        - staId
        type: object
        properties:
          _links:
            $ref: '#/components/schemas/Links'
          callbackReference:
            type: string
            description: URI exposed by the client on which to receive notifications via HTTP. At least one of callbackReference and websockNotifConfig shall be provided by the service consumer. If both are provided, it is up to WAIS to select an alternative and return only that alternative in the response, as specified in ETSI GS MEC 009, clause 6.12a.
          expiryDeadline:
            $ref: '#/components/schemas/TimeStamp'
          measurementId:
            type: string
            description: Unique identifier allocated by the service consumer to identify measurement reports associated with this measurement subscription.
          measurementInfo:
            $ref: '#/components/schemas/MeasurementInfo'
          requestTestNotification:
            type: boolean
            description: Set to TRUE by the service consumer to request a test notification via HTTP on the callbackReference URI, as specified in ETSI GS MEC 009, clause 6.12a.
          staId:
            type: array
            items:
              $ref: '#/components/schemas/StaIdentity'
            description: Identifier(s) to uniquely specify the target client station(s) for the subscription.
          websockNotifConfig:
            $ref: '#/components/schemas/WebsockNotifConfig'
            description: Provides details to negotiate and signal the use of a Websocket connection between the WAIS and the service consumer for notifications. At least one of callbackReference and websockNotifConfig shall be provided by the service consumer. If both are provided, it is up to WAIS to select an alternative and return only that alternative in the response, as specified in ETSI GS MEC 009, clause 6.12a.
Michel Roy's avatar
Michel Roy committed
    NeighborReport:
      title: NeighborReport
      required:
      - bssid
      - bssidInfo
      - channel
      - measurementId
      - operatingClass
      - phyType
      type: object
      properties:
Michel Roy's avatar
Michel Roy committed
        bssTransitionCandidatePreference:
          type: integer
          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.
          contentEncoding: int32
Michel Roy's avatar
Michel Roy committed
        bssid:
          type: string
          description: BSSID (MAC address) of the Access Point that is being reported.
Michel Roy's avatar
Michel Roy committed
        bssidInfo:
          $ref: '#/components/schemas/BssidInfo'
        channel:
          type: integer
          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.
          contentEncoding: int32
Michel Roy's avatar
Michel Roy committed
        measurementId:
          type: string
          description: Measurement ID of the Measurement configuration applied to this Neighbor Report.
Michel Roy's avatar
Michel Roy committed
        operatingClass:
          type: integer
          description: Operating Class field indicates an operating class value as defined in Annex E within IEEE 802.11-2016.
          contentEncoding: int32
Michel Roy's avatar
Michel Roy committed
        phyType:
          type: integer
          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.
        staId:
          $ref: '#/components/schemas/StaIdentity'
Michel Roy's avatar
Michel Roy committed
    NeighborReportConfig:
      title: NeighborReportConfig
      type: object
      properties:
Michel Roy's avatar
Michel Roy committed
        bssid:
          type: string
          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.
Michel Roy's avatar
Michel Roy committed
        ssid:
          type: string
          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.
Michel Roy's avatar
Michel Roy committed
    OBssLoad:
      title: OBssLoad
      required:
      - allocatedTrafficSelfMean
      - allocatedTrafficShareMean
      type: object
Michel Roy's avatar
Michel Roy committed
      properties:
        allocatedTrafficSelfMean:
          type: integer
          description: Mean of allocated traffic from this AP (BSS) in units of 32 µs per second.
          contentEncoding: int32
Michel Roy's avatar
Michel Roy committed
        allocatedTrafficSelfStdDev:
          type: integer
          description: Standard deviation from the mean of allocation traffic from this BSS in units of 32 µs per second.
          contentEncoding: int32
Michel Roy's avatar
Michel Roy committed
        allocatedTrafficShareMean:
          type: integer
          description: Mean of the sum of allocated traffic from other APs on the overlapping channel in unit of 32 µs per second.
          contentEncoding: int32
Michel Roy's avatar
Michel Roy committed
        allocatedTrafficShareStdDev:
          type: integer
          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.
          contentEncoding: int32
Michel Roy's avatar
Michel Roy committed
        overlap:
          type: integer
          description: Indicates the number of other APs that are sharing the same channel as the reporting AP.
          contentEncoding: int32
Michel Roy's avatar
Michel Roy committed
    ProblemDetails:
      title: ProblemDetails
      type: object
Michel Roy's avatar
Michel Roy committed
      properties:
        detail:
          type: string
          description: A human-readable explanation specific to this occurrence of the problem
Michel Roy's avatar
Michel Roy committed
        instance:
          type: string
          description: A URI reference that identifies the specific occurrence of the problem
Michel Roy's avatar
Michel Roy committed
        status:
          type: integer
          description: The HTTP status code for this occurrence of the problem
          contentEncoding: int32
Michel Roy's avatar
Michel Roy committed
        title:
          type: string
          description: A short, human-readable summary of the problem type
Michel Roy's avatar
Michel Roy committed
        type:
          type: string
          description: A URI reference according to IETF RFC 3986 that identifies the problem type
Michel Roy's avatar
Michel Roy committed
    ReportedBeaconFrameInfo:
      title: ReportedBeaconFrameInfo
      required:
      - frameType
      - phyType
      type: object
Michel Roy's avatar
Michel Roy committed
      properties:
        frameType:
          type: integer
          description: >-
Michel Roy's avatar
Michel Roy committed
            A value of 0 indicates a Beacon or Probe Response.
Michel Roy's avatar
Michel Roy committed
            A value of 1 indicates a Measurement Pilot frame.
          contentEncoding: int32
Michel Roy's avatar
Michel Roy committed
        phyType:
          type: integer
          description: Value between 0 and 127 coded according to dot11PHYType.
          contentEncoding: int32
    ReportingReasonQoSCounters:
      title: ReportingReasonQoSCounters
Michel Roy's avatar
Michel Roy committed
      required:
      - qosAckFailure
      - qosDiscarded
      - qosFailed
      - qosFrameDuplicate
      - qosMultipleRetry
      - qosRetry
      - qosRtsFailure
Michel Roy's avatar
Michel Roy committed
      type: object
      properties:
        qosAckFailure:
          type: boolean
          description: dot11QoSAckFailure
Michel Roy's avatar
Michel Roy committed
        qosDiscarded:
          type: boolean
          description: dot11QoSDiscarded
Michel Roy's avatar
Michel Roy committed
        qosFailed:
          type: boolean
          description: dot11QoSFailed
Michel Roy's avatar
Michel Roy committed
        qosFrameDuplicate:
          type: boolean
          description: dot11QoSFrameDuplicate
Michel Roy's avatar
Michel Roy committed
        qosMultipleRetry:
          type: boolean
          description: dot11QoSMultipleRetry
Michel Roy's avatar
Michel Roy committed
        qosRetry:
          type: boolean
          description: dot11QoSRetry
Michel Roy's avatar
Michel Roy committed
        qosRtsFailure:
          type: boolean
          description: dot11QoSRTSFailure
    ReportingReasonStaCounters:
      title: ReportingReasonStaCounters
Michel Roy's avatar
Michel Roy committed
      required:
      - ackFailure
      - failed
      - fcsError
      - frameDuplicate
      - multipleRetry
      - retry
      - rtsFailure
Michel Roy's avatar
Michel Roy committed
      type: object
      properties:
        ackFailure:
          type: boolean
          description: dot11AckFailure
Michel Roy's avatar
Michel Roy committed
        failed:
          type: boolean
          description: dot11Failed
Michel Roy's avatar
Michel Roy committed
        fcsError:
          type: boolean
          description: dot11FCSError
Michel Roy's avatar
Michel Roy committed
        frameDuplicate:
          type: boolean
          description: dot11FrameDuplicate
Michel Roy's avatar
Michel Roy committed
        multipleRetry:
          type: boolean
          description: dot11MultipleRetry
Michel Roy's avatar
Michel Roy committed
        retry:
          type: boolean
          description: dot11Retry
Michel Roy's avatar
Michel Roy committed
        rtsFailure:
          type: boolean
          description: dot11RTSFailure
Michel Roy's avatar
Michel Roy committed
    Rssi:
      title: Rssi
      required:
      - rssi
      type: object
Michel Roy's avatar
Michel Roy committed
      properties:
        rssi:
          type: integer
          description: The Received Signal Strength Indicator from a station
          contentEncoding: int32
Michel Roy's avatar
Michel Roy committed
    STACounterTriggerCondition:
      title: STACounterTriggerCondition
      type: object
Michel Roy's avatar
Michel Roy committed
      properties:
        ackFailureCountThreshold:
          type: integer
          description: Configure and set threshold for dot11AckFailureCount trigger
          contentEncoding: int32
Michel Roy's avatar
Michel Roy committed
        failedCountThreshold:
          type: integer
          description: Configure and set threshold for dot11FailedCount trigger
          contentEncoding: int32
Michel Roy's avatar
Michel Roy committed
        fcsErrorCountThreshold:
          type: integer
          description: Configure and set threshold for dot11FCSErrorCount trigger
          contentEncoding: int32
Michel Roy's avatar
Michel Roy committed
        frameDuplicateCountThreshold:
          type: integer
          description: Configure and set threshold for dot11FrameDuplicateCount trigger
          contentEncoding: int32
Michel Roy's avatar
Michel Roy committed
        multipleRetryCountThreshold:
          type: integer
          description: Configure and set threshold for dot11MultipleRetryCount trigger
          contentEncoding: int32
Michel Roy's avatar
Michel Roy committed
        retryCountThreshold:
          type: integer
          description: Configure and set threshold for dot11RetryCount trigger
          contentEncoding: int32
Michel Roy's avatar
Michel Roy committed
        rtsFailureCountThreshold:
          type: integer
          description: Configure and set threshold for dot11RTSFailureCount trigger
          contentEncoding: int32
Michel Roy's avatar
Michel Roy committed
    StaDataRate:
      title: StaDataRate
      type: object
Michel Roy's avatar
Michel Roy committed
      properties:
        staId:
          $ref: '#/components/schemas/StaIdentity'
        staLastDataDownlinkRate:
          type: integer
          description: The data transmit rate in kbps that was most recently used for transmission of data PPDUs from the access point to the station.
          contentEncoding: int32
Michel Roy's avatar
Michel Roy committed
        staLastDataUplinkRate:
          type: integer
          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.
          contentEncoding: int32
Michel Roy's avatar
Michel Roy committed
    StaDataRateNotification:
      title: StaDataRateNotification
      allOf:
      - $ref: '#/components/schemas/InlineNotification'
      - type: object
        properties:
          staDataRate:
            type: array
            items:
              $ref: '#/components/schemas/StaDataRate'
            description: Data rates of a client station.
          timeStamp:
            $ref: '#/components/schemas/TimeStamp'
Michel Roy's avatar
Michel Roy committed
    StaDataRateSubscription:
      title: StaDataRateSubscription
      allOf:
      - $ref: '#/components/schemas/InlineSubscription'
      - required:
        - staId
        type: object
        properties:
          _links:
            $ref: '#/components/schemas/Links'
          callbackReference:
            type: string
            description: URI exposed by the client on which to receive notifications via HTTP. At least one of callbackReference and websockNotifConfig shall be provided by the service consumer. If both are provided, it is up to WAIS to select an alternative and return only that alternative in the response, as specified in ETSI GS MEC 009, clause 6.12a.
          expiryDeadline:
            $ref: '#/components/schemas/TimeStamp'
          notificationEvent:
            $ref: '#/components/schemas/NotificationEvent1'
          notificationPeriod:
            type: integer
            description: >-
              Set for periodic notification reporting.Value indicates the notification period in seconds.
            contentEncoding: int32
          requestTestNotification:
            type: boolean
            description: Set to TRUE by the service consumer to request a test notification via HTTP on the callbackReference URI, as specified in ETSI GS MEC 009, clause 6.12a.
          staId:
            type: array
            items:
              $ref: '#/components/schemas/StaIdentity'
            description: Identifier(s) to uniquely specify the target client station(s) for the subscription.
          websockNotifConfig:
            $ref: '#/components/schemas/WebsockNotifConfig'
            description: Provides details to negotiate and signal the use of a Websocket connection between the WAIS and the service consumer for notifications. At least one of callbackReference and websockNotifConfig shall be provided by the service consumer. If both are provided, it is up to WAIS to select an alternative and return only that alternative in the response, as specified in ETSI GS MEC 009, clause 6.12a
    StaIdentity:
      title: StaIdentity
Michel Roy's avatar
Michel Roy committed
      required:
Michel Roy's avatar
Michel Roy committed
      type: object
      properties:
        aid:
          type: string
          description: Number which identifies a particular association between a station and an Access Point
Michel Roy's avatar
Michel Roy committed
        ipAddress:
          type: array
          items:
            type: string
          description: IPv4 or IPv6 address(es) allocated for the station.
Michel Roy's avatar
Michel Roy committed
        macId:
          type: string
          description: Unique identifier assigned to station (as network interface controller) for communications at the data link layer of a network segment.
Michel Roy's avatar
Michel Roy committed
        ssid:
          type: array
          items:
            type: string
          description: Service Set Identifier(s) to identify logical networks.
    StaInfo:
      title: StaInfo
Michel Roy's avatar
Michel Roy committed
      required:
Michel Roy's avatar
Michel Roy committed
      type: object
      properties:
        apAssociated:
          $ref: '#/components/schemas/ApAssociated'
        beaconReport:
          type: array
          items:
            $ref: '#/components/schemas/BeaconReport'
          description: Beacon Report as defined in IEEE 802.11-2016.
Michel Roy's avatar
Michel Roy committed
        channel:
          type: integer
          description: Channel currently used by the station to connect with its associated Access Point.
          contentEncoding: int32
Michel Roy's avatar
Michel Roy committed
        channelLoad:
Michel Roy's avatar
Michel Roy committed
          items:
            $ref: '#/components/schemas/ChannelLoad'
          description: Channel Load reports as seen by the station as defined IEEE 802.11-2016. Channel Load reports may be configured for any channel, including the station's current channel for association.
        neighborReport:
Michel Roy's avatar
Michel Roy committed
          type: array
          items:
            $ref: '#/components/schemas/NeighborReport'
          description: Information about neighbor Access Points seen by the station as defined IEEE 802.11-2016.
Michel Roy's avatar
Michel Roy committed
        rssi:
          $ref: '#/components/schemas/Rssi'
        staDataRate:
          $ref: '#/components/schemas/StaDataRate'
        staId:
          $ref: '#/components/schemas/StaIdentity'
        staStatistics:
          type: array
          items:
            $ref: '#/components/schemas/StaStatistics'
          description: Statistics as defined in IEEE 802.11-2016 for the client station collected over measurement duration.
Michel Roy's avatar
Michel Roy committed
        timeStamp:
          $ref: '#/components/schemas/TimeStamp'
    StaStatistics:
      title: StaStatistics
Michel Roy's avatar
Michel Roy committed
      required:
      - groupIdentity
      - measurementDuration
      - measurementId
Michel Roy's avatar
Michel Roy committed
      type: object
      properties:
        group2to9Data:
          $ref: '#/components/schemas/StaStatisticsGroup2to9Data'
        groupIdentity:
          type: integer
          description: >-
            Indicates the requested statistics group describing the Statistics Group Data according to Table 9-114 of IEEE 802.11-2016.

            Depending on group identity, one and only one of the STA Statistics Group Data will be present.
          contentEncoding: int32
Michel Roy's avatar
Michel Roy committed
        groupOneData:
          $ref: '#/components/schemas/StaStatisticsGroupOneData'
        groupZeroData:
          $ref: '#/components/schemas/StaStatisticsGroupZeroData'
        measurementDuration:
          type: integer
          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.
          contentEncoding: int32
Michel Roy's avatar
Michel Roy committed
        measurementId:
          type: string
          description: Measurement ID of the Measurement configuration applied to this STA Statistics Report.
Michel Roy's avatar
Michel Roy committed
        staId:
          $ref: '#/components/schemas/StaIdentity'
    StaStatisticsConfig:
      title: StaStatisticsConfig
Michel Roy's avatar
Michel Roy committed
      required:
      - groupIdentity
      - triggeredReport
Michel Roy's avatar
Michel Roy committed
      type: object
      properties:
        groupIdentity:
          type: integer
          description: As per Table 9-92 of IEEE 802.11-2016.
          contentEncoding: int32
Michel Roy's avatar
Michel Roy committed
        measurementCount:
Michel Roy's avatar
Michel Roy committed
          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.
          contentEncoding: int32
Michel Roy's avatar
Michel Roy committed
        triggerCondition:
          $ref: '#/components/schemas/STACounterTriggerCondition'
        triggerTimeout:
Michel Roy's avatar
Michel Roy committed
          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.
          contentEncoding: int32
Michel Roy's avatar
Michel Roy committed
        triggeredReport:
          type: boolean
          description: True = triggered reporting, otherwise duration.
    StaStatisticsGroup2to9Data:
      title: StaStatisticsGroup2to9Data
Michel Roy's avatar
Michel Roy committed
      required:
      - qosAckFailureCount
      - qosDiscardedFrameCount
      - qosFailedCount
      - qosFrameDuplicateCount
      - qosMPDUsReceivedCount
      - qosMultipleRetryCount
      - qosRTSFailureCount
      - qosRTSSuccessCount
      - qosReceivedFragmentCount
      - qosRetriesReceivedCount
      - qosRetryCount
      - qosTransmittedFragmentCount
      - qosTransmittedFrameCount
Michel Roy's avatar
Michel Roy committed
      type: object
      properties:
        qosAckFailureCount:
          type: integer
          description: dot11QosAckFailureCount counter
          contentEncoding: int32
Michel Roy's avatar
Michel Roy committed
        qosDiscardedFrameCount:
          type: integer
          description: dot11QosDiscardedFrameCount counter
          contentEncoding: int32
Michel Roy's avatar
Michel Roy committed
        qosFailedCount:
          type: integer
          description: dot11QosFailedCount counter
          contentEncoding: int32
Michel Roy's avatar
Michel Roy committed
        qosFrameDuplicateCount:
          type: integer
          description: dot11QosFrameDuplicateCount counter
          contentEncoding: int32
Michel Roy's avatar
Michel Roy committed
        qosMPDUsReceivedCount:
          type: integer
          description: dot11QosMPDUsReceivedCount counter
          contentEncoding: int32
Michel Roy's avatar
Michel Roy committed
        qosMultipleRetryCount:
          type: integer
          description: dot11QosMultipleRetryCount counter
          contentEncoding: int32
Michel Roy's avatar
Michel Roy committed
        qosRTSFailureCount:
          type: integer
          description: dot11QosRTSFailureCount counter
          contentEncoding: int32
Michel Roy's avatar
Michel Roy committed
        qosRTSSuccessCount:
          type: integer
          description: dot11QosRTSSuccessCount counter
          contentEncoding: int32
Michel Roy's avatar
Michel Roy committed
        qosReceivedFragmentCount:
          type: integer
          description: dot11QosReceivedFragmentCount counter
          contentEncoding: int32
Michel Roy's avatar
Michel Roy committed
        qosRetriesReceivedCount:
          type: integer
          description: dot11QosRetriesReceivedCount counter
          contentEncoding: int32
Michel Roy's avatar
Michel Roy committed
        qosRetryCount:
          type: integer
          description: dot11QosRetryCount counter
          contentEncoding: int32
Michel Roy's avatar
Michel Roy committed
        qosTransmittedFragmentCount:
          type: integer
          description: dot11QosTransmittedFragmentCount counter
          contentEncoding: int32
Michel Roy's avatar
Michel Roy committed
        qosTransmittedFrameCount:
          type: integer
          description: dot11QosTransmittedFrameCount counter
          contentEncoding: int32
Michel Roy's avatar
Michel Roy committed
        reportingReasonQoSCounters:
          $ref: '#/components/schemas/ReportingReasonQoSCounters'
    StaStatisticsGroupOneData:
      title: StaStatisticsGroupOneData
Michel Roy's avatar
Michel Roy committed
      required:
      - ackFailureCount
      - frameDuplicateCount
      - multipleRetryCount
      - retryCount
      - rtsFailureCount
      - rtsSuccessCount
Michel Roy's avatar
Michel Roy committed
      type: object
      properties:
        ackFailureCount:
          type: integer
          description: dot11AckFailureCount counter
          contentEncoding: int32
Michel Roy's avatar
Michel Roy committed
        frameDuplicateCount:
          type: integer
          description: dot11FrameDuplicateCount counter
          contentEncoding: int32
Michel Roy's avatar
Michel Roy committed
        multipleRetryCount:
          type: integer
          description: dot11MultipleRetryCount counter
          contentEncoding: int32
Michel Roy's avatar
Michel Roy committed
        reportingReasonStaCounters:
          $ref: '#/components/schemas/ReportingReasonStaCounters'
        retryCount:
          type: integer
          description: dot11RetryCount counter
          contentEncoding: int32
Michel Roy's avatar
Michel Roy committed
        rtsFailureCount:
          type: integer
          description: dot11RTSFailureCount counter
          contentEncoding: int32
Michel Roy's avatar
Michel Roy committed
        rtsSuccessCount:
          type: integer
          description: dot11RTSSuccessCount counter
          contentEncoding: int32
    StaStatisticsGroupZeroData:
      title: StaStatisticsGroupZeroData
Michel Roy's avatar
Michel Roy committed
      required:
      - failedCount
      - fcsErrorCount
      - groupReceivedFrameCount
      - groupTransmittedFrameCount
      - receivedFragmentCount
      - transmittedFragmentCount
      - transmittedFrameCount
Michel Roy's avatar
Michel Roy committed
      type: object
      properties:
        failedCount:
          type: integer
          description: dot11FailedCount counter
          contentEncoding: int32
Michel Roy's avatar
Michel Roy committed
        fcsErrorCount:
          type: integer
          description: dot11FCSErrorCount counter
          contentEncoding: int32
Michel Roy's avatar
Michel Roy committed
        groupReceivedFrameCount:
          type: integer
          description: dot11GroupReceivedFrameCount counter
          contentEncoding: int32
Michel Roy's avatar
Michel Roy committed
        groupTransmittedFrameCount:
          type: integer
          description: dot11GroupTransmittedFrameCount counter
          contentEncoding: int32
Michel Roy's avatar
Michel Roy committed
        receivedFragmentCount:
          type: integer
          description: dot11ReceivedFragmentCount counter
          contentEncoding: int32
Michel Roy's avatar
Michel Roy committed
        reportingReasonStaCounters:
          $ref: '#/components/schemas/ReportingReasonStaCounters'
        transmittedFragmentCount:
          type: integer
          description: dot11TransmittedFragmentCount counter
          contentEncoding: int32
Michel Roy's avatar
Michel Roy committed
        transmittedFrameCount:
          type: integer
          description: dot11TransmittedFrameCount counter
          contentEncoding: int32
    SubscriptionLinkList:
      title: SubscriptionLinkList
Michel Roy's avatar
Michel Roy committed
      required:
      type: object
      properties:
        _links:
          $ref: '#/components/schemas/Links6'
Michel Roy's avatar
Michel Roy committed
        subscription:
          type: array
          items:
            $ref: '#/components/schemas/Subscription'
          description: ''
    TestNotification:
      title: TestNotification
Michel Roy's avatar
Michel Roy committed
      required:
      - _links
      - notificationType
Michel Roy's avatar
Michel Roy committed
      type: object
      properties:
        _links:
          $ref: '#/components/schemas/Links1'
Michel Roy's avatar
Michel Roy committed
        notificationType:
          type: string
          description: Shall be set to "TestNotification".
    TimeStamp:
      title: TimeStamp
      required:
      - nanoSeconds
      - seconds
      type: object
      properties:
        nanoSeconds:
          type: integer
          description: The nanoseconds part of the time. Time is defined as Unix-time since January 1, 1970, 00:00:00 UTC.
          contentEncoding: int32
        seconds:
          type: integer
          description: The seconds part of the time. Time is defined as Unixtime since January 1, 1970, 00:00:00 UTC.
          contentEncoding: int32
    VhtCapabilities:
      title: VhtCapabilities
      required:
      - vhtCapInfo
      - vhtMcsNss
      type: object
      properties:
        vhtCapInfo:
          type: integer
          description: VHT capabilities Info as defined in IEEE 802.11-2016.
          contentEncoding: int32
        vhtMcsNss:
          type: integer
          description: Supported VHT-MCS and NSS Set as defined in IEEE 802.11-2016.
          contentEncoding: int32
    WanMetrics:
      title: WanMetrics
      required:
      - downlinkLoad
      - downlinkSpeed
      - lmd
      - uplinkLoad
      - uplinkSpeed
      - wanInfo
      type: object
      properties:
        downlinkLoad:
          type: integer
          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.
          contentEncoding: int32
        downlinkSpeed:
          type: integer
          description: 4-octet positive integer whose value is an estimate of the WAN Backhaul link current downlink speed in kilobits per second.
          contentEncoding: int32
          type: integer
          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.
          contentEncoding: int32
        uplinkLoad:
          type: integer
          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.
          contentEncoding: int32
        uplinkSpeed:
          type: integer
          description: 4-octet positive integer whose value is an estimate of the WAN Backhaul link's current uplink speed in kilobits per second.
          contentEncoding: int32
        wanInfo:
          type: integer
          description: Info about WAN link status, link symmetricity and capacity currently used.
          contentEncoding: int32
Michel Roy's avatar
Michel Roy committed
    WebsockNotifConfig:
      title: WebsockNotifConfig
      type: object
Michel Roy's avatar
Michel Roy committed
      properties:
        requestWebsocketUri:
          type: boolean
          description: Set to true by the service consumer to indicate that Websocket delivery is requested.
Michel Roy's avatar
Michel Roy committed
        websocketUri:
          type: string
          description: Set by WAIS to indicate to the service consumer the Websocket URI to be used for delivering notifications.
    WlanCapabilities:
      title: WlanCapabilities
      type: object
      properties:
        dmg:
          $ref: '#/components/schemas/DmgCapabilities'
        edmg:
          $ref: '#/components/schemas/EdmgCapabilities'
        he:
          $ref: '#/components/schemas/HeCapabilities'
        ht:
          $ref: '#/components/schemas/HtCapabilities'
        vht:
          $ref: '#/components/schemas/VhtCapabilities'
    InlineNotification:
      title: InlineNotification
      required:
      - notificationType
      type: object
      properties:
        notificationType:
          type: string
      discriminator:
        propertyName: notificationType
        mapping:
piscione's avatar
piscione committed
          AssocStaNotification: '#/components/schemas/AssocStaNotification'
          MeasurementReportNotification: '#/components/schemas/MeasurementReportNotification'
          StaDataRateNotification: '#/components/schemas/StaDataRateNotification'
    InlineSubscription:
      title: InlineSubscription
      required:
      - subscriptionType
      type: object
      properties:
        subscriptionType:
          type: string
      discriminator:
        propertyName: subscriptionType
        mapping:
piscione's avatar
piscione committed
          AssocStaNotification: '#/components/schemas/AssocStaNotification'
          MeasurementReportNotification: '#/components/schemas/MeasurementReportNotification'
          StaDataRateNotification: '#/components/schemas/StaDataRateNotification'
    Links:
      title: Links
      required:
      - self
      type: object
      properties:
        self:
          $ref: '#/components/schemas/LinkType'
      description: Hyperlink related to the resource. This shall be only included in the HTTP responses and in HTTP PUT requests.
    Links1:
      title: Links1
      required:
      - subscription
      type: object
      properties:
        subscription:
          $ref: '#/components/schemas/LinkType'
      description: Hyperlink related to the resource.
    Links4:
      title: Links4
      required:
      - self
      type: object
      properties:
        self:
          $ref: '#/components/schemas/LinkType'
      description: Hyperlink related to the resource.
    Links6:
      title: Links6
      required:
      - self
      type: object
      properties:
        self:
          $ref: '#/components/schemas/LinkType'
      description: List of hyperlinks related to the resource.
    MeasurementConfig1:
      title: MeasurementConfig1
      required:
      - href
      - measurementId
      type: object
      properties:
        href:
          type: string
          description: The URI referring to a measurement configuration.
        measurementId:
          type: string
          description: Unique identifier allocated by the service consumer to identify measurement reports associated with this measurement configuration.
    NotificationEvent:
      title: NotificationEvent
      required:
      - threshold
      - trigger
      type: object
      properties:
        threshold:
          type: integer
          description: Number of connected stations threshold for trigger-based event reporting.
          contentEncoding: int32
        trigger:
          $ref: '#/components/schemas/Trigger'
      description: Set for trigger-based event notification reporting.
    NotificationEvent1:
      title: NotificationEvent1
      required:
      - trigger
      type: object
      properties:
        downlinkRateThreshold:
          type: integer
          description: Downlink data rate threshold for StaDataRate reporting.
          contentEncoding: int32
        trigger:
          $ref: '#/components/schemas/Trigger1'
        uplinkRateThreshold:
          type: integer
          description: Uplink data rate threshold for StaDataRate reporting.
          contentEncoding: int32
      description: Set for trigger-based event notification reporting.
    Subscription:
      title: Subscription
      required:
      - href
      - subscriptionType
      type: object
      properties:
        href:
          type: string
          description: The URI referring to the subscription.
        subscriptionType:
          type: string
          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”
    Trigger:
      title: Trigger
      enum:
      - 1
      - 2
      type: integer
      description: >-
        Trigger for the notification:

        1 = Notification issued when the number of connected stations is greater than or equal to the threshold.

        2 = Notification issued when the number of connected stations is less than or equal to the threshold.
      examples:
      - 1
    Trigger1:
      title: Trigger1
      enum:
      - 1
      - 2
      - 3
      - 4
      - 5
      - 6
      - 7
      - 8
      type: integer
      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.
      examples:
      - 1
security:
- {}