diff --git a/.jenkins.sh b/.jenkins.sh index 425806ae95fbbf4b325b7c4e34e6211f7937d894..ef0a02168eb97478e4d3b9edb2baa78c1d4ede90 100644 --- a/.jenkins.sh +++ b/.jenkins.sh @@ -1,11 +1,11 @@ #!/bin/bash -specfiles=$(ls | egrep "^[^.]*Api.(json|yaml)") +specfiles=$(ls | egrep "^[^.]*.(json|yaml)") fres=0 for i in $specfiles ; do echo "-- Validating and linting OpenAPI file $i..." - swagger-cli validate "$i" + swagger-cli validate $i res=$? speccy lint "$i" res2=$? diff --git a/README.md b/README.md index 360e1df952d550c68f2d72b77ddb9cf784856acc..5022aa9ba2bafb4031dff5adc9b1a4a3b9229458 100644 --- a/README.md +++ b/README.md @@ -4,12 +4,11 @@ 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/master/UEAppInterfaceApi.yaml). -* [Edit the API online](https://forge.etsi.org/swagger/editor/?url=https://forge.etsi.org/gitlab/mec/gs016-ue-app-api/raw/master/UEAppInterfaceApi.yaml). +* [Navigate the API in the browser](https://forge.etsi.org/swagger/ui/?url=https://forge.etsi.org/gitlab/mec/gs016-ue-app-api/raw/stf593/UEAppInterfaceApi.yaml). +* [Edit the API online](https://forge.etsi.org/swagger/editor/?url=https://forge.etsi.org/gitlab/mec/gs016-ue-app-api/raw/stf593/UEAppInterfaceApi.yaml). ## License -Unless specified otherwise, the content of this repository and the files +Unless specified otherwise, the content of this repository and the files contained are released under the BSD-3-Clause license. See the attached LICENSE file or visit https://forge.etsi.org/legal-matters. - diff --git a/UEAppInterfaceApi.json b/UEAppInterfaceApi.json index 2c41f69cee258d5b259773cc90ef5752d2e610a3..f004d43c423782d87671ed62fe654507d4630b90 100644 --- a/UEAppInterfaceApi.json +++ b/UEAppInterfaceApi.json @@ -1,278 +1,367 @@ { - "openapi": "3.0.2", + "openapi": "3.0.0", "info": { - "title": "UE Application Interface API", - "version": "2.1.1", - "description": "The ETSI MEC ISG MEC016 UE Application Interface API described using OpenAPI", + "contact": { + "url": "https://forge.etsi.org/rep/mec/gs016-dev-app-api" + }, + "title": "ETSI GS MEC 016 Device application interface", + "version": "2.2.1", + "description": "The ETSI MEC ISG Device application interface API described using OpenAPI.", "license": { "name": "BSD-3-Clause", "url": "https://forge.etsi.org/legal-matters" - }, - "contact": { - "email": "cti_support@etsi.org" } }, "externalDocs": { - "description": "ETSI GS MEC016 UE Application Interface API, V2.1.1", - "url": "https://www.etsi.org/deliver/etsi_gs/MEC/001_099/016/02.01.01_60/gs_MEC016v020101p.pdf" + "description": "ETSI GS MEC016 V2.2.1 Device application interface", + "url": "https://www.etsi.org/deliver/etsi_gs/MEC/001_099/016/02.02.01_60/gs_MEC016v020201p.pdf" }, - "security": [ - { - "OauthSecurity": [ - "all" - ] - } - ], "servers": [ { - "url": "http://127.0.0.1:8081/mx2/v2" - }, - { - "url": "https://127.0.0.1:8081/mx2/v2" + "url": "https://localhost/dev_app/v1" } ], "tags": [ { - "name": "appList" - }, - { - "name": "appContext" - }, - { - "name": "callback" + "name": "dev_app" } ], "paths": { "/app_list": { "get": { - "description": "Used to query information about the available MEC applications.", - "operationId": "AppList_GET", "tags": [ - "appList" + "dev_app" ], + "summary": "Get available application information.", + "description": "Used to query information about the available MEC applications.", + "operationId": "meAppListGET", "parameters": [ { - "$ref": "#/components/parameters/Query.AppName" + "$ref": "#/components/parameters/Query.appName" }, { - "$ref": "#/components/parameters/Query.AppProvider" + "$ref": "#/components/parameters/Query.appProvider" }, { - "$ref": "#/components/parameters/Query.AppSoftVersion" + "$ref": "#/components/parameters/Query.appSoftVersion" }, { - "$ref": "#/components/parameters/Query.ServiceCont" + "$ref": "#/components/parameters/Query.vendorId" }, { - "$ref": "#/components/parameters/Query.VendorId" + "$ref": "#/components/parameters/Query.serviceCont" } ], "responses": { "200": { - "$ref": "#/components/responses/AppList" + "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": { - "$ref": "#/components/responses/Error.400" + "$ref": "#/components/responses/400" }, "401": { - "$ref": "#/components/responses/Error.401" + "$ref": "#/components/responses/401" }, "403": { - "$ref": "#/components/responses/Error.403" + "$ref": "#/components/responses/403" }, "404": { - "$ref": "#/components/responses/Error.404" + "$ref": "#/components/responses/404" } } } }, "/app_contexts": { "post": { - "description": "The POST method can be used to create a new application context. Upon success, the response contains entity body describing the created application context.", - "operationId": "AppContext_POST", "tags": [ - "appContext" + "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", "requestBody": { - "$ref": "#/components/requestBodies/AppContext" + "description": "Entity body in the request contains the Application Context as requested by the device application.", + "required": true, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/AppContext" + } + } + } }, + "parameters": [], "responses": { "201": { - "$ref": "#/components/responses/AppContext" + "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": { - "$ref": "#/components/responses/Error.400" + "$ref": "#/components/responses/400" }, "401": { - "$ref": "#/components/responses/Error.401" + "$ref": "#/components/responses/401" }, "403": { - "$ref": "#/components/responses/Error.403" + "$ref": "#/components/responses/403" }, "404": { - "$ref": "#/components/responses/Error.404" + "$ref": "#/components/responses/404" } }, "callbacks": { - "referenceURI": { - "$ref": "#/components/callbacks/NotificationEvent" + "notification": { + "{$request.body#/appContext.callbackReference}": { + "post": { + "summary": "Callback POST used to send a notification", + "description": "Notification with content based on subscription type", + "operationId": "notificationPOST", + "requestBody": { + "description": "Subscription notification", + "required": true, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/InlineNotification" + }, + "example": { + "notificationType": "ApplicationContextDeleteNotification", + "contextId": "contextId123" + } + } + } + }, + "responses": { + "204": { + "$ref": "#/components/responses/204" + } + } + } + } } } } }, "/app_contexts/{contextId}": { - "parameters": [ - { - "$ref": "#/components/parameters/Path.ContextId" - } - ], "put": { - "description": "The PUT method is used to update the callback reference of the existing application context. Upon successful operation, the target resource is updated with new callback reference.", - "operationId": "AppContextId_PUT", "tags": [ - "appContext" + "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", "requestBody": { - "$ref": "#/components/requestBodies/AppContext" + "description": "Only the callbackReference and/or appLocation attribute values are allowed to be updated. Other attributes and their values shall remain untouched.", + "required": true, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/AppContext" + } + } + } }, + "parameters": [ + { + "$ref": "#/components/parameters/Path.contextId" + } + ], "responses": { "204": { - "description": "No Content." + "$ref": "#/components/responses/204" }, "400": { - "$ref": "#/components/responses/Error.400" + "$ref": "#/components/responses/400" }, "401": { - "$ref": "#/components/responses/Error.401" + "$ref": "#/components/responses/401" }, "403": { - "$ref": "#/components/responses/Error.403" + "$ref": "#/components/responses/403" }, "404": { - "$ref": "#/components/responses/Error.404" - } - }, - "callbacks": { - "referenceURI": { - "$ref": "#/components/callbacks/NotificationEvent" + "$ref": "#/components/responses/404" } } }, "delete": { - "description": "The DELETE method is used to delete the resource that represents the existing application context.", - "operationId": "AppContextId_DEL", "tags": [ - "appContext" + "dev_app" + ], + "summary": "Deletion of an existing application context.", + "description": "Used to delete the resource that represents the existing application context.", + "operationId": "devAppContextDELETE", + "parameters": [ + { + "$ref": "#/components/parameters/Path.contextId" + } ], "responses": { "204": { - "description": "No Content" + "$ref": "#/components/responses/204" }, "400": { - "$ref": "#/components/responses/Error.400" + "$ref": "#/components/responses/400" }, "401": { - "$ref": "#/components/responses/Error.401" + "$ref": "#/components/responses/401" }, "403": { - "$ref": "#/components/responses/Error.403" + "$ref": "#/components/responses/403" }, "404": { - "$ref": "#/components/responses/Error.404" + "$ref": "#/components/responses/404" + } + } + } + }, + "/obtain_app_loc_availability": { + "post": { + "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", + "requestBody": { + "description": "Entity body in the request contains the user application information for the MEC system to evaluate the locations available for instantiation of that application.", + "required": true, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ApplicationLocationAvailability" + } + } + } + }, + "parameters": [], + "responses": { + "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": { + "$ref": "#/components/responses/400" + }, + "401": { + "$ref": "#/components/responses/401" + }, + "403": { + "$ref": "#/components/responses/403" + }, + "404": { + "$ref": "#/components/responses/404" } } } } }, "components": { - "callbacks": { - "NotificationEvent": { - "{$request.body#/callbackReference}": { - "post": { - "description": "Used by the UALCMP to inform the Device application of a modification to reference URI of the user application.", - "operationId": "NotificationEvent_POST", - "tags": [ - "callback" - ], - "requestBody": { - "$ref": "#/components/requestBodies/NotificationEvent" - }, - "responses": { - "204": { - "description": "No Content." - } + "responses": { + "204": { + "description": "Upon success, a response 204 No Content without any response body is returned." + }, + "400": { + "description": "Bad Request : used to indicate that incorrect parameters were passed to the request.", + "content": { + "application/problem+json": { + "schema": { + "$ref": "#/components/schemas/ProblemDetails" } } } - } - }, - "links": { - "PutAppContext": { - "operationId": "AppContextId_PUT", - "description": "The `contextId` value returned in the response can be used as the `contextId` parameter in `PUT /app_contexts/{contextId}`", - "parameters": { - "contextId": "$response.body#/contextId" + }, + "401": { + "description": "Unauthorized : used when the client did not submit credentials.", + "content": { + "application/problem+json": { + "schema": { + "$ref": "#/components/schemas/ProblemDetails" + } + } } }, - "DelAppContext": { - "operationId": "AppContextId_DEL", - "description": "The `contextId` value returned in the response can be used as the `contextId` parameter in `DELETE /app_contexts/{contextId}`", - "parameters": { - "contextId": "$response.body#/contextId" + "403": { + "description": "Forbidden : operation is not allowed given the current status of the resource.", + "content": { + "application/problem+json": { + "schema": { + "$ref": "#/components/schemas/ProblemDetails" + } + } + } + }, + "404": { + "description": "Not Found : used when a client provided a URI that cannot be mapped to a valid resource URI.", + "content": { + "application/problem+json": { + "schema": { + "$ref": "#/components/schemas/ProblemDetails" + } + } } } }, "parameters": { - "Query.AppName": { + "Query.appName": { "name": "appName", "in": "query", - "description": "Name to identify the MEC application", + "description": "Name to identify the MEC application.", "required": false, "schema": { "type": "array", "items": { - "type": "string" + "type": "string", + "maxLength": 32 } } }, - "Query.AppProvider": { + "Query.appProvider": { "name": "appProvider", "in": "query", - "description": "Provider of the MEC application", + "description": "Provider of the MEC application.", "required": false, "schema": { "type": "array", "items": { - "type": "string" + "type": "string", + "maxLength": 32 } } }, - "Query.AppSoftVersion": { + "Query.appSoftVersion": { "name": "appSoftVersion", "in": "query", - "description": "Software version of the MEC application", + "description": "Software version of the MEC application.", "required": false, "schema": { "type": "array", "items": { - "type": "string" + "type": "string", + "maxLength": 32 } } }, - "Query.ServiceCont": { - "name": "serviceCont", - "in": "query", - "description": "Required service continuity mode for this application", - "required": false, - "schema": { - "type": "string", - "enum": [ - "SERVICE_CONTINUITY_NOT_REQUIRED", - "SERVICE_CONTINUITY_REQUIRED" - ] - } - }, - "Query.VendorId": { + "Query.vendorId": { "name": "vendorId", "in": "query", "description": "Vendor identifier", @@ -280,438 +369,683 @@ "schema": { "type": "array", "items": { - "type": "string" + "type": "string", + "maxLength": 32 } } }, - "Path.ContextId": { + "Query.serviceCont": { + "name": "serviceCont", + "in": "query", + "description": "Required service continuity mode for this application. Permitted values: 0 = SERVICE_CONTINUITY_NOT_REQUIRED. 1 = SERVICE_CONTINUITY_REQUIRED.", + "required": false, + "schema": { + "type": "integer", + "enum": [ + 0, + 1 + ] + } + }, + "Path.contextId": { "name": "contextId", "in": "path", - "description": "Uniquely identifies the application context in the MEC system. It is assigned by the MEC system and included in the response to an AppContext create.", + "description": "Uniquely identifies the application context in the MEC system. It is assigned by the MEC system.", "required": true, "schema": { "type": "string" } } }, - "requestBodies": { - "AppContext": { - "description": "Uniquely identifies the application context in the MEC system. It is assigned by the MEC system and included in the response to an AppContext create.", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/AppContext" - } - } - }, - "required": true - }, - "NotificationEvent": { - "description": "Sent by the UALCMP to the Device application.", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/NotificationEvent" - } - } - }, - "required": true - } - }, - "responses": { - "AppContext": { - "description": "The response body contains the Application Context as it was created by the MEC system", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/AppContext" - } - } - }, - "links": { - "putAppContext": { - "$ref": "#/components/links/PutAppContext" - }, - "delAppContext": { - "$ref": "#/components/links/DelAppContext" - } - } - }, - "AppList": { - "description": "The response body contains the ApplicationList resource available for the querying Device application", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ApplicationList" - } - } - } - }, - "Error.400": { - "description": "Bad Request. It is used to indicate that incorrect parameters were passed to the request.", - "content": { - "application/problem+json": { - "schema": { - "$ref": "#/components/schemas/ProblemDetails" - } + "schemas": { + "AddressChangeNotification": { + "properties": { + "appInstanceId": { + "description": "Identifier of the user application instance.", + "type": "string", + "x-etsi-mec-cardinality": "1", + "x-etsi-mec-origin-type": "String" }, - "text/plain": { - "schema": { - "$ref": "#/components/schemas/Empty" - } - } - } - }, - "Error.401": { - "description": "Unauthorized. It is used when the client did not submit the appropriate credentials.", - "content": { - "application/problem+json": { - "schema": { - "$ref": "#/components/schemas/ProblemDetails" - } + "contextId": { + "description": "Uniquely identifies the application context in the MEC system.", + "type": "string", + "x-etsi-mec-cardinality": "1", + "x-etsi-mec-origin-type": "String" }, - "text/plain": { - "schema": { - "$ref": "#/components/schemas/Empty" - } - } - } - }, - "Error.403": { - "description": "Forbidden. The operation is not allowed given the current status of the resource. ", - "content": { - "application/problem+json": { - "schema": { - "$ref": "#/components/schemas/ProblemDetails" - } - } - } - }, - "Error.404": { - "description": "Not Found. It is used when a client provided a URI that cannot be mapped to a valid resource URI.", - "content": { - "application/problem+json": { - "schema": { - "$ref": "#/components/schemas/ProblemDetails" - } + "notificationType": { + "description": "Shall be set to \"AddressChangeNotification\".", + "type": "string", + "x-etsi-mec-cardinality": "1", + "x-etsi-mec-origin-type": "String" }, - "text/plain": { - "schema": { - "$ref": "#/components/schemas/Empty" - } - } - } - } - }, - "securitySchemes": { - "OauthSecurity": { - "type": "oauth2", - "flows": { - "clientCredentials": { - "tokenUrl": "https://oauth.exampleAPI/token", - "scopes": { - "all": "Single oauth2 scope for API" - } + "referenceURI": { + "description": "Address of the user application. Used as the reference URI for the application. Assigned by the MEC system.", + "format": "uri", + "type": "string", + "x-etsi-mec-cardinality": "1", + "x-etsi-mec-origin-type": "URI" } - } - } - }, - "schemas": { - "Empty": { - "description": "Empty schema" - }, - "ProblemDetails": { + }, + "required": [ + "notificationType", + "contextId", + "appInstanceId", + "referenceURI" + ], "type": "object", + "x-etsi-ref": "6.4.2" + }, + "AppContext": { "properties": { - "type": { - "$ref": "#/components/schemas/Problem.type" + "appAutoInstantiation": { + "description": "Provides indication to the MEC system that instantiation of the requested application is desired should a requested appLocation become available that was not at the time of the request.", + "type": "boolean", + "x-etsi-mec-cardinality": "0..1", + "x-etsi-mec-origin-type": "Boolean" }, - "title": { - "$ref": "#/components/schemas/Problem.title" + "appInfo": { + "description": "", + "properties": { + "appDId": { + "description": "Identifier of this MEC application descriptor. This attribute shall be globally unique. It is equivalent to the appDId defined in clause 6.2.1.2 of ETSI GS MEC 0102 [1]. It shall be present if the application is one in the ApplicationList.", + "type": "string", + "x-etsi-mec-cardinality": "0..1", + "x-etsi-mec-origin-type": "String" + }, + "appDVersion": { + "description": "Identifies the version of the application descriptor. It is equivalent to the appDVersion defined in clause 6.2.1.2 of ETSI GS MEC 0102 [1].", + "type": "string", + "x-etsi-mec-cardinality": "1", + "x-etsi-mec-origin-type": "String" + }, + "appDescription": { + "description": "Human readable description of the MEC application. The length of the value shall not exceed 128 characters.", + "type": "string", + "maxLength": 128, + "x-etsi-mec-cardinality": "0..1", + "x-etsi-mec-origin-type": "String" + }, + "appName": { + "description": "Name of the MEC application. The length of the value shall not exceed 32 characters.", + "type": "string", + "maxLength": 32, + "x-etsi-mec-cardinality": "1", + "x-etsi-mec-origin-type": "String" + }, + "appProvider": { + "description": "Provider of the MEC application.\nThe length of the value shall not exceed 32 characters.", + "type": "string", + "maxLength": 32, + "x-etsi-mec-cardinality": "1", + "x-etsi-mec-origin-type": "String" + }, + "appSoftVersion": { + "description": "Software version of the MEC application. The length of the value shall not exceed 32 characters.", + "type": "string", + "maxLength": 32, + "x-etsi-mec-cardinality": "0..1", + "x-etsi-mec-origin-type": "String" + }, + "appPackageSource": { + "description": "URI of the application package.\nIncluded in the request if the application is not one in the ApplicationList. appPackageSource enables on-boarding of the application package into the MEC system. The application package shall comply with the definitions in clause 6.2.1.2 of ETSI GS MEC 0102 [1].", + "format": "uri", + "type": "string", + "x-etsi-mec-cardinality": "0..1", + "x-etsi-mec-origin-type": "URI" + }, + "userAppInstanceInfo": { + "description": "List of user application instance information.", + "items": { + "type": "object", + "properties": { + "appInstanceId": { + "description": "Identifier of the user application instance. It shall only be included in the response.", + "type": "string", + "x-etsi-mec-cardinality": "0..1", + "x-etsi-mec-origin-type": "String" + }, + "appLocation": { + "$ref": "#/components/schemas/LocationConstraints" + }, + "referenceURI": { + "description": "Address of the user application instance. It shall only be included in the response.", + "format": "uri", + "type": "string", + "x-etsi-mec-cardinality": "0..1", + "x-etsi-mec-origin-type": "URI" + } + } + }, + "minItems": 1, + "type": "array", + "x-etsi-mec-cardinality": "1..N", + "x-etsi-mec-origin-type": "array (Structure inlined)" + } + }, + "required": [ + "appName", + "appProvider", + "appDVersion", + "userAppInstanceInfo" + ], + "type": "object", + "x-etsi-mec-cardinality": "1", + "x-etsi-mec-origin-type": "Structure (inlined)" }, - "status": { - "$ref": "#/components/schemas/Problem.status" + "appLocationUpdates": { + "description": "Used by the device application to request to receive notifications at the callbackReference URI relating to location availability for user application instantiation.", + "type": "boolean", + "x-etsi-mec-cardinality": "0..1", + "x-etsi-mec-origin-type": "Boolean" }, - "detail": { - "$ref": "#/components/schemas/Problem.detail" + "associateDevAppId": { + "description": "Uniquely identifies the device application. The length of the value shall not exceed 32 characters.", + "type": "string", + "maxLength": 32, + "x-etsi-mec-cardinality": "1", + "x-etsi-mec-origin-type": "String" }, - "instance": { - "$ref": "#/components/schemas/Problem.instance" + "callbackReference": { + "description": "URI assigned by the device application to receive application lifecycle related notifications. Inclusion in the request implies the client supports the pub/sub mechanism and is capable of receiving notifications. This endpoint shall be maintained for the lifetime of the application context.", + "format": "uri", + "type": "string", + "x-etsi-mec-cardinality": "0..1", + "x-etsi-mec-origin-type": "URI" + }, + "contextId": { + "description": "Uniquely identifies the application context in the MEC system. Assigned by the MEC system and shall be present other than in a create request. The length of the value shall not exceed 32 characters.", + "type": "string", + "maxLength": 32, + "x-etsi-mec-cardinality": "0..1", + "x-etsi-mec-origin-type": "String" } - } - }, - "Problem.type": { - "type": "string", - "format": "uri", - "description": "A URI reference according to IETF RFC 3986 that identifies the problem type" - }, - "Problem.title": { - "type": "string", - "description": "A short, human-readable summary of the problem type" - }, - "Problem.status": { - "type": "integer", - "format": "uint32", - "description": "The HTTP status code for this occurrence of the problem" - }, - "Problem.detail": { - "type": "string", - "description": "A human-readable explanation specific to this occurrence of the problem" - }, - "Problem.instance": { - "type": "string", - "format": "uri", - "description": "A URI reference that identifies the specific occurrence of the problem" - }, - "ApplicationList": { - "description": "Information on available applications", + }, + "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" + }, + "ApplicationContextDeleteNotification": { "properties": { - "appList": { - "$ref": "#/components/schemas/AppList" + "contextId": { + "description": "Uniquely identifies the application context that has been deleted from the MEC system.", + "type": "string", + "x-etsi-mec-cardinality": "1", + "x-etsi-mec-origin-type": "String" }, - "vendorSpecificExt": { - "$ref": "#/components/schemas/VendorSpecificExt" + "notificationType": { + "description": "Shall be set to \"ApplicationContextDeleteNotification\".", + "type": "string", + "x-etsi-mec-cardinality": "1", + "x-etsi-mec-origin-type": "String" } - } - }, - "AppList": { - "description": "List of user applications available to the device application", - "type": "array", - "minItems": 0, - "items": { - "type": "object", - "required": [ - "appInfo" - ], - "properties": { - "appInfo": { - "$ref": "#/components/schemas/AppInfo" - } - } - } - }, - "AppContext": { - "description": "Information on application context created by the MEC system", - "type": "object", + }, "required": [ - "contextId", - "associateUeAppId", - "callbackReference", - "appInfo" + "notificationType", + "contextId" ], + "type": "object", + "x-etsi-ref": "6.4.3" + }, + "ApplicationContextUpdateNotification": { "properties": { "contextId": { - "$ref": "#/components/schemas/ContextId" + "description": "Uniquely identifies the application context in the MEC system.", + "type": "string", + "x-etsi-mec-cardinality": "1", + "x-etsi-mec-origin-type": "String" }, - "associateUeAppId": { - "$ref": "#/components/schemas/AssociateUeAppId" + "notificationType": { + "description": "Shall be set to \"ApplicationContextUpdateNotification\".", + "type": "string", + "x-etsi-mec-cardinality": "1", + "x-etsi-mec-origin-type": "String" }, - "callbackReference": { - "$ref": "#/components/schemas/CallbackReference" - }, - "appInfo": { - "$ref": "#/components/schemas/AppInfoAppContext" + "userAppInstanceInfo": { + "description": "List of user application instance information.", + "items": { + "type": "object", + "properties": { + "appInstanceId": { + "description": "Identifier of the user application instance.", + "type": "string", + "x-etsi-mec-cardinality": "1", + "x-etsi-mec-origin-type": "String" + }, + "appLocation": { + "$ref": "#/components/schemas/LocationConstraints" + }, + "referenceURI": { + "description": "Address of the user application instance.", + "format": "uri", + "type": "string", + "x-etsi-mec-cardinality": "1", + "x-etsi-mec-origin-type": "URI" + } + } + }, + "minItems": 1, + "required": [ + "appInstanceId", + "referenceURI" + ], + "type": "array", + "x-etsi-mec-cardinality": "1..N", + "x-etsi-mec-origin-type": "array (Structure inlined)" } - } - }, - "NotificationEvent": { - "description": "The parameters used in the method \"Receiving notification events\".", + }, "type": "object", "required": [ - "referenceURI" + "notificationType", + "contextId", + "userAppInstanceInfo" ], + "x-etsi-ref": "6.4.4" + }, + "ApplicationList": { "properties": { - "referenceURI": { - "$ref": "#/components/schemas/ReferenceURL" + "appList": { + "description": "List of user applications available to the device application. As defined below.", + "items": { + "type": "object", + "properties": { + "appInfo": { + "description": "", + "properties": { + "appCharcs": { + "description": "Characteristics of the application. As defined below. The application characteristics relate to the system resources consumed by the application. A device application can use this information e.g. for estimating the cost of use of the application or for the expected user experience.", + "properties": { + "bandwidth": { + "description": "The required connection bandwidth in kbit/s for the use of the MEC application instance. ", + "type": "integer", + "format": "int32", + "x-etsi-mec-cardinality": "0..1", + "x-etsi-mec-origin-type": "uint32" + }, + "latency": { + "description": "The target round trip time in milliseconds supported by the MEC system for the MEC application instance.", + "type": "integer", + "format": "int32", + "x-etsi-mec-cardinality": "0..1", + "x-etsi-mec-origin-type": "uint32" + }, + "memory": { + "description": "The maximum size in Mbytes of the memory resource expected to be used by the MEC application instance in the MEC system.", + "type": "integer", + "format": "int32", + "x-etsi-mec-cardinality": "0..1", + "x-etsi-mec-origin-type": "uint32" + }, + "serviceCont": { + "description": "Required service continuity mode for this application. Permitted values: 0 = SERVICE_CONTINUITY_NOT_REQUIRED. 1 = SERVICE_CONTINUITY_REQUIRED.", + "enum": [ + 0, + 1 + ], + "type": "integer", + "x-etsi-mec-cardinality": "0..1", + "x-etsi-mec-origin-type": "Enum" + }, + "storage": { + "description": "The maximum size in Mbytes of the storage resource expected to be used by the MEC application instance in the MEC system.", + "type": "integer", + "format": "int32", + "x-etsi-mec-cardinality": "0..1", + "x-etsi-mec-origin-type": "uint32" + } + }, + "type": "object", + "x-etsi-mec-cardinality": "0..1", + "x-etsi-mec-origin-type": "Structure (inlined)" + }, + "appDId": { + "description": "Identifier of this MEC application descriptor. It is equivalent to the appDId defined in clause 6.2.1.2 of ETSI GS MEC 0102 [1]. This attribute shall be globally unique.", + "type": "string", + "x-etsi-mec-cardinality": "1", + "x-etsi-mec-origin-type": "String" + }, + "appDVersion": { + "description": "Identifies the version of the application descriptor. It is equivalent to the appDVersion defined in clause 6.2.1.2 of ETSI GS MEC 0102 [1].", + "type": "string", + "x-etsi-mec-cardinality": "1", + "x-etsi-mec-origin-type": "String" + }, + "appDescription": { + "description": "Human readable description of the MEC application (see note 2).", + "type": "string", + "maxLength": 128, + "x-etsi-mec-cardinality": "1", + "x-etsi-mec-origin-type": "String" + }, + "appLocation": { + "description": "Identifies the locations of the MEC application.", + "items": { + "$ref": "#/components/schemas/LocationConstraints" + }, + "minItems": 0, + "type": "array", + "x-etsi-mec-cardinality": "0..N", + "x-etsi-mec-origin-type": "LocationConstraints" + }, + "appName": { + "description": "Name of the MEC application. The length of the value shall not exceed 32 characters.", + "type": "string", + "maxLength": 32, + "x-etsi-mec-cardinality": "1", + "x-etsi-mec-origin-type": "String" + }, + "appProvider": { + "description": "Provider of the MEC application. The length of the value shall not exceed 32 characters.", + "type": "string", + "maxLength": 32, + "x-etsi-mec-cardinality": "1", + "x-etsi-mec-origin-type": "String" + }, + "appSoftVersion": { + "description": "Software version of the MEC application. The length of the value shall not exceed 32 characters.", + "type": "string", + "maxLength": 32, + "x-etsi-mec-cardinality": "1", + "x-etsi-mec-origin-type": "String" + } + }, + "required": [ + "appDId", + "appName", + "appProvider", + "appSoftVersion", + "appDVersion", + "appDescription" + ], + "type": "object", + "x-etsi-mec-cardinality": "1", + "x-etsi-mec-origin-type": "Structure (inlined)" + }, + "vendorSpecificExt": { + "description": "Extension for vendor specific information (see note 1).", + "properties": { + "vendorId": { + "description": "Vendor identifier. The length of the value shall not exceed 32 characters. The rest of the structure of vendor specific extension is not defined.", + "type": "string", + "maxLength": 32, + "x-etsi-mec-cardinality": "1", + "x-etsi-mec-origin-type": "String" + } + }, + "required": [ + "vendorId" + ], + "type": "object", + "x-etsi-mec-cardinality": "0..1", + "x-etsi-mec-origin-type": "Structure (inlined)" + } + } + }, + "minItems": 0, + "required": [ + "appInfo" + ], + "type": "array", + "x-etsi-mec-cardinality": "0..N", + "x-etsi-mec-origin-type": "Array (Structure (inlined))" } - } + }, + "type": "object", + "x-etsi-notes": "NOTE 1:\tThe vendor specific extension allows submitting information on the application lists that have been made available to the device application of the corresponding vendor.\nNOTE 2:\tThe language support may be limited. The length of the value shall not exceed 128 characters.", + "x-etsi-ref": "6.2.2" }, - "VendorSpecificExt": { - "description": "Extension for vendor-specific information", - "required": [ - "vendorId" - ], + "ApplicationLocationAvailability": { "properties": { - "vendorId": { - "$ref": "#/components/schemas/VendorId" + "appInfo": { + "description": "", + "properties": { + "appDVersion": { + "description": "Identifies the version of the application descriptor. It is equivalent to the appDVersion defined in clause 6.2.1.2 of ETSI GS MEC 0102 [1].", + "type": "string", + "x-etsi-mec-cardinality": "1", + "x-etsi-mec-origin-type": "String" + }, + "appDescription": { + "description": "Human readable description of the MEC application. The length of the value shall not exceed 128 characters.", + "type": "string", + "maxLength": 128, + "x-etsi-mec-cardinality": "0..1", + "x-etsi-mec-origin-type": "String" + }, + "appName": { + "description": "Name of the MEC application. The length of the value shall not exceed 32 characters.", + "type": "string", + "maxLength": 32, + "x-etsi-mec-cardinality": "1", + "x-etsi-mec-origin-type": "String" + }, + "appPackageSource": { + "description": "URI of the application package. Shall be included in the request. The application package shall comply with the definitions in clause 6.2.1.2 of ETSI GS MEC 0102 [1].", + "format": "uri", + "type": "string", + "x-etsi-mec-cardinality": "0..1", + "x-etsi-mec-origin-type": "URI" + }, + "appProvider": { + "description": "Provider of the MEC application. The length of the value shall not exceed 32 characters.", + "type": "string", + "maxLength": 32, + "x-etsi-mec-cardinality": "1", + "x-etsi-mec-origin-type": "String" + }, + "appSoftVersion": { + "description": "Software version of the MEC application. The length of the value shall not exceed 32 characters.", + "type": "string", + "maxLength": 32, + "x-etsi-mec-cardinality": "0..1", + "x-etsi-mec-origin-type": "String" + }, + "availableLocations": { + "description": "MEC application location constraints. ", + "items": { + "type": "object", + "properties": { + "appLocation": { + "$ref": "#/components/schemas/LocationConstraints" + } + } + }, + "minItems": 0, + "type": "array", + "x-etsi-mec-cardinality": "0..N", + "x-etsi-mec-origin-type": "array (Structure (inline))" + } + }, + "required": [ + "appName", + "appProvider", + "appDVersion" + ], + "type": "object", + "x-etsi-mec-cardinality": "1", + "x-etsi-mec-origin-type": "Structure (inlined)" + }, + "associateDevAppId": { + "description": "Uniquely identifies the device application. The length of the value shall not exceed 32 characters.", + "type": "string", + "maxLength": 32, + "x-etsi-mec-cardinality": "1", + "x-etsi-mec-origin-type": "String" } - } - }, - "ContextId": { - "description": "Uniquely identifies the application context in the MEC system. Assigned by the MEC system and included in the response. The length of the value shall not exceed 32 characters.", - "type": "string", - "readOnly": true - }, - "AssociateUeAppId": { - "description": "Uniquely identifies the Device application. Included in the request. The length of the value shall not exceed 32 characters.", - "type": "string", - "writeOnly": true - }, - "VendorId": { - "description": "Vendor identifier. The length of the value shall not exceed 32 characters. The rest of the structure of this vendor specific extension is not defined", - "type": "string" - }, - "AppInfo": { - "type": "object", + }, "required": [ - "appDId", - "appName", - "appProvider", - "appSoftVersion", - "appDVersion", - "appDescription" + "associateDevAppId", + "appInfo" ], + "type": "object", + "x-etsi-ref": "6.2.4" + }, + "ApplicationLocationAvailabilityNotification": { "properties": { - "appDId": { - "$ref": "#/components/schemas/AppDId" - }, - "appName": { - "$ref": "#/components/schemas/AppName" - }, - "appProvider": { - "$ref": "#/components/schemas/AppProvider" - }, - "appSoftVersion": { - "$ref": "#/components/schemas/AppSoftVersion" - }, - "appDVersion": { - "$ref": "#/components/schemas/AppDVersion" + "availableLocations": { + "description": "Locations available to the MEC application.", + "items": { + "type": "object", + "properties": { + "appLocation": { + "$ref": "#/components/schemas/LocationConstraints" + } + } + }, + "minItems": 1, + "required": [ + "appLocation" + ], + "type": "array", + "x-etsi-mec-cardinality": "1..N", + "x-etsi-mec-origin-type": "array (Structure (inline))" }, - "appDescription": { - "$ref": "#/components/schemas/AppDescription" + "contextId": { + "description": "Uniquely identifies the application context in the MEC system.", + "type": "string", + "x-etsi-mec-cardinality": "0..1", + "x-etsi-mec-origin-type": "String" }, - "appCharcs": { - "$ref": "#/components/schemas/AppCharcs" + "notificationType": { + "description": "Shall be set to \"ApplicationLocationAvailabilityNotification\".", + "type": "string", + "x-etsi-mec-cardinality": "1", + "x-etsi-mec-origin-type": "String" } - } - }, - "AppInfoAppContext": { - "description": "Included in the request", + }, "type": "object", "required": [ - "appName", - "appProvider", - "appDVersion" + "notificationType", + "availableLocations" ], - "properties": { - "appDId": { - "$ref": "#/components/schemas/AppDId" - }, - "appName": { - "$ref": "#/components/schemas/AppName" - }, - "appProvider": { - "$ref": "#/components/schemas/AppProvider" - }, - "appSoftVersion": { - "$ref": "#/components/schemas/AppSoftVersion" - }, - "appDVersion": { - "$ref": "#/components/schemas/AppDVersion" + "x-etsi-ref": "6.4.5" + }, + "InlineNotification": { + "oneOf": [ + { + "$ref": "#/components/schemas/AddressChangeNotification" }, - "appDescription": { - "$ref": "#/components/schemas/AppDescription" + { + "$ref": "#/components/schemas/ApplicationContextDeleteNotification" }, - "referenceURL": { - "$ref": "#/components/schemas/ReferenceURL" + { + "$ref": "#/components/schemas/ApplicationContextUpdateNotification" }, - "appPackageSource": { - "$ref": "#/components/schemas/AppPackageSource" + { + "$ref": "#/components/schemas/ApplicationLocationAvailabilityNotification" } + ], + "discriminator": { + "propertyName": "notificationType" } }, - "AppCharcs": { - "description": "The application characteristics relate to the system resources consumed by the application. Device application can use this information e.g., for estimating the cost of use of the application or for the expected user experience", + "LocationConstraints": { + "properties": { + "area": { + "$ref": "#/components/schemas/Polygon" + }, + "civicAddressElement": { + "description": "Zero or more elements comprising the civic address. Shall be absent if the \"area\" attribute is present.", + "items": { + "type": "object", + "properties": { + "caType": { + "description": "Describe the content type of caValue. The value of caType shall comply with section 3.4 of IETF RFC 4776 [6]. ", + "type": "integer", + "x-etsi-mec-cardinality": "1", + "x-etsi-mec-origin-type": "Integer" + }, + "caValue": { + "description": "Content of civic address element corresponding to the caType. The format caValue shall comply with section 3.4 of IETF RFC 4776 [6].", + "type": "string", + "x-etsi-mec-cardinality": "1", + "x-etsi-mec-origin-type": "String" + } + } + }, + "minItems": 0, + "required": [ + "caType", + "caValue" + ], + "type": "array", + "x-etsi-mec-cardinality": "0..N", + "x-etsi-mec-origin-type": "array (Structure inlined)" + }, + "countryCode": { + "description": "The two-letter ISO 3166 [7] country code in capital letters. Shall be present in case the \"area\" attribute is absent. May be absent if the \"area\" attribute is present (see note).", + "type": "string", + "maxLength": 2, + "x-etsi-mec-cardinality": "0..1", + "x-etsi-mec-origin-type": "String" + } + }, "type": "object", + "x-etsi-notes": "NOTE:\tIf both \"countryCode\" and \"area\" are present, no conflicts should exist between the values of these two attributes. In case of conflicts, the API producer (e.g. MEO, MEAO) shall disregard parts of the geographic area signalled by \"area\" that are outside the boundaries of the country signalled by \"countryCode\". If \"countryCode\" is absent, it is solely the \"area\" attribute that defines the location constraint.", + "x-etsi-ref": "6.5.2" + }, + "Polygon": { + "properties": { + "coordinates": { + "items": { + "items": { + "items": { + "type": "number", + "format": "float" + }, + "type": "array" + }, + "type": "array" + }, + "minItems": 1, + "type": "array", + "x-etsi-mec-cardinality": 1, + "x-etsi-mec-origin-type": "array" + } + }, + "type": "object" + }, + "ProblemDetails": { "properties": { - "memory": { - "$ref": "#/components/schemas/Memory" + "detail": { + "description": "A human-readable explanation specific to this occurrence of the problem", + "type": "string", + "x-etsi-mec-cardinality": "0..1", + "x-etsi-mec-origin-type": "String" }, - "storage": { - "$ref": "#/components/schemas/Storage" + "instance": { + "description": "A URI reference that identifies the specific occurrence of the problem", + "format": "uri", + "type": "string", + "x-etsi-mec-cardinality": "0..1", + "x-etsi-mec-origin-type": "URI" }, - "latency": { - "$ref": "#/components/schemas/Latency" + "status": { + "description": "The HTTP status code for this occurrence of the problem", + "format": "int32", + "type": "integer", + "x-etsi-mec-cardinality": "0..1", + "x-etsi-mec-origin-type": "Uint32" }, - "bandwidth": { - "$ref": "#/components/schemas/Bandwidth" + "title": { + "description": "A short, human-readable summary of the problem type", + "type": "string", + "x-etsi-mec-cardinality": "0..1", + "x-etsi-mec-origin-type": "String" }, - "serviceCont": { - "$ref": "#/components/schemas/ServiceCont" + "type": { + "description": "A URI reference according to IETF RFC 3986 that identifies the problem type", + "format": "uri", + "type": "string", + "x-etsi-mec-cardinality": "0..1", + "x-etsi-mec-origin-type": "URI" } - } - }, - "Memory": { - "description": "The maximum size in Mbytes of the memory resource reserved for the MEC application instance in the MEC system", - "type": "integer", - "format": "uint32" - }, - "Storage": { - "description": "The maximum size in Mbytes of the storage resource expected to be used by the MEC application instance in the MEC system", - "type": "integer", - "format": "uint32" - }, - "Latency": { - "description": "The target round trip time in milliseconds supported by the MEC system for the MEC application instance", - "type": "integer", - "format": "uint32" - }, - "Bandwidth": { - "description": "The required connection bandwidth in kbit/s for the use of the MEC application instance", - "type": "integer", - "format": "uint32" - }, - "ServiceCont": { - "description": "Required service continuity mode for this application.", - "type": "string", - "enum": [ - "SERVICE_CONTINUITY_NOT_REQUIRED", - "SERVICE_CONTINUITY_REQUIRED" - ], - "example": "SERVICE_CONTINUITY_NOT_REQUIRED" - }, - "AppDId": { - "description": "Identifier of this MEC application descriptor. It is equivalent to the appDId defined in clause 6.2.1.2 of ETSI GS MEC 010-2. This attribute shall be globally unique. It shall be present if the application is one in the ApplicationList.", - "type": "string" - }, - "AppName": { - "description": "Name of the MEC application. The length of the value shall not exceed 32 characters.", - "type": "string" - }, - "AppProvider": { - "description": "Provider of the MEC application. The length of the value shall not exceed 32 characters.", - "type": "string" - }, - "AppSoftVersion": { - "description": "Software version of the MEC application. The length of the value shall not exceed 32 characters.", - "type": "string" - }, - "AppDVersion": { - "description": "Identifies the version of the application descriptor. It is equivalent to the appDVersion defined in clause 6.2.1.2 of ETSI GS MEC 010-2.", - "type": "string" - }, - "AppDescription": { - "description": "Human readable description of the MEC application. NOTE the language support may be limited. The length of the value shall not exceed 128 characters.", - "type": "string" - }, - "CallbackReference": { - "description": "URI assigned by the Device application to receive application lifecycle related notifications. Included in the request. This subscription stays alive for the lifetime of the application context.", - "type": "string", - "format": "uri", - "writeOnly": true - }, - "ReferenceURL": { - "description": "Address of the user application. Used as the reference URL for the application. Assigned by the MEC system and included in the response", - "type": "string", - "format": "uri", - "readOnly": true - }, - "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 MEC system. The application package shall comply with the definitions in clause 6.2.1.2 of ETSI GS MEC 010-2", - "type": "string", - "format": "uri" + }, + "type": "object" } } } -} +} \ No newline at end of file diff --git a/UEAppInterfaceApi.yaml b/UEAppInterfaceApi.yaml index 8b8f4679b76a5cd42606036d6e97180210ccada1..f685176a2dc2bb72fcf78cc62ee3670016003985 100644 --- a/UEAppInterfaceApi.yaml +++ b/UEAppInterfaceApi.yaml @@ -1,573 +1,806 @@ -openapi: 3.0.2 +openapi: 3.0.0 info: - title: UE Application Interface API - version: 2.1.1 - description: >- - The ETSI MEC ISG MEC016 UE Application Interface API described using OpenAPI + contact: + url: https://forge.etsi.org/rep/mec/gs016-dev-app-api + title: 'ETSI GS MEC 016 Device application interface' + version: 2.2.1 + description: The ETSI MEC ISG Device application interface API described using OpenAPI. license: name: BSD-3-Clause - url: https://forge.etsi.org/legal-matters - contact: - email: cti_support@etsi.org + url: 'https://forge.etsi.org/legal-matters' + externalDocs: - description: >- - ETSI GS MEC016 UE Application Interface API, V2.1.1 - url: https://www.etsi.org/deliver/etsi_gs/MEC/001_099/016/02.01.01_60/gs_MEC016v020101p.pdf -security: - - OauthSecurity: - - all + description: ETSI GS MEC016 V2.2.1 Device application interface + url: 'https://www.etsi.org/deliver/etsi_gs/MEC/001_099/016/02.02.01_60/gs_MEC016v020201p.pdf' + servers: - - url: http://127.0.0.1:8081/mx2/v2 - - url: https://127.0.0.1:8081/mx2/v2 + - url: 'https://localhost/dev_app/v1' + tags: - - name: appList - - name: appContext - - name: callback +- name: "dev_app" + paths: - "/app_list": + /app_list: get: - description: >- - Used to query information about the available - MEC applications. - operationId: AppList_GET tags: - - appList + - "dev_app" + summary: "Get available application information." + description: "Used to query information about the available MEC applications." + operationId: "meAppListGET" parameters: - - $ref: "#/components/parameters/Query.AppName" - - $ref: "#/components/parameters/Query.AppProvider" - - $ref: "#/components/parameters/Query.AppSoftVersion" - - $ref: "#/components/parameters/Query.ServiceCont" - - $ref: "#/components/parameters/Query.VendorId" + - $ref: '#/components/parameters/Query.appName' + - $ref: '#/components/parameters/Query.appProvider' + - $ref: '#/components/parameters/Query.appSoftVersion' + - $ref: '#/components/parameters/Query.vendorId' + - $ref: '#/components/parameters/Query.serviceCont' responses: - "200": - $ref: '#/components/responses/AppList' - "400": - $ref: '#/components/responses/Error.400' - "401": - $ref: '#/components/responses/Error.401' - "403": - $ref: '#/components/responses/Error.403' - "404": - $ref: '#/components/responses/Error.404' - "/app_contexts": + 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: + $ref: "#/components/responses/400" + 401: + $ref: "#/components/responses/401" + 403: + $ref: '#/components/responses/403' + 404: + $ref: '#/components/responses/404' + /app_contexts: post: - description: >- - The POST method can be used to create a new application context. Upon - success, the response contains entity body describing the created - application context. - operationId: AppContext_POST tags: - - appContext + - "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" requestBody: - $ref: "#/components/requestBodies/AppContext" + description: "Entity body in the request contains the Application Context as requested by the device application." + required: true + content: + application/json: + schema: + $ref: '#/components/schemas/AppContext' + parameters: [] responses: - "201": - $ref: '#/components/responses/AppContext' - "400": - $ref: '#/components/responses/Error.400' - "401": - $ref: '#/components/responses/Error.401' - "403": - $ref: '#/components/responses/Error.403' - "404": - $ref: '#/components/responses/Error.404' + 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: + $ref: '#/components/responses/400' + 401: + $ref: '#/components/responses/401' + 403: + $ref: '#/components/responses/403' + 404: + $ref: '#/components/responses/404' callbacks: - referenceURI: - $ref: '#/components/callbacks/NotificationEvent' - "/app_contexts/{contextId}": - parameters: - - $ref: "#/components/parameters/Path.ContextId" + notification: + '{$request.body#/appContext.callbackReference}': + post: + summary: 'Callback POST used to send a notification' + description: 'Notification with content based on subscription type' + operationId: notificationPOST + requestBody: + description: Subscription notification + required: true + content: + application/json: + schema: + $ref: '#/components/schemas/InlineNotification' + example: + notificationType: ApplicationContextDeleteNotification + contextId: 'contextId123' + responses: + 204: + $ref: '#/components/responses/204' + /app_contexts/{contextId}: put: - description: >- - The PUT method is used to update the callback reference of the existing - application context. Upon successful operation, the target resource is - updated with new callback reference. - operationId: AppContextId_PUT tags: - - appContext + - "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" requestBody: - $ref: "#/components/requestBodies/AppContext" + description: "Only the callbackReference and/or appLocation attribute values are allowed to be updated. Other attributes and their values shall remain untouched." + required: true + content: + application/json: + schema: + $ref: '#/components/schemas/AppContext' + parameters: + - $ref: '#/components/parameters/Path.contextId' responses: - "204": - description: No Content. - "400": - $ref: '#/components/responses/Error.400' - "401": - $ref: '#/components/responses/Error.401' - "403": - $ref: '#/components/responses/Error.403' - "404": - $ref: '#/components/responses/Error.404' - callbacks: - referenceURI: - $ref: '#/components/callbacks/NotificationEvent' + 204: + $ref: '#/components/responses/204' + 400: + $ref: '#/components/responses/400' + 401: + $ref: '#/components/responses/401' + 403: + $ref: '#/components/responses/403' + 404: + $ref: '#/components/responses/404' delete: - description: >- - The DELETE method is used to delete the resource that represents the - existing application context. - operationId: AppContextId_DEL tags: - - appContext + - "dev_app" + summary: "Deletion of an existing application context." + description: "Used to delete the resource that represents the existing application context." + operationId: "devAppContextDELETE" + parameters: + - $ref: '#/components/parameters/Path.contextId' responses: - "204": - description: No Content - "400": - $ref: '#/components/responses/Error.400' - "401": - $ref: '#/components/responses/Error.401' - "403": - $ref: '#/components/responses/Error.403' - "404": - $ref: '#/components/responses/Error.404' + 204: + $ref: '#/components/responses/204' + 400: + $ref: '#/components/responses/400' + 401: + $ref: '#/components/responses/401' + 403: + $ref: '#/components/responses/403' + 404: + $ref: '#/components/responses/404' + /obtain_app_loc_availability: + post: + 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" + requestBody: + description: "Entity body in the request contains the user application information for the MEC system to evaluate the locations available for instantiation of that application." + required: true + content: + application/json: + schema: + $ref: '#/components/schemas/ApplicationLocationAvailability' + parameters: [] + responses: + 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: + $ref: '#/components/responses/400' + 401: + $ref: '#/components/responses/401' + 403: + $ref: '#/components/responses/403' + 404: + $ref: '#/components/responses/404' components: - callbacks: - NotificationEvent: - '{$request.body#/callbackReference}': - post: - description: >- - Used by the UALCMP to inform the Device application of - a modification to reference URI of the user application. - operationId: NotificationEvent_POST - tags: - - callback - requestBody: - $ref: '#/components/requestBodies/NotificationEvent' - responses: - '204': - description: No Content. - links: - PutAppContext: - operationId: AppContextId_PUT - description: The `contextId` value returned in the response can be used as the `contextId` parameter in `PUT /app_contexts/{contextId}` - parameters: - contextId: '$response.body#/contextId' - DelAppContext: - operationId: AppContextId_DEL - description: The `contextId` value returned in the response can be used as the `contextId` parameter in `DELETE /app_contexts/{contextId}` - parameters: - contextId: '$response.body#/contextId' + responses: + 204: + description: "Upon success, a response 204 No Content without any response body is returned." + 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: + description: 'Unauthorized : used when the client did not submit credentials.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/ProblemDetails' + 403: + description: 'Forbidden : operation is not allowed given the current status of the resource.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/ProblemDetails' + 404: + description: 'Not Found : used when a client provided a URI that cannot be mapped to a valid resource URI.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/ProblemDetails' parameters: - Query.AppName: + Query.appName: name: appName - in: query - description: >- - Name to identify the MEC application + in: "query" + description: "Name to identify the MEC application." required: false schema: type: array items: type: string - Query.AppProvider: + maxLength: 32 + Query.appProvider: name: appProvider - in: query - description: >- - Provider of the MEC application + in: "query" + description: "Provider of the MEC application." required: false schema: type: array items: type: string - Query.AppSoftVersion: + maxLength: 32 + Query.appSoftVersion: name: appSoftVersion - in: query - description: >- - Software version of the MEC application + in: "query" + description: "Software version of the MEC application." required: false schema: type: array items: type: string - Query.ServiceCont: - name: serviceCont - in: query - description: >- - Required service continuity mode for this application - required: false - schema: - type: string - enum: - - SERVICE_CONTINUITY_NOT_REQUIRED - - SERVICE_CONTINUITY_REQUIRED - Query.VendorId: + maxLength: 32 + Query.vendorId: name: vendorId - in: query - description: Vendor identifier + in: "query" + description: "Vendor identifier" required: false schema: type: array items: type: string - Path.ContextId: + maxLength: 32 + Query.serviceCont: + name: serviceCont + in: "query" + description: "Required service continuity mode for this application. Permitted values: + 0 = SERVICE_CONTINUITY_NOT_REQUIRED. + 1 = SERVICE_CONTINUITY_REQUIRED." + required: false + schema: + type: integer + enum: + - 0 + - 1 + Path.contextId: name: contextId - in: path - description: >- - Uniquely identifies the application context in the MEC system. - It is assigned by the MEC system and included in the response to - an AppContext create. + in: "path" + description: "Uniquely identifies the application context in the MEC system. It is assigned by the MEC system." required: true schema: type: string - requestBodies: - AppContext: - description: >- - Uniquely identifies the application context in the MEC system. - It is assigned by the MEC system and included in the response to - an AppContext create. - content: - application/json: - schema: - $ref: "#/components/schemas/AppContext" - required: true - NotificationEvent: - description: >- - Sent by the UALCMP to the Device application. - content: - application/json: - schema: - $ref: "#/components/schemas/NotificationEvent" - required: true - responses: - AppContext: - description: >- - The response body contains the Application Context as it was created - by the MEC system - content: - application/json: - schema: - $ref: "#/components/schemas/AppContext" - links: - putAppContext: - $ref: "#/components/links/PutAppContext" - delAppContext: - $ref: "#/components/links/DelAppContext" - AppList: - description: >- - The response body contains the ApplicationList resource available - for the querying Device application - content: - application/json: - schema: - $ref: "#/components/schemas/ApplicationList" - Error.400: - description: >- - Bad Request. - It is used to indicate that incorrect parameters were passed to the request. - content: - application/problem+json: - schema: - $ref: '#/components/schemas/ProblemDetails' - text/plain: - schema: - $ref: '#/components/schemas/Empty' - Error.401: - description: >- - Unauthorized. - It is used when the client did not submit the appropriate credentials. - content: - application/problem+json: - schema: - $ref: '#/components/schemas/ProblemDetails' - text/plain: - schema: - $ref: '#/components/schemas/Empty' - Error.403: - description: >- - Forbidden. - The operation is not allowed given the current status of the resource. - content: - application/problem+json: - schema: - $ref: '#/components/schemas/ProblemDetails' - Error.404: - description: >- - Not Found. - It is used when a client provided a URI that cannot be mapped - to a valid resource URI. - content: - application/problem+json: - schema: - $ref: '#/components/schemas/ProblemDetails' - text/plain: - schema: - $ref: '#/components/schemas/Empty' - securitySchemes: - OauthSecurity: - type: oauth2 - flows: - clientCredentials: - tokenUrl: https://oauth.exampleAPI/token - scopes: - all: Single oauth2 scope for API schemas: - Empty: - description: Empty schema - ProblemDetails: - type: object + AddressChangeNotification: properties: - type: - $ref: "#/components/schemas/Problem.type" - title: - $ref: "#/components/schemas/Problem.title" - status: - $ref: "#/components/schemas/Problem.status" - detail: - $ref: "#/components/schemas/Problem.detail" - instance: - $ref: "#/components/schemas/Problem.instance" - Problem.type: - type: string - format: uri - description: >- - A URI reference according to IETF RFC 3986 that identifies the problem - type - Problem.title: - type: string - description: >- - A short, human-readable summary of the problem type - Problem.status: - type: integer - format: uint32 - description: >- - The HTTP status code for this occurrence of the problem - Problem.detail: - type: string - description: >- - A human-readable explanation specific to this occurrence of the problem - Problem.instance: - type: string - format: uri - description: >- - A URI reference that identifies the specific occurrence of the problem - ApplicationList: - description: >- - Information on available applications + appInstanceId: + description: Identifier of the user application instance. + type: string + x-etsi-mec-cardinality: '1' + x-etsi-mec-origin-type: String + contextId: + description: Uniquely identifies the application context in the MEC system. + type: string + x-etsi-mec-cardinality: '1' + x-etsi-mec-origin-type: String + notificationType: + description: Shall be set to "AddressChangeNotification". + type: string + x-etsi-mec-cardinality: '1' + x-etsi-mec-origin-type: String + referenceURI: + description: 'Address of the user application. Used as the reference URI for the application. Assigned by the MEC system.' + format: uri + type: string + x-etsi-mec-cardinality: '1' + x-etsi-mec-origin-type: URI + required: + - notificationType + - contextId + - appInstanceId + - referenceURI type: object - properties: - appList: - $ref: "#/components/schemas/AppList" - vendorSpecificExt: - $ref: "#/components/schemas/VendorSpecificExt" - AppList: - description: >- - List of user applications available to the device application - type: array - minItems: 0 - items: - type: object - required: - - appInfo - properties: - appInfo: - $ref: "#/components/schemas/AppInfo" + x-etsi-ref: 6.4.2 AppContext: - description: >- - Information on application context created by the MEC system + properties: + appAutoInstantiation: + description: Provides indication to the MEC system that instantiation of the requested application is desired should a requested appLocation become available that was not at the time of the request. + type: boolean + x-etsi-mec-cardinality: 0..1 + x-etsi-mec-origin-type: Boolean + appInfo: + description: '' + properties: + appDId: + description: "Identifier of this MEC application descriptor. This attribute shall be globally unique. It is equivalent to the appDId defined in clause 6.2.1.2 of ETSI GS MEC 0102 [1]. It shall be present if the application is one in the ApplicationList." + type: string + x-etsi-mec-cardinality: 0..1 + x-etsi-mec-origin-type: String + appDVersion: + description: "Identifies the version of the application descriptor. It is equivalent to the appDVersion defined in clause 6.2.1.2 of ETSI GS MEC 0102 [1]." + type: string + x-etsi-mec-cardinality: '1' + x-etsi-mec-origin-type: String + appDescription: + description: "Human readable description of the MEC application. The length of the value shall not exceed 128 characters." + type: string + maxLength: 128 + x-etsi-mec-cardinality: 0..1 + x-etsi-mec-origin-type: String + appName: + description: "Name of the MEC application. The length of the value shall not exceed 32 characters." + type: string + maxLength: 32 + x-etsi-mec-cardinality: '1' + x-etsi-mec-origin-type: String + appProvider: + description: "Provider of the MEC application.\nThe length of the value shall not exceed 32 characters." + type: string + maxLength: 32 + x-etsi-mec-cardinality: '1' + x-etsi-mec-origin-type: String + appSoftVersion: + description: "Software version of the MEC application. The length of the value shall not exceed 32 characters." + type: string + maxLength: 32 + x-etsi-mec-cardinality: 0..1 + x-etsi-mec-origin-type: String + appPackageSource: + description: "URI of the application package.\nIncluded in the request if the application is not one in the ApplicationList. appPackageSource enables on-boarding of the application package into the MEC system. The application package shall comply with the definitions in clause 6.2.1.2 of ETSI GS MEC 0102 [1]." + format: uri + type: string + x-etsi-mec-cardinality: 0..1 + x-etsi-mec-origin-type: URI + userAppInstanceInfo: + description: List of user application instance information. + items: + type: object + properties: + appInstanceId: + description: 'Identifier of the user application instance. It shall only be included in the response.' + type: string + x-etsi-mec-cardinality: 0..1 + x-etsi-mec-origin-type: String + appLocation: + $ref: '#/components/schemas/LocationConstraints' + # description: 'Location of the user application instance. For a user application not provided by the requesting device application it shall match one of the appLocations in ApplicationList.' + # x-etsi-mec-cardinality: 0..1 + # x-etsi-mec-origin-type: LocationConstraints + referenceURI: + description: 'Address of the user application instance. It shall only be included in the response.' + format: uri + type: string + x-etsi-mec-cardinality: 0..1 + x-etsi-mec-origin-type: URI + minItems: 1 + type: array + x-etsi-mec-cardinality: 1..N + x-etsi-mec-origin-type: array (Structure inlined) + required: + - appName + - appProvider + - appDVersion + - userAppInstanceInfo + type: object + x-etsi-mec-cardinality: '1' + x-etsi-mec-origin-type: Structure (inlined) + appLocationUpdates: + description: Used by the device application to request to receive notifications at the callbackReference URI relating to location availability for user application instantiation. + type: boolean + x-etsi-mec-cardinality: 0..1 + x-etsi-mec-origin-type: Boolean + associateDevAppId: + description: "Uniquely identifies the device application. The length of the value shall not exceed 32 characters." + type: string + maxLength: 32 + x-etsi-mec-cardinality: '1' + x-etsi-mec-origin-type: String + callbackReference: + description: 'URI assigned by the device application to receive application lifecycle related notifications. Inclusion in the request implies the client supports the pub/sub mechanism and is capable of receiving notifications. This endpoint shall be maintained for the lifetime of the application context.' + format: uri + type: string + x-etsi-mec-cardinality: 0..1 + x-etsi-mec-origin-type: URI + contextId: + description: "Uniquely identifies the application context in the MEC system. Assigned by the MEC system and shall be present other than in a create request. The length of the value shall not exceed 32 characters." + type: string + maxLength: 32 + x-etsi-mec-cardinality: 0..1 + x-etsi-mec-origin-type: String + 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 + ApplicationContextDeleteNotification: + properties: + contextId: + description: Uniquely identifies the application context that has been deleted from the MEC system. + type: string + x-etsi-mec-cardinality: '1' + x-etsi-mec-origin-type: String + notificationType: + description: Shall be set to "ApplicationContextDeleteNotification". + type: string + x-etsi-mec-cardinality: '1' + x-etsi-mec-origin-type: String required: - - contextId - - associateUeAppId - - callbackReference - - appInfo + - notificationType + - contextId + type: object + x-etsi-ref: 6.4.3 + ApplicationContextUpdateNotification: properties: contextId: - $ref: "#/components/schemas/ContextId" - associateUeAppId: - $ref: "#/components/schemas/AssociateUeAppId" - callbackReference: - $ref: "#/components/schemas/CallbackReference" - appInfo: - $ref: "#/components/schemas/AppInfoAppContext" - NotificationEvent: - description: >- - The parameters used in the method "Receiving notification events". + description: Uniquely identifies the application context in the MEC system. + type: string + x-etsi-mec-cardinality: '1' + x-etsi-mec-origin-type: String + notificationType: + description: Shall be set to "ApplicationContextUpdateNotification". + type: string + x-etsi-mec-cardinality: '1' + x-etsi-mec-origin-type: String + userAppInstanceInfo: + description: List of user application instance information. + items: + type: object + properties: + appInstanceId: + description: Identifier of the user application instance. + type: string + x-etsi-mec-cardinality: '1' + x-etsi-mec-origin-type: String + appLocation: + $ref: '#/components/schemas/LocationConstraints' + # description: Location of the user application instance. + # x-etsi-mec-cardinality: 0..1 + # x-etsi-mec-origin-type: LocationConstraints + referenceURI: + description: Address of the user application instance. + format: uri + type: string + x-etsi-mec-cardinality: '1' + x-etsi-mec-origin-type: URI + minItems: 1 + required: + - appInstanceId + - referenceURI + type: array + x-etsi-mec-cardinality: 1..N + x-etsi-mec-origin-type: array (Structure inlined) type: object required: - - referenceURI - properties: - referenceURI: - $ref: "#/components/schemas/ReferenceURL" - VendorSpecificExt: - description: >- - Extension for vendor-specific information - required: - - vendorId + - notificationType + - contextId + - userAppInstanceInfo + x-etsi-ref: 6.4.4 + ApplicationList: properties: - vendorId: - $ref: "#/components/schemas/VendorId" - ContextId: - description: >- - Uniquely identifies the application context in the MEC system. - Assigned by the MEC system and included in the response. The - length of the value shall not exceed 32 characters. - type: string - readOnly: true - AssociateUeAppId: - description: >- - Uniquely identifies the Device application. Included in the request. The - length of the value shall not exceed 32 characters. - type: string - writeOnly: true - VendorId: - description: >- - Vendor identifier. The length of the value shall not exceed 32 - characters. The rest of the structure of this vendor specific extension - is not defined - type: string - AppInfo: + appList: + description: 'List of user applications available to the device application. As defined below.' + items: + type: object + properties: + appInfo: + description: '' + properties: + appCharcs: + description: 'Characteristics of the application. As defined below. The application characteristics relate to the system resources consumed by the application. A device application can use this information e.g. for estimating the cost of use of the application or for the expected user experience.' + properties: + bandwidth: + description: 'The required connection bandwidth in kbit/s for the use of the MEC application instance. ' + type: integer + format: int32 + x-etsi-mec-cardinality: 0..1 + x-etsi-mec-origin-type: uint32 + latency: + description: The target round trip time in milliseconds supported by the MEC system for the MEC application instance. + type: integer + format: int32 + x-etsi-mec-cardinality: 0..1 + x-etsi-mec-origin-type: uint32 + memory: + description: The maximum size in Mbytes of the memory resource expected to be used by the MEC application instance in the MEC system. + type: integer + format: int32 + x-etsi-mec-cardinality: 0..1 + x-etsi-mec-origin-type: uint32 + serviceCont: + description: 'Required service continuity mode for this application. Permitted values: + 0 = SERVICE_CONTINUITY_NOT_REQUIRED. + 1 = SERVICE_CONTINUITY_REQUIRED.' + enum: + - 0 + - 1 + type: integer + x-etsi-mec-cardinality: 0..1 + x-etsi-mec-origin-type: Enum + storage: + description: The maximum size in Mbytes of the storage resource expected to be used by the MEC application instance in the MEC system. + type: integer + format: int32 + x-etsi-mec-cardinality: 0..1 + x-etsi-mec-origin-type: uint32 + type: object + x-etsi-mec-cardinality: 0..1 + x-etsi-mec-origin-type: Structure (inlined) + appDId: + description: "Identifier of this MEC application descriptor. It is equivalent to the appDId defined in clause 6.2.1.2 of ETSI GS MEC 0102 [1]. This attribute shall be globally unique." + type: string + x-etsi-mec-cardinality: '1' + x-etsi-mec-origin-type: String + appDVersion: + description: Identifies the version of the application descriptor. It is equivalent to the appDVersion defined in clause 6.2.1.2 of ETSI GS MEC 0102 [1]. + type: string + x-etsi-mec-cardinality: '1' + x-etsi-mec-origin-type: String + appDescription: + description: Human readable description of the MEC application (see note 2). + type: string + maxLength: 128 + x-etsi-mec-cardinality: '1' + x-etsi-mec-origin-type: String + appLocation: + description: Identifies the locations of the MEC application. + items: + $ref: '#/components/schemas/LocationConstraints' + minItems: 0 + type: array + x-etsi-mec-cardinality: 0..N + x-etsi-mec-origin-type: LocationConstraints + appName: + description: 'Name of the MEC application. The length of the value shall not exceed 32 characters.' + type: string + maxLength: 32 + x-etsi-mec-cardinality: '1' + x-etsi-mec-origin-type: String + appProvider: + description: 'Provider of the MEC application. The length of the value shall not exceed 32 characters.' + type: string + maxLength: 32 + x-etsi-mec-cardinality: '1' + x-etsi-mec-origin-type: String + appSoftVersion: + description: 'Software version of the MEC application. The length of the value shall not exceed 32 characters.' + type: string + maxLength: 32 + x-etsi-mec-cardinality: '1' + x-etsi-mec-origin-type: String + required: + - appDId + - appName + - appProvider + - appSoftVersion + - appDVersion + - appDescription + type: object + x-etsi-mec-cardinality: '1' + x-etsi-mec-origin-type: Structure (inlined) + vendorSpecificExt: + description: Extension for vendor specific information (see note 1). + properties: + vendorId: + description: 'Vendor identifier. The length of the value shall not exceed 32 characters. The rest of the structure of vendor specific extension is not defined.' + type: string + maxLength: 32 + x-etsi-mec-cardinality: '1' + x-etsi-mec-origin-type: String + required: + - vendorId + type: object + x-etsi-mec-cardinality: 0..1 + x-etsi-mec-origin-type: Structure (inlined) + minItems: 0 + required: + - appInfo + type: array + x-etsi-mec-cardinality: 0..N + x-etsi-mec-origin-type: Array (Structure (inlined)) type: object + x-etsi-notes: "NOTE 1:\tThe vendor specific extension allows submitting information\ + \ on the application lists that have been made available to the device application\ + \ of the corresponding vendor.\nNOTE 2:\tThe language support may be limited.\ + \ The length of the value shall not exceed 128 characters." + x-etsi-ref: 6.2.2 + ApplicationLocationAvailability: + properties: + appInfo: + description: '' + properties: + appDVersion: + description: "Identifies the version of the application descriptor. It is equivalent to the appDVersion defined in clause 6.2.1.2 of ETSI GS MEC 0102 [1]." + type: string + x-etsi-mec-cardinality: '1' + x-etsi-mec-origin-type: String + appDescription: + description: "Human readable description of the MEC application. The length of the value shall not exceed 128 characters." + type: string + maxLength: 128 + x-etsi-mec-cardinality: 0..1 + x-etsi-mec-origin-type: String + appName: + description: "Name of the MEC application. The length of the value shall not exceed 32 characters." + type: string + maxLength: 32 + x-etsi-mec-cardinality: '1' + x-etsi-mec-origin-type: String + appPackageSource: + description: "URI of the application package. Shall be included in the request. The application package shall comply with the definitions in clause 6.2.1.2 of ETSI GS MEC 0102 [1]." + format: uri + type: string + x-etsi-mec-cardinality: 0..1 + x-etsi-mec-origin-type: URI + appProvider: + description: "Provider of the MEC application. The length of the value shall not exceed 32 characters." + type: string + maxLength: 32 + x-etsi-mec-cardinality: '1' + x-etsi-mec-origin-type: String + appSoftVersion: + description: "Software version of the MEC application. The length of the value shall not exceed 32 characters." + type: string + maxLength: 32 + x-etsi-mec-cardinality: 0..1 + x-etsi-mec-origin-type: String + availableLocations: + description: 'MEC application location constraints. ' + items: + type: object + properties: + appLocation: + $ref: '#/components/schemas/LocationConstraints' + # description: Shall only be included in the response, where it indicates a location constraint available in the MEC system. + # x-etsi-mec-cardinality: 0..1 + # x-etsi-mec-origin-type: LocationConstraints + minItems: 0 + type: array + x-etsi-mec-cardinality: 0..N + x-etsi-mec-origin-type: array (Structure (inline)) + required: + - appName + - appProvider + - appDVersion + type: object + x-etsi-mec-cardinality: '1' + x-etsi-mec-origin-type: Structure (inlined) + associateDevAppId: + description: "Uniquely identifies the device application. The length of the value shall not exceed 32 characters." + type: string + maxLength: 32 + x-etsi-mec-cardinality: '1' + x-etsi-mec-origin-type: String required: - - appDId - - appName - - appProvider - - appSoftVersion - - appDVersion - - appDescription + - associateDevAppId + - appInfo + type: object + x-etsi-ref: 6.2.4 + ApplicationLocationAvailabilityNotification: properties: - appDId: - $ref: "#/components/schemas/AppDId" - appName: - $ref: "#/components/schemas/AppName" - appProvider: - $ref: "#/components/schemas/AppProvider" - appSoftVersion: - $ref: "#/components/schemas/AppSoftVersion" - appDVersion: - $ref: "#/components/schemas/AppDVersion" - appDescription: - $ref: "#/components/schemas/AppDescription" - appCharcs: - $ref: "#/components/schemas/AppCharcs" - AppInfoAppContext: - description: Included in the request + availableLocations: + description: Locations available to the MEC application. + items: + type: object + properties: + appLocation: + $ref: '#/components/schemas/LocationConstraints' + # description: 'It shall match one of the appLocations in the AppContext sent in the Application context create ' + # x-etsi-mec-cardinality: '1' + # x-etsi-mec-origin-type: LocationConstraints + minItems: 1 + required: + - appLocation + type: array + x-etsi-mec-cardinality: 1..N + x-etsi-mec-origin-type: array (Structure (inline)) + contextId: + description: Uniquely identifies the application context in the MEC system. + type: string + x-etsi-mec-cardinality: 0..1 + x-etsi-mec-origin-type: String + notificationType: + description: Shall be set to "ApplicationLocationAvailabilityNotification". + type: string + x-etsi-mec-cardinality: '1' + x-etsi-mec-origin-type: String type: object required: - - appName - - appProvider - - appDVersion + - notificationType + - availableLocations + x-etsi-ref: 6.4.5 + InlineNotification: + oneOf: + - $ref: '#/components/schemas/AddressChangeNotification' + - $ref: '#/components/schemas/ApplicationContextDeleteNotification' + - $ref: '#/components/schemas/ApplicationContextUpdateNotification' + - $ref: '#/components/schemas/ApplicationLocationAvailabilityNotification' + discriminator: + propertyName: notificationType + LocationConstraints: + properties: + area: + $ref: '#/components/schemas/Polygon' + # description: "Geographic area. Shall be absent if the \"civicAddressElement\" attribute is present. The content of this attribute shall follow the provisions for the \"Polygon\" geometry object as defined in IETF RFC 7946 [8], for which the \"type\" member shall be set to the value \"Polygon\". See note." + # x-etsi-mec-cardinality: 0..1 + # x-etsi-mec-origin-type: Polygon + civicAddressElement: + description: Zero or more elements comprising the civic address. Shall be absent if the "area" attribute is present. + items: + type: object + properties: + caType: + description: "Describe the content type of caValue. The value of caType shall comply with section 3.4 of IETF RFC 4776 [6]. " + type: integer + x-etsi-mec-cardinality: '1' + x-etsi-mec-origin-type: Integer + caValue: + description: "Content of civic address element corresponding to the caType. The format caValue shall comply with section 3.4 of IETF RFC 4776 [6]." + type: string + x-etsi-mec-cardinality: '1' + x-etsi-mec-origin-type: String + minItems: 0 + required: + - caType + - caValue + type: array + x-etsi-mec-cardinality: 0..N + x-etsi-mec-origin-type: array (Structure inlined) + countryCode: + description: The two-letter ISO 3166 [7] country code in capital letters. Shall be present in case the "area" attribute is absent. May be absent if the "area" attribute is present (see note). + type: string + maxLength: 2 + x-etsi-mec-cardinality: 0..1 + x-etsi-mec-origin-type: String + type: object + x-etsi-notes: "NOTE:\tIf both \"countryCode\" and \"area\" are present, no conflicts\ + \ should exist between the values of these two attributes. In case of conflicts,\ + \ the API producer (e.g. MEO, MEAO) shall disregard parts of the geographic\ + \ area signalled by \"area\" that are outside the boundaries of the country\ + \ signalled by \"countryCode\". If \"countryCode\" is absent, it is solely\ + \ the \"area\" attribute that defines the location constraint." + x-etsi-ref: 6.5.2 + Polygon: properties: - appDId: - $ref: "#/components/schemas/AppDId" - appName: - $ref: "#/components/schemas/AppName" - appProvider: - $ref: "#/components/schemas/AppProvider" - appSoftVersion: - $ref: "#/components/schemas/AppSoftVersion" - appDVersion: - $ref: "#/components/schemas/AppDVersion" - appDescription: - $ref: "#/components/schemas/AppDescription" - referenceURL: - $ref: "#/components/schemas/ReferenceURL" - appPackageSource: - $ref: "#/components/schemas/AppPackageSource" - AppCharcs: - description: >- - The application characteristics relate to the system resources consumed - by the application. Device application can use this information e.g., for - estimating the cost of use of the application or for the expected user - experience + coordinates: + items: + items: + items: + type: number + format: float + type: array + type: array + minItems: 1 + type: array + x-etsi-mec-cardinality: 1 + x-etsi-mec-origin-type: array type: object + ProblemDetails: properties: - memory: - $ref: "#/components/schemas/Memory" - storage: - $ref: "#/components/schemas/Storage" - latency: - $ref: "#/components/schemas/Latency" - bandwidth: - $ref: "#/components/schemas/Bandwidth" - serviceCont: - $ref: "#/components/schemas/ServiceCont" - Memory: - description: >- - The maximum size in Mbytes of the memory resource reserved for the - MEC application instance in the MEC system - type: integer - format: uint32 - Storage: - description: >- - The maximum size in Mbytes of the storage resource expected to be used - by the MEC application instance in the MEC system - type: integer - format: uint32 - Latency: - description: >- - The target round trip time in milliseconds supported by the MEC - system for the MEC application instance - type: integer - format: uint32 - Bandwidth: - description: >- - The required connection bandwidth in kbit/s for the use of the MEC - application instance - type: integer - format: uint32 - ServiceCont: - description: >- - Required service continuity mode for this application. - type: string - enum: - - SERVICE_CONTINUITY_NOT_REQUIRED - - SERVICE_CONTINUITY_REQUIRED - example: - SERVICE_CONTINUITY_NOT_REQUIRED - AppDId: - description: >- - Identifier of this MEC application descriptor. It is equivalent to - the appDId defined in clause 6.2.1.2 of ETSI GS MEC 010-2. - This attribute shall be globally unique. It shall be present if the - application is one in the ApplicationList. - type: string - AppName: - description: >- - Name of the MEC application. The length of the value shall not - exceed 32 characters. - type: string - AppProvider: - description: >- - Provider of the MEC application. The length of the value shall - not exceed 32 characters. - type: string - AppSoftVersion: - description: >- - Software version of the MEC application. The length of the value - shall not exceed 32 characters. - type: string - AppDVersion: - description: >- - Identifies the version of the application descriptor. It is - equivalent to the appDVersion defined in clause 6.2.1.2 of - ETSI GS MEC 010-2. - type: string - AppDescription: - description: >- - Human readable description of the MEC application. NOTE the - language support may be limited. The length of the value shall not - exceed 128 characters. - type: string - CallbackReference: - description: >- - URI assigned by the Device application to receive application lifecycle - related notifications. Included in the request. This subscription stays - alive for the lifetime of the application context. - type: string - format: uri - writeOnly: true - ReferenceURL: - description: >- - Address of the user application. Used as the reference URL for the - application. Assigned by the MEC system and included in the - response - type: string - format: uri - readOnly: true - 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 MEC system. The - application package shall comply with the definitions in clause 6.2.1.2 - of ETSI GS MEC 010-2 - type: string - format: uri + detail: + description: A human-readable explanation specific to this occurrence of the problem + type: string + x-etsi-mec-cardinality: 0..1 + x-etsi-mec-origin-type: String + instance: + description: A URI reference that identifies the specific occurrence of the problem + format: uri + type: string + x-etsi-mec-cardinality: 0..1 + x-etsi-mec-origin-type: URI + status: + description: The HTTP status code for this occurrence of the problem + format: int32 + type: integer + x-etsi-mec-cardinality: 0..1 + x-etsi-mec-origin-type: Uint32 + title: + description: A short, human-readable summary of the problem type + type: string + x-etsi-mec-cardinality: 0..1 + x-etsi-mec-origin-type: String + type: + description: A URI reference according to IETF RFC 3986 that identifies the problem type + format: uri + type: string + x-etsi-mec-cardinality: 0..1 + x-etsi-mec-origin-type: URI + type: object