Merge branch 'stf606-final' into 'master' (7dc352ee) · Commits · MEC - Multi-access Edge Computing / Device Application Interface API

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/gs016-ue-app-api/raw/v2.2.1/UEAppInterfaceApi.yaml).
		* [Edit the API online](https://forge.etsi.org/swagger/editor/?url=https://forge.etsi.org/rep/mec/gs016-ue-app-api/raw/v2.2.1/UEAppInterfaceApi.yaml).
		* [Navigate the API in the browser](https://forge.etsi.org/swagger/ui/?url=https://forge.etsi.org/rep/mec/gs016-ue-app-api/raw/stf606-final/UEAppInterfaceApi.yaml).
		* [Edit the API online](https://forge.etsi.org/swagger/editor/?url=https://forge.etsi.org/rep/mec/gs016-ue-app-api/raw/stf606-final/UEAppInterfaceApi.yaml).

		## License

UEAppInterfaceApi.json

+20 −68

Original line number	Diff line number	Diff line
		{
		"openapi": "3.0.0",
		"openapi": "3.1.0",
		"info": {
		"contact": {
		"url": "https://forge.etsi.org/rep/mec/gs016-dev-app-api"
		@@ -29,9 +29,7 @@
		"paths": {
		"/app_list": {
		"get": {
		"tags": [
		"dev_app"
		],
		"tags": ["dev_app"],
		"summary": "Get available application information.",
		"description": "Used to query information about the available MEC applications.",
		"operationId": "meAppListGET",
		@@ -80,9 +78,7 @@
		},
		"/app_contexts": {
		"post": {
		"tags": [
		"dev_app"
		],
		"tags": ["dev_app"],
		"summary": "Creation of a new application context.",
		"description": "Used to create a new application context. Upon success, the response contains entity body describing the created application context.",
		"operationId": "devAppContextsGET",
		@@ -157,9 +153,7 @@
		},
		"/app_contexts/{contextId}": {
		"put": {
		"tags": [
		"dev_app"
		],
		"tags": ["dev_app"],
		"summary": "Updating the callbackReference and/or appLocation of an existing application context.",
		"description": "Used to update the callback reference and/or application location constraints of an existing application context. Upon successful operation, the target resource is updated with the new application context information.",
		"operationId": "devAppContextPUT",
		@@ -198,9 +192,7 @@
		}
		},
		"delete": {
		"tags": [
		"dev_app"
		],
		"tags": ["dev_app"],
		"summary": "Deletion of an existing application context.",
		"description": "Used to delete the resource that represents the existing application context.",
		"operationId": "devAppContextDELETE",
		@@ -230,9 +222,7 @@
		},
		"/obtain_app_loc_availability": {
		"post": {
		"tags": [
		"dev_app"
		],
		"tags": ["dev_app"],
		"summary": "Obtain the location constraints for a new application context.",
		"description": "Used to obtain the locations available for instantiation of a specific user application in the MEC system.",
		"operationId": "appLocationAvailabilityPOST",
		@@ -381,10 +371,7 @@
		"required": false,
		"schema": {
		"type": "integer",
		"enum": [
		0,
		1
		]
		"enum": [0, 1]
		}
		},
		"Path.contextId": {
		@@ -560,10 +547,7 @@
		"x-etsi-mec-origin-type": "String"
		}
		},
		"required": [
		"associateDevAppId",
		"appInfo"
		],
		"required": ["associateDevAppId", "appInfo"],
		"type": "object",
		"x-etsi-notes": "NOTE 1:\tIf a value of the attribute is included in the request, the same value shall be included in the response.\nNOTE 2:\tThe design of the current operation with callback reference assumes no web proxy between the entity that originates the notification and the entity that receives it.\nNOTE 3:\tThe language support for the application description may be limited.\nNOTE 4:\tAttribute appLocationUpdates and appAutoInstantiation shall not both be set to TRUE.",
		"x-etsi-ref": "6.2.3"
		@@ -583,10 +567,7 @@
		"x-etsi-mec-origin-type": "String"
		}
		},
		"required": [
		"notificationType",
		"contextId"
		],
		"required": ["notificationType", "contextId"],
		"type": "object",
		"x-etsi-ref": "6.4.3"
		},
		@@ -628,21 +609,14 @@
		}
		},
		"minItems": 1,
		"required": [
		"appInstanceId",
		"referenceURI"
		],
		"required": ["appInstanceId", "referenceURI"],
		"type": "array",
		"x-etsi-mec-cardinality": "1..N",
		"x-etsi-mec-origin-type": "array (Structure inlined)"
		}
		},
		"type": "object",
		"required": [
		"notificationType",
		"contextId",
		"userAppInstanceInfo"
		],
		"required": ["notificationType", "contextId", "userAppInstanceInfo"],
		"x-etsi-ref": "6.4.4"
		},
		"ApplicationList": {
		@@ -681,10 +655,7 @@
		},
		"serviceCont": {
		"description": "Required service continuity mode for this application. Permitted values: 0 = SERVICE_CONTINUITY_NOT_REQUIRED. 1 = SERVICE_CONTINUITY_REQUIRED.",
		"enum": [
		0,
		1
		],
		"enum": [0, 1],
		"type": "integer",
		"x-etsi-mec-cardinality": "0..1",
		"x-etsi-mec-origin-type": "Enum"
		@@ -775,9 +746,7 @@
		"x-etsi-mec-origin-type": "String"
		}
		},
		"required": [
		"vendorId"
		],
		"required": ["vendorId"],
		"type": "object",
		"x-etsi-mec-cardinality": "0..1",
		"x-etsi-mec-origin-type": "Structure (inlined)"
		@@ -785,9 +754,7 @@
		}
		},
		"minItems": 0,
		"required": [
		"appInfo"
		],
		"required": ["appInfo"],
		"type": "array",
		"x-etsi-mec-cardinality": "0..N",
		"x-etsi-mec-origin-type": "Array (Structure (inlined))"
		@@ -859,11 +826,7 @@
		"x-etsi-mec-origin-type": "array (Structure (inline))"
		}
		},
		"required": [
		"appName",
		"appProvider",
		"appDVersion"
		],
		"required": ["appName", "appProvider", "appDVersion"],
		"type": "object",
		"x-etsi-mec-cardinality": "1",
		"x-etsi-mec-origin-type": "Structure (inlined)"
		@@ -876,10 +839,7 @@
		"x-etsi-mec-origin-type": "String"
		}
		},
		"required": [
		"associateDevAppId",
		"appInfo"
		],
		"required": ["associateDevAppId", "appInfo"],
		"type": "object",
		"x-etsi-ref": "6.2.4"
		},
		@@ -896,9 +856,7 @@
		}
		},
		"minItems": 1,
		"required": [
		"appLocation"
		],
		"required": ["appLocation"],
		"type": "array",
		"x-etsi-mec-cardinality": "1..N",
		"x-etsi-mec-origin-type": "array (Structure (inline))"
		@@ -917,10 +875,7 @@
		}
		},
		"type": "object",
		"required": [
		"notificationType",
		"availableLocations"
		],
		"required": ["notificationType", "availableLocations"],
		"x-etsi-ref": "6.4.5"
		},
		"InlineNotification": {
		@@ -967,10 +922,7 @@
		}
		},
		"minItems": 0,
		"required": [
		"caType",
		"caValue"
		],
		"required": ["caType", "caValue"],
		"type": "array",
		"x-etsi-mec-cardinality": "0..N",
		"x-etsi-mec-origin-type": "array (Structure inlined)"

UEAppInterfaceApi.yaml

+32 −32

Original line number	Diff line number	Diff line
		openapi: 3.0.0
		openapi: 3.1.0
		info:
		contact:
		url: https://forge.etsi.org/rep/mec/gs016-dev-app-api
		@@ -34,19 +34,19 @@ paths:
		- $ref: '#/components/parameters/Query.vendorId'
		- $ref: '#/components/parameters/Query.serviceCont'
		responses:
		200:
		"200":
		description: "The response body contains an array of the user applications available to the querying device application."
		content:
		application/json:
		schema:
		$ref: "#/components/schemas/ApplicationList"
		400:
		"400":
		$ref: "#/components/responses/400"
		401:
		"401":
		$ref: "#/components/responses/401"
		403:
		"403":
		$ref: '#/components/responses/403'
		404:
		"404":
		$ref: '#/components/responses/404'
		/app_contexts:
		post:
		@@ -64,19 +64,19 @@ paths:
		$ref: '#/components/schemas/AppContext'
		parameters: []
		responses:
		201:
		"201":
		description: "The response body contains the Application Context as it was created by the MEC system, which includes the reference URI(s) of the associated user application instance(s). The URI of the resource created within the MEC system associated with the request, with its specific application context ID, shall be included in the 'Location' HTTP header of the response."
		content:
		application/json:
		schema:
		$ref: "#/components/schemas/AppContext"
		400:
		"400":
		$ref: '#/components/responses/400'
		401:
		"401":
		$ref: '#/components/responses/401'
		403:
		"403":
		$ref: '#/components/responses/403'
		404:
		"404":
		$ref: '#/components/responses/404'
		callbacks:
		notification:
		@@ -96,7 +96,7 @@ paths:
		notificationType: ApplicationContextDeleteNotification
		contextId: 'contextId123'
		responses:
		204:
		"204":
		$ref: '#/components/responses/204'
		/app_contexts/{contextId}:
		put:
		@@ -115,15 +115,15 @@ paths:
		parameters:
		- $ref: '#/components/parameters/Path.contextId'
		responses:
		204:
		"204":
		$ref: '#/components/responses/204'
		400:
		"400":
		$ref: '#/components/responses/400'
		401:
		"401":
		$ref: '#/components/responses/401'
		403:
		"403":
		$ref: '#/components/responses/403'
		404:
		"404":
		$ref: '#/components/responses/404'
		delete:
		tags:
		@@ -134,15 +134,15 @@ paths:
		parameters:
		- $ref: '#/components/parameters/Path.contextId'
		responses:
		204:
		"204":
		$ref: '#/components/responses/204'
		400:
		"400":
		$ref: '#/components/responses/400'
		401:
		"401":
		$ref: '#/components/responses/401'
		403:
		"403":
		$ref: '#/components/responses/403'
		404:
		"404":
		$ref: '#/components/responses/404'
		/obtain_app_loc_availability:
		post:
		@@ -160,43 +160,43 @@ paths:
		$ref: '#/components/schemas/ApplicationLocationAvailability'
		parameters: []
		responses:
		200:
		"200":
		description: "The response body contains the locations available for instantiation of the requested user application in the MEC system."
		content:
		application/json:
		schema:
		$ref: "#/components/schemas/ApplicationLocationAvailability"
		400:
		"400":
		$ref: '#/components/responses/400'
		401:
		"401":
		$ref: '#/components/responses/401'
		403:
		"403":
		$ref: '#/components/responses/403'
		404:
		"404":
		$ref: '#/components/responses/404'
		components:
		responses:
		204:
		'204':
		description: "Upon success, a response 204 No Content without any response body is returned."
		400:
		'400':
		description: 'Bad Request : used to indicate that incorrect parameters were passed to the request.'
		content:
		application/problem+json:
		schema:
		$ref: '#/components/schemas/ProblemDetails'
		401:
		'401':
		description: 'Unauthorized : used when the client did not submit credentials.'
		content:
		application/problem+json:
		schema:
		$ref: '#/components/schemas/ProblemDetails'
		403:
		'403':
		description: 'Forbidden : operation is not allowed given the current status of the resource.'
		content:
		application/problem+json:
		schema:
		$ref: '#/components/schemas/ProblemDetails'
		404:
		'404':
		description: 'Not Found : used when a client provided a URI that cannot be mapped to a valid resource URI.'
		content:
		application/problem+json:

Admin message