From 85dfbd09ce4a9ecf5c4574e0d7d2ec15e7aa113b Mon Sep 17 00:00:00 2001 From: featherstone Date: Fri, 10 May 2019 17:52:45 +0100 Subject: [PATCH] MEC-016 v2.1.1 changes --- UEAppInterfaceApi.json | 89 +++++++++++++++++++++++++++--------------- UEAppInterfaceApi.yaml | 82 +++++++++++++++++++++++++------------- 2 files changed, 111 insertions(+), 60 deletions(-) diff --git a/UEAppInterfaceApi.json b/UEAppInterfaceApi.json index f0f71a3..2c41f69 100644 --- a/UEAppInterfaceApi.json +++ b/UEAppInterfaceApi.json @@ -2,7 +2,7 @@ "openapi": "3.0.2", "info": { "title": "UE Application Interface API", - "version": "1.1.1", + "version": "2.1.1", "description": "The ETSI MEC ISG MEC016 UE Application Interface API described using OpenAPI", "license": { "name": "BSD-3-Clause", @@ -13,8 +13,8 @@ } }, "externalDocs": { - "description": "ETSI GS MEC016 UE Application Interface API, V1.1.1", - "url": "http://www.etsi.org/deliver/etsi_gs/MEC/001_099/016/01.01.01_60/gs_MEC016v010101p.pdf" + "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": [ { @@ -25,10 +25,10 @@ ], "servers": [ { - "url": "http://127.0.0.1:8081/mx2/v1" + "url": "http://127.0.0.1:8081/mx2/v2" }, { - "url": "https://127.0.0.1:8081/mx2/v1" + "url": "https://127.0.0.1:8081/mx2/v2" } ], "tags": [ @@ -189,7 +189,7 @@ "NotificationEvent": { "{$request.body#/callbackReference}": { "post": { - "description": "Used by the UALCMP to inform the UE application of a modification to reference URI of the user application.", + "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" @@ -307,7 +307,7 @@ "required": true }, "NotificationEvent": { - "description": "Sent by the UALCMP to the UE application.", + "description": "Sent by the UALCMP to the Device application.", "content": { "application/json": { "schema": { @@ -338,7 +338,7 @@ } }, "AppList": { - "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 Device application", "content": { "application/json": { "schema": { @@ -467,14 +467,30 @@ "description": "Information on available applications", "type": "object", "properties": { - "appInfo": { - "$ref": "#/components/schemas/AppInfo" + "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" + } + } + } + }, "AppContext": { "description": "Information on application context created by the MEC system", "type": "object", @@ -495,7 +511,7 @@ "$ref": "#/components/schemas/CallbackReference" }, "appInfo": { - "$ref": "#/components/schemas/RequiredAppInfo" + "$ref": "#/components/schemas/AppInfoAppContext" } } }, @@ -511,14 +527,6 @@ } } }, - "VendorSpecificExtList": { - "description": "Extension for vendor specific information.", - "type": "array", - "minItems": 0, - "items": { - "$ref": "#/components/schemas/VendorSpecificExt" - } - }, "VendorSpecificExt": { "description": "Extension for vendor-specific information", "required": [ @@ -536,7 +544,7 @@ "readOnly": true }, "AssociateUeAppId": { - "description": "Uniquely identifies the UE application. Included in the request. The length of the value shall not exceed 32 characters.", + "description": "Uniquely identifies the Device application. Included in the request. The length of the value shall not exceed 32 characters.", "type": "string", "writeOnly": true }, @@ -545,20 +553,19 @@ "type": "string" }, "AppInfo": { - "description": "User applications available for the UE application", - "type": "array", - "items": { - "$ref": "#/components/schemas/AppInfoList" - } - }, - "AppInfoList": { "type": "object", "required": [ + "appDId", "appName", "appProvider", + "appSoftVersion", + "appDVersion", "appDescription" ], "properties": { + "appDId": { + "$ref": "#/components/schemas/AppDId" + }, "appName": { "$ref": "#/components/schemas/AppName" }, @@ -568,6 +575,9 @@ "appSoftVersion": { "$ref": "#/components/schemas/AppSoftVersion" }, + "appDVersion": { + "$ref": "#/components/schemas/AppDVersion" + }, "appDescription": { "$ref": "#/components/schemas/AppDescription" }, @@ -576,15 +586,18 @@ } } }, - "RequiredAppInfo": { + "AppInfoAppContext": { "description": "Included in the request", "type": "object", "required": [ "appName", "appProvider", - "referenceURL" + "appDVersion" ], "properties": { + "appDId": { + "$ref": "#/components/schemas/AppDId" + }, "appName": { "$ref": "#/components/schemas/AppName" }, @@ -594,6 +607,9 @@ "appSoftVersion": { "$ref": "#/components/schemas/AppSoftVersion" }, + "appDVersion": { + "$ref": "#/components/schemas/AppDVersion" + }, "appDescription": { "$ref": "#/components/schemas/AppDescription" }, @@ -606,7 +622,7 @@ } }, "AppCharcs": { - "description": "The application characteristics relate to the system resources consumed by the application. UE application can use this information e.g., for estimating the cost of use of the application or for the expected user experience", + "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", "type": "object", "properties": { "memory": { @@ -652,7 +668,12 @@ "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.", @@ -666,12 +687,16 @@ "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 UE application to receive application lifecycle related notifications. Included in the request. This subscription stays alive for the lifetime of the application context.", + "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 diff --git a/UEAppInterfaceApi.yaml b/UEAppInterfaceApi.yaml index b31962c..8b8f467 100644 --- a/UEAppInterfaceApi.yaml +++ b/UEAppInterfaceApi.yaml @@ -1,7 +1,7 @@ openapi: 3.0.2 info: title: UE Application Interface API - version: 1.1.1 + version: 2.1.1 description: >- The ETSI MEC ISG MEC016 UE Application Interface API described using OpenAPI license: @@ -11,14 +11,14 @@ info: email: cti_support@etsi.org externalDocs: description: >- - ETSI GS MEC016 UE Application Interface API, V1.1.1 - url: http://www.etsi.org/deliver/etsi_gs/MEC/001_099/016/01.01.01_60/gs_MEC016v010101p.pdf + 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 servers: - - url: http://127.0.0.1:8081/mx2/v1 - - url: https://127.0.0.1:8081/mx2/v1 + - url: http://127.0.0.1:8081/mx2/v2 + - url: https://127.0.0.1:8081/mx2/v2 tags: - name: appList - name: appContext @@ -125,7 +125,7 @@ components: '{$request.body#/callbackReference}': post: description: >- - Used by the UALCMP to inform the UE application of + Used by the UALCMP to inform the Device application of a modification to reference URI of the user application. operationId: NotificationEvent_POST tags: @@ -220,7 +220,7 @@ components: required: true NotificationEvent: description: >- - Sent by the UALCMP to the UE application. + Sent by the UALCMP to the Device application. content: application/json: schema: @@ -243,7 +243,7 @@ components: AppList: description: >- The response body contains the ApplicationList resource available - for the querying UE application + for the querying Device application content: application/json: schema: @@ -343,10 +343,22 @@ components: Information on available applications type: object properties: - appInfo: - $ref: "#/components/schemas/AppInfo" + 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" AppContext: description: >- Information on application context created by the MEC system @@ -364,7 +376,7 @@ components: callbackReference: $ref: "#/components/schemas/CallbackReference" appInfo: - $ref: "#/components/schemas/RequiredAppInfo" + $ref: "#/components/schemas/AppInfoAppContext" NotificationEvent: description: >- The parameters used in the method "Receiving notification events". @@ -374,12 +386,6 @@ components: properties: referenceURI: $ref: "#/components/schemas/ReferenceURL" - VendorSpecificExtList: - description: Extension for vendor specific information. - type: array - minItems: 0 - items: - $ref: "#/components/schemas/VendorSpecificExt" VendorSpecificExt: description: >- Extension for vendor-specific information @@ -397,7 +403,7 @@ components: readOnly: true AssociateUeAppId: description: >- - Uniquely identifies the UE application. Included in the request. The + Uniquely identifies the Device application. Included in the request. The length of the value shall not exceed 32 characters. type: string writeOnly: true @@ -408,42 +414,47 @@ components: is not defined type: string AppInfo: - description: >- - User applications available for the UE application - type: array - items: - $ref: "#/components/schemas/AppInfoList" - AppInfoList: type: object required: + - appDId - appName - appProvider + - appSoftVersion + - appDVersion - appDescription 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" - RequiredAppInfo: + AppInfoAppContext: description: Included in the request type: object required: - appName - appProvider - - referenceURL + - appDVersion 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: @@ -453,7 +464,7 @@ components: AppCharcs: description: >- The application characteristics relate to the system resources consumed - by the application. UE application can use this information e.g., for + 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 type: object @@ -499,6 +510,15 @@ components: 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 @@ -514,6 +534,12 @@ components: 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 @@ -522,7 +548,7 @@ components: type: string CallbackReference: description: >- - URI assigned by the UE application to receive application lifecycle + 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 -- GitLab