Removed extra '/' from basePath. To each procedure, added tags and operationId (378ceeba) · Commits · MEC - Multi-access Edge Computing / Location API

LocationAPI.json

+136 −63

Original line number	Diff line number	Diff line
		@@ -3,18 +3,18 @@
		"info": {
		"title": "Location API",
		"version": "1.1.1",
		"description": "The ETSI MEC ISG MEC013 Location API described using OpenAPI. The API is based on the Open Mobile Alliance's specification RESTful Network API for Zonal Presence",
		"description": "The ETSI MEC ISG MEC012 Location API described using OpenAPI. The API is based on the Open Mobile Alliance's specification RESTful Network API for Zonal Presence",
		"license": {
		"name": "ETSI Forge copyright notice",
		"url": "https://forge.etsi.org/etsi-forge-copyright-notice.txt"
		}
		},
		"externalDocs": {
		"description": "ETSI GS MEC013 Location Service API, V1.1.1",
		"description": "ETSI MEC013 V1.1.1 Location Service API",
		"url": "http://www.etsi.org/deliver/etsi_gs/MEC/001_099/013/01.01.01_60/gs_mec013v010101p.pdf"
		},
		"host": "127.0.0.1:8081",
		"basePath": "/exampleAPI/location/v1/",
		"basePath": "/exampleAPI/location/v1",
		"schemes": [
		"http",
		"https"
		@@ -25,6 +25,17 @@
		"produces": [
		"application/json"
		],
		"tags": [
		{
		"name": "zones"
		},
		{
		"name": "users"
		},
		{
		"name": "subscriptions"
		}
		],
		"parameters": {
		"Body.UserTrackingSubscription": {
		"name": "userTrackingSubscription",
		@@ -106,6 +117,10 @@
		"paths": {
		"/zones": {
		"get": {
		"tags": [
		"zones"
		],
		"operationId": "zonesGet",
		"description": "Used to get a list of identifiers for zones authorized for use by the application.",
		"produces": [
		"application/json"
		@@ -148,16 +163,20 @@
		}
		},
		"/zones/{zoneId}": {
		"get": {
		"description": "Used to get the status of a zone.",
		"produces": [
		"application/json"
		],
		"parameters": [
		{
		"$ref": "#/parameters/Path.ZoneId"
		}
		],
		"get": {
		"tags": [
		"zones"
		],
		"operationId": "zonesGetById",
		"description": "Used to get the status of a zone.",
		"produces": [
		"application/json"
		],
		"responses": {
		"200": {
		"description": "Successful response to a query regarding the status of a zone",
		@@ -184,15 +203,21 @@
		}
		},
		"/zones/{zoneId}/accessPoints": {
		"parameters": [
		{
		"$ref": "#/parameters/Path.ZoneId"
		}
		],
		"get": {
		"tags": [
		"zones"
		],
		"operationId": "zonesByIdGetAps",
		"description": "Access point status can be retrieved for sets of access points matching attribute in the request.",
		"produces": [
		"application/json"
		],
		"parameters": [
		{
		"$ref": "#/parameters/Path.ZoneId"
		},
		{
		"$ref": "#/parameters/Query.InterestRealm"
		}
		@@ -264,11 +289,6 @@
		}
		},
		"/zones/{zoneId}/accessPoints/{accessPointId}": {
		"get": {
		"description": "Access point status can be retrieved for sets of access points matching attribute in the request.",
		"produces": [
		"application/json"
		],
		"parameters": [
		{
		"$ref": "#/parameters/Path.ZoneId"
		@@ -277,6 +297,15 @@
		"$ref": "#/parameters/Path.AccessPointId"
		}
		],
		"get": {
		"tags": [
		"zones"
		],
		"operationId": "zonesByIdGetApsById",
		"description": "Access point status can be retrieved for sets of access points matching attribute in the request.",
		"produces": [
		"application/json"
		],
		"responses": {
		"200": {
		"description": "Successful response to a query a named set of access point status request",
		@@ -311,6 +340,10 @@
		},
		"/users": {
		"get": {
		"tags": [
		"users"
		],
		"operationId": "usersGet",
		"description": "Users currently using a zone may be retrieved for sets of access points matching attribute in the request",
		"produces": [
		"application/json"
		@@ -377,16 +410,20 @@
		}
		},
		"/users/{userId}": {
		"get": {
		"description": "Users currently using a zone may be retrieved for sets of access points matching attribute in the request",
		"produces": [
		"application/json"
		],
		"parameters": [
		{
		"$ref": "#/parameters/Path.UserId"
		}
		],
		"get": {
		"tags": [
		"users"
		],
		"operationId": "usersGetById",
		"description": "Users currently using a zone may be retrieved for sets of access points matching attribute in the request",
		"produces": [
		"application/json"
		],
		"responses": {
		"200": {
		"description": "Successful response to a query users within a zone request",
		@@ -420,6 +457,10 @@
		},
		"/subscriptions/zonalTraffic": {
		"get": {
		"tags": [
		"subscriptions"
		],
		"operationId": "zonalTrafficSubGet",
		"description": "This operation is used for retrieving all active subscriptions to zonal traffic change notifications.",
		"produces": [
		"application/json"
		@@ -479,6 +520,10 @@
		}
		},
		"post": {
		"tags": [
		"subscriptions"
		],
		"operationId": "zonalTrafficSubPost",
		"description": "This operation is used for creating a new subscription to zonal traffic change notification.",
		"produces": [
		"application/json"
		@@ -517,16 +562,20 @@
		}
		},
		"/subscriptions/zonalTraffic/{subscriptionId}": {
		"get": {
		"description": "This operation is used for updating an individual subscription to zonal traffic change notification.",
		"produces": [
		"application/json"
		],
		"parameters": [
		{
		"$ref": "#/parameters/Path.SubscriptionId"
		}
		],
		"get": {
		"tags": [
		"subscriptions"
		],
		"operationId": "zonalTrafficSubGetById",
		"description": "This operation is used for updating an individual subscription to zonal traffic change notification.",
		"produces": [
		"application/json"
		],
		"responses": {
		"200": {
		"description": "Response to retrieve individual zonal traffic subscription",
		@@ -555,14 +604,15 @@
		}
		},
		"put": {
		"tags": [
		"subscriptions"
		],
		"operationId": "zonalTrafficSubPutById",
		"description": "This operation is used for updating an individual subscription to zonal traffic change notification.",
		"produces": [
		"application/json"
		],
		"parameters": [
		{
		"$ref": "#/parameters/Path.SubscriptionId"
		},
		{
		"$ref": "#/parameters/Body.ZonalTrafficSubscription"
		}
		@@ -595,15 +645,14 @@
		}
		},
		"delete": {
		"tags": [
		"subscriptions"
		],
		"operationId": "zonalTrafficSubDelById",
		"description": "This operation is used for cancelling a subscription and stopping corresponding notifications.",
		"produces": [
		"application/json"
		],
		"parameters": [
		{
		"$ref": "#/parameters/Path.SubscriptionId"
		}
		],
		"responses": {
		"204": {
		"description": "No content"
		@@ -613,6 +662,10 @@
		},
		"/subscriptions/userTracking": {
		"get": {
		"tags": [
		"subscriptions"
		],
		"operationId": "userTrackingSubGet",
		"description": "This operation is used for retrieving all active subscriptions to user tracking change notifications.",
		"produces": [
		"application/json"
		@@ -670,6 +723,10 @@
		}
		},
		"post": {
		"tags": [
		"subscriptions"
		],
		"operationId": "userTrackingSubPost",
		"description": "This operation is used for creating a new subscription to user tracking change notification",
		"produces": [
		"application/json"
		@@ -707,16 +764,20 @@
		}
		},
		"/subscriptions/userTracking/{subscriptionId}": {
		"get": {
		"description": "This operation is used for retrieving an individual subscription to user tracking change notification.",
		"produces": [
		"application/json"
		],
		"parameters": [
		{
		"$ref": "#/parameters/Path.SubscriptionId"
		}
		],
		"get": {
		"tags": [
		"subscriptions"
		],
		"operationId": "userTrackingSubGetById",
		"description": "This operation is used for retrieving an individual subscription to user tracking change notification.",
		"produces": [
		"application/json"
		],
		"responses": {
		"200": {
		"description": "Response to retrieve individual user tracking subscription",
		@@ -744,14 +805,15 @@
		}
		},
		"put": {
		"tags": [
		"subscriptions"
		],
		"operationId": "userTrackingSubPutById",
		"description": "This operation is used for updating an individual subscription to user tracking change notification.",
		"produces": [
		"application/json"
		],
		"parameters": [
		{
		"$ref": "#/parameters/Path.SubscriptionId"
		},
		{
		"$ref": "#/parameters/Body.UserTrackingSubscription"
		}
		@@ -783,15 +845,14 @@
		}
		},
		"delete": {
		"tags": [
		"subscriptions"
		],
		"operationId": "userTrackingSubDelById",
		"description": "This operation is used for retrieving an individual subscription to user tracking change notification.",
		"produces": [
		"application/json"
		],
		"parameters": [
		{
		"$ref": "#/parameters/Path.SubscriptionId"
		}
		],
		"responses": {
		"204": {
		"description": "No Content"
		@@ -801,6 +862,10 @@
		},
		"/subscriptions/zonalStatus": {
		"get": {
		"tags": [
		"subscriptions"
		],
		"operationId": "zoneStatusGet",
		"description": "This operation is used for creating a new subscription to zone status change notification.",
		"produces": [
		"application/json"
		@@ -860,6 +925,10 @@
		}
		},
		"post": {
		"tags": [
		"subscriptions"
		],
		"operationId": "zoneStatusPost",
		"description": "This operation is used for creating a new subscription to zone status change notification.",
		"produces": [
		"application/json"
		@@ -898,16 +967,20 @@
		}
		},
		"/subscriptions/zoneStatus/{subscriptionId}": {
		"get": {
		"description": "This operation is used for retrieving an individual subscription to zone status change notification.",
		"produces": [
		"application/json"
		],
		"parameters": [
		{
		"$ref": "#/parameters/Path.SubscriptionId"
		}
		],
		"get": {
		"tags": [
		"subscriptions"
		],
		"operationId": "zoneStatusGetById",
		"description": "This operation is used for retrieving an individual subscription to zone status change notification.",
		"produces": [
		"application/json"
		],
		"responses": {
		"200": {
		"description": "Response to retrieve individual zone status subscription",
		@@ -936,14 +1009,15 @@
		}
		},
		"put": {
		"tags": [
		"subscriptions"
		],
		"operationId": "zoneStatusPutById",
		"description": "This operation is used for updating an individual subscription to zone status change notification.",
		"produces": [
		"application/json"
		],
		"parameters": [
		{
		"$ref": "#/parameters/Path.SubscriptionId"
		},
		{
		"$ref": "#/parameters/Body.ZoneStatusSubscription"
		}
		@@ -976,15 +1050,14 @@
		}
		},
		"delete": {
		"tags": [
		"subscriptions"
		],
		"operationId": "zoneStatusDelById",
		"description": "This operation is used for cancelling a subscription and stopping corresponding notifications.",
		"produces": [
		"application/json"
		],
		"parameters": [
		{
		"$ref": "#/parameters/Path.SubscriptionId"
		}
		],
		"responses": {
		"204": {
		"description": "No content"

LocationAPI.split.yaml

+7 −1

Original line number	Diff line number	Diff line
		@@ -16,7 +16,7 @@ externalDocs:
		$ref: './externalDocs/index.yaml'

		host: 127.0.0.1:8081
		basePath: /exampleAPI/location/v1/
		basePath: /exampleAPI/location/v1
		schemes:
		- http
		- https
		@@ -25,6 +25,12 @@ consumes:
		produces:
		- application/json

		################################################################################
		# Tags #
		################################################################################
		tags:
		$ref: './tags/index.yaml'

		################################################################################
		# Parameters #
		################################################################################

LocationAPI.yaml

+1116 −1056

Original line number	Diff line number	Diff line
		@@ -2,15 +2,15 @@ swagger: '2.0'
		info:
		title: Location API
		version: 1.1.1
		description: 'The ETSI MEC ISG MEC013 Location API described using OpenAPI. The API is based on the Open Mobile Alliance''s specification RESTful Network API for Zonal Presence'
		description: The ETSI MEC ISG MEC012 Location API described using OpenAPI. The API is based on the Open Mobile Alliance's specification RESTful Network API for Zonal Presence
		license:
		name: ETSI Forge copyright notice
		url: 'https://forge.etsi.org/etsi-forge-copyright-notice.txt'
		externalDocs:
		description: ETSI GS MEC013 Location Service API, V1.1.1
		description: ETSI MEC013 V1.1.1 Location Service API
		url: 'http://www.etsi.org/deliver/etsi_gs/MEC/001_099/013/01.01.01_60/gs_mec013v010101p.pdf'
		host: '127.0.0.1:8081'
		basePath: /exampleAPI/location/v1/
		basePath: /exampleAPI/location/v1
		schemes:
		- http
		- https
		@@ -18,6 +18,10 @@ consumes:
		- application/json
		produces:
		- application/json
		tags:
		- name: zones
		- name: users
		- name: subscriptions
		parameters:
		Body.UserTrackingSubscription:
		name: userTrackingSubscription
		@@ -85,6 +89,9 @@ parameters:
		paths:
		/zones:
		get:
		tags:
		- zones
		operationId: zonesGet
		description: Used to get a list of identifiers for zones authorized for use by the application.
		produces:
		- application/json
		@@ -111,12 +118,15 @@ paths:
		resourceURL: 'http://example.com/exampleAPI/location/v1/zones/zone02'
		resourceURL: 'http://example.com/exampleAPI/location/v1/zones'
		'/zones/{zoneId}':
		parameters:
		- $ref: '#/parameters/Path.ZoneId'
		get:
		tags:
		- zones
		operationId: zonesGetById
		description: Used to get the status of a zone.
		produces:
		- application/json
		parameters:
		- $ref: '#/parameters/Path.ZoneId'
		responses:
		'200':
		description: Successful response to a query regarding the status of a zone
		@@ -133,12 +143,16 @@ paths:
		numberOfUsers: '10'
		resourceURL: 'http://example.com/exampleAPI/location/v1/zones/zone01'
		'/zones/{zoneId}/accessPoints':
		parameters:
		- $ref: '#/parameters/Path.ZoneId'
		get:
		tags:
		- zones
		operationId: zonesByIdGetAps
		description: Access point status can be retrieved for sets of access points matching attribute in the request.
		produces:
		- application/json
		parameters:
		- $ref: '#/parameters/Path.ZoneId'
		- $ref: '#/parameters/Query.InterestRealm'
		responses:
		'200':
		@@ -187,13 +201,16 @@ paths:
		resourceURL: 'http://example.com/exampleAPI/location/v1/zones/zone01/accessPoints/ap003'
		resourceURL: 'http://example.com/exampleAPI/location/v1/zones/zone01/accessPoints'
		'/zones/{zoneId}/accessPoints/{accessPointId}':
		parameters:
		- $ref: '#/parameters/Path.ZoneId'
		- $ref: '#/parameters/Path.AccessPointId'
		get:
		tags:
		- zones
		operationId: zonesByIdGetApsById
		description: Access point status can be retrieved for sets of access points matching attribute in the request.
		produces:
		- application/json
		parameters:
		- $ref: '#/parameters/Path.ZoneId'
		- $ref: '#/parameters/Path.AccessPointId'
		responses:
		'200':
		description: Successful response to a query a named set of access point status request
		@@ -217,6 +234,9 @@ paths:
		resourceURL: 'http://example.com/exampleAPI/location/v1/zones/zone001/accessPoints/ap001'
		/users:
		get:
		tags:
		- users
		operationId: usersGet
		description: Users currently using a zone may be retrieved for sets of access points matching attribute in the request
		produces:
		- application/json
		@@ -256,12 +276,15 @@ paths:
		resourceURL: 'http://example.com/exampleAPI/location/v1/users/acr%3A192.0.2.5'
		resourceURL: 'http://example.com/exampleAPI/location/v1/users'
		'/users/{userId}':
		parameters:
		- $ref: '#/parameters/Path.UserId'
		get:
		tags:
		- users
		operationId: usersGetById
		description: Users currently using a zone may be retrieved for sets of access points matching attribute in the request
		produces:
		- application/json
		parameters:
		- $ref: '#/parameters/Path.UserId'
		responses:
		'200':
		description: Successful response to a query users within a zone request
		@@ -284,6 +307,9 @@ paths:
		contextLocationInfo: GroundFloor
		/subscriptions/zonalTraffic:
		get:
		tags:
		- subscriptions
		operationId: zonalTrafficSubGet
		description: This operation is used for retrieving all active subscriptions to zonal traffic change notifications.
		produces:
		- application/json
		@@ -322,6 +348,9 @@ paths:
		userEventCriteria: Transferring
		resourceURL: 'http://example.com/exampleAPI/location/v1/zonalTraffic'
		post:
		tags:
		- subscriptions
		operationId: zonalTrafficSubPost
		description: This operation is used for creating a new subscription to zonal traffic change notification.
		produces:
		- application/json
		@@ -345,12 +374,15 @@ paths:
		interestRealm: LA
		userEventCriteria: Transferring
		'/subscriptions/zonalTraffic/{subscriptionId}':
		parameters:
		- $ref: '#/parameters/Path.SubscriptionId'
		get:
		tags:
		- subscriptions
		operationId: zonalTrafficSubGetById
		description: This operation is used for updating an individual subscription to zonal traffic change notification.
		produces:
		- application/json
		parameters:
		- $ref: '#/parameters/Path.SubscriptionId'
		responses:
		'200':
		description: Response to retrieve individual zonal traffic subscription
		@@ -369,11 +401,13 @@ paths:
		interestRealm: LA
		userEventCriteria: Transferring
		put:
		tags:
		- subscriptions
		operationId: zonalTrafficSubPutById
		description: This operation is used for updating an individual subscription to zonal traffic change notification.
		produces:
		- application/json
		parameters:
		- $ref: '#/parameters/Path.SubscriptionId'
		- $ref: '#/parameters/Body.ZonalTrafficSubscription'
		responses:
		'200':
		@@ -393,16 +427,20 @@ paths:
		interestRealm: LA
		userEventCriteria: Transferring
		delete:
		tags:
		- subscriptions
		operationId: zonalTrafficSubDelById
		description: This operation is used for cancelling a subscription and stopping corresponding notifications.
		produces:
		- application/json
		parameters:
		- $ref: '#/parameters/Path.SubscriptionId'
		responses:
		'204':
		description: No content
		/subscriptions/userTracking:
		get:
		tags:
		- subscriptions
		operationId: userTrackingSubGet
		description: This operation is used for retrieving all active subscriptions to user tracking change notifications.
		produces:
		- application/json
		@@ -439,6 +477,9 @@ paths:
		userEventCriteria: Transferring
		resourceURL: 'http://example.com/exampleAPI/location/v1/subscriptions/userTracking'
		post:
		tags:
		- subscriptions
		operationId: userTrackingSubPost
		description: This operation is used for creating a new subscription to user tracking change notification
		produces:
		- application/json
		@@ -461,12 +502,15 @@ paths:
		address: 'acr:192.0.2.1'
		userEventCriteria: Transferring
		'/subscriptions/userTracking/{subscriptionId}':
		parameters:
		- $ref: '#/parameters/Path.SubscriptionId'
		get:
		tags:
		- subscriptions
		operationId: userTrackingSubGetById
		description: This operation is used for retrieving an individual subscription to user tracking change notification.
		produces:
		- application/json
		parameters:
		- $ref: '#/parameters/Path.SubscriptionId'
		responses:
		'200':
		description: Response to retrieve individual user tracking subscription
		@@ -484,11 +528,13 @@ paths:
		address: 'acr:192.0.2.1'
		userEventCriteria: Transferring
		put:
		tags:
		- subscriptions
		operationId: userTrackingSubPutById
		description: This operation is used for updating an individual subscription to user tracking change notification.
		produces:
		- application/json
		parameters:
		- $ref: '#/parameters/Path.SubscriptionId'
		- $ref: '#/parameters/Body.UserTrackingSubscription'
		responses:
		'200':
		@@ -507,16 +553,20 @@ paths:
		address: 'acr:192.0.2.1'
		userEventCriteria: Transferring
		delete:
		tags:
		- subscriptions
		operationId: userTrackingSubDelById
		description: This operation is used for retrieving an individual subscription to user tracking change notification.
		produces:
		- application/json
		parameters:
		- $ref: '#/parameters/Path.SubscriptionId'
		responses:
		'204':
		description: No Content
		/subscriptions/zonalStatus:
		get:
		tags:
		- subscriptions
		operationId: zoneStatusGet
		description: This operation is used for creating a new subscription to zone status change notification.
		produces:
		- application/json
		@@ -555,6 +605,9 @@ paths:
		operationStatus: Serviceable
		resourceURL: 'http://example.com/exampleAPI/location/v1/subscriptions/zoneStatus'
		post:
		tags:
		- subscriptions
		operationId: zoneStatusPost
		description: This operation is used for creating a new subscription to zone status change notification.
		produces:
		- application/json
		@@ -578,12 +631,15 @@ paths:
		numberOfUsersZoneThreshold: '500'
		operationStatus: Serviceable
		'/subscriptions/zoneStatus/{subscriptionId}':
		parameters:
		- $ref: '#/parameters/Path.SubscriptionId'
		get:
		tags:
		- subscriptions
		operationId: zoneStatusGetById
		description: This operation is used for retrieving an individual subscription to zone status change notification.
		produces:
		- application/json
		parameters:
		- $ref: '#/parameters/Path.SubscriptionId'
		responses:
		'200':
		description: Response to retrieve individual zone status subscription
		@@ -602,11 +658,13 @@ paths:
		numberOfUsersZoneThreshold: '500'
		operationStatus: Serviceable
		put:
		tags:
		- subscriptions
		operationId: zoneStatusPutById
		description: This operation is used for updating an individual subscription to zone status change notification.
		produces:
		- application/json
		parameters:
		- $ref: '#/parameters/Path.SubscriptionId'
		- $ref: '#/parameters/Body.ZoneStatusSubscription'
		responses:
		'200':
		@@ -626,11 +684,12 @@ paths:
		numberOfUsersZoneThreshold: '500'
		operationStatus: Serviceable
		delete:
		tags:
		- subscriptions
		operationId: zoneStatusDelById
		description: This operation is used for cancelling a subscription and stopping corresponding notifications.
		produces:
		- application/json
		parameters:
		- $ref: '#/parameters/Path.SubscriptionId'
		responses:
		'204':
		description: No content
		@@ -709,6 +768,7 @@ definitions:
		description: The connection type for the access point
		type: string
		enum:
		- Femto
		- LTE-femto
		- Smallcell
		- LTE-smallcell

paths/SubsUserTrackId.yaml

+3 −0

File changed.

Preview size limit exceeded, changes collapsed.

paths/SubsUserTrackId_Del.yaml

+3 −3

File changed.

Preview size limit exceeded, changes collapsed.