WlanInformationApi.json 135 KB
Newer Older
Michel Roy's avatar
Michel Roy committed
          "type": "string",
          "format": "uri"
        }
      },
Michel Roy's avatar
Michel Roy committed
      "Query.Filter": {
        "name": "filter",
        "in": "query",
        "description": "Attribute-based filtering expression according to clause 6.19 of ETSI GS MEC 009. .",
        "required": false,
        "schema": {
          "type": "string"
        }
      },
      "Query.AllFields": {
        "name": "all_fields",
        "in": "query",
        "description": "Include all complex attributes in the response. See clause 6.18 of ETSI GS MEC 009 for details.",
        "required": false,
        "schema": {
          "type": "string"
        }
      },
      "Query.Fields": {
        "name": "fields",
        "in": "query",
        "description": "Complex attributes to be included into the response. See clause 6.18 of ETSI GS MEC 009 for details.",
        "required": false,
        "schema": {
          "type": "array",
          "items": {
            "type": "string"
          }
        }
      },
      "Query.ExcludeFields": {
        "name": "exclude_fields",
        "in": "query",
        "description": "Complex attributes to be excluded from the response. See clause 6.18 of ETSI GS MEC 009 for details.",
        "required": false,
        "schema": {
          "type": "array",
          "items": {
            "type": "string"
          }
        }
      },
      "Query.ExcludeDefault": {
        "name": "exclude_default",
        "in": "query",
        "description": "Indicates to exclude the following complex attributes from the response. See clause 6.18 of ETSI GS MEC 009 for details. The following attributes shall be excluded from the structure in the response body if this parameter is provided, or none of the parameters \"all_fields\", \"fields\", \"exclude_fields\", \"exclude_default\" are provided: Not applicable",
        "required": false,
        "schema": {
          "type": "array",
          "items": {
            "type": "string"
          }
        }
      },
      "Query.SubscriptionType": {
        "name": "subscription_type",
        "in": "query",
Michel Roy's avatar
Michel Roy committed
        "description": "Filter on a specific subscription type. Permitted values: assoc_sta, sta_data_rate, measure_report.",
Michel Roy's avatar
Michel Roy committed
        "required": false,
        "schema": {
          "type": "string"
        }
      }
    },
    "schemas": {
      "ApAssociated": {
        "properties": {
          "assocId": {
            "description": "Unique number which identifies a particular association between the station and Access Point.",
            "type": "string",
            "x-etsi-mec-cardinality": "0..1",
Michel Roy's avatar
Michel Roy committed
            "x-etsi-mec-origin-type": "String"
Michel Roy's avatar
Michel Roy committed
          "bssid": {
            "description": "Basic Service Set Identifier (BSSID) is a unique identifier assigned to the Access Point (as network interface controller) for communications at the data link layer of a network segment. BSSID is typically set to an access point's MAC address.",
            "type": "string",
            "x-etsi-mec-cardinality": "1",
            "x-etsi-mec-origin-type": "String"
          },
          "ipAddress": {
            "description": "IPv4 or IPv6 address allocated for the Access Point.",
            "items": {
              "type": "string"
Michel Roy's avatar
Michel Roy committed
            },
            "minItems": 0,
            "type": "array",
            "x-etsi-mec-cardinality": "0..N",
Michel Roy's avatar
Michel Roy committed
            "x-etsi-mec-origin-type": "String"
Michel Roy's avatar
Michel Roy committed
          },
          "ssid": {
            "description": "Service Set Identifier to identify logical networks.",
            "items": {
              "type": "string"
            },
            "minItems": 0,
            "type": "array",
            "x-etsi-mec-cardinality": "0..N",
            "x-etsi-mec-origin-type": "String"
          }
        },
        "required": [
Michel Roy's avatar
Michel Roy committed
          "bssid"
Michel Roy's avatar
Michel Roy committed
        ],
        "type": "object",
        "x-etsi-ref": "6.5.12"
      },
      "ApIdentity": {
        "properties": {
Michel Roy's avatar
Michel Roy committed
          "bssid": {
            "description": "Basic Service Set Identifier (BSSID) is a unique Identifier assigned to an Access Point (as network interface controller) for communications at the data link layer of a network segment. BSSID is typically set to an access point's MAC address.",
            "type": "string",
            "x-etsi-mec-cardinality": "1",
            "x-etsi-mec-origin-type": "String"
          },
Michel Roy's avatar
Michel Roy committed
          "ipAddress": {
            "description": "IPv4 or IPv6 address allocated for the Access Point.",
            "items": {
              "type": "string"
            },
            "minItems": 0,
            "type": "array",
            "x-etsi-mec-cardinality": "0..N",
            "x-etsi-mec-origin-type": "String"
          },
          "ssid": {
Michel Roy's avatar
Michel Roy committed
            "description": "Service Set Identifier (SSID) to identify logical WLAN networks available via the Access Point.",
Michel Roy's avatar
Michel Roy committed
            "items": {
              "type": "string"
            },
            "minItems": 0,
            "type": "array",
            "x-etsi-mec-cardinality": "0..N",
            "x-etsi-mec-origin-type": "String"
          }
        },
        "required": [
Michel Roy's avatar
Michel Roy committed
          "bssid"
Michel Roy's avatar
Michel Roy committed
        ],
        "type": "object",
        "x-etsi-ref": "6.5.3"
      },
      "ApInfo": {
        "properties": {
          "apId": {
Michel Roy's avatar
Michel Roy committed
            "$ref": "#/components/schemas/ApIdentity"
Michel Roy's avatar
Michel Roy committed
          },
          "apLocation": {
Michel Roy's avatar
Michel Roy committed
            "$ref": "#/components/schemas/ApLocation"
Michel Roy's avatar
Michel Roy committed
          },
          "bssLoad": {
Michel Roy's avatar
Michel Roy committed
            "$ref": "#/components/schemas/BssLoad"
Michel Roy's avatar
Michel Roy committed
          },
          "channel": {
            "description": "Channel configured for the Access Point.",
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"
          },
          "extBssLoad": {
Michel Roy's avatar
Michel Roy committed
            "$ref": "#/components/schemas/ExtBssLoad"
Michel Roy's avatar
Michel Roy committed
          "oBssLoad": {
            "$ref": "#/components/schemas/OBssLoad"
          },
Michel Roy's avatar
Michel Roy committed
          "timeStamp": {
Michel Roy's avatar
Michel Roy committed
            "$ref": "#/components/schemas/TimeStamp"
Michel Roy's avatar
Michel Roy committed
          },
          "wanMetrics": {
Michel Roy's avatar
Michel Roy committed
            "$ref": "#/components/schemas/WanMetrics"
Michel Roy's avatar
Michel Roy committed
          },
          "wlanCap": {
Michel Roy's avatar
Michel Roy committed
            "$ref": "#/components/schemas/WlanCapabilities"
Michel Roy's avatar
Michel Roy committed
          }
        },
        "required": [
          "apId"
        ],
        "type": "object",
        "x-etsi-ref": "6.2.2"
      },
      "ApLocation": {
        "properties": {
          "civicLocation": {
Michel Roy's avatar
Michel Roy committed
            "$ref": "#/components/schemas/CivicLocation"
Michel Roy's avatar
Michel Roy committed
          },
          "geolocation": {
Michel Roy's avatar
Michel Roy committed
            "$ref": "#/components/schemas/GeoLocation"
Michel Roy's avatar
Michel Roy committed
          }
        },
        "type": "object",
        "x-etsi-ref": "6.5.9"
      },
      "AssocStaNotification": {
        "properties": {
          "apId": {
Michel Roy's avatar
Michel Roy committed
            "$ref": "#/components/schemas/ApIdentity"
Michel Roy's avatar
Michel Roy committed
          },
          "notificationType": {
            "description": "Shall be set to \"AssocStaNotification\".",
            "type": "string",
            "x-etsi-mec-cardinality": "1",
            "x-etsi-mec-origin-type": "String"
          },
          "staId": {
            "description": "Identifier(s) to uniquely specify the client station(s) associated.",
            "items": {
              "$ref": "#/components/schemas/StaIdentity"
            },
            "minItems": 0,
            "type": "array",
            "x-etsi-mec-cardinality": "0..N",
            "x-etsi-mec-origin-type": "StaIdentity"
          },
          "timeStamp": {
Michel Roy's avatar
Michel Roy committed
            "$ref": "#/components/schemas/TimeStamp"
Michel Roy's avatar
Michel Roy committed
          }
        },
        "required": [
          "notificationType",
          "apId"
        ],
        "type": "object",
        "x-etsi-ref": "6.4.2"
      },
      "AssocStaSubscription": {
        "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)"
          },
          "apId": {
Michel Roy's avatar
Michel Roy committed
            "$ref": "#/components/schemas/ApIdentity"
Michel Roy's avatar
Michel Roy committed
          },
          "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": {
              "threshold": {
                "description": "Number of connected stations threshold for trigger-based event reporting.",
                "format": "uint8",
                "type": "integer",
                "x-etsi-mec-cardinality": "1",
                "x-etsi-mec-origin-type": "Uint8"
              },
              "trigger": {
                "description": "Trigger for the notification:\n1 = Notification issued when the number of connected stations is greater than or equal to the threshold.\n2 = Notification issued when the number of connected stations is less than or equal to the threshold.",
                "enum": [
                  1,
                  2
                ],
                "type": "integer",
                "x-etsi-mec-cardinality": "1",
                "x-etsi-mec-origin-type": "Enum (inline)"
              }
            },
            "required": [
              "trigger",
              "threshold"
            ],
            "type": "object",
            "x-etsi-mec-cardinality": "0..1",
            "x-etsi-mec-origin-type": "Structure (inline)"
          },
          "notificationPeriod": {
            "description": "Set for periodic notification reporting.\nValue indicates the notification period in seconds.",
            "format": "uint8",
            "type": "integer",
            "x-etsi-mec-cardinality": "0..1",
            "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",
            "x-etsi-mec-origin-type": "Boolean"
          },
Michel Roy's avatar
Michel Roy committed
          "subscriptionType": {
            "description": "Shall be set to \"AssocStaSubscription\".",
            "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"
Michel Roy's avatar
Michel Roy committed
          }
        },
        "required": [
          "subscriptionType",
          "apId"
        ],
        "type": "object",
Michel Roy's avatar
Michel Roy committed
        "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:\tAssocStaSubscription 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.",
Michel Roy's avatar
Michel Roy committed
        "x-etsi-ref": "6.3.2"
      },
Michel Roy's avatar
Michel Roy committed
      "BeaconReport": {
Michel Roy's avatar
Michel Roy committed
        "properties": {
Michel Roy's avatar
Michel Roy committed
          "antennaId": {
            "description": "The Antenna ID field contains the identifying number for the antenna(s) used for this measurement. Antenna ID is defined in section 9.4.2.40 of IEEE 802.11-2016 [8].",
            "format": "uint8",
            "type": "integer",
Michel Roy's avatar
Michel Roy committed
            "x-etsi-mec-cardinality": "0..1",
Michel Roy's avatar
Michel Roy committed
            "x-etsi-mec-origin-type": "Uint8"
Michel Roy's avatar
Michel Roy committed
          "bssid": {
            "description": "Indicates the BSSID of the BSS for which a beacon report has been received.",
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
          "channel": {
Michel Roy's avatar
Michel Roy committed
            "description": "Channel number where the beacon was received.",
Michel Roy's avatar
Michel Roy committed
            "format": "uint8",
Michel Roy's avatar
Michel Roy committed
            "type": "integer",
            "x-etsi-mec-cardinality": "1",
Michel Roy's avatar
Michel Roy committed
            "x-etsi-mec-origin-type": "Uint8"
Michel Roy's avatar
Michel Roy committed
          },
          "measurementId": {
            "description": "Measurement ID of the Measurement configuration applied to this Beacon Report.",
            "type": "string",
            "x-etsi-mec-cardinality": "1",
            "x-etsi-mec-origin-type": "String"
          },
Michel Roy's avatar
Michel Roy committed
          "operatingClass": {
            "description": "Operating Class field indicates an operating class value as defined in Annex E within IEEE 802.11-2016 [8].",
            "format": "uint8",
Michel Roy's avatar
Michel Roy committed
            "type": "integer",
            "x-etsi-mec-cardinality": "1",
Michel Roy's avatar
Michel Roy committed
            "x-etsi-mec-origin-type": "Uint8"
Michel Roy's avatar
Michel Roy committed
          "parentTsf": {
            "description": "The Parent TSF field contains the lower 4 octets of the measuring STA's TSF timer value at the start of reception of the first octet of the timestamp field of the reported Beacon, Measurement Pilot, or Probe Response frame at the time the Beacon, Measurement Pilot, or Probe Response frame being reported was received.",
            "format": "uint32",
            "type": "integer",
            "x-etsi-mec-cardinality": "0..1",
            "x-etsi-mec-origin-type": "Uint32"
          },
          "rcpi": {
            "description": "RCPI indicates the received channel power of the Beacon, Measurement Pilot, or Probe Response frame, which is a logarithmic function of the received signal power, as defined in section 9.4.2.38 of IEEE 802.11-2016 [8].",
            "format": "uint8",
            "type": "integer",
            "x-etsi-mec-cardinality": "0..1",
            "x-etsi-mec-origin-type": "Uint8"
          },
          "reportedFrameInfo": {
            "$ref": "#/components/schemas/ReportedBeaconFrameInfo"
          },
          "rsni": {
            "description": "RSNI indicates the received signal-to-noise indication for the Beacon, Measurement Pilot, or Probe Response frame, as described in section 9.4.2.41 of IEEE 802.11-2016 [8].",
            "format": "uint8",
            "type": "integer",
            "x-etsi-mec-cardinality": "0..1",
            "x-etsi-mec-origin-type": "Uint8"
          },
          "ssid": {
            "description": "The SSID subelement indicates the ESS or IBSS for which a beacon report is received.",
            "type": "string",
            "x-etsi-mec-cardinality": "0..1",
Michel Roy's avatar
Michel Roy committed
            "x-etsi-mec-origin-type": "String"
          },
          "staId": {
Michel Roy's avatar
Michel Roy committed
            "$ref": "#/components/schemas/StaIdentity"
Michel Roy's avatar
Michel Roy committed
          }
        },
        "required": [
          "measurementId",
Michel Roy's avatar
Michel Roy committed
          "operatingClass",
          "channel",
          "reportedFrameInfo",
          "bssid"
Michel Roy's avatar
Michel Roy committed
        ],
        "type": "object",
        "x-etsi-ref": "6.5.27"
      },
Michel Roy's avatar
Michel Roy committed
      "BeaconReportingConfig": {
        "properties": {
          "reportingCondition": {
            "description": "Reporting condition for the Beacon Report as per Table 9-89 of IEEE 802.11-2016 [8]:\n0 = Report to be issued after each measurement.\n1 = measured RCPI level is greater than the threshold.\n2 = measured RCPI level is less than the threshold.\n3 = measured RSNI level is greater than the threshold.\n4 = measured RSNI level is less than the threshold.\n5 = measured RCPI level is greater than a threshold defined by an offset from the serving AP's reference RCPI.\n6 = measured RCPI level is less than a threshold defined by an offset from the serving AP's reference RCPI.\n7 = measured RSNI level is greater than a threshold defined by an offset from the serving AP's reference RSNI.\n8 = measured RSNI level is less than a threshold defined by an offset from the serving AP's reference RSNI.\n9 = measured RCPI level is in a range bound by the serving AP's reference RCPI and an offset from the serving AP's reference RCPI.\n10 = measured RSNI level is in a range bound by the serving AP's reference RSNI and an offset from the serving AP's reference RSNI.",
            "format": "uint8",
            "type": "integer",
            "x-etsi-mec-cardinality": "1",
            "x-etsi-mec-origin-type": "Uint8"
          },
          "threshold": {
            "description": "The threshold subfield contains either the threshold value or the offset value to be used for conditional reporting.\n\nFor reportingCondition subfield with values 1 and 2, the threshold value is a logarithmic function of the received signal power, as defined in section 9.4.2.38 of IEEE 802.11-2016 [8].\n\nFor reportingCondition subfield values 3 and 4, the threshold value is a logarithmic function of the signal-to-noise ratio, as described in section 9.4.2.41 of IEEE 802.11-2016 [8].\n\nFor reportingCondition subfield values 5 to 10, the offset value is an 8-bit 2s complement integer in units of 0,5 dBm. The indicated reporting condition applies individually to each measured Beacon, Measurement Pilot, or Probe Response frame.",
            "format": "uint8",
            "type": "integer",
            "x-etsi-mec-cardinality": "1",
            "x-etsi-mec-origin-type": "Uint8"
          }
        },
        "required": [
          "reportingCondition",
          "threshold"
        ],
        "type": "object",
        "x-etsi-ref": "6.5.28"
      },
Michel Roy's avatar
Michel Roy committed
      "BeaconRequestConfig": {
        "properties": {
Michel Roy's avatar
Michel Roy committed
          "beaconReportingConf": {
            "$ref": "#/components/schemas/BeaconReportingConfig"
          },
          "bssid": {
            "description": "The BSSID field indicates the BSS for which a beacon report is requested. If absent, the requested beacon reports should include all BSSs on the channel.",
            "type": "string",
            "x-etsi-mec-cardinality": "0..1",
Michel Roy's avatar
Michel Roy committed
            "x-etsi-mec-origin-type": "String"
          },
          "channelId": {
Michel Roy's avatar
Michel Roy committed
            "description": "Channel number to scan. A Channel Number of 0 indicates a request to make iterative measurements for all supported channels in the Operating Class where the measurement is permitted on the channel and the channel is valid for the current regulatory domain. A Channel Number of 255 indicates a request to make iterative measurements for all supported channels in the current Operating Class listed in the latest AP Channel Report received from the serving AP.",
            "format": "uint8",
Michel Roy's avatar
Michel Roy committed
            "type": "integer",
            "x-etsi-mec-cardinality": "1",
Michel Roy's avatar
Michel Roy committed
            "x-etsi-mec-origin-type": "Uint8"
Michel Roy's avatar
Michel Roy committed
          },
          "measurementMode": {
            "description": "0 for passive.\n1 for active.\n2 for beacon table.",
Michel Roy's avatar
Michel Roy committed
            "format": "uint8",
Michel Roy's avatar
Michel Roy committed
            "type": "integer",
            "x-etsi-mec-cardinality": "1",
Michel Roy's avatar
Michel Roy committed
            "x-etsi-mec-origin-type": "Uint8"
Michel Roy's avatar
Michel Roy committed
          "operatingClass": {
            "description": "Operating Class field indicates an operating class value as defined in Annex E within IEEE 802.112016 [8].",
            "format": "uint8",
Michel Roy's avatar
Michel Roy committed
            "type": "integer",
            "x-etsi-mec-cardinality": "1",
Michel Roy's avatar
Michel Roy committed
            "x-etsi-mec-origin-type": "Uint8"
Michel Roy's avatar
Michel Roy committed
          "ssid": {
            "description": "The SSID subelement indicates the ESS or IBSS for which a beacon report is requested.",
            "type": "string",
            "x-etsi-mec-cardinality": "0..1",
Michel Roy's avatar
Michel Roy committed
            "x-etsi-mec-origin-type": "String"
          }
        },
        "required": [
Michel Roy's avatar
Michel Roy committed
          "operatingClass",
Michel Roy's avatar
Michel Roy committed
          "channelId",
          "measurementMode",
Michel Roy's avatar
Michel Roy committed
          "beaconReportingConf"
Michel Roy's avatar
Michel Roy committed
        ],
        "type": "object",
        "x-etsi-ref": "6.5.25"
      },
Michel Roy's avatar
Michel Roy committed
      "BssCapabilities": {
        "properties": {
          "apsd": {
            "description": "APSD Option implemented",
            "type": "boolean",
            "x-etsi-mec-cardinality": "1",
            "x-etsi-mec-origin-type": "Boolean"
          },
          "delayedBACK": {
            "description": "Delayed Block Ack Option implemented",
            "type": "boolean",
            "x-etsi-mec-cardinality": "1",
            "x-etsi-mec-origin-type": "Boolean"
          },
          "immediateBACK": {
            "description": "Immediate Block Ack Option implemented",
            "type": "boolean",
            "x-etsi-mec-cardinality": "1",
            "x-etsi-mec-origin-type": "Boolean"
          },
          "qos": {
            "description": "QoS Option implemented",
            "type": "boolean",
            "x-etsi-mec-cardinality": "1",
            "x-etsi-mec-origin-type": "Boolean"
          },
          "radioMeasurements": {
            "description": "Radio Measurement Activated",
            "type": "boolean",
            "x-etsi-mec-cardinality": "1",
            "x-etsi-mec-origin-type": "Boolean"
          },
          "spectrumManagement": {
            "description": "Spectrum Management required",
            "type": "boolean",
            "x-etsi-mec-cardinality": "1",
            "x-etsi-mec-origin-type": "Boolean"
          }
        },
        "required": [
          "spectrumManagement",
          "qos",
          "apsd",
          "radioMeasurements",
          "delayedBACK",
          "immediateBACK"
        ],
        "type": "object",
        "x-etsi-ref": "6.5.31"
      },
Michel Roy's avatar
Michel Roy committed
      "BssLoad": {
        "properties": {
          "availAdmCap": {
            "description": "Available Admission Capacity that specifies the remaining amount of medium time available via explicit admission control, in units of 32 s/s.",
Michel Roy's avatar
Michel Roy committed
            "format": "uint16",
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"
          },
          "channelUtilization": {
            "description": "The percentage of time, linearly scaled with 255 representing 100 %, that the AP sensed the medium was busy, as indicated by either the physical or virtual Carrier Sense (CS) mechanism.",
Michel Roy's avatar
Michel Roy committed
            "format": "uint8",
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"
          },
          "staCount": {
            "description": "An unsigned integer that indicates the total number of STAs currently associated with this BSS.",
Michel Roy's avatar
Michel Roy committed
            "format": "uint16",
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"
          }
        },
        "required": [
          "staCount",
          "channelUtilization",
          "availAdmCap"
        ],
        "type": "object",
        "x-etsi-ref": "6.5.7"
      },
Michel Roy's avatar
Michel Roy committed
      "BssidInfo": {
Michel Roy's avatar
Michel Roy committed
        "properties": {
Michel Roy's avatar
Michel Roy committed
          "apReachability": {
            "description": "The apReachability field indicates whether the AP identified by this BSSID is reachable by the STA that requested the neighbor report. Valid values:\n0 = reserved\n1 = not reachable\n2 = unknown\n3 = reachable.",
            "format": "uint8",
Michel Roy's avatar
Michel Roy committed
            "type": "integer",
            "x-etsi-mec-cardinality": "1",
Michel Roy's avatar
Michel Roy committed
            "x-etsi-mec-origin-type": "Uint8"
Michel Roy's avatar
Michel Roy committed
          "capabilities": {
            "$ref": "#/components/schemas/BssCapabilities"
          },
          "ftm": {
            "description": "True indicates the AP represented by this BSSID is an AP that has set the Fine Timing Measurement Responder field of the Extended Capabilities element to 1.\n\nFalse indicates either that the reporting AP has dot11FineTimingMsmtRespActivated equal to false, or the reported AP has not set the Fine Timing Measurement Responder field of the Extended Capabilities element to 1 or that the Fine Timing Measurement Responder field of the reported AP is not available to the reporting AP at this time.",
            "type": "boolean",
Michel Roy's avatar
Michel Roy committed
            "x-etsi-mec-cardinality": "1",
Michel Roy's avatar
Michel Roy committed
            "x-etsi-mec-origin-type": "Boolean"
          },
          "highThroughput": {
            "description": "True indicates that the AP represented by this BSSID is an HT AP including the HT Capabilities element in its Beacons, and that the contents of that HT Capabilities element are identical to the HT Capabilities element advertised by the AP sending the report.",
            "type": "boolean",
            "x-etsi-mec-cardinality": "1",
            "x-etsi-mec-origin-type": "Boolean"
          },
          "mobilityDomain": {
            "description": "True indicates the AP represented by this BSSID is including an MDE in its Beacon frames and that the contents of that MDE are identical to the MDE advertised by the AP sending the report.",
            "type": "boolean",
            "x-etsi-mec-cardinality": "1",
            "x-etsi-mec-origin-type": "Boolean"
          },
          "security": {
            "description": "True indicates the AP identified by this BSSID supports the same security provisioning as used by the STA in its current association.\n\nFalse indicates either that the AP does not support the same security provisioning or that the security information is not available at this time.",
            "type": "boolean",
            "x-etsi-mec-cardinality": "1",
            "x-etsi-mec-origin-type": "Boolean"
          },
          "veryHighThroughput": {
            "description": "True indicates that the AP represented by this BSSID is a VHT AP and that the VHT Capabilities element, if included as a subelement in the report, is identical in content to the VHT Capabilities element included in the AP's Beacon.",
            "type": "boolean",
            "x-etsi-mec-cardinality": "1",
            "x-etsi-mec-origin-type": "Boolean"
Michel Roy's avatar
Michel Roy committed
          }
        },
        "required": [
Michel Roy's avatar
Michel Roy committed
          "apReachability",
          "security",
          "capabilities",
          "mobilityDomain",
          "highThroughput",
          "veryHighThroughput",
          "ftm"
Michel Roy's avatar
Michel Roy committed
        ],
        "type": "object",
Michel Roy's avatar
Michel Roy committed
        "x-etsi-ref": "6.5.30"
Michel Roy's avatar
Michel Roy committed
      "ChannelLoad": {
Michel Roy's avatar
Michel Roy committed
        "properties": {
Michel Roy's avatar
Michel Roy committed
          "channel": {
            "description": "Channel number indicates the channel number for which the measurement report applies.",
            "format": "uint8",
            "type": "integer",
            "x-etsi-mec-cardinality": "1",
            "x-etsi-mec-origin-type": "Uint8"
Michel Roy's avatar
Michel Roy committed
          "channelLoad": {
            "description": "Proportion of measurement duration for which the measuring STA determined the channel to be busy, as a percentage of time, linearly scaled with 255 representing 100 %.",
            "format": "uint8",
            "type": "integer",
            "x-etsi-mec-cardinality": "1",
            "x-etsi-mec-origin-type": "Uint8"
Michel Roy's avatar
Michel Roy committed
          "measurementDuration": {
            "description": "Duration over which the Channel Load report was measured, in units of TUs of 1 024 µs.",
            "format": "uint8",
            "type": "integer",
            "x-etsi-mec-cardinality": "1",
            "x-etsi-mec-origin-type": "Uint8"
Michel Roy's avatar
Michel Roy committed
          "measurementId": {
            "description": "Measurement ID of the Measurement configuration applied to this Channel Load Report.",
Michel Roy's avatar
Michel Roy committed
            "type": "string",
Michel Roy's avatar
Michel Roy committed
            "x-etsi-mec-cardinality": "1",
Michel Roy's avatar
Michel Roy committed
            "x-etsi-mec-origin-type": "String"
          },
Michel Roy's avatar
Michel Roy committed
          "operatingClass": {
            "description": "Operating Class field indicates an operating class value as defined in Annex E within IEEE 802.11-2016 [8].",
            "format": "uint8",
            "type": "integer",
            "x-etsi-mec-cardinality": "1",
            "x-etsi-mec-origin-type": "Uint8"
          },
          "staId": {
            "$ref": "#/components/schemas/StaIdentity"
          }
        },
        "required": [
          "measurementId",
          "operatingClass",
          "channel",
          "measurementDuration",
          "channelLoad"
        ],
        "type": "object",
        "x-etsi-ref": "6.5.39"
      },
      "ChannelLoadConfig": {
        "properties": {
          "channel": {
            "description": "Channel for which the channel load report is requested.",
            "type": "integer",
            "x-etsi-mec-cardinality": "1",
            "x-etsi-mec-origin-type": "Integer"
          },
          "operatingClass": {
            "description": "Operating Class field indicates an operating class value as defined in Annex E within IEEE 802.11-2016 [8].",
            "format": "uint8",
            "type": "integer",
            "x-etsi-mec-cardinality": "1",
            "x-etsi-mec-origin-type": "Uint8"
          },
          "reportingCondition": {
            "description": "Reporting condition for the Beacon Report as per Table 9-153 of IEEE 802.11-2016 [8]:\n0 = Report to be issued after each measurement.\n1 = Report to be issued when Channel Load is greater than or equal to the threshold.\n2 = Report to be issued when Channel Load is less than or equal to the threshold.\n\nIf this optional field is not provided, channel load report should be issued after each measurement (reportingCondition = 0).",
            "format": "uint8",
            "type": "integer",
            "x-etsi-mec-cardinality": "0..1",
            "x-etsi-mec-origin-type": "Uint8"
          },
          "threshold": {
            "description": "Channel Load reference value for threshold reporting. This field shall be provided for reportingCondition values 1 and 2.",
            "format": "uint8",
            "type": "integer",
            "x-etsi-mec-cardinality": "0..1",
            "x-etsi-mec-origin-type": "Uint8"
          }
        },
        "required": [
          "operatingClass",
          "channel"
        ],
        "type": "object",
        "x-etsi-ref": "6.5.24"
      },
      "CivicLocation": {
        "properties": {
          "ca0": {
            "description": "Language",
            "type": "string",
            "x-etsi-mec-cardinality": "0..1",
            "x-etsi-mec-origin-type": "String"
          },
          "ca1": {
            "description": "National subdivisions (state, canton, region, province, prefecture) ",
            "type": "string",
            "x-etsi-mec-cardinality": "0..1",
            "x-etsi-mec-origin-type": "String"
          },
          "ca128": {
            "description": "Script",
            "type": "string",
            "x-etsi-mec-cardinality": "0..1",
            "x-etsi-mec-origin-type": "String"
          },
          "ca16": {
            "description": "Leading street direction",
            "type": "string",
            "x-etsi-mec-cardinality": "0..1",
            "x-etsi-mec-origin-type": "String"
          },
          "ca17": {
            "description": "Trailing street suffix",
            "type": "string",
            "x-etsi-mec-cardinality": "0..1",
            "x-etsi-mec-origin-type": "String"
Michel Roy's avatar
Michel Roy committed
          },
          "ca18": {
            "description": "Street suffix or type",
            "type": "string",
            "x-etsi-mec-cardinality": "0..1",
            "x-etsi-mec-origin-type": "String"
          },
          "ca19": {
            "description": "House number",
            "type": "string",
            "x-etsi-mec-cardinality": "0..1",
            "x-etsi-mec-origin-type": "String"
          },
          "ca2": {
            "description": "County, parish, gun (JP), district (IN)",
            "type": "string",
            "x-etsi-mec-cardinality": "0..1",
            "x-etsi-mec-origin-type": "String"
          },
          "ca20": {
            "description": "House number suffix",
            "type": "string",
            "x-etsi-mec-cardinality": "0..1",
            "x-etsi-mec-origin-type": "String"
          },
          "ca21": {
            "description": "Landmark of vanity address",
            "type": "string",
            "x-etsi-mec-cardinality": "0..1",
            "x-etsi-mec-origin-type": "String"
          },
          "ca22": {
            "description": "Additional location information",
            "type": "string",
            "x-etsi-mec-cardinality": "0..1",
            "x-etsi-mec-origin-type": "String"
          },
          "ca23": {
            "description": "Name (residence and office occupant)",
            "type": "string",
            "x-etsi-mec-cardinality": "0..1",
            "x-etsi-mec-origin-type": "String"
          },
          "ca24": {
            "description": "Postal/zip code",
            "type": "string",
            "x-etsi-mec-cardinality": "0..1",
            "x-etsi-mec-origin-type": "String"
          },
          "ca25": {
            "description": "Building (structure)",
            "type": "string",
            "x-etsi-mec-cardinality": "0..1",
            "x-etsi-mec-origin-type": "String"
          },
          "ca26": {
            "description": "Unit (apartment/suite)",
            "type": "string",
            "x-etsi-mec-cardinality": "0..1",
            "x-etsi-mec-origin-type": "String"
          },
          "ca27": {
            "description": "Floor",
            "type": "string",
            "x-etsi-mec-cardinality": "0..1",
            "x-etsi-mec-origin-type": "String"
          },
          "ca28": {
            "description": "Room",
            "type": "string",
            "x-etsi-mec-cardinality": "0..1",
            "x-etsi-mec-origin-type": "String"
          },
          "ca29": {
            "description": "Type of place",
            "type": "string",
            "x-etsi-mec-cardinality": "0..1",
            "x-etsi-mec-origin-type": "String"
          },
          "ca3": {
            "description": "City, township, shi (JP)",
            "type": "string",
            "x-etsi-mec-cardinality": "0..1",
            "x-etsi-mec-origin-type": "String"
          },
          "ca30": {
            "description": "Postal community name",
            "type": "string",
            "x-etsi-mec-cardinality": "0..1",
            "x-etsi-mec-origin-type": "String"
          },
          "ca31": {
            "description": "Post office box",
            "type": "string",
            "x-etsi-mec-cardinality": "0..1",
            "x-etsi-mec-origin-type": "String"
          },
          "ca32": {
            "description": "Additional code",
            "type": "string",
            "x-etsi-mec-cardinality": "0..1",
            "x-etsi-mec-origin-type": "String"
          },
          "ca33": {
            "description": "Seat (desk.cubicle, workstation)",
            "type": "string",
            "x-etsi-mec-cardinality": "0..1",
            "x-etsi-mec-origin-type": "String"
          },
          "ca34": {
            "description": "Primary road name",
            "type": "string",
            "x-etsi-mec-cardinality": "0..1",
            "x-etsi-mec-origin-type": "String"
          },
          "ca35": {
            "description": "Road section",
            "type": "string",
            "x-etsi-mec-cardinality": "0..1",
            "x-etsi-mec-origin-type": "String"
          },
          "ca36": {
            "description": "Branch road name",
            "type": "string",
            "x-etsi-mec-cardinality": "0..1",
            "x-etsi-mec-origin-type": "String"
          },
          "ca37": {
            "description": "Sub-branch road name",
            "type": "string",
            "x-etsi-mec-cardinality": "0..1",
            "x-etsi-mec-origin-type": "String"
          },
          "ca38": {
            "description": "Street name pre-modifier",
            "type": "string",
            "x-etsi-mec-cardinality": "0..1",
            "x-etsi-mec-origin-type": "String"
          },
          "ca39": {
            "description": "Street name post-modifier",
            "type": "string",
            "x-etsi-mec-cardinality": "0..1",
            "x-etsi-mec-origin-type": "String"
          },
          "ca4": {
            "description": "City division, borough, city district, ward, chou (JP)",
            "type": "string",
            "x-etsi-mec-cardinality": "0..1",
            "x-etsi-mec-origin-type": "String"
          },
          "ca5": {
            "description": "Neighborhood, block",
            "type": "string",
            "x-etsi-mec-cardinality": "0..1",
            "x-etsi-mec-origin-type": "String"
          },
          "ca6": {
            "description": "Group of streets below the neighborhood level ",
            "type": "string",
            "x-etsi-mec-cardinality": "0..1",
            "x-etsi-mec-origin-type": "String"
          },
          "country": {
            "description": "The two-letter ISO 3166 [i.9] country code in capital ASCII letters, e.g. DE or US, as per ISO 3166 [i.9]",
            "type": "string",
            "x-etsi-mec-cardinality": "1",
            "x-etsi-mec-origin-type": "String"
          }
        },
        "required": [
          "country"
        ],
        "type": "object",
        "x-etsi-ref": "6.5.20"
      },
      "DmgCapabilities": {
        "properties": {
          "ExtScMcsCap": {
Michel Roy's avatar
Michel Roy committed
            "description": "Extended SC MCS capabilities as defined in IEEE 802.11-2016 [8].",
Michel Roy's avatar
Michel Roy committed
            "format": "uint8",
Michel Roy's avatar
Michel Roy committed
            "type": "integer",
            "x-etsi-mec-cardinality": "1",
            "x-etsi-mec-origin-type": "Uint8"
          },
          "dmgApOrPcpCapInfo": {
Michel Roy's avatar
Michel Roy committed
            "description": "DMG AP or PCP capabilities information as defined in IEEE 802.11-2016 [8].",
Michel Roy's avatar
Michel Roy committed
            "format": "uint16",
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"
          },
          "dmgStaBeamTrackTimeLimit": {
Michel Roy's avatar
Michel Roy committed
            "description": "DMG station beam tracking time limit as defined in IEEE 802.11-2016 [8]. ",
Michel Roy's avatar
Michel Roy committed
            "format": "uint16",
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"
          },
          "dmgStaCapInfo": {
Michel Roy's avatar
Michel Roy committed
            "description": "DMG station capabilities information as defined in IEEE 802.11-2016 [8]. ",
            "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"
          },
          "maxNrBasicAmsduSubframes": {
Michel Roy's avatar
Michel Roy committed
            "description": "Number of basic A-MSDU subframes in A-MSDU as defined in IEEE 802.11-2016 [8].",
Michel Roy's avatar
Michel Roy committed
            "format": "uint8",
Michel Roy's avatar
Michel Roy committed
            "type": "integer",
            "x-etsi-mec-cardinality": "1",
            "x-etsi-mec-origin-type": "Uint8"
          },
          "maxNrShortAmsduSubframes": {
Michel Roy's avatar
Michel Roy committed
            "description": "Number of short A-MSDU subframes in A-MSDU as defined in IEEE 802.11-2016 [8].",
Michel Roy's avatar
Michel Roy committed
            "format": "uint8",
Michel Roy's avatar
Michel Roy committed
            "type": "integer",
            "x-etsi-mec-cardinality": "1",
            "x-etsi-mec-origin-type": "Uint8"
          }
        },
        "required": [
          "dmgStaCapInfo",
          "dmgApOrPcpCapInfo",
          "dmgStaBeamTrackTimeLimit",
          "ExtScMcsCap",
          "maxNrBasicAmsduSubframes",
Michel Roy's avatar
Michel Roy committed
          "maxNrShortAmsduSubframes"
Michel Roy's avatar
Michel Roy committed
        ],
        "type": "object",
        "x-etsi-ref": "6.5.17"
      },
      "EdmgCapabilities": {
        "properties": {
          "ampduParameters": {
Michel Roy's avatar
Michel Roy committed
            "description": "A-MPDU parameters as defined in draft IEEE P802.11ay [i.11]",
Michel Roy's avatar
Michel Roy committed
            "format": "uint8",
Michel Roy's avatar
Michel Roy committed
            "type": "integer",
            "x-etsi-mec-cardinality": "1",
            "x-etsi-mec-origin-type": "Uint8"
          },
          "supportedMcs": {
Michel Roy's avatar
Michel Roy committed
            "description": "Supported MCS as defined in draft IEEE P802.11ay [i.11]",
Michel Roy's avatar
Michel Roy committed
            "format": "uint32",
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"
          },
          "trnParameters": {
Michel Roy's avatar
Michel Roy committed
            "description": "Training parameters as defined in draft IEEE P802.11ay [i.11]",
Michel Roy's avatar
Michel Roy committed
            "format": "uint16",
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"
          }
        },
        "required": [
          "ampduParameters",
          "trnParameters",
          "supportedMcs"
        ],
        "type": "object",
        "x-etsi-ref": "6.5.18"
      },
Michel Roy's avatar
Michel Roy committed
      "ExpiryNotification": {
        "properties": {
          "_links": {
            "description": "Hyperlink related to the resource.",
            "properties": {
              "subscription": {
                "$ref": "#/components/schemas/LinkType"
              }
            },
            "required": [
              "subscription"
            ],
            "type": "object",
            "x-etsi-mec-cardinality": "1",
            "x-etsi-mec-origin-type": "Structure (inlined)"
          },