Update API file for MEC 028 to v2.3.1 (bb641188) · Commits · MEC - Multi-access Edge Computing / ETSI MEC Sandbox Frontend

config/api/wais-api.yaml

+36 −19

Original line number	Diff line number	Diff line
		@@ -3,18 +3,18 @@ info:
		contact:
		url: 'https://forge.etsi.org/rep/mec/gs028-wai-api'
		title: ETSI GS MEC 028 - WLAN Access Information API
		version: 2.2.1
		version: 2.3.1
		description: 'The ETSI MEC ISG MEC028 WLAN Access Information API described using OpenAPI
		<p>Note<br>MEC Sandbox supports all WAI API endpoints and a limited set of subscription types; complete details on the WAI API can be found on [ETSI Forge](http://www.etsi.org/deliver/etsi_gs/MEC/001_099/028/02.02.01_60/gs_mec028v020201p.pdf).
		<p>Note<br>MEC Sandbox supports all WAI API endpoints and a limited set of subscription types; complete details on the WAI API can be found on [ETSI Forge](http://www.etsi.org/deliver/etsi_gs/MEC/001_099/028/02.03.01_60/gs_mec028v020301p.pdf).
		<p>Supported subscriptions types:
		<p> - AssocStaSubscription'
		license:
		name: BSD-3-Clause
		url: 'https://forge.etsi.org/legal-matters'
		externalDocs:
		description: ETSI MEC028 V2.2.1 WLAN Information API
		description: ETSI MEC028 V2.3.1 WLAN Information API
		url: >-
		https://www.etsi.org/deliver/etsi_gs/MEC/001_099/028/02.02.01_60/gs_mec028v020201p.pdf
		https://www.etsi.org/deliver/etsi_gs/MEC/001_099/028/02.03.01_60/gs_mec028v020301p.pdf
		servers:
		- url: 'https://localhost/sandboxname/wai/v2'
		tags:
		@@ -146,6 +146,9 @@ paths:
		example:
		subscriptionType: AssocStaSubscription
		callbackReference: 'http://meAppClient.example.com/wai/v2/notifications/1'
		expiryDeadline:
		seconds: 1977836800
		nanoSeconds: 0
		apId:
		bssid: 005C0A0A0A0A
		notificationEvent:
		@@ -211,7 +214,7 @@ paths:
		responses:
		'204':
		$ref: '#/components/responses/204'
		'/subscriptions/{subscriptionId}':
		/subscriptions/{subscriptionId}:
		get:
		tags:
		- wai
		@@ -400,6 +403,9 @@ paths:
		href: 'http://meAppServer.example.com/wai/v2/measurements/meas123'
		staId:
		macId: 005C01111111
		ssid:
		- myNetworkSsid
		- myOtherNetworkSsid
		measurementId: myId1
		measurementInfo: {}
		'400':
		@@ -418,7 +424,7 @@ paths:
		$ref: '#/components/responses/422'
		'429':
		$ref: '#/components/responses/429'
		'/measurements/{measurementConfigId}':
		/measurements/{measurementConfigId}:
		get:
		tags:
		- unsupported
		@@ -442,6 +448,9 @@ paths:
		href: 'http://meAppServer.example.com/wai/v2/measurements/meas123'
		staId:
		macId: 005C01111111
		ssid:
		- myNetworkSsid
		- myOtherNetworkSsid
		measurementId: myId1
		measurementInfo: {}
		'400':
		@@ -477,6 +486,9 @@ paths:
		href: 'http://meAppServer.example.com/wai/v2/measurements/meas123'
		staId:
		macId: 005C01111111
		ssid:
		- myNetworkSsid
		- myOtherNetworkSsid
		measurementId: myId1
		measurementInfo: {}
		parameters:
		@@ -494,6 +506,9 @@ paths:
		href: 'http://meAppServer.example.com/wai/v2/measurements/123'
		staId:
		macId: 005C01111111
		ssid:
		- myNetworkSsid
		- myOtherNetworkSsid
		measurementId: myId1
		measurementInfo: {}
		'400':
		@@ -854,6 +869,8 @@ components:
		apId:
		$ref: '#/components/schemas/ApIdentity'
		callbackReference:
		description: >-
		URI exposed by the client on which to receive notifications
		type: string
		expiryDeadline:
		$ref: '#/components/schemas/TimeStamp'
		@@ -899,9 +916,8 @@ components:
		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.
		Set to TRUE by the service consumer to request a test notification via HTTP
		on the callbackReference URI.
		type: boolean
		x-etsi-mec-cardinality: 0..1
		x-etsi-mec-origin-type: Boolean
		@@ -921,7 +937,7 @@ components:
		BeaconReport:
		properties:
		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]."
		description: "The Antenna ID field contains the identifying number for the antenna(s) used for this measurement. Antenna ID is defined in clause\_9.4.2.40 of IEEE 802.11-2016 [8]."
		format: uint8
		type: integer
		x-etsi-mec-cardinality: 0..1
		@@ -966,7 +982,7 @@ components:
		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]."
		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 clause\_9.4.2.38 of IEEE 802.11-2016 [8]."
		format: uint8
		type: integer
		x-etsi-mec-cardinality: 0..1
		@@ -974,7 +990,7 @@ components:
		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]."
		description: "RSNI indicates the received signal-to-noise indication for the Beacon, Measurement Pilot, or Probe Response frame, as described in clause\_9.4.2.41 of IEEE 802.11-2016 [8]."
		format: uint8
		type: integer
		x-etsi-mec-cardinality: 0..1
		@@ -1035,7 +1051,7 @@ components:
		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."
		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 clause\_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 clause\_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'
		@@ -1998,6 +2014,7 @@ components:
		x-etsi-mec-cardinality: 0..1
		x-etsi-mec-origin-type: Structure (inlined)
		callbackReference:
		description: URI exposed by the client on which to receive notifications.
		type: string
		expiryDeadline:
		$ref: '#/components/schemas/TimeStamp'
		@@ -2013,8 +2030,7 @@ components:
		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.
		via HTTP on the callbackReference URI.
		type: boolean
		x-etsi-mec-cardinality: 0..1
		x-etsi-mec-origin-type: Boolean
		@@ -2438,6 +2454,8 @@ components:
		x-etsi-mec-cardinality: 0..1
		x-etsi-mec-origin-type: Structure (inlined)
		callbackReference:
		description: >-
		URI exposed by the client on which to receive notifications
		type: string
		expiryDeadline:
		$ref: '#/components/schemas/TimeStamp'
		@@ -2510,9 +2528,8 @@ components:
		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.
		Set to TRUE by the service consumer to request a test notification via HTTP
		on the callbackReference URI.
		type: boolean
		x-etsi-mec-cardinality: 0..1
		x-etsi-mec-origin-type: Boolean