WlanInformationApi.json 135 KB
Newer Older
Michel Roy's avatar
Michel Roy committed
          "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"
      },
Michel Roy's avatar
Michel Roy committed
      "ExtBssLoad": {
        "properties": {
          "muMimoStaCount": {
            "description": "Indicates the total number of STAs currently associated with this BSS that have a 1 in the MU Beamformee Capable field of their VHT Capabilities element.",
Michel Roy's avatar
Michel Roy committed
            "format": "uint16",
Michel Roy's avatar
Michel Roy committed
            "type": "integer",
Michel Roy's avatar
Michel Roy committed
            "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",
Michel Roy's avatar
Michel Roy committed
            "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",
Michel Roy's avatar
Michel Roy committed
            "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",
Michel Roy's avatar
Michel Roy committed
            "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",
Michel Roy's avatar
Michel Roy committed
            "type": "integer",
Michel Roy's avatar
Michel Roy committed
            "x-etsi-mec-cardinality": "1",
            "x-etsi-mec-origin-type": "UInt8"
          }
        },
        "required": [
          "muMimoStaCount",
          "spatStreamUnderUtil",
          "obsSec20MhzUtil",
          "obsSec40MhzUtil",
          "obsSec80MhzUtil"
        ],
        "type": "object",
        "x-etsi-ref": "6.5.8"
      },
      "GeoLocation": {
        "properties": {
          "altitude": {
            "description": "The altitude value of location as defined in IETF RFC 6225 [6]",
Michel Roy's avatar
Michel Roy committed
            "format": "uint32",
Michel Roy's avatar
Michel Roy committed
            "type": "integer",
Michel Roy's avatar
Michel Roy committed
            "x-etsi-mec-cardinality": "0..1",
            "x-etsi-mec-origin-type": "Uint32"
          },
          "altitudeType": {
            "description": "The type description for altitude information e.g. floors or meters as defined in IETF RFC 6225 [6]",
Michel Roy's avatar
Michel Roy committed
            "format": "uint8",
Michel Roy's avatar
Michel Roy committed
            "type": "integer",
            "x-etsi-mec-cardinality": "0..1",
            "x-etsi-mec-origin-type": "Uint8"
          },
          "altitudeUncertainty": {
            "description": "The uncertainty for altitude information as defined in IETF RFC 6225 [6]",
Michel Roy's avatar
Michel Roy committed
            "format": "uint8",
Michel Roy's avatar
Michel Roy committed
            "type": "integer",
            "x-etsi-mec-cardinality": "0..1",
            "x-etsi-mec-origin-type": "Uint8"
          },
          "datum": {
            "description": "The datum value to express how coordinates are organized and related to real world as defined in IETF RFC 6225 [6]",
Michel Roy's avatar
Michel Roy committed
            "format": "uint8",
Michel Roy's avatar
Michel Roy committed
            "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",
Michel Roy's avatar
Michel Roy committed
            "type": "integer",
Michel Roy's avatar
Michel Roy committed
            "x-etsi-mec-cardinality": "1",
            "x-etsi-mec-origin-type": "Uint64"
          },
          "latUncertainty": {
            "description": "The uncertainty for Latitude information as defined in IETF RFC 6225 [6]",
Michel Roy's avatar
Michel Roy committed
            "format": "uint8",
Michel Roy's avatar
Michel Roy committed
            "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",
Michel Roy's avatar
Michel Roy committed
            "type": "integer",
Michel Roy's avatar
Michel Roy committed
            "x-etsi-mec-cardinality": "1",
            "x-etsi-mec-origin-type": "Uint64"
          },
          "longUncertainty": {
            "description": "The uncertainty for Longitude information as defined in IETF RFC 6225 [6]",
Michel Roy's avatar
Michel Roy committed
            "format": "uint8",
Michel Roy's avatar
Michel Roy committed
            "type": "integer",
            "x-etsi-mec-cardinality": "1",
            "x-etsi-mec-origin-type": "Uint8"
          }
        },
        "required": [
          "latUncertainty",
          "lat",
          "longUncertainty",
          "long",
          "datum"
        ],
        "type": "object",
        "x-etsi-ref": "6.5.19"
      },
      "HeCapabilities": {
        "properties": {
          "heMacCapInfo": {
            "description": "MAC capabilities of an Access Point.",
Michel Roy's avatar
Michel Roy committed
            "format": "uint8",
Michel Roy's avatar
Michel Roy committed
            "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",
Michel Roy's avatar
Michel Roy committed
            "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",
Michel Roy's avatar
Michel Roy committed
            "type": "integer",
            "x-etsi-mec-cardinality": "1",
            "x-etsi-mec-origin-type": "Uint8"
          }
        },
        "required": [
          "heMacCapInfo",
          "hePhyCapinfo",
          "supportedHeMcsNssSet"
        ],
        "type": "object",
        "x-etsi-ref": "6.5.16"
      },
      "HtCapabilities": {
        "properties": {
          "ampduParameters": {
            "description": "A-MPDU parameters as defined in IEEE 802.11-2016 [8].",
Michel Roy's avatar
Michel Roy committed
            "format": "uint8",
Michel Roy's avatar
Michel Roy committed
            "type": "integer",
Michel Roy's avatar
Michel Roy committed
            "x-etsi-mec-cardinality": "1",
            "x-etsi-mec-origin-type": "UInt8"
          },
          "aselCap": {
            "description": "ASEL capabilities as defined in IEEE 802.11-2016 [8].",
Michel Roy's avatar
Michel Roy committed
            "format": "uint8",
Michel Roy's avatar
Michel Roy committed
            "type": "integer",
Michel Roy's avatar
Michel Roy committed
            "x-etsi-mec-cardinality": "1",
            "x-etsi-mec-origin-type": "UInt8"
          },
          "htCapabilityInfo": {
            "description": "HT Capability Information as defined in IEEE 802.11-2016 [8].",
Michel Roy's avatar
Michel Roy committed
            "format": "uint16",
Michel Roy's avatar
Michel Roy committed
            "type": "integer",
Michel Roy's avatar
Michel Roy committed
            "x-etsi-mec-cardinality": "1",
            "x-etsi-mec-origin-type": "UInt16"
          },
          "htExtendedCap": {
            "description": "Extended HT Capabilities as defined in IEEE 802.11-2016 [8].",
Michel Roy's avatar
Michel Roy committed
            "format": "uint16",
Michel Roy's avatar
Michel Roy committed
            "type": "integer",
Michel Roy's avatar
Michel Roy committed
            "x-etsi-mec-cardinality": "1",
            "x-etsi-mec-origin-type": "UInt16"
          },
          "supportedMcsSet": {
            "description": "Supported MCS set as defined in IEEE 802.11-2016 [8].",
Michel Roy's avatar
Michel Roy committed
            "format": "uint128",
Michel Roy's avatar
Michel Roy committed
            "type": "integer",
Michel Roy's avatar
Michel Roy committed
            "x-etsi-mec-cardinality": "1",
            "x-etsi-mec-origin-type": "Uint128"
          },
          "txBeamFormCap": {
            "description": "Transmit Beamforming Capabilities as defined in IEEE 802.11-2016 [8].",
Michel Roy's avatar
Michel Roy committed
            "format": "uint32",
Michel Roy's avatar
Michel Roy committed
            "type": "integer",
Michel Roy's avatar
Michel Roy committed
            "x-etsi-mec-cardinality": "1",
            "x-etsi-mec-origin-type": "UInt32"
          }
        },
        "required": [
          "htCapabilityInfo",
          "ampduParameters",
          "supportedMcsSet",
          "htExtendedCap",
          "txBeamFormCap",
          "aselCap"
        ],
        "type": "object",
Michel Roy's avatar
Michel Roy committed
        "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"
Michel Roy's avatar
Michel Roy committed
        ]
      },
      "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"
Michel Roy's avatar
Michel Roy committed
        ]
Michel Roy's avatar
Michel Roy committed
      },
      "LinkType": {
        "properties": {
          "href": {
Michel Roy's avatar
Michel Roy committed
            "type": "string"
Michel Roy's avatar
Michel Roy committed
          }
        },
        "required": [
          "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)"
Michel Roy's avatar
Michel Roy committed
          },
          "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.",
Michel Roy's avatar
Michel Roy committed
            "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"
Michel Roy's avatar
Michel Roy committed
          "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"
Michel Roy's avatar
Michel Roy committed
          }
        },
        "required": [
Michel Roy's avatar
Michel Roy committed
          "staId",
Michel Roy's avatar
Michel Roy committed
          "measurementId",
Michel Roy's avatar
Michel Roy committed
          "measurementInfo"
Michel Roy's avatar
Michel Roy committed
        ],
        "type": "object",
        "x-etsi-ref": "6.2.4"
      },
Michel Roy's avatar
Michel Roy committed
      "MeasurementConfigLinkList": {
Michel Roy's avatar
Michel Roy committed
        "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",
Michel Roy's avatar
Michel Roy committed
            "x-etsi-mec-cardinality": "1",
Michel Roy's avatar
Michel Roy committed
            "x-etsi-mec-origin-type": "Structure (inlined)"
Michel Roy's avatar
Michel Roy committed
          "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)"
Michel Roy's avatar
Michel Roy committed
          }
        },
        "required": [
Michel Roy's avatar
Michel Roy committed
          "_links"
Michel Roy's avatar
Michel Roy committed
        ],
        "type": "object",
Michel Roy's avatar
Michel Roy committed
        "x-etsi-ref": "6.2.5"
Michel Roy's avatar
Michel Roy committed
      "MeasurementInfo": {
Michel Roy's avatar
Michel Roy committed
        "properties": {
Michel Roy's avatar
Michel Roy committed
          "beaconRequestConf": {
            "$ref": "#/components/schemas/BeaconRequestConfig"
Michel Roy's avatar
Michel Roy committed
          "channelLoadConf": {
            "$ref": "#/components/schemas/ChannelLoadConfig"
Michel Roy's avatar
Michel Roy committed
          "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",
Michel Roy's avatar
Michel Roy committed
            "type": "integer",
            "x-etsi-mec-cardinality": "0..1",
Michel Roy's avatar
Michel Roy committed
            "x-etsi-mec-origin-type": "Uint16"
Michel Roy's avatar
Michel Roy committed
          "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",
            "x-etsi-mec-cardinality": "0..1",
            "x-etsi-mec-origin-type": "Uint16"
          },
          "staStatisticsConf": {
            "$ref": "#/components/schemas/StaStatisticsConfig"
          }
        },
        "type": "object",
        "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": {
          "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,
            "type": "array",
            "x-etsi-mec-cardinality": "0..N",
            "x-etsi-mec-origin-type": "NeighborReport"
          },
          "notificationType": {
            "description": "Shall be set to \"MeasurementReportNotification\".",
            "type": "string",
            "x-etsi-mec-cardinality": "1",
            "x-etsi-mec-origin-type": "String"
          },
          "staStatistics": {
            "description": "STA Statistics Report as defined in IEEE 802.11-2016 [8].",
            "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": [
          "notificationType"
        ],
        "type": "object",
        "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": {
            "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",
            "x-etsi-mec-origin-type": "Structure (inlined)"
          },
          "callbackReference": {
            "type": "string"
          },
          "expiryDeadline": {
            "$ref": "#/components/schemas/TimeStamp"
          },
          "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": {
            "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 \"MeasurementReportSubscription\".",
            "type": "string",
            "x-etsi-mec-cardinality": "1",
            "x-etsi-mec-origin-type": "String"
          },
          "websockNotifConfig": {
            "$ref": "#/components/schemas/WebsockNotifConfig"
          }
        },
        "required": [
          "subscriptionType",
          "staId",
          "measurementId",
          "measurementInfo"
        ],
        "type": "object",
        "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": {
          "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",
            "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"
          },
          "bssidInfo": {
            "$ref": "#/components/schemas/BssidInfo"
          },
          "channel": {
            "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].",
            "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 Neighbor 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"
          },
          "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",
            "x-etsi-mec-origin-type": "Uint8"
          },
          "staId": {
            "$ref": "#/components/schemas/StaIdentity"
          }
        },
        "required": [
          "measurementId",
          "bssid",
          "bssidInfo",
          "operatingClass",
          "channel",
          "phyType"
        ],
        "type": "object",
        "x-etsi-ref": "6.5.10"
      },
      "NeighborReportConfig": {
        "properties": {
          "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",
            "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",
            "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",
            "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",
            "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",
            "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",
            "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",
            "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",
            "x-etsi-mec-origin-type": "String"
          },
          "instance": {
            "description": "A URI reference that identifies the specific occurrence of the problem",
            "format": "uri",
            "type": "string",
            "x-etsi-mec-cardinality": "0..1",
            "x-etsi-mec-origin-type": "URI"
          },
          "status": {
            "description": "The HTTP status code for this occurrence of the problem",
            "format": "uint32",
            "type": "integer",
            "x-etsi-mec-cardinality": "0..1",
            "x-etsi-mec-origin-type": "Uint32"
          },
          "title": {
            "description": "A short, human-readable summary of the problem type",
            "type": "string",
Michel Roy's avatar
Michel Roy committed
            "x-etsi-mec-cardinality": "0..1",
            "x-etsi-mec-origin-type": "String"
          },
          "type": {
            "description": "A URI reference according to IETF RFC 3986 that identifies the problem type",
            "format": "uri",
            "type": "string",
            "x-etsi-mec-cardinality": "0..1",
            "x-etsi-mec-origin-type": "URI"
          }
        },
        "type": "object"
      },
Michel Roy's avatar
Michel Roy committed
      "ReportedBeaconFrameInfo": {
        "properties": {
          "frameType": {
            "description": "A value of 0 indicates a Beacon or Probe Response.\nA value of 1 indicates a Measurement Pilot frame.",
            "format": "uint8",
            "type": "integer",
            "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",
            "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"
      },
Michel Roy's avatar
Michel Roy committed
      "Rssi": {
        "properties": {
          "rssi": {
            "description": "The Received Signal Strength Indicator from a station",
Michel Roy's avatar
Michel Roy committed
            "format": "uint8",
Michel Roy's avatar
Michel Roy committed
            "type": "integer",
            "x-etsi-mec-cardinality": "1",
            "x-etsi-mec-origin-type": "Uint8"
          }
        },
        "required": [
          "rssi"
        ],
        "type": "object",
Michel Roy's avatar
Michel Roy committed
        "x-etsi-ref": "6.5.21"
      },
      "STACounterTriggerCondition": {
        "properties": {
          "ackFailureCountThreshold": {
            "description": "Configure and set threshold for dot11AckFailureCount trigger",
            "format": "uint32",
            "type": "integer",
            "x-etsi-mec-cardinality": "0..1",
            "x-etsi-mec-origin-type": "Uint32"
          },
          "failedCountThreshold": {
            "description": "Configure and set threshold for dot11FailedCount trigger",
            "format": "uint32",
            "type": "integer",
            "x-etsi-mec-cardinality": "0..1",
            "x-etsi-mec-origin-type": "Uint32"
          },
          "fcsErrorCountThreshold": {
            "description": "Configure and set threshold for dot11FCSErrorCount trigger",
            "format": "uint32",
            "type": "integer",
            "x-etsi-mec-cardinality": "0..1",
            "x-etsi-mec-origin-type": "Uint32"
          },
          "frameDuplicateCountThreshold": {
            "description": "Configure and set threshold for dot11FrameDuplicateCount trigger",
            "format": "uint32",
            "type": "integer",
            "x-etsi-mec-cardinality": "0..1",
            "x-etsi-mec-origin-type": "Uint32"
          },
          "multipleRetryCountThreshold": {
            "description": "Configure and set threshold for dot11MultipleRetryCount trigger",
            "format": "uint32",
            "type": "integer",
            "x-etsi-mec-cardinality": "0..1",
            "x-etsi-mec-origin-type": "Uint32"
          },
          "retryCountThreshold": {
            "description": "Configure and set threshold for dot11RetryCount trigger",
            "format": "uint32",
            "type": "integer",
            "x-etsi-mec-cardinality": "0..1",
            "x-etsi-mec-origin-type": "Uint32"
          },
          "rtsFailureCountThreshold": {
            "description": "Configure and set threshold for dot11RTSFailureCount trigger",
            "format": "uint32",
            "type": "integer",
            "x-etsi-mec-cardinality": "0..1",
            "x-etsi-mec-origin-type": "Uint32"
          }
        },
        "type": "object",
        "x-etsi-ref": "6.5.33"
Michel Roy's avatar
Michel Roy committed
      },
      "StaDataRate": {
        "properties": {
          "staId": {
Michel Roy's avatar
Michel Roy committed
            "$ref": "#/components/schemas/StaIdentity"
Michel Roy's avatar
Michel Roy committed
          },
          "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",
Michel Roy's avatar
Michel Roy committed
            "type": "integer",
            "x-etsi-mec-cardinality": "0..1",
            "x-etsi-mec-origin-type": "Uint32"
          },
          "staLastDataUplinkRate": {
            "description": "The data transmit rate in Kbps that was most recently used for transmission of data PPDUs from the associated station to the access point.",
Michel Roy's avatar
Michel Roy committed
            "format": "uint32",
Michel Roy's avatar
Michel Roy committed
            "type": "integer",
            "x-etsi-mec-cardinality": "0..1",
            "x-etsi-mec-origin-type": "Uint32"
          }
        },
        "type": "object",
Michel Roy's avatar
Michel Roy committed
        "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",
Michel Roy's avatar
Michel Roy committed
        "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": {
Michel Roy's avatar
Michel Roy committed
            "$ref": "#/components/schemas/TimeStamp"
Michel Roy's avatar
Michel Roy committed
          }
        },
        "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": {
Michel Roy's avatar
Michel Roy committed
                "$ref": "#/components/schemas/LinkType"
Michel Roy's avatar
Michel Roy committed
            "required": [
              "self"
            ],
Michel Roy's avatar
Michel Roy committed
            "type": "object",
            "x-etsi-mec-cardinality": "0..1",
            "x-etsi-mec-origin-type": "Structure (inlined)"
          },
          "callbackReference": {
Michel Roy's avatar
Michel Roy committed
            "type": "string"
Michel Roy's avatar
Michel Roy committed
          },
          "expiryDeadline": {
Michel Roy's avatar
Michel Roy committed
            "$ref": "#/components/schemas/TimeStamp"
Michel Roy's avatar
Michel Roy committed
          "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:\n1 = Notification issued when the STA's downlink data rate is greater than or equal to the downlink threshold.\n2 = Notification issued when the STA's downlink data rate is less than or equal to the downlink threshold.\n3 = Notification issued when the STA's uplink data rate is greater than or equal to the uplink threshold.\n4 = Notification issued when the STA's uplink data rate is less than or equal to the uplink threshold.\n5 = Notification issued when the STA's downlink and uplink data rate is greater than or equal to their thresholds.\n6 = Notification issued when the STA's downlink and uplink data rate is less than or equal to their thresholds.\n7 = Notification issued when the STA's downlink or uplink data rate is greater than or equal to their thresholds.\n8 = 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"
              }
            },