WlanInformationApi.yaml 112 KB
Newer Older
          type: array
          x-etsi-mec-cardinality: 0..N
Michel Roy's avatar
Michel Roy committed
          x-etsi-mec-origin-type: Structure (inlined)
      required:
        - _links
      type: object
      x-etsi-ref: 6.3.4
    TestNotification:
      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)
        notificationType:
          description: Shall be set to "TestNotification".
          type: string
          x-etsi-mec-cardinality: '1'
          x-etsi-mec-origin-type: String
      required:
Michel Roy's avatar
Michel Roy committed
        - notificationType
        - _links
      type: object
Michel Roy's avatar
Michel Roy committed
      x-etsi-ref: 6.4.6
    TimeStamp:
      properties:
        nanoSeconds:
Michel Roy's avatar
Michel Roy committed
          description: >-
            The nanoseconds part of the time. Time is defined as Unix-time since
            January 1, 1970, 00:00:00 UTC.
Michel Roy's avatar
Michel Roy committed
          format: uint32
          type: integer
          x-etsi-mec-cardinality: '1'
          x-etsi-mec-origin-type: Uint32
        seconds:
Michel Roy's avatar
Michel Roy committed
          description: >-
            The seconds part of the time. Time is defined as Unixtime since
            January 1, 1970, 00:00:00 UTC.
Michel Roy's avatar
Michel Roy committed
          format: uint32
          type: integer
          x-etsi-mec-cardinality: '1'
          x-etsi-mec-origin-type: Uint32
      required:
Michel Roy's avatar
Michel Roy committed
        - seconds
        - nanoSeconds
      type: object
      x-etsi-ref: 6.5.2
    VhtCapabilities:
      properties:
        vhtCapInfo:
Michel Roy's avatar
Michel Roy committed
          description: 'VHT capabilities Info 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
        vhtMcsNss:
Michel Roy's avatar
Michel Roy committed
          description: 'Supported VHT-MCS and NSS Set as defined in IEEE 802.11-2016 [8].'
          format: uint64
          type: integer
          x-etsi-mec-cardinality: '1'
          x-etsi-mec-origin-type: UInt64
      required:
Michel Roy's avatar
Michel Roy committed
        - vhtCapInfo
        - vhtMcsNss
      type: object
      x-etsi-ref: 6.5.15
    WanMetrics:
      properties:
        downlinkLoad:
Michel Roy's avatar
Michel Roy committed
          description: "1-octet positive integer representing the current percentage loading of the downlink WAN connection, scaled linearly with 255 representing 100\_%, as measured over an interval the duration of which is reported in Load Measurement Duration. In cases where the downlink load is unknown to the AP, the value is set to zero."
Michel Roy's avatar
Michel Roy committed
          format: uint8
          type: integer
          x-etsi-mec-cardinality: '1'
          x-etsi-mec-origin-type: UInt8
        downlinkSpeed:
Michel Roy's avatar
Michel Roy committed
          description: >-
            4-octet positive integer whose value is an estimate of the WAN
            Backhaul link current downlink speed in kilobits per second.
Michel Roy's avatar
Michel Roy committed
          format: uint32
          type: integer
          x-etsi-mec-cardinality: '1'
          x-etsi-mec-origin-type: Uint32
        lmd:
Michel Roy's avatar
Michel Roy committed
          description: >-
            The LMD (Load Measurement Duration) field is a 2-octet positive
            integer representing the duration over which the Downlink Load and
            Uplink Load have been measured, in tenths of a second. When the
            actual load measurement duration is greater than the maximum value,
            the maximum value will be reported. The value of the LMD field is
            set to 0 when neither the uplink nor downlink load can be computed.
            When the uplink and downlink loads are computed over different
            intervals, the maximum interval is reported.
Michel Roy's avatar
Michel Roy committed
          format: uint16
          type: integer
          x-etsi-mec-cardinality: '1'
          x-etsi-mec-origin-type: Uint16
        uplinkLoad:
Michel Roy's avatar
Michel Roy committed
          description: "1-octet positive integer representing the current percentage loading of the uplink WAN connection, scaled linearly with 255 representing 100\_%, as measured over an interval, the duration of which is reported in Load Measurement Duration. In cases where the uplink load is unknown to the AP, the value is set to zero."
Michel Roy's avatar
Michel Roy committed
          format: uint8
          type: integer
          x-etsi-mec-cardinality: '1'
          x-etsi-mec-origin-type: Uint8
        uplinkSpeed:
Michel Roy's avatar
Michel Roy committed
          description: >-
            4-octet positive integer whose value is an estimate of the WAN
            Backhaul link's current uplink speed in kilobits per second.
Michel Roy's avatar
Michel Roy committed
          format: uint32
          type: integer
          x-etsi-mec-cardinality: '1'
          x-etsi-mec-origin-type: UInt32
        wanInfo:
Michel Roy's avatar
Michel Roy committed
          description: >-
            Info about WAN link status, link symmetricity and capacity currently
            used.
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
        - wanInfo
        - downlinkSpeed
        - uplinkSpeed
        - downlinkLoad
        - uplinkLoad
        - lmd
      type: object
      x-etsi-ref: 6.5.6
Michel Roy's avatar
Michel Roy committed
    WebsockNotifConfig:
      properties:
        requestWebsocketUri:
          description: >-
            Set to true by the service consumer to indicate that Websocket
            delivery is requested.
          type: boolean
          x-etsi-mec-cardinality: 0..1
          x-etsi-mec-origin-type: Boolean
        websocketUri:
          description: >-
            Set by WAIS to indicate to the service consumer the
            Websocket URI to be used for delivering notifications.
          type: string
      type: object
      x-etsi-ref: 6.3.6
    WlanCapabilities:
      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'
      type: object
      x-etsi-ref: 6.5.4