Merge branch 'stf606-final' into 'master' (443a6fa5) · Commits · MEC - Multi-access Edge Computing / Location API

LocationAPI.json

+113 −371

File changed.

Preview size limit exceeded, changes collapsed.

LocationAPI.yaml

+229 −258

Original line number	Diff line number	Diff line
		@@ -3,14 +3,14 @@ info:
		contact:
		url: https://forge.etsi.org/rep/mec/gs013-location-api
		title: ETSI GS MEC 013 - Location API
		version: 2.1.1
		version: 2.2.1
		description: The ETSI MEC ISG MEC013 Location API described using OpenAPI.
		license:
		name: BSD-3-Clause
		url: 'https://forge.etsi.org/legal-matters'
		externalDocs:
		description: ETSI MEC013 V2.1.1 Location API
		url: 'http://www.etsi.org/deliver/etsi_gs/MEC/001_099/013/02.01.01_60/gs_mec013v020101p.pdf'
		description: ETSI MEC013 V2.2.1 Location API
		url: 'http://www.etsi.org/deliver/etsi_gs/MEC/001_099/013/02.02.01_60/gs_mec013v020201p.pdf'
		servers:
		- url: 'https://localhost/location/v2'
		tags:
		@@ -84,7 +84,7 @@ paths:
		$ref: '#/components/responses/406'
		'429':
		$ref: '#/components/responses/429'
		x-swagger-router-controller: "queries"
		x-swagger-router-controller: 'queries'
		/queries/zones:
		get:
		tags:
		@@ -114,7 +114,7 @@ paths:
		$ref: '#/components/responses/406'
		'429':
		$ref: '#/components/responses/429'
		x-swagger-router-controller: "queries"
		x-swagger-router-controller: 'queries'
		/queries/zones/{zoneId}:
		get:
		tags:
		@@ -179,7 +179,7 @@ paths:
		$ref: '#/components/responses/406'
		'429':
		$ref: '#/components/responses/429'
		x-swagger-router-controller: "queries"
		x-swagger-router-controller: 'queries'
		/queries/zones/{zoneId}/accessPoints/{accessPointId}:
		get:
		tags:
		@@ -653,7 +653,7 @@ paths:
		responses:
		'204':
		$ref: '#/components/responses/204'
		x-swagger-router-controller: "subscriptions"
		x-swagger-router-controller: 'subscriptions'
		/subscriptions/distance/{subscriptionId}:
		get:
		tags:
		@@ -1035,7 +1035,7 @@ paths:
		$ref: '#/components/responses/422'
		'429':
		$ref: '#/components/responses/429'
		x-swagger-router-controller: "subscriptions"
		x-swagger-router-controller: 'subscriptions'
		delete:
		tags:
		- 'location'
		@@ -1065,7 +1065,7 @@ paths:
		operationId: userTrackingSubListGET
		responses:
		'200':
		description: "Response to retrieve user tracking subscriptions"
		description: 'Response to retrieve user tracking subscriptions'
		content:
		application/json:
		schema:
		@@ -1083,13 +1083,13 @@ paths:
		callbackReference:
		notifyURL: 'http://clientApp.example.com/location_notifications/123456'
		address: 'acr:192.0.2.1'
		userEventCriteria: ["Transferring"]
		userEventCriteria: ['Transferring']
		- clientCorrelator: '0124'
		resourceURL: 'http://meAppServer.example.com/location/v2/subscriptions/userTracking/subscription124'
		callbackReference:
		notifyURL: 'http://clientApp.example.com/location_notifications/123456'
		address: 'acr:192.0.2.2'
		userEventCriteria: ["Transferring"]
		userEventCriteria: ['Transferring']
		resourceURL: 'http://meAppServer.example.com/location/v2/subscriptions/userTracking'
		post:
		tags:
		@@ -1113,7 +1113,7 @@ paths:
		callbackReference:
		notifyURL: 'http://my.callback.com/location_notifications/some-id'
		address: 'acr:10.0.0.1'
		userEventCriteria: ["Transferring"]
		userEventCriteria: ['Transferring']
		responses:
		'201':
		description: 'Successful subscription'
		@@ -1130,7 +1130,7 @@ paths:
		callbackReference:
		notifyURL: 'http://my.callback.com/location_notifications/some-id'
		address: 'acr:10.0.0.1'
		userEventCriteria: ["Transferring"]
		userEventCriteria: ['Transferring']
		resourceURL: 'http://meAppServer.example.com/location/v2/subscriptions/userTracking/sub123'
		'400':
		$ref: '#/components/responses/400'
		@@ -1206,7 +1206,7 @@ paths:
		callbackReference:
		notifyURL: 'http://my.callback.com/location_notifications/some-id'
		address: 'acr:10.0.0.1'
		userEventCriteria: ["Transferring"]
		userEventCriteria: ['Transferring']
		resourceURL: 'http://meAppServer.example.com/location/v2/subscriptions/userTracking/sub123'
		'400':
		$ref: '#/components/responses/400'
		@@ -1243,7 +1243,7 @@ paths:
		callbackReference:
		notifyURL: 'http://my.callback.com/location_notifications/some-id'
		address: 'acr:10.0.0.1'
		userEventCriteria: ["Transferring"]
		userEventCriteria: ['Transferring']
		resourceURL: 'http://meAppServer.example.com/location/v2/subscriptions/userTracking/sub123'
		parameters:
		- $ref: '#/components/parameters/Path.SubscrId'
		@@ -1263,7 +1263,7 @@ paths:
		callbackReference:
		notifyURL: 'http://my.callback.com/location_notifications/some-id'
		address: 'acr:10.0.0.1'
		userEventCriteria: ["Transferring"]
		userEventCriteria: ['Transferring']
		resourceURL: 'http://meAppServer.example.com/location/v2/subscriptions/userTracking/sub123'
		'400':
		$ref: '#/components/responses/400'
		@@ -1329,13 +1329,13 @@ paths:
		callbackReference:
		notifyURL: 'http://clientApp.example.com/location_notifications/123456'
		zoneId: 'zone01'
		userEventCriteria: ["Transferring"]
		userEventCriteria: ['Transferring']
		- clientCorrelator: '0124'
		resourceURL: 'http://meAppServer.example.com/location/v2/subscriptions/zonalTraffic/subscription124'
		callbackReference:
		notifyURL: 'http://clientApp.example.com/location_notifications/123456'
		zoneId: 'zone02'
		userEventCriteria: ["Transferring"]
		userEventCriteria: ['Transferring']
		resourceURL: 'http://meAppServer.example.com/location/v2/subscriptions/zonalTraffic'
		post:
		tags:
		@@ -1359,7 +1359,7 @@ paths:
		callbackReference:
		notifyURL: 'http://my.callback.com/location_notifications/some-id'
		zoneId: 'zone01'
		userEventCriteria: ["Transferring"]
		userEventCriteria: ['Transferring']
		responses:
		'201':
		description: 'Successful subscription'
		@@ -1376,7 +1376,7 @@ paths:
		callbackReference:
		notifyURL: 'http://my.callback.com/location_notifications/some-id'
		zoneId: 'zone01'
		userEventCriteria: ["Transferring"]
		userEventCriteria: ['Transferring']
		resourceURL: 'http://meAppServer.example.com/location/v2/subscriptions/zonalTraffic/sub123'
		'400':
		$ref: '#/components/responses/400'
		@@ -1452,7 +1452,7 @@ paths:
		callbackReference:
		notifyURL: 'http://my.callback.com/location_notifications/some-id'
		zoneId: 'zone01'
		userEventCriteria: ["Transferring"]
		userEventCriteria: ['Transferring']
		resourceURL: 'http://meAppServer.example.com/location/v2/subscriptions/zonalTraffic/sub123'
		'400':
		$ref: '#/components/responses/400'
		@@ -1466,7 +1466,7 @@ paths:
		$ref: '#/components/responses/406'
		'429':
		$ref: '#/components/responses/429'
		x-swagger-router-controller: "subscriptions"
		x-swagger-router-controller: 'subscriptions'
		put:
		tags:
		- 'location'
		@@ -1489,7 +1489,7 @@ paths:
		callbackReference:
		notifyURL: 'http://my.callback.com/location_notifications/some-id'
		zoneId: 'zone01'
		userEventCriteria: ["Transferring"]
		userEventCriteria: ['Transferring']
		resourceURL: 'http://meAppServer.example.com/location/v2/subscriptions/zonalTraffic/sub123'
		parameters:
		- $ref: '#/components/parameters/Path.SubscrId'
		@@ -1509,7 +1509,7 @@ paths:
		callbackReference:
		notifyURL: 'http://my.callback.com/location_notifications/some-id'
		zoneId: 'zone01'
		userEventCriteria: ["Transferring"]
		userEventCriteria: ['Transferring']
		resourceURL: 'http://meAppServer.example.com/location/v2/subscriptions/zonalTraffic/sub123'
		'400':
		$ref: '#/components/responses/400'
		@@ -1710,7 +1710,7 @@ paths:
		$ref: '#/components/responses/406'
		'429':
		$ref: '#/components/responses/429'
		x-swagger-router-controller: "subscriptions"
		x-swagger-router-controller: 'subscriptions'
		put:
		tags:
		- 'location'
		@@ -1831,14 +1831,16 @@ components:
		schema:
		$ref: '#/components/schemas/ProblemDetails'
		'412':
		description: 'Precondition failed : used when a condition has failed during conditional requests, e.g. when
		description:
		'Precondition failed : used when a condition has failed during conditional requests, e.g. when
		using ETags to avoid write conflicts when using PUT'
		content:
		application/problem+json:
		schema:
		$ref: '#/components/schemas/ProblemDetails'
		'414':
		description: 'URI Too Long : used to indicate that the server is refusing to process the request because the request URI is
		description:
		'URI Too Long : used to indicate that the server is refusing to process the request because the request URI is
		longer than the server is willing or able to process.'
		content:
		application/problem+json:
		@@ -1851,7 +1853,8 @@ components:
		schema:
		$ref: '#/components/schemas/ProblemDetails'
		'422':
		description: 'Unprocessable Entity : used to indicate that the server understands the content type of the request entity and that the
		description:
		'Unprocessable Entity : used to indicate that the server understands the content type of the request entity and that the
		syntax of the request entity is correct but that the server is unable to process the contained instructions. This error condition can occur if an
		JSON request body is syntactically correct but semantically incorrect, for example if the target area for the request is considered too large. This
		error condition can also occur if the capabilities required by the request are not supported.'
		@@ -2266,17 +2269,17 @@ components:
		LocationInfo:
		properties:
		accuracy:
		description: Horizontal accuracy / (semi-major) uncertainty of location provided in meters, as defined in [14]. Present only if "shape" equals 4, 5 or 6
		description: Horizontal accuracy / (semi-major) uncertainty of location provided in meters, as defined in ETSI TS 123 032 [14]. Present only if "shape" equals 4, 5 or 6
		type: integer
		x-etsi-mec-cardinality: 0..1
		x-etsi-mec-origin-type: UnsignedInt
		accuracyAltitude:
		description: Altitude accuracy / uncertainty of location provided in meters, as defined in [14]. Present only if "shape" equals 3 or 4
		description: Altitude accuracy / uncertainty of location provided in meters, as defined in ETSI TS 123 032 [14]. Present only if "shape" equals 3 or 4
		type: integer
		x-etsi-mec-cardinality: 0..1
		x-etsi-mec-origin-type: UnsignedInt
		accuracySemiMinor:
		description: Horizontal accuracy / (semi-major) uncertainty of location provided in meters, as defined in [14]. Present only if "shape" equals 4, 5 or 6
		description: Horizontal accuracy / (semi-major) uncertainty of location provided in meters, as defined in ETSI TS 123 032 [14]. Present only if "shape" equals 4, 5 or 6
		type: integer
		x-etsi-mec-cardinality: 0..1
		x-etsi-mec-origin-type: UnsignedInt
		@@ -2287,7 +2290,7 @@ components:
		x-etsi-mec-cardinality: 0..1
		x-etsi-mec-origin-type: Float
		confidence:
		description: Confidence by which the position of a target entity is known to be within the shape description, expressed as a percentage and defined in [14]. Present only if "shape" equals 1, 4 or 6
		description: Confidence by which the position of a target entity is known to be within the shape description, expressed as a percentage and defined in ETSI TS 123 032 [14]. Present only if "shape" equals 1, 4 or 6
		type: integer
		x-etsi-mec-cardinality: 0..1
		x-etsi-mec-origin-type: UnsignedInt
		@@ -2325,12 +2328,12 @@ components:
		x-etsi-mec-cardinality: 0..1
		x-etsi-mec-origin-type: UnsignedInt
		orientationMajorAxis:
		description: "Angle of orientation of the major axis, expressed in the range 0\xB0 to 180\xB0, as defined in [14]. Present only if \"shape\" equals 4 or 6"
		description: "Angle of orientation of the major axis, expressed in the range 0\xB0 to 180\xB0, as defined in ETSI TS 123 032 [14]. Present only if \"shape\" equals 4 or 6"
		type: integer
		x-etsi-mec-cardinality: 0..1
		x-etsi-mec-origin-type: UnsignedInt
		shape:
		description: 'Shape information, as detailed in [14], associated with the reported location coordinate: <p>1 = ELLIPSOID_ARC <p>2 = ELLIPSOID_POINT <p>3 = ELLIPSOID_POINT_ALTITUDE <p>4 = ELLIPSOID_POINT_ALTITUDE_UNCERT_ELLIPSOID <p>5 = ELLIPSOID_POINT_UNCERT_CIRCLE <p>6 = ELLIPSOID_POINT_UNCERT_ELLIPSE <p>7 = POLYGON'
		description: 'Shape information, as detailed in ETSI TS 123 032 [14], associated with the reported location coordinate: <p>1 = ELLIPSOID_ARC <p>2 = ELLIPSOID_POINT <p>3 = ELLIPSOID_POINT_ALTITUDE <p>4 = ELLIPSOID_POINT_ALTITUDE_UNCERT_ELLIPSOID <p>5 = ELLIPSOID_POINT_UNCERT_CIRCLE <p>6 = ELLIPSOID_POINT_UNCERT_ELLIPSE <p>7 = POLYGON'
		type: integer
		x-etsi-mec-cardinality: '1'
		x-etsi-mec-origin-type: Enum_inlined
		@@ -2342,35 +2345,35 @@ components:
		x-etsi-mec-cardinality: 0..1
		x-etsi-mec-origin-type: UnsignedInt
		velocity:
		description: "Structure with attributes relating to the target entity\u2019s velocity, as defined in [14]."
		description: "Structure with attributes relating to the target entity\u2019s velocity, as defined in ETSI TS 123 032 [14]."
		properties:
		bearing:
		description: "Bearing, expressed in the range 0\xB0 to 360\xB0, as defined in [14]."
		description: "Bearing, expressed in the range 0\xB0 to 360\xB0, as defined in ETSI TS 123 032 [14]."
		type: integer
		x-etsi-mec-cardinality: '1'
		x-etsi-mec-origin-type: UnsignedInt
		horizontalSpeed:
		description: Horizontal speed, expressed in km/h and defined in [14].
		description: Horizontal speed, expressed in km/h and defined in ETSI TS 123 032 [14].
		type: integer
		x-etsi-mec-cardinality: '1'
		x-etsi-mec-origin-type: UnsignedInt
		uncertainty:
		description: Horizontal uncertainty, as defined in [14]. Present only if "velocityType" equals 3 or 4
		description: Horizontal uncertainty, as defined in ETSI TS 123 032 [14]. Present only if "velocityType" equals 3 or 4
		type: integer
		x-etsi-mec-cardinality: 0..1
		x-etsi-mec-origin-type: UnsignedInt
		velocityType:
		description: 'Velocity information, as detailed in [14], associated with the reported location coordinate: <p>1 = HORIZONTAL <p>2 = HORIZONTAL_VERTICAL <p>3 = HORIZONTAL_UNCERT <p>4 = HORIZONTAL_VERTICAL_UNCERT'
		description: 'Velocity information, as detailed in ETSI TS 123 032 [14], associated with the reported location coordinate: <p>1 = HORIZONTAL <p>2 = HORIZONTAL_VERTICAL <p>3 = HORIZONTAL_UNCERT <p>4 = HORIZONTAL_VERTICAL_UNCERT'
		type: integer
		x-etsi-mec-cardinality: '1'
		x-etsi-mec-origin-type: Enum_inlined
		verticalSpeed:
		description: Vertical speed, expressed in km/h and defined in [14]. Present only if "velocityType" equals 2 or 4
		description: Vertical speed, expressed in km/h and defined in ETSI TS 123 032 [14]. Present only if "velocityType" equals 2 or 4
		type: integer
		x-etsi-mec-cardinality: 0..1
		x-etsi-mec-origin-type: Int
		verticalUncertainty:
		description: Vertical uncertainty, as defined in [14]. Present only if "velocityType" equals 4
		description: Vertical uncertainty, as defined in ETSI TS 123 032 [14]. Present only if "velocityType" equals 4
		type: integer
		x-etsi-mec-cardinality: 0..1
		x-etsi-mec-origin-type: UnsignedInt
		@@ -2575,31 +2578,6 @@ components:
		- messageId
		- text
		type: object
		SubscriptionCancellationNotification:
		description: A type containing the subscription cancellation notification.
		properties:
		address:
		description: Address of terminal if the error applies to an individual terminal.
		type: string
		x-etsi-mec-cardinality: 0..1
		x-etsi-mec-origin-type: anyURI
		callbackData:
		description: CallbackData if passed by the application in the receiptRequest element during the associated subscription operation
		type: string
		x-etsi-mec-cardinality: 0..1
		x-etsi-mec-origin-type: string
		link:
		description: Link to other resources that are in relationship with the resource.
		items:
		$ref: '#/components/schemas/Link'
		type: array
		x-etsi-mec-cardinality: 0..N
		x-etsi-mec-origin-type: Link
		reason:
		$ref: '#/components/schemas/ServiceError'
		required:
		- terminalLocation
		type: object
		SubscriptionNotification:
		description: A type containing the notification subscription.
		properties:
		@@ -2670,13 +2648,6 @@ components:
		- address
		- locationRetrievalStatus
		type: object
		TerminalLocationList:
		description: Collection of the terminal locations.
		items:
		$ref: '#/components/schemas/TerminalLocation'
		type: array
		x-etsi-mec-cardinality: 1..N
		x-etsi-mec-origin-type: TerminalLocation
		TimeStamp:
		properties:
		nanoSeconds:
		@@ -2733,7 +2704,7 @@ components:
		description: Self-referring URL, see note 1.
		type: string
		x-etsi-mec-cardinality: '1'
		x-etsi-mec-origin-type: String
		x-etsi-mec-origin-type: AnyURI
		timestamp:
		$ref: '#/components/schemas/TimeStamp'
		zoneId:

README.md

+2 −2

Original line number	Diff line number	Diff line
		@@ -4,8 +4,8 @@ This repository contains OpenAPIs descriptions for the interfaces specified in E

		## Online resources

		* [Navigate the API in the browser](https://forge.etsi.org/swagger/ui/?url=https://forge.etsi.org/rep/mec/gs013-location-api/raw/stf606-final/LocationAPI.yaml).
		* [Edit the API online](https://forge.etsi.org/swagger/editor/?url=https://forge.etsi.org/rep/mec/gs013-location-api/raw/stf606-final/LocationAPI.yaml).
		* [Navigate the API in the browser](https://forge.etsi.org/swagger/ui/?url=https://forge.etsi.org/rep/mec/gs013-location-api/raw/stf606-draft/LocationAPI.yaml).
		* [Edit the API online](https://forge.etsi.org/swagger/editor/?url=https://forge.etsi.org/rep/mec/gs013-location-api/raw/stf606-draft/LocationAPI.yaml).

		## License