Updated to V1.0.1 release MEC(17)000425 and corrected unit32 (835c6dc9) · Commits · MEC - Multi-access Edge Computing / Device Application Interface API

UEAppInterfaceApi.json

+622 −604

Original line number	Original line	Diff line number	Diff line
	{		{
	"swagger": "2.0",		"swagger": "2.0",
	"info": {		"info": {
	"description": "An initial attempt to describe the MEC UE Application Interface API using OpenAPI",		"description": "The ETSI MEC ISG MEC016 UE Application Interface API described using OpenAPI",
	"version": "0.3.1",		"version": "1.0.1",
	"title": "UE Application Interface API",		"title": "UE Application Interface API",
	"license": {		"license": {
	"name": "ETSI Forge copyright notice",		"name": "ETSI Forge copyright notice",
	@@ -10,7 +10,7 @@
	}		}
	},		},
	"externalDocs": {		"externalDocs": {
	"description": "ETSI MEC016 V0.3.1 UE Application Interface API",		"description": "ETSI GS MEC016 UE Application Interface API, V1.0.1",
	"url": "https://docbox.etsi.org/ISG/MEC/70-Draft/0016UEAppInterface"		"url": "https://docbox.etsi.org/ISG/MEC/70-Draft/0016UEAppInterface"
	},		},
	"host": "127.0.0.1:8081",		"host": "127.0.0.1:8081",
	@@ -139,6 +139,7 @@
	"200": {		"200": {
	"description": "The response body contains the ApplicationList resource available for the querying UE application",		"description": "The response body contains the ApplicationList resource available for the querying UE application",
	"schema": {		"schema": {
			"type": "object",
	"required": [		"required": [
	"ApplicationList"		"ApplicationList"
	],		],
	@@ -152,6 +153,7 @@
	"400": {		"400": {
	"description": "Incorrect parameters were passed in the request.More information should be provided in the \"detail\" attribute of the \"ProblemDetails\" structure.",		"description": "Incorrect parameters were passed in the request.More information should be provided in the \"detail\" attribute of the \"ProblemDetails\" structure.",
	"schema": {		"schema": {
			"type": "object",
	"properties": {		"properties": {
	"ProblemDetails": {		"ProblemDetails": {
	"$ref": "#/definitions/ProblemDetails"		"$ref": "#/definitions/ProblemDetails"
	@@ -162,6 +164,7 @@
	"401": {		"401": {
	"description": "An erroneous or missing bearer token. More information should be provided in the \"detail\" attribute of the \"ProblemDetails\" structure.",		"description": "An erroneous or missing bearer token. More information should be provided in the \"detail\" attribute of the \"ProblemDetails\" structure.",
	"schema": {		"schema": {
			"type": "object",
	"properties": {		"properties": {
	"ProblemDetails": {		"ProblemDetails": {
	"$ref": "#/definitions/ProblemDetails"		"$ref": "#/definitions/ProblemDetails"
	@@ -172,6 +175,7 @@
	"403": {		"403": {
	"description": "The operation is not allowed given the current status of the resource. More information should be provided in the \"detail\" attribute of the \"ProblemDetails\" structure.",		"description": "The operation is not allowed given the current status of the resource. More information should be provided in the \"detail\" attribute of the \"ProblemDetails\" structure.",
	"schema": {		"schema": {
			"type": "object",
	"required": [		"required": [
	"ProblemDetails"		"ProblemDetails"
	],		],
	@@ -185,6 +189,7 @@
	"404": {		"404": {
	"description": "The client provided a URI that cannot be mapped to a valid resource URL. More information should be provided in the \"detail\" attribute of the \"ProblemDetails\" structure.",		"description": "The client provided a URI that cannot be mapped to a valid resource URL. More information should be provided in the \"detail\" attribute of the \"ProblemDetails\" structure.",
	"schema": {		"schema": {
			"type": "object",
	"properties": {		"properties": {
	"ProblemDetails": {		"ProblemDetails": {
	"$ref": "#/definitions/ProblemDetails"		"$ref": "#/definitions/ProblemDetails"
	@@ -210,6 +215,7 @@
	"201": {		"201": {
	"description": "The response body contains the Application Context as it was created by the mobile edge system",		"description": "The response body contains the Application Context as it was created by the mobile edge system",
	"schema": {		"schema": {
			"type": "object",
	"required": [		"required": [
	"AppContext"		"AppContext"
	],		],
	@@ -223,6 +229,7 @@
	"400": {		"400": {
	"description": "Incorrect parameters were passed in the request.More information should be provided in the \"detail\" attribute of the \"ProblemDetails\" structure.",		"description": "Incorrect parameters were passed in the request.More information should be provided in the \"detail\" attribute of the \"ProblemDetails\" structure.",
	"schema": {		"schema": {
			"type": "object",
	"properties": {		"properties": {
	"ProblemDetails": {		"ProblemDetails": {
	"$ref": "#/definitions/ProblemDetails"		"$ref": "#/definitions/ProblemDetails"
	@@ -233,6 +240,7 @@
	"401": {		"401": {
	"description": "An erroneous or missing bearer token. More information should be provided in the \"detail\" attribute of the \"ProblemDetails\" structure.",		"description": "An erroneous or missing bearer token. More information should be provided in the \"detail\" attribute of the \"ProblemDetails\" structure.",
	"schema": {		"schema": {
			"type": "object",
	"properties": {		"properties": {
	"ProblemDetails": {		"ProblemDetails": {
	"$ref": "#/definitions/ProblemDetails"		"$ref": "#/definitions/ProblemDetails"
	@@ -243,6 +251,7 @@
	"403": {		"403": {
	"description": "The operation is not allowed given the current status of the resource. More information should be provided in the \"detail\" attribute of the \"ProblemDetails\" structure.",		"description": "The operation is not allowed given the current status of the resource. More information should be provided in the \"detail\" attribute of the \"ProblemDetails\" structure.",
	"schema": {		"schema": {
			"type": "object",
	"required": [		"required": [
	"ProblemDetails"		"ProblemDetails"
	],		],
	@@ -256,6 +265,7 @@
	"404": {		"404": {
	"description": "The client provided a URI that cannot be mapped to a valid resource URL. More information should be provided in the \"detail\" attribute of the \"ProblemDetails\" structure.",		"description": "The client provided a URI that cannot be mapped to a valid resource URL. More information should be provided in the \"detail\" attribute of the \"ProblemDetails\" structure.",
	"schema": {		"schema": {
			"type": "object",
	"properties": {		"properties": {
	"ProblemDetails": {		"ProblemDetails": {
	"$ref": "#/definitions/ProblemDetails"		"$ref": "#/definitions/ProblemDetails"
	@@ -287,6 +297,7 @@
	"400": {		"400": {
	"description": "Incorrect parameters were passed in the request.More information should be provided in the \"detail\" attribute of the \"ProblemDetails\" structure.",		"description": "Incorrect parameters were passed in the request.More information should be provided in the \"detail\" attribute of the \"ProblemDetails\" structure.",
	"schema": {		"schema": {
			"type": "object",
	"properties": {		"properties": {
	"ProblemDetails": {		"ProblemDetails": {
	"$ref": "#/definitions/ProblemDetails"		"$ref": "#/definitions/ProblemDetails"
	@@ -297,6 +308,7 @@
	"401": {		"401": {
	"description": "An erroneous or missing bearer token. More information should be provided in the \"detail\" attribute of the \"ProblemDetails\" structure.",		"description": "An erroneous or missing bearer token. More information should be provided in the \"detail\" attribute of the \"ProblemDetails\" structure.",
	"schema": {		"schema": {
			"type": "object",
	"properties": {		"properties": {
	"ProblemDetails": {		"ProblemDetails": {
	"$ref": "#/definitions/ProblemDetails"		"$ref": "#/definitions/ProblemDetails"
	@@ -307,6 +319,7 @@
	"403": {		"403": {
	"description": "The operation is not allowed given the current status of the resource. More information should be provided in the \"detail\" attribute of the \"ProblemDetails\" structure.",		"description": "The operation is not allowed given the current status of the resource. More information should be provided in the \"detail\" attribute of the \"ProblemDetails\" structure.",
	"schema": {		"schema": {
			"type": "object",
	"required": [		"required": [
	"ProblemDetails"		"ProblemDetails"
	],		],
	@@ -320,6 +333,7 @@
	"404": {		"404": {
	"description": "The client provided a URI that cannot be mapped to a valid resource URL. More information should be provided in the \"detail\" attribute of the \"ProblemDetails\" structure.",		"description": "The client provided a URI that cannot be mapped to a valid resource URL. More information should be provided in the \"detail\" attribute of the \"ProblemDetails\" structure.",
	"schema": {		"schema": {
			"type": "object",
	"properties": {		"properties": {
	"ProblemDetails": {		"ProblemDetails": {
	"$ref": "#/definitions/ProblemDetails"		"$ref": "#/definitions/ProblemDetails"
	@@ -346,6 +360,7 @@
	"400": {		"400": {
	"description": "Incorrect parameters were passed in the request. More information should be provided in the \"detail\" attribute of the \"ProblemDetails\" structure.",		"description": "Incorrect parameters were passed in the request. More information should be provided in the \"detail\" attribute of the \"ProblemDetails\" structure.",
	"schema": {		"schema": {
			"type": "object",
	"properties": {		"properties": {
	"ProblemDetails": {		"ProblemDetails": {
	"$ref": "#/definitions/ProblemDetails"		"$ref": "#/definitions/ProblemDetails"
	@@ -356,6 +371,7 @@
	"401": {		"401": {
	"description": "An erroneous or missing bearer token. More information should be provided in the \"detail\" attribute of the \"ProblemDetails\" structure.",		"description": "An erroneous or missing bearer token. More information should be provided in the \"detail\" attribute of the \"ProblemDetails\" structure.",
	"schema": {		"schema": {
			"type": "object",
	"properties": {		"properties": {
	"ProblemDetails": {		"ProblemDetails": {
	"$ref": "#/definitions/ProblemDetails"		"$ref": "#/definitions/ProblemDetails"
	@@ -366,6 +382,7 @@
	"403": {		"403": {
	"description": "The operation is not allowed given the current status of the resource. More information should be provided in the \"detail\" attribute of the \"ProblemDetails\" structure.",		"description": "The operation is not allowed given the current status of the resource. More information should be provided in the \"detail\" attribute of the \"ProblemDetails\" structure.",
	"schema": {		"schema": {
			"type": "object",
	"required": [		"required": [
	"ProblemDetails"		"ProblemDetails"
	],		],
	@@ -379,6 +396,7 @@
	"404": {		"404": {
	"description": "The client provided a URI that cannot be mapped to a valid resource URL. More information should be provided in the \"detail\" attribute of the \"ProblemDetails\" structure.",		"description": "The client provided a URI that cannot be mapped to a valid resource URL. More information should be provided in the \"detail\" attribute of the \"ProblemDetails\" structure.",
	"schema": {		"schema": {
			"type": "object",
	"properties": {		"properties": {
	"ProblemDetails": {		"ProblemDetails": {
	"$ref": "#/definitions/ProblemDetails"		"$ref": "#/definitions/ProblemDetails"
	@@ -435,7 +453,7 @@
	"description": "A URI reference that identifies the specific occurrence of the problem"		"description": "A URI reference that identifies the specific occurrence of the problem"
	},		},
	"ApplicationList": {		"ApplicationList": {
	"description": "information on available applications",		"description": "Information on available applications",
	"type": "object",		"type": "object",
	"properties": {		"properties": {
	"appInfo": {		"appInfo": {
	@@ -447,7 +465,7 @@
	}		}
	},		},
	"AppContext": {		"AppContext": {
	"description": "information on application context created by the mobile edge system",		"description": "Information on application context created by the mobile edge system",
	"type": "object",		"type": "object",
	"required": [		"required": [
	"contextId",		"contextId",
	@@ -470,7 +488,7 @@
	}		}
	},		},
	"NotificationEvent": {		"NotificationEvent": {
	"description": "the parameters used in the method 'Receiving notification events'.",		"description": "The parameters used in the method \"Receiving notification events\".",
	"type": "object",		"type": "object",
	"required": [		"required": [
	"referenceURI"		"referenceURI"
	@@ -589,22 +607,22 @@
	"Memory": {		"Memory": {
	"description": "The maximum size in Mbytes of the memory resource reserved for the mobile edge application instance in the mobile edge system",		"description": "The maximum size in Mbytes of the memory resource reserved for the mobile edge application instance in the mobile edge system",
	"type": "integer",		"type": "integer",
	"format": "unit32"		"format": "uint32"
	},		},
	"Storage": {		"Storage": {
	"description": "The maximum size in Mbytes of the storage resource expected to be used by the mobile edge application instance in the mobile edge system",		"description": "The maximum size in Mbytes of the storage resource expected to be used by the mobile edge application instance in the mobile edge system",
	"type": "integer",		"type": "integer",
	"format": "unit32"		"format": "uint32"
	},		},
	"Latency": {		"Latency": {
	"description": "The target round trip time in milliseconds supported by the mobile edge system for the mobile edge application instance",		"description": "The target round trip time in milliseconds supported by the mobile edge system for the mobile edge application instance",
	"type": "integer",		"type": "integer",
	"format": "unit32"		"format": "uint32"
	},		},
	"Bandwidth": {		"Bandwidth": {
	"description": "The required connection bandwidth in kbit/s for the use of the mobile edge application instance",		"description": "The required connection bandwidth in kbit/s for the use of the mobile edge application instance",
	"type": "integer",		"type": "integer",
	"format": "unit32"		"format": "uint32"
	},		},
	"ServiceCont": {		"ServiceCont": {
	"description": "Required service continuity mode for this application.",		"description": "Required service continuity mode for this application.",
	@@ -627,7 +645,7 @@
	"type": "string"		"type": "string"
	},		},
	"AppDescription": {		"AppDescription": {
	"description": "-> Human readable description of the mobile edge application. 'NOTE:' the language support may be limited. The length of the value shall not exceed 128 characters.",		"description": "Human readable description of the mobile edge application. NOTE: the language support may be limited. The length of the value shall not exceed 128 characters.",
	"type": "string"		"type": "string"
	},		},
	"CallbackReference": {		"CallbackReference": {
	@@ -641,7 +659,7 @@
	"format": "uri"		"format": "uri"
	},		},
	"AppPackageSource": {		"AppPackageSource": {
	"description": "URI of the application package. Included in the request if the application is not one in the ApplicationList. appPackageSource enables on-boarding of the application package into the mobile edge system. The application package shall comply with the definitions in clause 6.2.1.2 of ETSI GS MEC 010-2 [1]",		"description": "URI of the application package. Included in the request if the application is not one in the ApplicationList. appPackageSource enables on-boarding of the application package into the mobile edge system. The application package shall comply with the definitions in clause 6.2.1.2 of ETSI GS MEC 010-2",
	"type": "string",		"type": "string",
	"format": "uri"		"format": "uri"
	}		}

UEAppInterfaceApi.yaml

+81 −118

File changed.

Preview size limit exceeded, changes collapsed.

Admin message