Commit 6c6f29a0 authored by Michel Roy's avatar Michel Roy
Browse files

review update

parent a6373bd6
Pipeline #5045 passed with stage
in 0 seconds
{
"openapi": "3.0.0",
"info": {
"contact": {
"url": "https://forge.etsi.org/rep/mec/gs028-wai-api"
},
"title": "ETSI GS MEC 028 - WLAN Access Information API",
"version": "2.1.1",
"description": "The ETSI MEC ISG MEC028 WLAN Access Information API described using OpenAPI",
......@@ -15,14 +18,19 @@
},
"servers": [
{
"url": "https://{apiRoot}/wai/v2"
"url": "https://localhost/wai/v2"
}
],
"tags": [
{
"name": "wai"
}
],
"paths": {
"/queries/ap/ap_information": {
"get": {
"tags": [
""
"wai"
],
"summary": "Retrieve information on existing Access Points",
"description": "Queries information about existing WLAN Access Points",
......@@ -87,7 +95,7 @@
"/queries/sta/sta_information": {
"get": {
"tags": [
""
"wai"
],
"summary": "Retrieve information on existing Stations",
"description": "Queries information about existing WLAN stations",
......@@ -149,10 +157,10 @@
}
}
},
"/subscriptions/": {
"/subscriptions": {
"get": {
"tags": [
""
"wai"
],
"summary": "Retrieve information on subscriptions for notifications",
"description": "Queries information on subscriptions for notifications",
......@@ -223,7 +231,7 @@
},
"post": {
"tags": [
""
"wai"
],
"summary": "Create a new subscription",
"description": "Creates a new subscription to WLAN Access Information notifications",
......@@ -410,7 +418,7 @@
"/subscriptions/{subscriptionId}": {
"get": {
"tags": [
""
"wai"
],
"summary": "Retrieve information on current specific subscription",
"description": "Queries information about an existing subscription, identified by its self-referring URI returned on creation (initial POST)",
......@@ -491,7 +499,7 @@
},
"put": {
"tags": [
""
"wai"
],
"summary": "Modify an existing subscription",
"description": "Updates an existing subscription, identified by its self-referring URI returned on creation (initial POST)",
......@@ -614,7 +622,7 @@
},
"delete": {
"tags": [
""
"wai"
],
"summary": "Cancel an existing subscription",
"description": "Cancels an existing subscription, identified by its self-referring URI returned on creation (initial POST)",
......@@ -957,139 +965,35 @@
"ApInfo": {
"properties": {
"apId": {
"allOf": [
{
"$ref": "#/components/schemas/ApIdentity"
},
{
"description": "Identifier(s) to uniquely specify the Access Point whose information is exposed within this data type."
},
{
"x-etsi-mec-cardinality": "1"
},
{
"x-etsi-mec-origin-type": "ApIdentity"
}
]
"$ref": "#/components/schemas/ApIdentity"
},
"apLocation": {
"allOf": [
{
"$ref": "#/components/schemas/ApLocation"
},
{
"description": "The location on the Access Point."
},
{
"x-etsi-mec-cardinality": "0..1"
},
{
"x-etsi-mec-origin-type": "ApLocation"
}
]
"$ref": "#/components/schemas/ApLocation"
},
"apNeighbor": {
"allOf": [
{
"$ref": "#/components/schemas/NeighborReport"
},
{
"description": "Information about neighbor Access Points."
},
{
"x-etsi-mec-cardinality": "0..1"
},
{
"x-etsi-mec-origin-type": "NeighborReport"
}
]
"$ref": "#/components/schemas/NeighborReport"
},
"bssLoad": {
"allOf": [
{
"$ref": "#/components/schemas/BssLoad"
},
{
"description": "BSS Load attribute contains information on the current STA population and traffic levels in the BSS as defined in IEEE 802.11-2016 [8]."
},
{
"x-etsi-mec-cardinality": "0..1"
},
{
"x-etsi-mec-origin-type": "BssLoad"
}
]
"$ref": "#/components/schemas/BssLoad"
},
"channel": {
"type": "integer",
"format": "uint32",
"description": "Channel configured for the Access Point.",
"format": "int32",
"type": "integer",
"x-etsi-mec-cardinality": "0..1",
"x-etsi-mec-origin-type": "Uint32"
},
"extBssLoad": {
"allOf": [
{
"$ref": "#/components/schemas/ExtBssLoad"
},
{
"description": "Extended BSS Load attribute contains more detailed information on the current STA population and traffic levels in the BSS as per ETSI GS MEC 002 [i.4]."
},
{
"x-etsi-mec-cardinality": "0..1"
},
{
"x-etsi-mec-origin-type": "ExtBssLoad"
}
]
"$ref": "#/components/schemas/ExtBssLoad"
},
"timeStamp": {
"allOf": [
{
"$ref": "#/components/schemas/TimeStamp"
},
{
"description": "Time stamp."
},
{
"x-etsi-mec-cardinality": "0..1"
},
{
"x-etsi-mec-origin-type": "TimeStamp"
}
]
"$ref": "#/components/schemas/TimeStamp"
},
"wanMetrics": {
"allOf": [
{
"$ref": "#/components/schemas/WanMetrics"
},
{
"description": "WAN Metrics element provides information about the WAN link connecting an IEEE 802.11 Access Node and the Internet. Transmission characteristics such as the speed of the WAN connection to the Internet are included in Hotspot 2.0 Technical Specification v1.0.0 [i.3]."
},
{
"x-etsi-mec-cardinality": "0..1"
},
{
"x-etsi-mec-origin-type": "WanMetrics"
}
]
"$ref": "#/components/schemas/WanMetrics"
},
"wlanCap": {
"allOf": [
{
"$ref": "#/components/schemas/WlanCapabilities"
},
{
"description": "WLAN capabilities of Access Point."
},
{
"x-etsi-mec-cardinality": "0..1"
},
{
"x-etsi-mec-origin-type": "WlanCapabilities"
}
]
"$ref": "#/components/schemas/WlanCapabilities"
}
},
"required": [
......@@ -1101,36 +1005,10 @@
"ApLocation": {
"properties": {
"civicLocation": {
"allOf": [
{
"$ref": "#/components/schemas/CivicLocation"
},
{
"description": "Civic Location of the AP as described in IETF RFC 4776 [7]."
},
{
"x-etsi-mec-cardinality": "0..1"
},
{
"x-etsi-mec-origin-type": "CivicLocation"
}
]
"$ref": "#/components/schemas/CivicLocation"
},
"geolocation": {
"allOf": [
{
"$ref": "#/components/schemas/GeoLocation"
},
{
"description": "Geospatial Location of the AP as defined in IEEE 802.11-2016 [8]."
},
{
"x-etsi-mec-cardinality": "0..1"
},
{
"x-etsi-mec-origin-type": "GeoLocation"
}
]
"$ref": "#/components/schemas/GeoLocation"
}
},
"type": "object",
......@@ -1139,20 +1017,7 @@
"AssocStaNotification": {
"properties": {
"apId": {
"allOf": [
{
"$ref": "#/components/schemas/ApIdentity"
},
{
"description": "Identifier(s) to uniquely specify the Access Point to which the client stations are associated."
},
{
"x-etsi-mec-cardinality": "1"
},
{
"x-etsi-mec-origin-type": "ApIdentity"
}
]
"$ref": "#/components/schemas/ApIdentity"
},
"notificationType": {
"description": "Shall be set to \"AssocStaNotification\".",
......@@ -1171,20 +1036,7 @@
"x-etsi-mec-origin-type": "StaIdentity"
},
"timeStamp": {
"allOf": [
{
"$ref": "#/components/schemas/TimeStamp"
},
{
"description": "Time stamp."
},
{
"x-etsi-mec-cardinality": "0..1"
},
{
"x-etsi-mec-origin-type": "TimeStamp"
}
]
"$ref": "#/components/schemas/TimeStamp"
}
},
"required": [
......@@ -1200,41 +1052,18 @@
"description": "Hyperlink related to the resource. This shall be only included in the HTTP responses and in HTTP PUT requests.",
"properties": {
"self": {
"allOf": [
{
"$ref": "#/components/schemas/LinkType"
},
{
"description": "URI referring to a resource"
},
{
"x-etsi-mec-cardinality": 1
},
{
"x-etsi-mec-origin-type": "LinkType"
}
]
"$ref": "#/components/schemas/LinkType"
}
},
"required": [
"self"
],
"type": "object",
"x-etsi-mec-cardinality": "0..1",
"x-etsi-mec-origin-type": "Structure (inlined)"
},
"apId": {
"allOf": [
{
"$ref": "#/components/schemas/ApIdentity"
},
{
"description": "Identifier(s) to uniquely specify the target Access Point for the subscription"
},
{
"x-etsi-mec-cardinality": "1"
},
{
"x-etsi-mec-origin-type": "ApIdentity"
}
]
"$ref": "#/components/schemas/ApIdentity"
},
"callbackReference": {
"description": "URI selected by the service consumer to receive notifications on the subscribed WLAN information. This shall be included both in the request and in response.",
......@@ -1244,20 +1073,7 @@
"x-etsi-mec-origin-type": "URI"
},
"expiryDeadline": {
"allOf": [
{
"$ref": "#/components/schemas/TimeStamp"
},
{
"description": "The expiration time of the subscription determined by the WLAN Access Information Service."
},
{
"x-etsi-mec-cardinality": "0..1"
},
{
"x-etsi-mec-origin-type": "TimeStamp"
}
]
"$ref": "#/components/schemas/TimeStamp"
},
"subscriptionType": {
"description": "Shall be set to \"AssocStaSubscription\".",
......@@ -1346,20 +1162,7 @@
"x-etsi-mec-origin-type": "String"
},
"staId": {
"allOf": [
{
"$ref": "#/components/schemas/StaIdentity"
},
{
"description": "Identifier to uniquely specify the station whose information is exposed within this data type."
},
{
"x-etsi-mec-cardinality": "1"
},
{
"x-etsi-mec-origin-type": "StaIdentity"
}
]
"$ref": "#/components/schemas/StaIdentity"
}
},
"required": [
......@@ -1414,20 +1217,7 @@
"x-etsi-mec-origin-type": "String"
},
"staId": {
"allOf": [
{
"$ref": "#/components/schemas/StaIdentity"
},
{
"description": "Identifier to uniquely specify the station whose information is exposed within this data type."
},
{
"x-etsi-mec-cardinality": "1"
},
{
"x-etsi-mec-origin-type": "StaIdentity"
}
]
"$ref": "#/components/schemas/StaIdentity"
}
},
"required": [
......@@ -1444,20 +1234,23 @@
"BssLoad": {
"properties": {
"availAdmCap": {
"type": "integer",
"description": "Available Admission Capacity that specifies the remaining amount of medium time available via explicit admission control, in units of 32 s/s.",
"format": "int32",
"type": "integer",
"x-etsi-mec-cardinality": "1",
"x-etsi-mec-origin-type": "Uint16"
},
"channelUtilization": {
"type": "integer",
"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.",
"format": "int32",
"type": "integer",
"x-etsi-mec-cardinality": "1",
"x-etsi-mec-origin-type": "UInt8"
},
"staCount": {
"type": "integer",
"description": "An unsigned integer that indicates the total number of STAs currently associated with this BSS.",
"format": "int32",
"type": "integer",
"x-etsi-mec-cardinality": "1",
"x-etsi-mec-origin-type": "UInt16"
}
......@@ -1473,20 +1266,7 @@
"ChannelLoadConfig": {
"properties": {
"apId": {
"allOf": [
{
"$ref": "#/components/schemas/ApIdentity"
},
{
"description": "Identifier(s) to uniquely specify the target Access Point"
},
{
"x-etsi-mec-cardinality": "1"
},
{
"x-etsi-mec-origin-type": "ApIdentity"
}
]
"$ref": "#/components/schemas/ApIdentity"
},
"cChannelId": {
"description": "Channel number which load is reported",
......@@ -1720,49 +1500,57 @@
"properties": {
"ExtScMcsCap": {
"description": "Extended SC MCS capabilities as defined in draft IEEE P802.11/D4.0 [i.11]",
"format": "int32",
"type": "integer",
"x-etsi-mec-cardinality": "1",
"x-etsi-mec-origin-type": "Uint8"
},
"dmgApOrPcpCapInfo": {
"type": "integer",
"description": "DMG AP or PCP capabilities information as defined in draft IEEE P802.11/D4.0 [i.11]",
"format": "int32",
"type": "integer",
"x-etsi-mec-cardinality": "1",
"x-etsi-mec-origin-type": "Uint16"
},
"dmgStaBeamTrackTimeLimit": {
"type": "integer",
"description": "DMG station beam tracking time limit as defined in draft IEEE P802.11/D4.0 [i.11]",
"format": "int32",
"type": "integer",
"x-etsi-mec-cardinality": "1",
"x-etsi-mec-origin-type": "Uint16"
},
"dmgStaCapInfo": {
"type": "integer",
"description": "DMG station capabilities information as defined in draft IEEE P802.11/D4.0 [i.11]",
"format": "int64",
"type": "integer",
"x-etsi-mec-cardinality": "1",
"x-etsi-mec-origin-type": "Uint64"
},
"maxNrBasicAmsduSubframes": {
"description": "Number of basic A-MSDU subframes in A-MSDU as defined in draft IEEE P802.11/D4.0 [i.11]",
"format": "int32",
"type": "integer",
"x-etsi-mec-cardinality": "1",
"x-etsi-mec-origin-type": "Uint8"
},
"maxNrShortAmsduSubframes": {
"description": "Number of short A-MSDU subframes in A-MSDU as defined in draft IEEE P802.11/D4.0 [i.11]",
"format": "int32",
"type": "integer",
"x-etsi-mec-cardinality": "1",
"x-etsi-mec-origin-type": "Uint8"
},
"sarCap": {
"description": "SAR capabilities as defined in draft IEEE P802.11/D4.0 [i.11]",
"format": "int32",
"type": "integer",
"x-etsi-mec-cardinality": "1",
"x-etsi-mec-origin-type": "Uint8"
},
"tddCap": {
"type": "integer",
"description": "TDD capabilities as defined in draft IEEE P802.11/D4.0 [i.11]",
"format": "int32",
"type": "integer",
"x-etsi-mec-cardinality": "1",
"x-etsi-mec-origin-type": "Uint16"
}
......@@ -1784,26 +1572,29 @@
"properties": {
"ampduParameters": {
"description": "A-MPDU parameters as defined in draft IEEE P802.11/D4.0 [i.11]",
"format": "Uint8",
"type": "integer",
"x-etsi-mec-cardinality": "1",
"x-etsi-mec-origin-type": "Uint8"
},
"reserved": {
"description": "",
"format": "int32",
"type": "integer",
"x-etsi-mec-cardinality": "0..1",
"x-etsi-mec-origin-type": "Uint8"
},
"supportedMcs": {
"type": "integer",
"format": "uint32",
"description": "Supported MCS as defined in draft IEEE P802.11/D4.0 [i.11]",
"format": "int32",
"type": "integer",
"x-etsi-mec-cardinality": "1",
"x-etsi-mec-origin-type": "Uint32"
},
"trnParameters": {
"type": "integer",
"description": "Training parameters as defined in draft IEEE P802.11/D4.0 [i.11]",
"format": "int32",
"type": "integer",
"x-etsi-mec-cardinality": "1",
"x-etsi-mec-origin-type": "Uint16"
}
......@@ -1819,32 +1610,37 @@
"ExtBssLoad": {
"properties": {
"muMimoStaCount": {
"type": "integer",
"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.",
"format": "int32",
"type": "integer",
"x-etsi-mec-cardinality": "1",
"x-etsi-mec-origin-type": "UInt16"
},
"obsSec20MhzUtil": {
"description": "Observable loading on each of the secondary 20 MHz channel.",
"format": "int32",
"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.",
"format": "int32",
"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.",
"format": "int32",
"type": "integer",
"x-etsi-mec-cardinality": "1",
"x-etsi-mec-origin-type": "Uint8"
},
"spatStreamUnderUtil": {
"type": "integer",
"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.",
"format": "int32",
"type": "integer",
"x-etsi-mec-cardinality": "1",
"x-etsi-mec-origin-type": "UInt8"
}
......@@ -1862,50 +1658,57 @@
"GeoLocation": {
"properties": {
"altitude": {
"type": "integer",
"format": "uint32",
"description": "The altitude value of location as defined in IETF RFC 6225 [6]",
"format": "int32",
"type": "integer",
"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]",
"format": "int32",
"type": "integer",
"x-etsi-mec-cardinality": "0..1",