From 7ea3988112ee8e45107cb8a131f36e525b9dd3d3 Mon Sep 17 00:00:00 2001 From: featherstone Date: Mon, 28 Jan 2019 21:00:25 +0000 Subject: [PATCH 01/21] MEC11 GS2.0.5, OpenAPI3 --- Mp1.json | 159 ++++++++++++++++++++++++++++++++++++++++++++++++++---- Mp1.yaml | 130 ++++++++++++++++++++++++++++++++++++++++---- README.md | 2 +- 3 files changed, 271 insertions(+), 20 deletions(-) diff --git a/Mp1.json b/Mp1.json index c960089..b8537b8 100644 --- a/Mp1.json +++ b/Mp1.json @@ -10,7 +10,7 @@ ], "info": { "title": "Mp1 API", - "version": "1.1.1", + "version": "2.0.5", "description": "The ETSI MEC ISG MEC011 Application Enablement API described using OpenAPI", "license": { "name": "ETSI Forge copyright notice", @@ -18,8 +18,8 @@ } }, "externalDocs": { - "description": "ETSI GS MEC011 Application Enablement API, V1.1.1", - "url": "http://www.etsi.org/deliver/etsi_gs/MEC/001_099/011/01.01.01_60/gs_mec011v010101p.pdf" + "description": "ETSI GS MEC011 Application Enablement API, V2.0.5", + "url": "https://docbox.etsi.org/ISG/MEC/70-Draft/0011v211Plat.App.Enabl/MEC-0011v211Plat.App.Enablv205.zip" }, "paths": { "/applications/{appInstanceId}/dns_rules": { @@ -276,10 +276,15 @@ } } }, - "/services": { + "/applications/{appInstanceId}/services": { + "parameters": [ + { + "$ref": "#/components/parameters/Path.AppInstanceId" + } + ], "get": { "description": "This method retrieves information about a list of meService resources. This method is typically used in \"service availability query\" procedure", - "operationId": "Services_GET", + "operationId": "AppServices_GET", "parameters": [ { "$ref": "#/components/parameters/Query.Ser_instance_id" @@ -289,6 +294,15 @@ }, { "$ref": "#/components/parameters/Query.Ser_category_id" + }, + { + "$ref": "#/components/parameters/Query.Consumed_local_only" + }, + { + "$ref": "#/components/parameters/Query.Is_local" + }, + { + "$ref": "#/components/parameters/Query.LocalityTypes" } ], "responses": { @@ -308,7 +322,7 @@ }, "post": { "description": "This method is used to create a meService resource. This method is typically used in \"service availability update and new service registration\" procedure", - "operationId": "Services_POST", + "operationId": "AppServices_POST", "responses": { "201": { "$ref": "#/components/responses/Services.201" @@ -328,15 +342,18 @@ } } }, - "/services/{serviceId}": { + "/applications/{appInstanceId}/services/{serviceId}": { "parameters": [ + { + "$ref": "#/components/parameters/Path.AppInstanceId" + }, { "$ref": "#/components/parameters/Path.ServiceId" } ], "get": { "description": "This method retrieves information about a meService resource. This method is typically used in \"service availability query\" procedure", - "operationId": "ServicesServiceId_GET", + "operationId": "AppServicesServiceId_GET", "responses": { "200": { "$ref": "#/components/responses/ServicesServiceId.200" @@ -354,7 +371,7 @@ }, "put": { "description": "This method updates the information about a meService resource", - "operationId": "ServicesServiceId_PUT", + "operationId": "AppServicesServiceId_PUT", "responses": { "200": { "$ref": "#/components/responses/ServicesServiceId.200" @@ -377,6 +394,71 @@ } } }, + "/services": { + "get": { + "description": "This method retrieves information about a list of meService resources. This method is typically used in \"service availability query\" procedure", + "operationId": "Services_GET", + "parameters": [ + { + "$ref": "#/components/parameters/Query.Ser_instance_id" + }, + { + "$ref": "#/components/parameters/Query.Ser_name" + }, + { + "$ref": "#/components/parameters/Query.Ser_category_id" + }, + { + "$ref": "#/components/parameters/Query.Consumed_local_only" + }, + { + "$ref": "#/components/parameters/Query.Is_local" + }, + { + "$ref": "#/components/parameters/Query.LocalityTypes" + } + ], + "responses": { + "200": { + "$ref": "#/components/responses/Services.200" + }, + "400": { + "$ref": "#/components/responses/Error.400" + }, + "403": { + "$ref": "#/components/responses/Error.403" + }, + "404": { + "$ref": "#/components/responses/Error.404" + } + } + } + }, + "/services/{serviceId}": { + "parameters": [ + { + "$ref": "#/components/parameters/Path.ServiceId" + } + ], + "get": { + "description": "This method retrieves information about a meService resource. This method is typically used in \"service availability query\" procedure", + "operationId": "ServicesServiceId_GET", + "responses": { + "200": { + "$ref": "#/components/responses/ServicesServiceId.200" + }, + "400": { + "$ref": "#/components/responses/Error.400" + }, + "403": { + "$ref": "#/components/responses/Error.403" + }, + "404": { + "$ref": "#/components/responses/Error.404" + } + } + } + }, "/timing/current_time": { "get": { "description": "This method retrieves the information of the platform's current time which corresponds to the get platform time procedure", @@ -1000,6 +1082,19 @@ ], "example": "JSON" }, + "LocalityTypes": { + "description": "The scope of locality as expressed by \"consumedLocalOnly\" and \"isLocal\". If absent, defaults to MEC_HOST", + "type": "string", + "enum": [ + "MEC_SYSTEM", + "MEC_HOST", + "NFVI_POP", + "ZONE", + "ZONE_GROUP", + "NFVI_NODE" + ], + "example": "MEC_SYSTEM" + }, "ServiceInfo.SerInstanceId": { "description": "Identifier of the service instance assigned by the MEPM / mobile edge platform.", "type": "string", @@ -1030,6 +1125,16 @@ "type": "string", "example": "ServiceVersion1" }, + "ServiceInfo.ConsumedLocalOnly": { + "description": "Indicate whether the service can only be consumed by the MEC applications located in the same locality (as defined by scopeOfLocality) as this service instance.", + "type": "boolean", + "example": false + }, + "ServiceInfo.IsLocal": { + "description": "Indicate whether the service is located in the same locality (as defined by scopeOfLocality) as the consuming MEC application.", + "type": "boolean", + "example": true + }, "ServiceInfo": { "description": "This type represents the general information of a mobile edge service.", "type": "object", @@ -1063,6 +1168,15 @@ }, "serializer": { "$ref": "#/components/schemas/SerializerTypes" + }, + "scopeOfLocality": { + "$ref": "#/components/schemas/LocalityTypes" + }, + "consumedLocalOnly": { + "$ref": "#/components/schemas/ServiceInfo.ConsumedLocalOnly" + }, + "isLocal": { + "$ref": "#/components/schemas/ServiceInfo.IsLocal" } } }, @@ -1671,6 +1785,33 @@ "type": "string" } } + }, + "Query.LocalityTypes": { + "name": "scope_of_locality", + "description": "A MEC application instance may use scope_of_locality as an input parameter to query the availability of a list of MEC service instances with a certain scope of locality.", + "in": "query", + "required": false, + "schema": { + "type": "string" + } + }, + "Query.Is_local": { + "name": "is_local", + "description": "Indicate whether the service is located in the same locality (as defined by scopeOfLocality) as the consuming MEC application.", + "in": "query", + "required": false, + "schema": { + "type": "boolean" + } + }, + "Query.Consumed_local_only": { + "name": "consumed_local_only", + "description": "Indicate whether the service can only be consumed by the MEC applications located in the same locality (as defined by scopeOfLocality) as this service instance.", + "in": "query", + "required": false, + "schema": { + "type": "boolean" + } } }, "responses": { diff --git a/Mp1.yaml b/Mp1.yaml index 0990f87..baf06ea 100644 --- a/Mp1.yaml +++ b/Mp1.yaml @@ -4,15 +4,15 @@ servers: - url: 'https://127.0.0.1:8081/mp1/v1/' info: title: Mp1 API - version: 1.1.1 + version: 2.0.5 description: The ETSI MEC ISG MEC011 Application Enablement API described using OpenAPI license: name: ETSI Forge copyright notice url: 'https://forge.etsi.org/etsi-forge-copyright-notice.txt' externalDocs: - description: 'ETSI GS MEC011 Application Enablement API, V1.1.1' + description: 'ETSI GS MEC011 Application Enablement API, V2.0.5' url: >- - http://www.etsi.org/deliver/etsi_gs/MEC/001_099/011/01.01.01_60/gs_mec011v010101p.pdf + https://docbox.etsi.org/ISG/MEC/70-Draft/0011v211Plat.App.Enabl/MEC-0011v211Plat.App.Enablv205.zip paths: '/applications/{appInstanceId}/dns_rules': parameters: @@ -192,16 +192,21 @@ paths: $ref: '#/components/responses/Error.412' requestBody: $ref: '#/components/requestBodies/ApplicationsTrafficRule' - '/services': + '/applications/{appInstanceId}/services': + parameters: + - $ref: '#/components/parameters/Path.AppInstanceId' get: description: >- This method retrieves information about a list of meService resources. This method is typically used in "service availability query" procedure - operationId: Services_GET + operationId: AppServices_GET parameters: - $ref: '#/components/parameters/Query.Ser_instance_id' - $ref: '#/components/parameters/Query.Ser_name' - $ref: '#/components/parameters/Query.Ser_category_id' + - $ref: '#/components/parameters/Query.Consumed_local_only' + - $ref: '#/components/parameters/Query.Is_local' + - $ref: '#/components/parameters/Query.LocalityTypes' responses: '200': $ref: '#/components/responses/Services.200' @@ -216,7 +221,7 @@ paths: This method is used to create a meService resource. This method is typically used in "service availability update and new service registration" procedure - operationId: Services_POST + operationId: AppServices_POST responses: '201': $ref: '#/components/responses/Services.201' @@ -228,14 +233,15 @@ paths: $ref: '#/components/responses/Error.404' requestBody: $ref: '#/components/requestBodies/Services' - '/services/{serviceId}': + '/applications/{appInstanceId}/services/{serviceId}': parameters: + - $ref: '#/components/parameters/Path.AppInstanceId' - $ref: '#/components/parameters/Path.ServiceId' get: description: >- This method retrieves information about a meService resource. This method is typically used in "service availability query" procedure - operationId: ServicesServiceId_GET + operationId: AppServicesServiceId_GET responses: '200': $ref: '#/components/responses/ServicesServiceId.200' @@ -247,7 +253,7 @@ paths: $ref: '#/components/responses/Error.404' put: description: This method updates the information about a meService resource - operationId: ServicesServiceId_PUT + operationId: AppServicesServiceId_PUT responses: '200': $ref: '#/components/responses/ServicesServiceId.200' @@ -261,6 +267,51 @@ paths: $ref: '#/components/responses/Error.412' requestBody: $ref: '#/components/requestBodies/ServicesServiceId' + + + '/services': + get: + description: >- + This method retrieves information about a list of meService resources. + This method is typically used in "service availability query" procedure + operationId: Services_GET + parameters: + - $ref: '#/components/parameters/Query.Ser_instance_id' + - $ref: '#/components/parameters/Query.Ser_name' + - $ref: '#/components/parameters/Query.Ser_category_id' + - $ref: '#/components/parameters/Query.Consumed_local_only' + - $ref: '#/components/parameters/Query.Is_local' + - $ref: '#/components/parameters/Query.LocalityTypes' + responses: + '200': + $ref: '#/components/responses/Services.200' + '400': + $ref: '#/components/responses/Error.400' + '403': + $ref: '#/components/responses/Error.403' + '404': + $ref: '#/components/responses/Error.404' + '/services/{serviceId}': + parameters: + - $ref: '#/components/parameters/Path.ServiceId' + get: + description: >- + This method retrieves information about a meService resource. This + method is typically used in "service availability query" procedure + operationId: ServicesServiceId_GET + responses: + '200': + $ref: '#/components/responses/ServicesServiceId.200' + '400': + $ref: '#/components/responses/Error.400' + '403': + $ref: '#/components/responses/Error.403' + '404': + $ref: '#/components/responses/Error.404' + + + + '/timing/current_time': get: description: >- @@ -768,7 +819,18 @@ components: - JSON - XML - PROTOBUF3 - example: JSON + example: 'JSON' + LocalityTypes: + description: The scope of locality as expressed by "consumedLocalOnly" and "isLocal". If absent, defaults to MEC_HOST + type: string + enum: + - MEC_SYSTEM + - MEC_HOST + - NFVI_POP + - ZONE + - ZONE_GROUP + - NFVI_NODE + example: 'MEC_SYSTEM' ServiceInfo.SerInstanceId: description: >- Identifier of the service instance assigned by the MEPM / mobile edge @@ -802,6 +864,19 @@ components: description: Service version type: string example: 'ServiceVersion1' + ServiceInfo.ConsumedLocalOnly: + description: >- + Indicate whether the service can only be consumed by the MEC applications + located in the same locality (as defined by scopeOfLocality) as this + service instance. + type: boolean + example: false + ServiceInfo.IsLocal: + description: >- + Indicate whether the service is located in the same locality (as defined + by scopeOfLocality) as the consuming MEC application. + type: boolean + example: true ServiceInfo: description: This type represents the general information of a mobile edge service. type: object @@ -827,6 +902,12 @@ components: $ref: '#/components/schemas/TransportInfo' serializer: $ref: '#/components/schemas/SerializerTypes' + scopeOfLocality: + $ref: '#/components/schemas/LocalityTypes' + consumedLocalOnly: + $ref: '#/components/schemas/ServiceInfo.ConsumedLocalOnly' + isLocal: + $ref: '#/components/schemas/ServiceInfo.IsLocal' Subscription: description: A link to the related subscription type: object @@ -1330,6 +1411,35 @@ components: type: array items: type: string + Query.LocalityTypes: + name: scope_of_locality + description: >- + A MEC application instance may use scope_of_locality as an input + parameter to query the availability of a list of MEC service instances + with a certain scope of locality. + in: query + required: false + schema: + type: string + Query.Is_local: + name: is_local + description: >- + Indicate whether the service is located in the same locality (as + defined by scopeOfLocality) as the consuming MEC application. + in: query + required: false + schema: + type: boolean + Query.Consumed_local_only: + name: consumed_local_only + description: >- + Indicate whether the service can only be consumed by the MEC + applications located in the same locality (as defined by + scopeOfLocality) as this service instance. + in: query + required: false + schema: + type: boolean responses: ApplicationsDnsRules.200: description: >- diff --git a/README.md b/README.md index 3655537..3f36872 100644 --- a/README.md +++ b/README.md @@ -4,7 +4,7 @@ This repository contains OpenAPIs descriptions for the interfaces specified in E ## Online resources -* [Specification document](https://www.etsi.org/deliver/etsi_gs/MEC/001_099/011/01.01.01_60/gs_mec011v010101p.pdf) +* [Specification document](https://docbox.etsi.org/ISG/MEC/70-Draft/0011v211Plat.App.Enabl/MEC-0011v211Plat.App.Enablv205.zip) * [Navigate the API in the browser](https://forge.etsi.org/swagger/ui/?url=https://forge.etsi.org/gitlab/mec/gs011-app-enablement-api/raw/develop/Mp1.yaml). * [Edit the API online](https://forge.etsi.org/swagger/editor/?url=https://forge.etsi.org/gitlab/mec/gs011-app-enablement-api/raw/develop/Mp1.yaml). -- GitLab From 39370fa7b01d6111176091b4dc24851d0c8ae9de Mon Sep 17 00:00:00 2001 From: featherstone Date: Mon, 28 Jan 2019 21:06:21 +0000 Subject: [PATCH 02/21] Updated URIs in README --- README.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 3f36872..25f27f7 100644 --- a/README.md +++ b/README.md @@ -5,8 +5,8 @@ This repository contains OpenAPIs descriptions for the interfaces specified in E ## Online resources * [Specification document](https://docbox.etsi.org/ISG/MEC/70-Draft/0011v211Plat.App.Enabl/MEC-0011v211Plat.App.Enablv205.zip) -* [Navigate the API in the browser](https://forge.etsi.org/swagger/ui/?url=https://forge.etsi.org/gitlab/mec/gs011-app-enablement-api/raw/develop/Mp1.yaml). -* [Edit the API online](https://forge.etsi.org/swagger/editor/?url=https://forge.etsi.org/gitlab/mec/gs011-app-enablement-api/raw/develop/Mp1.yaml). +* [Navigate the API in the browser](https://forge.etsi.org/swagger/ui/?url=https://forge.etsi.org/gitlab/mec/gs011-app-enablement-api/raw/mec11v205-openAPI3/Mp1.yaml). +* [Edit the API online](https://forge.etsi.org/swagger/editor/?url=https://forge.etsi.org/gitlab/mec/gs011-app-enablement-api/raw/mec11v205-openAPI3/Mp1.yaml). -- GitLab From 3851063dd50e7d8ef7cf0bc45e83bbbd5066fbb9 Mon Sep 17 00:00:00 2001 From: featherstone Date: Thu, 28 Feb 2019 22:04:49 +0000 Subject: [PATCH 03/21] oAuth2Info is not a required parameter & used oneOf for endpoint --- Mp1.json | 73 ++++++++++++++++++++++++++++++++------------------------ Mp1.yaml | 47 ++++++++++++++++++++---------------- 2 files changed, 68 insertions(+), 52 deletions(-) diff --git a/Mp1.json b/Mp1.json index b8537b8..c259ae2 100644 --- a/Mp1.json +++ b/Mp1.json @@ -810,14 +810,31 @@ }, "EndPointInfo.Addresses": { "description": "Entry point information of the service as one or more pairs of IP address and port", - "type": "array", - "items": { - "$ref": "#/components/schemas/EndPointInfo.Address" + "type": "object", + "required": [ + "addresses" + ], + "properties": { + "addresses": { + "type": "array", + "minItems": 0, + "items": { + "$ref": "#/components/schemas/EndPointInfo.Address" + } + } } }, "EndPointInfo.Alternative": { "description": "Entry point information of the service in a format defined by an implementation, or in an external specification.", - "type": "object" + "type": "object", + "required": [ + "alternative" + ], + "properties": { + "alternative": { + "type": "object" + } + } }, "EndPointInfo.Uri": { "description": "Entry point information of the service", @@ -827,23 +844,17 @@ }, "EndPointInfo.Uris": { "description": "Entry point information of the service as string, formatted according to URI syntax", - "type": "array", - "items": { - "$ref": "#/components/schemas/EndPointInfo.Uri" - } - }, - "EndPointInfo": { - "description": "This type represents information about a transport endpoint", "type": "object", + "required": [ + "uris" + ], "properties": { "uris": { - "$ref": "#/components/schemas/EndPointInfo.Uris" - }, - "addresses": { - "$ref": "#/components/schemas/EndPointInfo.Addresses" - }, - "alternative": { - "$ref": "#/components/schemas/EndPointInfo.Alternative" + "type": "array", + "minItems": 0, + "items": { + "$ref": "#/components/schemas/EndPointInfo.Uri" + } } } }, @@ -993,9 +1004,6 @@ "SecurityInfo": { "description": "This type represents security information related to a transport", "type": "object", - "required": [ - "oAuth2Info" - ], "properties": { "oAuth2Info": { "$ref": "#/components/schemas/SecurityInfo.OAuth2Info" @@ -1632,7 +1640,19 @@ "$ref": "#/components/schemas/TransportInfo.Version" }, "endpoint": { - "$ref": "#/components/schemas/EndPointInfo" + "description": "This type represents information about a transport endpoint", + "type": "object", + "oneOf": [ + { + "$ref": "#/components/schemas/EndPointInfo.Uris" + }, + { + "$ref": "#/components/schemas/EndPointInfo.Addresses" + }, + { + "$ref": "#/components/schemas/EndPointInfo.Alternative" + } + ] }, "security": { "$ref": "#/components/schemas/SecurityInfo" @@ -2368,12 +2388,6 @@ "endpoint": { "uris": [ "/meMp1/service/EntryPoint" - ], - "addresses": [ - { - "host": "192.0.2.0", - "port": 8080 - } ] }, "security": { @@ -2408,9 +2422,6 @@ "protocol": "HTTP", "version": "2.0", "endpoint": { - "uris": [ - "/meMp1/service/EntryPoint" - ], "addresses": [ { "host": "192.0.2.0", diff --git a/Mp1.yaml b/Mp1.yaml index baf06ea..c2e1846 100644 --- a/Mp1.yaml +++ b/Mp1.yaml @@ -603,14 +603,25 @@ components: description: >- Entry point information of the service as one or more pairs of IP address and port - type: array - items: - $ref: '#/components/schemas/EndPointInfo.Address' + type: object + required: + - addresses + properties: + addresses: + type: array + minItems: 0 + items: + $ref: '#/components/schemas/EndPointInfo.Address' EndPointInfo.Alternative: description: >- Entry point information of the service in a format defined by an implementation, or in an external specification. type: object + required: + - alternative + properties: + alternative: + type: object EndPointInfo.Uri: description: Entry point information of the service type: string @@ -620,19 +631,15 @@ components: description: >- Entry point information of the service as string, formatted according to URI syntax - type: array - items: - $ref: '#/components/schemas/EndPointInfo.Uri' - EndPointInfo: - description: This type represents information about a transport endpoint type: object + required: + - uris properties: uris: - $ref: '#/components/schemas/EndPointInfo.Uris' - addresses: - $ref: '#/components/schemas/EndPointInfo.Addresses' - alternative: - $ref: '#/components/schemas/EndPointInfo.Alternative' + type: array + minItems: 0 + items: + $ref: '#/components/schemas/EndPointInfo.Uri' LinkType: description: This type represents a type of link and may be referenced from data structures type: object @@ -746,8 +753,6 @@ components: SecurityInfo: description: This type represents security information related to a transport type: object - required: - - oAuth2Info properties: oAuth2Info: $ref: '#/components/schemas/SecurityInfo.OAuth2Info' @@ -1278,7 +1283,12 @@ components: version: $ref: '#/components/schemas/TransportInfo.Version' endpoint: - $ref: '#/components/schemas/EndPointInfo' + description: This type represents information about a transport endpoint + type: object + oneOf: + - $ref: '#/components/schemas/EndPointInfo.Uris' + - $ref: '#/components/schemas/EndPointInfo.Addresses' + - $ref: '#/components/schemas/EndPointInfo.Alternative' security: $ref: '#/components/schemas/SecurityInfo' implSpecificInfo: @@ -1824,9 +1834,6 @@ components: endpoint: uris: - '/meMp1/service/EntryPoint' - addresses: - - host: '192.0.2.0' - port: 8080 security: oAuth2Info: grantTypes: 'OAUTH2_CLIENT_CREDENTIALS' @@ -1852,8 +1859,6 @@ components: protocol: 'HTTP' version: '2.0' endpoint: - uris: - - '/meMp1/service/EntryPoint' addresses: - host: '192.0.2.0' port: 8080 -- GitLab From 248136a7fe60c2eb9c058286606e5bb3995d031c Mon Sep 17 00:00:00 2001 From: featherstone Date: Fri, 1 Mar 2019 09:56:02 +0000 Subject: [PATCH 04/21] host and port are required for an EndPointInfo addresses array instance --- Mp1.json | 4 ++++ Mp1.yaml | 3 +++ 2 files changed, 7 insertions(+) diff --git a/Mp1.json b/Mp1.json index c259ae2..dddf928 100644 --- a/Mp1.json +++ b/Mp1.json @@ -799,6 +799,10 @@ "EndPointInfo.Address": { "description": "A IP address and port pair", "type": "object", + "required": [ + "host", + "port" + ], "properties": { "host": { "$ref": "#/components/schemas/EndPointInfo.Address.Host" diff --git a/Mp1.yaml b/Mp1.yaml index c2e1846..1ec7efe 100644 --- a/Mp1.yaml +++ b/Mp1.yaml @@ -594,6 +594,9 @@ components: EndPointInfo.Address: description: A IP address and port pair type: object + required: + - host + - port properties: host: $ref: '#/components/schemas/EndPointInfo.Address.Host' -- GitLab From 614bb942caf0964860a03bddbff4736985f1b9e6 Mon Sep 17 00:00:00 2001 From: featherstone Date: Sat, 2 Mar 2019 16:30:17 +0000 Subject: [PATCH 05/21] removed transpordId from ServiceInfo examples --- Mp1.json | 2 -- Mp1.yaml | 2 -- 2 files changed, 4 deletions(-) diff --git a/Mp1.json b/Mp1.json index dddf928..001a744 100644 --- a/Mp1.json +++ b/Mp1.json @@ -2381,7 +2381,6 @@ }, "version": "ServiceVersion1", "state": "ACTIVE", - "transportId": "Rest1", "transportInfo": { "id": "TransId12345", "name": "REST", @@ -2417,7 +2416,6 @@ }, "version": "ServiceVersion1", "state": "ACTIVE", - "transportId": "Rest1", "transportInfo": { "id": "TransId12345", "name": "REST", diff --git a/Mp1.yaml b/Mp1.yaml index 1ec7efe..e2f169a 100644 --- a/Mp1.yaml +++ b/Mp1.yaml @@ -1826,7 +1826,6 @@ components: version: 'version1' version: 'ServiceVersion1' state: 'ACTIVE' - transportId: 'Rest1' transportInfo: id: 'TransId12345' name: 'REST' @@ -1853,7 +1852,6 @@ components: version: 'version1' version: 'ServiceVersion1' state: 'ACTIVE' - transportId: 'Rest1' transportInfo: id: 'TransId12345' name: 'REST' -- GitLab From 6e4de84c9d70fb5b5576a4eda751c95be0dd11c9 Mon Sep 17 00:00:00 2001 From: featherstone Date: Fri, 15 Mar 2019 15:41:24 +0000 Subject: [PATCH 06/21] Sepeated ServiceInfo POST message body Signed-off-by: featherstone --- .vscode/settings.json | 3 ++ Mp1.json | 83 +++++++++++++++++++++++++++++++++++++++++-- Mp1.yaml | 59 ++++++++++++++++++++++++++---- 3 files changed, 137 insertions(+), 8 deletions(-) create mode 100644 .vscode/settings.json diff --git a/.vscode/settings.json b/.vscode/settings.json new file mode 100644 index 0000000..3b66410 --- /dev/null +++ b/.vscode/settings.json @@ -0,0 +1,3 @@ +{ + "git.ignoreLimitWarning": true +} \ No newline at end of file diff --git a/Mp1.json b/Mp1.json index 001a744..8b104e6 100644 --- a/Mp1.json +++ b/Mp1.json @@ -338,7 +338,7 @@ } }, "requestBody": { - "$ref": "#/components/requestBodies/Services" + "$ref": "#/components/requestBodies/Services.Post" } } }, @@ -1130,6 +1130,7 @@ "ServiceInfo.TransportId": { "description": "Identifier of the platform-provided transport to be used by the service. Valid identifiers may be obtained using the \"Transport information query\" procedure. May be present in POST requests to signal the use of a platform-provided transport for the service, and shall be absent otherwise.", "type": "string", + "writeOnly": true, "example": "Rest1" }, "ServiceInfo.Version": { @@ -1147,7 +1148,7 @@ "type": "boolean", "example": true }, - "ServiceInfo": { + "ServiceInfo.Post": { "description": "This type represents the general information of a mobile edge service.", "type": "object", "required": [ @@ -1156,6 +1157,18 @@ "state", "serializer" ], + "oneOf": [ + { + "required": [ + "transportId" + ] + }, + { + "required": [ + "transportInfo" + ] + } + ], "properties": { "serInstanceId": { "$ref": "#/components/schemas/ServiceInfo.SerInstanceId" @@ -1192,6 +1205,49 @@ } } }, + "ServiceInfo": { + "description": "This type represents the general information of a mobile edge service.", + "type": "object", + "required": [ + "serName", + "version", + "state", + "transportInfo", + "serializer" + ], + "properties": { + "serInstanceId": { + "$ref": "#/components/schemas/ServiceInfo.SerInstanceId" + }, + "serName": { + "$ref": "#/components/schemas/ServiceInfo.SerName" + }, + "serCategory": { + "$ref": "#/components/schemas/CategoryRef" + }, + "version": { + "$ref": "#/components/schemas/ServiceInfo.Version" + }, + "state": { + "$ref": "#/components/schemas/ServiceInfo.State" + }, + "transportInfo": { + "$ref": "#/components/schemas/TransportInfo" + }, + "serializer": { + "$ref": "#/components/schemas/SerializerTypes" + }, + "scopeOfLocality": { + "$ref": "#/components/schemas/LocalityTypes" + }, + "consumedLocalOnly": { + "$ref": "#/components/schemas/ServiceInfo.ConsumedLocalOnly" + }, + "isLocal": { + "$ref": "#/components/schemas/ServiceInfo.IsLocal" + } + } + }, "Subscription": { "description": "A link to the related subscription", "type": "object", @@ -2098,6 +2154,11 @@ } } } + }, + "links": { + "getTransportInfo": { + "$ref": "#/components/links/GetTransportInfo" + } } }, "Error.400": { @@ -2208,6 +2269,17 @@ "description": "New ServiceInfo with updated \"state\" is included as entity body of the request", "required": true }, + "Services.Post": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ServiceInfo.Post" + } + } + }, + "description": "New ServiceInfo with updated \"state\" is included as entity body of the request", + "required": true + }, "ServicesServiceId": { "content": { "application/json": { @@ -2313,6 +2385,13 @@ "trafficRuleId": "$response.body#/trafficRuleId" } }, + "GetTransportInfo": { + "operationId": "AppServices_POST", + "description": "The `id` value returned in the response can be used as the `transportId` parameter in `POST /applications/{appInstanceId}/services`. The first transport is provided as the link as wildcards are not supported", + "parameters": { + "transportId": "$response.body#/0/id" + } + }, "GetIndividualMeMp1Subscription": { "operationId": "ApplicationsSubscription_GET", "description": "The `subscriptionId` value returned in the response can be used as the `subscriptionId` parameter in `GET /applications/{appInstanceId}/subscriptions/{subscriptionType}/{subscriptionId}`", diff --git a/Mp1.yaml b/Mp1.yaml index e2f169a..5a3ebd1 100644 --- a/Mp1.yaml +++ b/Mp1.yaml @@ -232,7 +232,7 @@ paths: '404': $ref: '#/components/responses/Error.404' requestBody: - $ref: '#/components/requestBodies/Services' + $ref: '#/components/requestBodies/Services.Post' '/applications/{appInstanceId}/services/{serviceId}': parameters: - $ref: '#/components/parameters/Path.AppInstanceId' @@ -308,10 +308,6 @@ paths: $ref: '#/components/responses/Error.403' '404': $ref: '#/components/responses/Error.404' - - - - '/timing/current_time': get: description: >- @@ -867,6 +863,7 @@ components: platform-provided transport for the service, and shall be absent otherwise. type: string + writeOnly: true example: 'Rest1' ServiceInfo.Version: description: Service version @@ -885,7 +882,7 @@ components: by scopeOfLocality) as the consuming MEC application. type: boolean example: true - ServiceInfo: + ServiceInfo.Post: description: This type represents the general information of a mobile edge service. type: object required: @@ -893,6 +890,9 @@ components: - version - state - serializer + oneOf: + - required: [transportId] + - required: [transportInfo] properties: serInstanceId: $ref: '#/components/schemas/ServiceInfo.SerInstanceId' @@ -914,6 +914,36 @@ components: $ref: '#/components/schemas/LocalityTypes' consumedLocalOnly: $ref: '#/components/schemas/ServiceInfo.ConsumedLocalOnly' + isLocal: + $ref: '#/components/schemas/ServiceInfo.IsLocal' + ServiceInfo: + description: This type represents the general information of a mobile edge service. + type: object + required: + - serName + - version + - state + - transportInfo + - serializer + properties: + serInstanceId: + $ref: '#/components/schemas/ServiceInfo.SerInstanceId' + serName: + $ref: '#/components/schemas/ServiceInfo.SerName' + serCategory: + $ref: '#/components/schemas/CategoryRef' + version: + $ref: '#/components/schemas/ServiceInfo.Version' + state: + $ref: '#/components/schemas/ServiceInfo.State' + transportInfo: + $ref: '#/components/schemas/TransportInfo' + serializer: + $ref: '#/components/schemas/SerializerTypes' + scopeOfLocality: + $ref: '#/components/schemas/LocalityTypes' + consumedLocalOnly: + $ref: '#/components/schemas/ServiceInfo.ConsumedLocalOnly' isLocal: $ref: '#/components/schemas/ServiceInfo.IsLocal' Subscription: @@ -1637,6 +1667,9 @@ components: minItems: 0 items: $ref: '#/components/schemas/TransportInfo' + links: + getTransportInfo: + $ref: '#/components/links/GetTransportInfo' Error.400: description: Bad Request content: @@ -1705,6 +1738,15 @@ components: New ServiceInfo with updated "state" is included as entity body of the request required: true + Services.Post: + content: + application/json: + schema: + $ref: '#/components/schemas/ServiceInfo.Post' + description: >- + New ServiceInfo with updated "state" is included as entity body of the + request + required: true ServicesServiceId: content: application/json: @@ -1774,6 +1816,11 @@ components: description: The `trafficRuleId` value returned in the response can be used as the `trafficRuleId` parameter in `PUT /applications/{appInstanceId}/traffic_rules/{trafficRuleId}` parameters: trafficRuleId: '$response.body#/trafficRuleId' + GetTransportInfo: + operationId: AppServices_POST + description: The `id` value returned in the response can be used as the `transportId` parameter in `POST /applications/{appInstanceId}/services`. The first transport is provided as the link as wildcards are not supported + parameters: + transportId: '$response.body#/0/id' GetIndividualMeMp1Subscription: operationId: ApplicationsSubscription_GET description: The `subscriptionId` value returned in the response can be used as the `subscriptionId` parameter in `GET /applications/{appInstanceId}/subscriptions/{subscriptionType}/{subscriptionId}` -- GitLab From dfc34de96f65e398f866f9732890dd3e53404123 Mon Sep 17 00:00:00 2001 From: featherstone Date: Tue, 7 May 2019 17:23:34 +0100 Subject: [PATCH 07/21] Moving from MEC-011 v2.0.5 to v2.0.8 --- Mp1.json | 213 +++++++++++++++++++++++++++++++++++++----------------- Mp1.yaml | 151 ++++++++++++++++++++++++++++++-------- README.md | 6 +- 3 files changed, 272 insertions(+), 98 deletions(-) diff --git a/Mp1.json b/Mp1.json index 387f66b..44df18a 100644 --- a/Mp1.json +++ b/Mp1.json @@ -10,7 +10,7 @@ ], "info": { "title": "Mp1 API", - "version": "2.0.5", + "version": "2.0.8", "description": "The ETSI MEC ISG MEC011 Application Enablement API described using OpenAPI", "license": { "name": "ETSI Forge copyright notice", @@ -21,18 +21,24 @@ } }, "externalDocs": { - "description": "ETSI GS MEC011 Application Enablement API, V2.0.5", - "url": "https://docbox.etsi.org/ISG/MEC/70-Draft/0011v211Plat.App.Enabl/MEC-0011v211Plat.App.Enablv205.zip" + "description": "ETSI GS MEC011 Application Enablement API, V2.0.8", + "url": "https://docbox.etsi.org/ISG/MEC/70-Draft/0011v211Plat.App.Enabl/MEC-0011v211Plat.App.Enablv208.zip" }, "tags": [ { - "name": "trafficRules" + "name": "appTrafficRules" }, { - "name": "dnsRules" + "name": "appDnsRules" }, { - "name": "subscriptions" + "name": "appSubscriptions" + }, + { + "name": "appConfirmTermination" + }, + { + "name": "appServices" }, { "name": "services" @@ -48,6 +54,40 @@ } ], "paths": { + "/applications/{appInstanceId}/confirm_termination": { + "parameters": [ + { + "$ref": "#/components/parameters/Path.AppInstanceId" + } + ], + "post": { + "description": "This method is used to confirm the application level termination of an application instance.", + "operationId": "ApplicationsConfirmTermination_POST", + "tags": [ + "appConfirmTermination" + ], + "responses": { + "204": { + "description": "No Content" + }, + "401": { + "$ref": "#/components/responses/Error.401" + }, + "403": { + "$ref": "#/components/responses/Error.403" + }, + "404": { + "$ref": "#/components/responses/Error.404" + }, + "409": { + "$ref": "#/components/responses/Error.409" + }, + "429": { + "$ref": "#/components/responses/Error.429" + } + } + } + }, "/applications/{appInstanceId}/dns_rules": { "parameters": [ { @@ -58,7 +98,7 @@ "description": "This method retrieves information about all the DNS rules associated with a mobile edge application instance.", "operationId": "ApplicationsDnsRules_GET", "tags": [ - "trafficRules" + "appTrafficRules" ], "responses": { "200": { @@ -89,7 +129,7 @@ "description": "This method retrieves information about a DNS rule associated with a mobile edge application instance.", "operationId": "ApplicationsDnsRule_GET", "tags": [ - "dnsRules" + "appDnsRules" ], "responses": { "200": { @@ -110,7 +150,7 @@ "description": "This method activates, de-activates or updates a traffic rule.", "operationId": "ApplicationsDnsRule_PUT", "tags": [ - "dnsRules" + "appDnsRules" ], "responses": { "200": { @@ -144,7 +184,7 @@ "description": "The GET method may be used to request information about all subscriptions for this requestor. Upon success, the response contains entity body with all the subscriptions for the requestor.", "operationId": "ApplicationsSubscriptions_GET", "tags": [ - "subscriptions" + "appSubscriptions" ], "responses": { "200": { @@ -165,7 +205,7 @@ "description": "The POST method may be used to create a new subscription. One example use case is to create a new subscription to the mobile edge service availability notifications. Upon success, the response contains entity body describing the created subscription.", "operationId": "ApplicationsSubscriptions_POST", "tags": [ - "subscriptions" + "appSubscriptions" ], "responses": { "201": { @@ -210,7 +250,7 @@ "description": "The GET method requests information about a subscription for this requestor. Upon success, the response contains entity body with the subscription for the requestor.", "operationId": "ApplicationsSubscription_GET", "tags": [ - "subscriptions" + "appSubscriptions" ], "responses": { "200": { @@ -231,7 +271,7 @@ "description": "This method deletes a meMp1Subscription. This method is typically used in \"Unsubscribing from service availability event notifications\" procedure.", "operationId": "ApplicationsSubscription_DELETE", "tags": [ - "subscriptions" + "appSubscriptions" ], "responses": { "204": { @@ -256,7 +296,7 @@ "description": "This method retrieves information about all the traffic rules associated with a mobile edge application instance.", "operationId": "ApplicationsTrafficRules_GET", "tags": [ - "trafficRules" + "appTrafficRules" ], "responses": { "200": { @@ -287,7 +327,7 @@ "description": "This method retrieves information about all the traffic rules associated with a mobile edge application instance.", "operationId": "ApplicationsTrafficRule_GET", "tags": [ - "trafficRules" + "appTrafficRules" ], "responses": { "200": { @@ -308,7 +348,7 @@ "description": "This method retrieves information about all the traffic rules associated with a mobile edge application instance.", "operationId": "ApplicationsTrafficRule_PUT", "tags": [ - "trafficRules" + "appTrafficRules" ], "responses": { "200": { @@ -342,7 +382,7 @@ "description": "This method retrieves information about a list of meService resources. This method is typically used in \"service availability query\" procedure", "operationId": "AppServices_GET", "tags": [ - "services" + "appServices" ], "parameters": [ { @@ -383,7 +423,7 @@ "description": "This method is used to create a meService resource. This method is typically used in \"service availability update and new service registration\" procedure", "operationId": "AppServices_POST", "tags": [ - "services" + "appServices" ], "responses": { "201": { @@ -417,7 +457,7 @@ "description": "This method retrieves information about a meService resource. This method is typically used in \"service availability query\" procedure", "operationId": "AppServicesServiceId_GET", "tags": [ - "services" + "appServices" ], "responses": { "200": { @@ -438,7 +478,7 @@ "description": "This method updates the information about a meService resource", "operationId": "AppServicesServiceId_PUT", "tags": [ - "services" + "appServices" ], "responses": { "200": { @@ -466,6 +506,9 @@ "get": { "description": "This method retrieves information about a list of meService resources. This method is typically used in \"service availability query\" procedure", "operationId": "Services_GET", + "tags": [ + "services" + ], "parameters": [ { "$ref": "#/components/parameters/Query.Ser_instance_id" @@ -511,6 +554,9 @@ "get": { "description": "This method retrieves information about a meService resource. This method is typically used in \"service availability query\" procedure", "operationId": "ServicesServiceId_GET", + "tags": [ + "services" + ], "responses": { "200": { "$ref": "#/components/responses/ServicesServiceId.200" @@ -602,6 +648,21 @@ "Empty": { "description": "Empty schema" }, + "AppTerminationNotification.Links": { + "description": "List of hyperlinks related to the resource.", + "type": "object", + "required": [ + "subscription" + ], + "properties": { + "subscription": { + "$ref": "#/components/schemas/LinkType" + }, + "confirmTermination": { + "$ref": "#/components/schemas/LinkType.ConfirmTermination" + } + } + }, "AppTerminationNotification.MaxGracefulTimeout": { "description": "Maximum timeout value in seconds for graceful termination or graceful stop of an application instance.", "type": "integer", @@ -629,7 +690,7 @@ "$ref": "#/components/schemas/AppTerminationNotification.MaxGracefulTimeout" }, "_links": { - "$ref": "#/components/schemas/Subscription" + "$ref": "#/components/schemas/AppTerminationNotification.Links" } } }, @@ -683,7 +744,7 @@ "example": "id12345" }, "CategoryRef.Name": { - "description": "Name of the category", + "description": "Name of the category, example values include RNI, Location & Bandwidth Management", "type": "string", "example": "RNI" }, @@ -948,6 +1009,15 @@ } } }, + "LinkType.ConfirmTermination": { + "description": "Link to the task resource where to confirm termination in case the application is ready to be terminated before expiry of the timeout.", + "type": "object", + "properties": { + "href": { + "$ref": "#/components/schemas/Href" + } + } + }, "Href": { "description": "URI referring to a resource", "type": "string", @@ -964,8 +1034,8 @@ "self": { "$ref": "#/components/schemas/LinkType" }, - "subscription": { - "description": "Subscription list", + "subscriptions": { + "description": "The MEC application instance's subscriptions", "type": "array", "items": { "$ref": "#/components/schemas/Mp1SubscriptionLinkList.Subscription" @@ -1325,40 +1395,6 @@ } } }, - "ServiceInfo": { - "description": "This type represents the general information of a mobile edge service.", - "type": "object", - "required": [ - "serName", - "version", - "state", - "transportInfo", - "serializer" - ], - "properties": { - "serInstanceId": { - "$ref": "#/components/schemas/ServiceInfo.SerInstanceId" - }, - "serName": { - "$ref": "#/components/schemas/ServiceInfo.SerName" - }, - "serCategory": { - "$ref": "#/components/schemas/CategoryRef" - }, - "version": { - "$ref": "#/components/schemas/ServiceInfo.Version" - }, - "state": { - "$ref": "#/components/schemas/ServiceInfo.State" - }, - "transportInfo": { - "$ref": "#/components/schemas/TransportInfo" - }, - "serializer": { - "$ref": "#/components/schemas/SerializerTypes" - } - } - }, "Subscription": { "description": "A link to the related subscription", "type": "object", @@ -2273,7 +2309,22 @@ } }, "Error.400": { - "description": "Bad Request", + "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": { @@ -2288,7 +2339,7 @@ } }, "Error.403": { - "description": "Forbidden", + "description": "Forbidden. The operation is not allowed given the current status of the resource. ", "content": { "application/problem+json": { "schema": { @@ -2298,7 +2349,22 @@ } }, "Error.404": { - "description": "Not Found", + "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" + } + } + } + }, + "Error.409": { + "description": "Conflict. The operation cannot be executed currently, due to a conflict with the state of the resource. Typically, this is because the application instance resource is in NOT_INSTANTIATED state.", "content": { "application/problem+json": { "schema": { @@ -2313,7 +2379,22 @@ } }, "Error.412": { - "description": "Precondition Failed", + "description": "Precondition Failed. It is used when a condition has failed during conditional requests, e.g. when using ETags to avoid write conflicts.", + "content": { + "application/problem+json": { + "schema": { + "$ref": "#/components/schemas/ProblemDetails" + } + }, + "text/plain": { + "schema": { + "$ref": "#/components/schemas/Empty" + } + } + } + }, + "Error.429": { + "description": "Too Many Requests. It is used when a rate limiter has triggered.", "content": { "application/problem+json": { "schema": { @@ -2409,7 +2490,8 @@ "$ref": "#/components/schemas/AppTerminationNotification" } } - } + }, + "required": true }, "ServiceAvailabilityNotification": { "content": { @@ -2418,7 +2500,8 @@ "$ref": "#/components/schemas/ServiceAvailabilityNotification" } } - } + }, + "required": true } }, "callbacks": { @@ -2700,4 +2783,4 @@ } } } -} +} \ No newline at end of file diff --git a/Mp1.yaml b/Mp1.yaml index bf46e6b..c0cfe97 100644 --- a/Mp1.yaml +++ b/Mp1.yaml @@ -4,7 +4,7 @@ servers: - url: 'https://127.0.0.1:8081/mp1/v1' info: title: Mp1 API - version: 2.0.5 + version: 2.0.8 description: The ETSI MEC ISG MEC011 Application Enablement API described using OpenAPI license: name: ETSI Forge copyright notice @@ -12,18 +12,43 @@ info: contact: email: cti_support@etsi.org externalDocs: - description: 'ETSI GS MEC011 Application Enablement API, V2.0.5' + description: 'ETSI GS MEC011 Application Enablement API, V2.0.8' url: >- - https://docbox.etsi.org/ISG/MEC/70-Draft/0011v211Plat.App.Enabl/MEC-0011v211Plat.App.Enablv205.zip + https://docbox.etsi.org/ISG/MEC/70-Draft/0011v211Plat.App.Enabl/MEC-0011v211Plat.App.Enablv208.zip tags: - - name: trafficRules - - name: dnsRules - - name: subscriptions + - name: appTrafficRules + - name: appDnsRules + - name: appSubscriptions + - name: appConfirmTermination + - name: appServices - name: services - name: timing - name: transports - name: callbacks paths: + '/applications/{appInstanceId}/confirm_termination': + parameters: + - $ref: '#/components/parameters/Path.AppInstanceId' + post: + description: >- + This method is used to confirm the application level termination + of an application instance. + operationId: ApplicationsConfirmTermination_POST + tags: + - appConfirmTermination + responses: + '204': + description: No Content + '401': + $ref: '#/components/responses/Error.401' + '403': + $ref: '#/components/responses/Error.403' + '404': + $ref: '#/components/responses/Error.404' + '409': + $ref: '#/components/responses/Error.409' + '429': + $ref: '#/components/responses/Error.429' '/applications/{appInstanceId}/dns_rules': parameters: - $ref: '#/components/parameters/Path.AppInstanceId' @@ -33,7 +58,7 @@ paths: with a mobile edge application instance. operationId: ApplicationsDnsRules_GET tags: - - trafficRules + - appTrafficRules responses: '200': $ref: '#/components/responses/ApplicationsDnsRules.200' @@ -53,7 +78,7 @@ paths: mobile edge application instance. operationId: ApplicationsDnsRule_GET tags: - - dnsRules + - appDnsRules responses: '200': $ref: '#/components/responses/ApplicationsDnsRule.200' @@ -67,7 +92,7 @@ paths: description: 'This method activates, de-activates or updates a traffic rule.' operationId: ApplicationsDnsRule_PUT tags: - - dnsRules + - appDnsRules responses: '200': $ref: '#/components/responses/ApplicationsDnsRule.200' @@ -91,7 +116,7 @@ paths: entity body with all the subscriptions for the requestor. operationId: ApplicationsSubscriptions_GET tags: - - subscriptions + - appSubscriptions responses: '200': $ref: '#/components/responses/ApplicationsSubscriptions.200' @@ -109,7 +134,7 @@ paths: body describing the created subscription. operationId: ApplicationsSubscriptions_POST tags: - - subscriptions + - appSubscriptions responses: '201': $ref: '#/components/responses/ApplicationsSubscriptions.201' @@ -138,7 +163,7 @@ paths: subscription for the requestor. operationId: ApplicationsSubscription_GET tags: - - subscriptions + - appSubscriptions responses: '200': $ref: '#/components/responses/ApplicationsSubscription.200' @@ -155,7 +180,7 @@ paths: procedure. operationId: ApplicationsSubscription_DELETE tags: - - subscriptions + - appSubscriptions responses: '204': description: No Content @@ -172,7 +197,7 @@ paths: with a mobile edge application instance. operationId: ApplicationsTrafficRules_GET tags: - - trafficRules + - appTrafficRules responses: '200': $ref: '#/components/responses/ApplicationsTrafficRules.200' @@ -192,7 +217,7 @@ paths: with a mobile edge application instance. operationId: ApplicationsTrafficRule_GET tags: - - trafficRules + - appTrafficRules responses: '200': $ref: '#/components/responses/ApplicationsTrafficRule.200' @@ -208,7 +233,7 @@ paths: with a mobile edge application instance. operationId: ApplicationsTrafficRule_PUT tags: - - trafficRules + - appTrafficRules responses: '200': $ref: '#/components/responses/ApplicationsTrafficRule.200' @@ -231,7 +256,7 @@ paths: This method is typically used in "service availability query" procedure operationId: AppServices_GET tags: - - services + - appServices parameters: - $ref: '#/components/parameters/Query.Ser_instance_id' - $ref: '#/components/parameters/Query.Ser_name' @@ -255,7 +280,7 @@ paths: registration" procedure operationId: AppServices_POST tags: - - services + - appServices responses: '201': $ref: '#/components/responses/Services.201' @@ -277,7 +302,7 @@ paths: method is typically used in "service availability query" procedure operationId: AppServicesServiceId_GET tags: - - services + - appServices responses: '200': $ref: '#/components/responses/ServicesServiceId.200' @@ -291,7 +316,7 @@ paths: description: This method updates the information about a meService resource operationId: AppServicesServiceId_PUT tags: - - services + - appServices responses: '200': $ref: '#/components/responses/ServicesServiceId.200' @@ -305,14 +330,14 @@ paths: $ref: '#/components/responses/Error.412' requestBody: $ref: '#/components/requestBodies/ServicesServiceId' - - '/services': get: description: >- This method retrieves information about a list of meService resources. This method is typically used in "service availability query" procedure operationId: Services_GET + tags: + - services parameters: - $ref: '#/components/parameters/Query.Ser_instance_id' - $ref: '#/components/parameters/Query.Ser_name' @@ -337,6 +362,8 @@ paths: This method retrieves information about a meService resource. This method is typically used in "service availability query" procedure operationId: ServicesServiceId_GET + tags: + - services responses: '200': $ref: '#/components/responses/ServicesServiceId.200' @@ -403,6 +430,17 @@ components: schemas: Empty: description: Empty schema + AppTerminationNotification.Links: + description: >- + List of hyperlinks related to the resource. + type: object + required: + - subscription + properties: + subscription: + $ref: '#/components/schemas/LinkType' + confirmTermination: + $ref: '#/components/schemas/LinkType.ConfirmTermination' AppTerminationNotification.MaxGracefulTimeout: description: >- Maximum timeout value in seconds for graceful termination or graceful @@ -430,7 +468,7 @@ components: maxGracefulTimeout: $ref: '#/components/schemas/AppTerminationNotification.MaxGracefulTimeout' _links: - $ref: '#/components/schemas/Subscription' + $ref: '#/components/schemas/AppTerminationNotification.Links' AppTerminationNotificationSubscription.AppInstanceId: description: It is used as the filtering criterion for the subscribed events. type: string @@ -479,7 +517,7 @@ components: type: string example: 'id12345' CategoryRef.Name: - description: Name of the category + description: Name of the category, example values include RNI, Location & Bandwidth Management type: string example: 'RNI' CategoryRef.Version: @@ -689,6 +727,14 @@ components: properties: href: $ref: '#/components/schemas/Href' + LinkType.ConfirmTermination: + description: >- + Link to the task resource where to confirm termination in case the + application is ready to be terminated before expiry of the timeout. + type: object + properties: + href: + $ref: '#/components/schemas/Href' Href: description: URI referring to a resource type: string @@ -702,8 +748,8 @@ components: properties: self: $ref: '#/components/schemas/LinkType' - subscription: - description: Subscription list + subscriptions: + description: The MEC application instance's subscriptions type: array items: $ref: '#/components/schemas/Mp1SubscriptionLinkList.Subscription' @@ -1715,7 +1761,20 @@ components: getTransportInfo: $ref: '#/components/links/GetTransportInfo' Error.400: - description: Bad Request + 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: @@ -1724,13 +1783,31 @@ components: schema: $ref: '#/components/schemas/Empty' Error.403: - description: Forbidden + 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 + 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' + Error.409: + description: >- + Conflict. + The operation cannot be executed currently, due to a conflict with + the state of the resource. Typically, this is because the application + instance resource is in NOT_INSTANTIATED state. content: application/problem+json: schema: @@ -1739,7 +1816,21 @@ components: schema: $ref: '#/components/schemas/Empty' Error.412: - description: Precondition Failed + description: >- + Precondition Failed. + It is used when a condition has failed during conditional requests, + e.g. when using ETags to avoid write conflicts. + content: + application/problem+json: + schema: + $ref: '#/components/schemas/ProblemDetails' + text/plain: + schema: + $ref: '#/components/schemas/Empty' + Error.429: + description: >- + Too Many Requests. + It is used when a rate limiter has triggered. content: application/problem+json: schema: diff --git a/README.md b/README.md index 25f27f7..1a41884 100644 --- a/README.md +++ b/README.md @@ -4,9 +4,9 @@ This repository contains OpenAPIs descriptions for the interfaces specified in E ## Online resources -* [Specification document](https://docbox.etsi.org/ISG/MEC/70-Draft/0011v211Plat.App.Enabl/MEC-0011v211Plat.App.Enablv205.zip) -* [Navigate the API in the browser](https://forge.etsi.org/swagger/ui/?url=https://forge.etsi.org/gitlab/mec/gs011-app-enablement-api/raw/mec11v205-openAPI3/Mp1.yaml). -* [Edit the API online](https://forge.etsi.org/swagger/editor/?url=https://forge.etsi.org/gitlab/mec/gs011-app-enablement-api/raw/mec11v205-openAPI3/Mp1.yaml). +* [Specification document](https://docbox.etsi.org/ISG/MEC/70-Draft/0011v211Plat.App.Enabl/MEC-0011v211Plat.App.Enablv208.zip) +* [Navigate the API in the browser](https://forge.etsi.org/swagger/ui/?url=https://forge.etsi.org/gitlab/mec/gs011-app-enablement-api/raw/develop/Mp1.yaml). +* [Edit the API online](https://forge.etsi.org/swagger/editor/?url=https://forge.etsi.org/gitlab/mec/gs011-app-enablement-api/raw/develop/Mp1.yaml). -- GitLab From e23acf882c8763eb9c9aa41f005f5a2dd8afef48 Mon Sep 17 00:00:00 2001 From: featherstone Date: Wed, 8 May 2019 11:43:04 +0100 Subject: [PATCH 08/21] Corrected dns_rules tag --- Mp1.json | 12 ++++++++++-- Mp1.yaml | 8 +++++++- 2 files changed, 17 insertions(+), 3 deletions(-) diff --git a/Mp1.json b/Mp1.json index 44df18a..0e6efe9 100644 --- a/Mp1.json +++ b/Mp1.json @@ -98,7 +98,7 @@ "description": "This method retrieves information about all the DNS rules associated with a mobile edge application instance.", "operationId": "ApplicationsDnsRules_GET", "tags": [ - "appTrafficRules" + "appDnsRules" ], "responses": { "200": { @@ -890,7 +890,7 @@ "description": "Time to live value", "type": "integer", "format": "uint32", - "example": "?" + "example": 300 }, "DnsRule": { "description": "This type represents the general information of a DNS rule.", @@ -2647,6 +2647,14 @@ "ipAddress": "146.241.7.3", "ttl": 300, "state": "ACTIVE" + }, + { + "dnsRuleId": "DnsRule2", + "domainName": "www.example.com", + "ipAddressType": "IP_V4", + "ipAddress": "146.241.7.4", + "ttl": 300, + "state": "INACTIVE" } ] }, diff --git a/Mp1.yaml b/Mp1.yaml index c0cfe97..1f27a14 100644 --- a/Mp1.yaml +++ b/Mp1.yaml @@ -58,7 +58,7 @@ paths: with a mobile edge application instance. operationId: ApplicationsDnsRules_GET tags: - - appTrafficRules + - appDnsRules responses: '200': $ref: '#/components/responses/ApplicationsDnsRules.200' @@ -2018,6 +2018,12 @@ components: ipAddress: '146.241.7.3' ttl: 300 state: 'ACTIVE' + - dnsRuleId: 'DnsRule2' + domainName: 'www.example.com' + ipAddressType: 'IP_V4' + ipAddress: '146.241.7.4' + ttl: 300 + state: 'INACTIVE' ServiceInfo: value: serInstanceId: 'ServiceInstance123' -- GitLab From a0317469836436e6bb51ccfdb4c74500988eb68d Mon Sep 17 00:00:00 2001 From: featherstone Date: Mon, 20 May 2019 10:18:16 +0100 Subject: [PATCH 09/21] grantTypes enum array. Updated jenkins script to use swagger-cli and speccy --- .jenkins.sh | 19 ++++++++++--------- Mp1.json | 10 ++++++++-- Mp1.yaml | 8 +++++++- 3 files changed, 25 insertions(+), 12 deletions(-) diff --git a/.jenkins.sh b/.jenkins.sh index b24a061..448356c 100644 --- a/.jenkins.sh +++ b/.jenkins.sh @@ -1,17 +1,18 @@ #!/bin/bash -specfiles=$(ls | egrep -i "^Mp1.(json|yaml)") +specfiles=$(ls | egrep "^[^.]*.(json|yaml)") fres=0 for i in $specfiles ; do - echo "-- Validating OpenAPI file $i..." - swagger-tools validate $i - res=$? - fres=$(($fres||$res)) - echo -e "-- Validator returned $res.\n" + echo "-- Validating and linting OpenAPI file $i..." + swagger-cli validate "$i" + res=$? + speccy lint "$i" + res2=$? + fres=$(($fres||$res||$res2)) + echo "--- Validator returned $res, linter returned $res2." done -echo "-- Final validator returns $fres." - -exit $fres +echo "-- Final validation returns $fres." +exit $fres \ No newline at end of file diff --git a/Mp1.json b/Mp1.json index 0e6efe9..1850af1 100644 --- a/Mp1.json +++ b/Mp1.json @@ -890,7 +890,7 @@ "description": "Time to live value", "type": "integer", "format": "uint32", - "example": 300 + "example": "?" }, "DnsRule": { "description": "This type represents the general information of a DNS rule.", @@ -1144,7 +1144,13 @@ ], "properties": { "grantTypes": { - "$ref": "#/components/schemas/SecurityInfo.OAuth2Info.GrantTypes" + "description": "List of supported OAuth 2.0 grant types.", + "type": "array", + "minItems": 1, + "maxItems": 4, + "items": { + "$ref": "#/components/schemas/SecurityInfo.OAuth2Info.GrantTypes" + } }, "tokenEndpoint": { "$ref": "#/components/schemas/SecurityInfo.OAuth2Info.TokenEndpoint" diff --git a/Mp1.yaml b/Mp1.yaml index 1f27a14..eeeb600 100644 --- a/Mp1.yaml +++ b/Mp1.yaml @@ -835,7 +835,13 @@ components: - tokenEndpoint properties: grantTypes: - $ref: '#/components/schemas/SecurityInfo.OAuth2Info.GrantTypes' + description: >- + List of supported OAuth 2.0 grant types. + type: array + minItems: 1 + maxItems: 4 + items: + $ref: '#/components/schemas/SecurityInfo.OAuth2Info.GrantTypes' tokenEndpoint: $ref: '#/components/schemas/SecurityInfo.OAuth2Info.TokenEndpoint' type: object -- GitLab From 6aed4f7d409da157e2f3394d1af0c1e92dad183d Mon Sep 17 00:00:00 2001 From: Walter Featherstone Date: Mon, 20 May 2019 14:08:01 +0200 Subject: [PATCH 10/21] Update ServiceInfo & ServiceInfoList examples --- Mp1.yaml | 6 ++++-- 1 file changed, 4 insertions(+), 2 deletions(-) diff --git a/Mp1.yaml b/Mp1.yaml index eeeb600..0437ebe 100644 --- a/Mp1.yaml +++ b/Mp1.yaml @@ -2053,7 +2053,8 @@ components: - '/meMp1/service/EntryPoint' security: oAuth2Info: - grantTypes: 'OAUTH2_CLIENT_CREDENTIALS' + grantTypes: + - 'OAUTH2_CLIENT_CREDENTIALS' tokenEndpoint: '/meMp1/security/TokenEndPoint' serializer: 'JSON' ServiceInfoList: @@ -2080,7 +2081,8 @@ components: port: 8080 security: oAuth2Info: - grantTypes: 'OAUTH2_CLIENT_CREDENTIALS' + grantTypes: + - 'OAUTH2_CLIENT_CREDENTIALS' tokenEndpoint: '/meMp1/security/TokenEndPoint' serializer: 'JSON' TrafficRule: -- GitLab From ed92669f6184eb5304f5825aef5523b14d3fdc27 Mon Sep 17 00:00:00 2001 From: Walter Featherstone Date: Mon, 20 May 2019 14:10:08 +0200 Subject: [PATCH 11/21] Update ServiceInfo & ServiceInfoList examples --- Mp1.json | 8 ++++++-- 1 file changed, 6 insertions(+), 2 deletions(-) diff --git a/Mp1.json b/Mp1.json index 1850af1..0efc868 100644 --- a/Mp1.json +++ b/Mp1.json @@ -2690,7 +2690,9 @@ }, "security": { "oAuth2Info": { - "grantTypes": "OAUTH2_CLIENT_CREDENTIALS", + "grantTypes": [ + "OAUTH2_CLIENT_CREDENTIALS" + ], "tokenEndpoint": "/meMp1/security/TokenEndPoint" } } @@ -2728,7 +2730,9 @@ }, "security": { "oAuth2Info": { - "grantTypes": "OAUTH2_CLIENT_CREDENTIALS", + "grantTypes": [ + "OAUTH2_CLIENT_CREDENTIALS" + ], "tokenEndpoint": "/meMp1/security/TokenEndPoint" } } -- GitLab From 2b024cdac0ea4b72129f2d6c2c5f122c7e622801 Mon Sep 17 00:00:00 2001 From: featherstone Date: Thu, 23 May 2019 12:26:18 +0100 Subject: [PATCH 12/21] Removed subsciptionType from resource URIs --- Mp1.json | 19 ++++++++----------- Mp1.yaml | 19 +++++++++---------- 2 files changed, 17 insertions(+), 21 deletions(-) diff --git a/Mp1.json b/Mp1.json index 0efc868..a7e751e 100644 --- a/Mp1.json +++ b/Mp1.json @@ -234,14 +234,11 @@ } } }, - "/applications/{appInstanceId}/subscriptions/{subscriptionType}/{subscriptionId}": { + "/applications/{appInstanceId}/subscriptions/{subscriptionId}": { "parameters": [ { "$ref": "#/components/parameters/Path.AppInstanceId" }, - { - "$ref": "#/components/parameters/Path.SubscriptionType" - }, { "$ref": "#/components/parameters/Path.SubscriptionId" } @@ -2602,7 +2599,7 @@ }, "GetIndividualMeMp1Subscription": { "operationId": "ApplicationsSubscription_GET", - "description": "The `subscriptionId` value returned in the response can be used as the `subscriptionId` parameter in `GET /applications/{appInstanceId}/subscriptions/{subscriptionType}/{subscriptionId}`", + "description": "The `subscriptionId` value returned in the response can be used as the `subscriptionId` parameter in `GET /applications/{appInstanceId}/subscriptions/{subscriptionId}`", "parameters": { "description": "regex = \\/mp1\\/v1\\/applications\\/.*\\/subscriptions\\/.*\\/(.*);subscriptionId = href.match(regex)[1];// where \"href\" is an attribute within the subscription attribute within the _links attribute", "subscriptionId": "TBC" @@ -2610,25 +2607,25 @@ }, "DelIndividualMeMp1Subscription": { "operationId": "ApplicationsSubscription_DELETE", - "description": "The `subscriptionId` value returned in the response can be used as the `subscriptionId` parameter in `DELETE /applications/{appInstanceId}/subscriptions/{subscriptionType}/{subscriptionId}`", + "description": "The `subscriptionId` value returned in the response can be used as the `subscriptionId` parameter in `DELETE /applications/{appInstanceId}/subscriptions/{subscriptionId}`", "parameters": { - "description": "regex = \\/mp1\\/v1\\/applications\\/.*\\/subscriptions\\/.*\\/(.*);subscriptionId = href.match(regex)[1];// where \"href\" is an attribute within the subscription attribute within the _links attribute", + "description": "regex = \\/mp1\\/v1\\/applications\\/.*\\/subscriptions\\/(.*);subscriptionId = href.match(regex)[1];// where \"href\" is an attribute within the subscription attribute within the _links attribute", "subscriptionId": "TBC" } }, "GetIndividualMeMp1SubscriptionLinkList": { "operationId": "ApplicationsSubscription_GET", - "description": "The `subscriptionId` value returned in the response can be used as the `subscriptionId` parameter in `GET /applications/{appInstanceId}/subscriptions/{subscriptionType}/{subscriptionId}`", + "description": "The `subscriptionId` value returned in the response can be used as the `subscriptionId` parameter in `GET /applications/{appInstanceId}/subscriptions/{subscriptionId}`", "parameters": { - "description": "regex = \\/mp1\\/v1\\/applications\\/.*\\/subscriptions\\/.*\\/(.*);subscriptionId = href.match(regex)[1];// where \"href\" is an attribute within the subscription attribute within the _links attribute", + "description": "regex = \\/mp1\\/v1\\/applications\\/.*\\/subscriptions\\/(.*);subscriptionId = href.match(regex)[1];// where \"href\" is an attribute within the subscription attribute within the _links attribute", "subscriptionId": "TBC" } }, "DelIndividualMeMp1SubscriptionLinkList": { "operationId": "ApplicationsSubscription_DELETE", - "description": "The `subscriptionId` value returned in the response can be used as the `subscriptionId` parameter in `DELETE /applications/{appInstanceId}/subscriptions/{subscriptionType}/{subscriptionId}`", + "description": "The `subscriptionId` value returned in the response can be used as the `subscriptionId` parameter in `DELETE /applications/{appInstanceId}/subscriptions/{subscriptionId}`", "parameters": { - "description": "regex = \\/mp1\\/v1\\/applications\\/.*\\/subscriptions\\/.*\\/(.*);subscriptionId = href.match(regex)[1];// where \"href\" is an attribute within the subscription attribute within the _links attribute", + "description": "regex = \\/mp1\\/v1\\/applications\\/.*\\/subscriptions\\/(.*);subscriptionId = href.match(regex)[1];// where \"href\" is an attribute within the subscription attribute within the _links attribute", "subscriptionId": "TBC" } } diff --git a/Mp1.yaml b/Mp1.yaml index 0437ebe..bdea187 100644 --- a/Mp1.yaml +++ b/Mp1.yaml @@ -151,10 +151,9 @@ paths: $ref: '#/components/callbacks/AppTerminationNotification' serviceAvailabilityNotification: $ref: '#/components/callbacks/ServiceAvailabilityNotification' - '/applications/{appInstanceId}/subscriptions/{subscriptionType}/{subscriptionId}': + '/applications/{appInstanceId}/subscriptions/{subscriptionId}': parameters: - $ref: '#/components/parameters/Path.AppInstanceId' - - $ref: '#/components/parameters/Path.SubscriptionType' - $ref: '#/components/parameters/Path.SubscriptionId' get: description: >- @@ -1985,27 +1984,27 @@ components: transportId: '$response.body#/0/id' GetIndividualMeMp1Subscription: operationId: ApplicationsSubscription_GET - description: The `subscriptionId` value returned in the response can be used as the `subscriptionId` parameter in `GET /applications/{appInstanceId}/subscriptions/{subscriptionType}/{subscriptionId}` + description: The `subscriptionId` value returned in the response can be used as the `subscriptionId` parameter in `GET /applications/{appInstanceId}/subscriptions/{subscriptionId}` parameters: description: regex = \/mp1\/v1\/applications\/.*\/subscriptions\/.*\/(.*);subscriptionId = href.match(regex)[1];// where "href" is an attribute within the subscription attribute within the _links attribute subscriptionId: 'TBC' DelIndividualMeMp1Subscription: operationId: ApplicationsSubscription_DELETE - description: The `subscriptionId` value returned in the response can be used as the `subscriptionId` parameter in `DELETE /applications/{appInstanceId}/subscriptions/{subscriptionType}/{subscriptionId}` + description: The `subscriptionId` value returned in the response can be used as the `subscriptionId` parameter in `DELETE /applications/{appInstanceId}/subscriptions/{subscriptionId}` parameters: - description: regex = \/mp1\/v1\/applications\/.*\/subscriptions\/.*\/(.*);subscriptionId = href.match(regex)[1];// where "href" is an attribute within the subscription attribute within the _links attribute + description: regex = \/mp1\/v1\/applications\/.*\/subscriptions\/(.*);subscriptionId = href.match(regex)[1];// where "href" is an attribute within the subscription attribute within the _links attribute subscriptionId: 'TBC' GetIndividualMeMp1SubscriptionLinkList: operationId: ApplicationsSubscription_GET - description: The `subscriptionId` value returned in the response can be used as the `subscriptionId` parameter in `GET /applications/{appInstanceId}/subscriptions/{subscriptionType}/{subscriptionId}` + description: The `subscriptionId` value returned in the response can be used as the `subscriptionId` parameter in `GET /applications/{appInstanceId}/subscriptions/{subscriptionId}` parameters: - description: regex = \/mp1\/v1\/applications\/.*\/subscriptions\/.*\/(.*);subscriptionId = href.match(regex)[1];// where "href" is an attribute within the subscription attribute within the _links attribute + description: regex = \/mp1\/v1\/applications\/.*\/subscriptions\/(.*);subscriptionId = href.match(regex)[1];// where "href" is an attribute within the subscription attribute within the _links attribute subscriptionId: 'TBC' DelIndividualMeMp1SubscriptionLinkList: operationId: ApplicationsSubscription_DELETE - description: The `subscriptionId` value returned in the response can be used as the `subscriptionId` parameter in `DELETE /applications/{appInstanceId}/subscriptions/{subscriptionType}/{subscriptionId}` + description: The `subscriptionId` value returned in the response can be used as the `subscriptionId` parameter in `DELETE /applications/{appInstanceId}/subscriptions/{subscriptionId}` parameters: - description: regex = \/mp1\/v1\/applications\/.*\/subscriptions\/.*\/(.*);subscriptionId = href.match(regex)[1];// where "href" is an attribute within the subscription attribute within the _links attribute + description: regex = \/mp1\/v1\/applications\/.*\/subscriptions\/(.*);subscriptionId = href.match(regex)[1];// where "href" is an attribute within the subscription attribute within the _links attribute subscriptionId: 'TBC' examples: DnsRule: @@ -2122,4 +2121,4 @@ components: dstInterface: interfaceType: 'IP' dstIpAddress: '20.1.1.1' - state: 'ACTIVE' + state: 'ACTIVE' \ No newline at end of file -- GitLab From b409f1b80d24f8fa03aefe93990a4d3109a3323b Mon Sep 17 00:00:00 2001 From: featherstone Date: Fri, 21 Jun 2019 12:00:29 +0100 Subject: [PATCH 13/21] Updated to align with GS MEC-011 v2.0.9 --- Mp1.json => MecAppSupportApi.json | 1421 +++---------------- MecServiceMgmtApi.json | 1551 +++++++++++++++++++++ Mp1.yaml | 2124 ----------------------------- 3 files changed, 1714 insertions(+), 3382 deletions(-) rename Mp1.json => MecAppSupportApi.json (56%) create mode 100644 MecServiceMgmtApi.json delete mode 100644 Mp1.yaml diff --git a/Mp1.json b/MecAppSupportApi.json similarity index 56% rename from Mp1.json rename to MecAppSupportApi.json index a7e751e..8878fa0 100644 --- a/Mp1.json +++ b/MecAppSupportApi.json @@ -2,16 +2,16 @@ "openapi": "3.0.2", "servers": [ { - "url": "http://127.0.0.1:8081/mp1/v1" + "url": "http://127.0.0.1:8081/mec_app_support/v1" }, { - "url": "https://127.0.0.1:8081/mp1/v1" + "url": "https://127.0.0.1:8081/mec_app_support/v1" } ], "info": { - "title": "Mp1 API", - "version": "2.0.8", - "description": "The ETSI MEC ISG MEC011 Application Enablement API described using OpenAPI", + "title": "MEC Application Support API", + "version": "2.0.9", + "description": "The ETSI MEC ISG MEC011 MEC Application Support API described using OpenAPI", "license": { "name": "ETSI Forge copyright notice", "url": "https://forge.etsi.org/etsi-forge-copyright-notice.txt" @@ -21,8 +21,8 @@ } }, "externalDocs": { - "description": "ETSI GS MEC011 Application Enablement API, V2.0.8", - "url": "https://docbox.etsi.org/ISG/MEC/70-Draft/0011v211Plat.App.Enabl/MEC-0011v211Plat.App.Enablv208.zip" + "description": "ETSI GS MEC011 Application Enablement API, V2.0.9", + "url": "https://docbox.etsi.org/ISG/MEC/70-Draft/0011v211Plat.App.Enabl/MEC-0011v211Plat.App.Enablv209.zip" }, "tags": [ { @@ -37,72 +37,29 @@ { "name": "appConfirmTermination" }, - { - "name": "appServices" - }, - { - "name": "services" - }, { "name": "timing" }, - { - "name": "transports" - }, { "name": "callbacks" } ], "paths": { - "/applications/{appInstanceId}/confirm_termination": { - "parameters": [ - { - "$ref": "#/components/parameters/Path.AppInstanceId" - } - ], - "post": { - "description": "This method is used to confirm the application level termination of an application instance.", - "operationId": "ApplicationsConfirmTermination_POST", - "tags": [ - "appConfirmTermination" - ], - "responses": { - "204": { - "description": "No Content" - }, - "401": { - "$ref": "#/components/responses/Error.401" - }, - "403": { - "$ref": "#/components/responses/Error.403" - }, - "404": { - "$ref": "#/components/responses/Error.404" - }, - "409": { - "$ref": "#/components/responses/Error.409" - }, - "429": { - "$ref": "#/components/responses/Error.429" - } - } - } - }, - "/applications/{appInstanceId}/dns_rules": { + "/applications/{appInstanceId}/traffic_rules": { "parameters": [ { "$ref": "#/components/parameters/Path.AppInstanceId" } ], "get": { - "description": "This method retrieves information about all the DNS rules associated with a mobile edge application instance.", - "operationId": "ApplicationsDnsRules_GET", + "description": "This method retrieves information about all the traffic rules associated with a MEC application instance.", + "operationId": "ApplicationsTrafficRules_GET", "tags": [ - "appDnsRules" + "appTrafficRules" ], "responses": { "200": { - "$ref": "#/components/responses/ApplicationsDnsRules.200" + "$ref": "#/components/responses/ApplicationsTrafficRules.200" }, "400": { "$ref": "#/components/responses/Error.400" @@ -116,24 +73,24 @@ } } }, - "/applications/{appInstanceId}/dns_rules/{dnsRuleId}": { + "/applications/{appInstanceId}/traffic_rules/{trafficRuleId}": { "parameters": [ { "$ref": "#/components/parameters/Path.AppInstanceId" }, { - "$ref": "#/components/parameters/Path.DnsRuleId" + "$ref": "#/components/parameters/Path.TrafficRuleId" } ], "get": { - "description": "This method retrieves information about a DNS rule associated with a mobile edge application instance.", - "operationId": "ApplicationsDnsRule_GET", + "description": "This method retrieves information about all the traffic rules associated with a MEC application instance.", + "operationId": "ApplicationsTrafficRule_GET", "tags": [ - "appDnsRules" + "appTrafficRules" ], "responses": { "200": { - "$ref": "#/components/responses/ApplicationsDnsRule.200" + "$ref": "#/components/responses/ApplicationsTrafficRule.200" }, "400": { "$ref": "#/components/responses/Error.400" @@ -147,14 +104,14 @@ } }, "put": { - "description": "This method activates, de-activates or updates a traffic rule.", - "operationId": "ApplicationsDnsRule_PUT", + "description": "This method retrieves information about all the traffic rules associated with a MEC application instance.", + "operationId": "ApplicationsTrafficRule_PUT", "tags": [ - "appDnsRules" + "appTrafficRules" ], "responses": { "200": { - "$ref": "#/components/responses/ApplicationsDnsRule.200" + "$ref": "#/components/responses/ApplicationsTrafficRule.200" }, "400": { "$ref": "#/components/responses/Error.400" @@ -170,134 +127,25 @@ } }, "requestBody": { - "$ref": "#/components/requestBodies/ApplicationsDnsRule" - } - } - }, - "/applications/{appInstanceId}/subscriptions": { - "parameters": [ - { - "$ref": "#/components/parameters/Path.AppInstanceId" - } - ], - "get": { - "description": "The GET method may be used to request information about all subscriptions for this requestor. Upon success, the response contains entity body with all the subscriptions for the requestor.", - "operationId": "ApplicationsSubscriptions_GET", - "tags": [ - "appSubscriptions" - ], - "responses": { - "200": { - "$ref": "#/components/responses/ApplicationsSubscriptions.200" - }, - "400": { - "$ref": "#/components/responses/Error.400" - }, - "403": { - "$ref": "#/components/responses/Error.403" - }, - "404": { - "$ref": "#/components/responses/Error.404" - } - } - }, - "post": { - "description": "The POST method may be used to create a new subscription. One example use case is to create a new subscription to the mobile edge service availability notifications. Upon success, the response contains entity body describing the created subscription.", - "operationId": "ApplicationsSubscriptions_POST", - "tags": [ - "appSubscriptions" - ], - "responses": { - "201": { - "$ref": "#/components/responses/ApplicationsSubscriptions.201" - }, - "400": { - "$ref": "#/components/responses/Error.400" - }, - "403": { - "$ref": "#/components/responses/Error.403" - }, - "404": { - "$ref": "#/components/responses/Error.404" - } - }, - "requestBody": { - "$ref": "#/components/requestBodies/ApplicationsSubscriptions" - }, - "callbacks": { - "appTerminationNotification": { - "$ref": "#/components/callbacks/AppTerminationNotification" - }, - "serviceAvailabilityNotification": { - "$ref": "#/components/callbacks/ServiceAvailabilityNotification" - } - } - } - }, - "/applications/{appInstanceId}/subscriptions/{subscriptionId}": { - "parameters": [ - { - "$ref": "#/components/parameters/Path.AppInstanceId" - }, - { - "$ref": "#/components/parameters/Path.SubscriptionId" - } - ], - "get": { - "description": "The GET method requests information about a subscription for this requestor. Upon success, the response contains entity body with the subscription for the requestor.", - "operationId": "ApplicationsSubscription_GET", - "tags": [ - "appSubscriptions" - ], - "responses": { - "200": { - "$ref": "#/components/responses/ApplicationsSubscription.200" - }, - "400": { - "$ref": "#/components/responses/Error.400" - }, - "403": { - "$ref": "#/components/responses/Error.403" - }, - "404": { - "$ref": "#/components/responses/Error.404" - } - } - }, - "delete": { - "description": "This method deletes a meMp1Subscription. This method is typically used in \"Unsubscribing from service availability event notifications\" procedure.", - "operationId": "ApplicationsSubscription_DELETE", - "tags": [ - "appSubscriptions" - ], - "responses": { - "204": { - "description": "No Content" - }, - "403": { - "$ref": "#/components/responses/Error.403" - }, - "404": { - "$ref": "#/components/responses/Error.404" - } + "$ref": "#/components/requestBodies/ApplicationsTrafficRule" } } }, - "/applications/{appInstanceId}/traffic_rules": { + "/applications/{appInstanceId}/dns_rules": { "parameters": [ { "$ref": "#/components/parameters/Path.AppInstanceId" } ], "get": { - "description": "This method retrieves information about all the traffic rules associated with a mobile edge application instance.", - "operationId": "ApplicationsTrafficRules_GET", + "description": "This method retrieves information about all the DNS rules associated with a MEC application instance.", + "operationId": "ApplicationsDnsRules_GET", "tags": [ - "appTrafficRules" + "appDnsRules" ], "responses": { "200": { - "$ref": "#/components/responses/ApplicationsTrafficRules.200" + "$ref": "#/components/responses/ApplicationsDnsRules.200" }, "400": { "$ref": "#/components/responses/Error.400" @@ -311,24 +159,24 @@ } } }, - "/applications/{appInstanceId}/traffic_rules/{trafficRuleId}": { + "/applications/{appInstanceId}/dns_rules/{dnsRuleId}": { "parameters": [ { "$ref": "#/components/parameters/Path.AppInstanceId" }, { - "$ref": "#/components/parameters/Path.TrafficRuleId" + "$ref": "#/components/parameters/Path.DnsRuleId" } ], "get": { - "description": "This method retrieves information about all the traffic rules associated with a mobile edge application instance.", - "operationId": "ApplicationsTrafficRule_GET", + "description": "This method retrieves information about a DNS rule associated with a MEC application instance.", + "operationId": "ApplicationsDnsRule_GET", "tags": [ - "appTrafficRules" + "appDnsRules" ], "responses": { "200": { - "$ref": "#/components/responses/ApplicationsTrafficRule.200" + "$ref": "#/components/responses/ApplicationsDnsRule.200" }, "400": { "$ref": "#/components/responses/Error.400" @@ -342,14 +190,14 @@ } }, "put": { - "description": "This method retrieves information about all the traffic rules associated with a mobile edge application instance.", - "operationId": "ApplicationsTrafficRule_PUT", + "description": "This method activates, de-activates or updates a traffic rule.", + "operationId": "ApplicationsDnsRule_PUT", "tags": [ - "appTrafficRules" + "appDnsRules" ], "responses": { "200": { - "$ref": "#/components/responses/ApplicationsTrafficRule.200" + "$ref": "#/components/responses/ApplicationsDnsRule.200" }, "400": { "$ref": "#/components/responses/Error.400" @@ -365,45 +213,25 @@ } }, "requestBody": { - "$ref": "#/components/requestBodies/ApplicationsTrafficRule" + "$ref": "#/components/requestBodies/ApplicationsDnsRule" } } }, - "/applications/{appInstanceId}/services": { + "/applications/{appInstanceId}/subscriptions": { "parameters": [ { "$ref": "#/components/parameters/Path.AppInstanceId" } ], "get": { - "description": "This method retrieves information about a list of meService resources. This method is typically used in \"service availability query\" procedure", - "operationId": "AppServices_GET", + "description": "The GET method may be used to request information about all subscriptions for this requestor. Upon success, the response contains entity body with all the subscriptions for the requestor.", + "operationId": "ApplicationsSubscriptions_GET", "tags": [ - "appServices" - ], - "parameters": [ - { - "$ref": "#/components/parameters/Query.Ser_instance_id" - }, - { - "$ref": "#/components/parameters/Query.Ser_name" - }, - { - "$ref": "#/components/parameters/Query.Ser_category_id" - }, - { - "$ref": "#/components/parameters/Query.Consumed_local_only" - }, - { - "$ref": "#/components/parameters/Query.Is_local" - }, - { - "$ref": "#/components/parameters/Query.LocalityTypes" - } + "appSubscriptions" ], "responses": { "200": { - "$ref": "#/components/responses/Services.200" + "$ref": "#/components/responses/ApplicationsSubscriptions.200" }, "400": { "$ref": "#/components/responses/Error.400" @@ -417,14 +245,14 @@ } }, "post": { - "description": "This method is used to create a meService resource. This method is typically used in \"service availability update and new service registration\" procedure", - "operationId": "AppServices_POST", + "description": "The POST method may be used to create a new subscription. One example use case is to create a new subscription to the MEC service availability notifications. Upon success, the response contains entity body describing the created subscription.", + "operationId": "ApplicationsSubscriptions_POST", "tags": [ - "appServices" + "appSubscriptions" ], "responses": { "201": { - "$ref": "#/components/responses/Services.201" + "$ref": "#/components/responses/ApplicationsSubscriptions.201" }, "400": { "$ref": "#/components/responses/Error.400" @@ -437,28 +265,33 @@ } }, "requestBody": { - "$ref": "#/components/requestBodies/Services.Post" + "$ref": "#/components/requestBodies/ApplicationsSubscriptions" + }, + "callbacks": { + "appTerminationNotification": { + "$ref": "#/components/callbacks/AppTerminationNotification" + } } } }, - "/applications/{appInstanceId}/services/{serviceId}": { + "/applications/{appInstanceId}/subscriptions/{subscriptionId}": { "parameters": [ { "$ref": "#/components/parameters/Path.AppInstanceId" }, { - "$ref": "#/components/parameters/Path.ServiceId" + "$ref": "#/components/parameters/Path.SubscriptionId" } ], "get": { - "description": "This method retrieves information about a meService resource. This method is typically used in \"service availability query\" procedure", - "operationId": "AppServicesServiceId_GET", + "description": "The GET method requests information about a subscription for this requestor. Upon success, the response contains entity body with the subscription for the requestor.", + "operationId": "ApplicationsSubscription_GET", "tags": [ - "appServices" + "appSubscriptions" ], "responses": { "200": { - "$ref": "#/components/responses/ServicesServiceId.200" + "$ref": "#/components/responses/ApplicationsSubscription.200" }, "400": { "$ref": "#/components/responses/Error.400" @@ -471,67 +304,15 @@ } } }, - "put": { - "description": "This method updates the information about a meService resource", - "operationId": "AppServicesServiceId_PUT", - "tags": [ - "appServices" - ], - "responses": { - "200": { - "$ref": "#/components/responses/ServicesServiceId.200" - }, - "400": { - "$ref": "#/components/responses/Error.400" - }, - "403": { - "$ref": "#/components/responses/Error.403" - }, - "404": { - "$ref": "#/components/responses/Error.404" - }, - "412": { - "$ref": "#/components/responses/Error.412" - } - }, - "requestBody": { - "$ref": "#/components/requestBodies/ServicesServiceId" - } - } - }, - "/services": { - "get": { - "description": "This method retrieves information about a list of meService resources. This method is typically used in \"service availability query\" procedure", - "operationId": "Services_GET", + "delete": { + "description": "This method deletes a mecAppSuptApiSubscription. This method is typically used in \"Unsubscribing from service availability event notifications\" procedure.", + "operationId": "ApplicationsSubscription_DELETE", "tags": [ - "services" - ], - "parameters": [ - { - "$ref": "#/components/parameters/Query.Ser_instance_id" - }, - { - "$ref": "#/components/parameters/Query.Ser_name" - }, - { - "$ref": "#/components/parameters/Query.Ser_category_id" - }, - { - "$ref": "#/components/parameters/Query.Consumed_local_only" - }, - { - "$ref": "#/components/parameters/Query.Is_local" - }, - { - "$ref": "#/components/parameters/Query.LocalityTypes" - } + "appSubscriptions" ], "responses": { - "200": { - "$ref": "#/components/responses/Services.200" - }, - "400": { - "$ref": "#/components/responses/Error.400" + "204": { + "description": "No Content" }, "403": { "$ref": "#/components/responses/Error.403" @@ -542,53 +323,36 @@ } } }, - "/services/{serviceId}": { + "/applications/{appInstanceId}/confirm_termination": { "parameters": [ { - "$ref": "#/components/parameters/Path.ServiceId" + "$ref": "#/components/parameters/Path.AppInstanceId" } ], - "get": { - "description": "This method retrieves information about a meService resource. This method is typically used in \"service availability query\" procedure", - "operationId": "ServicesServiceId_GET", - "tags": [ - "services" - ], - "responses": { - "200": { - "$ref": "#/components/responses/ServicesServiceId.200" - }, - "400": { - "$ref": "#/components/responses/Error.400" - }, - "403": { - "$ref": "#/components/responses/Error.403" - }, - "404": { - "$ref": "#/components/responses/Error.404" - } - } - } - }, - "/timing/current_time": { - "get": { - "description": "This method retrieves the information of the platform's current time which corresponds to the get platform time procedure", - "operationId": "TimingCurrentTime_GET", + "post": { + "description": "This method is used to confirm the application level termination of an application instance.", + "operationId": "ApplicationsConfirmTermination_POST", "tags": [ - "timing" + "appConfirmTermination" ], "responses": { - "200": { - "$ref": "#/components/responses/TimingCurrentTime.200" + "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" + }, + "409": { + "$ref": "#/components/responses/Error.409" + }, + "429": { + "$ref": "#/components/responses/Error.429" } } } @@ -616,16 +380,16 @@ } } }, - "/transports": { + "/timing/current_time": { "get": { - "description": "This method retrieves information about a list of available transports. This method is typically used by a service-producing application to discover transports provided by the mobile edge platform in the \"transport information query\" procedure", - "operationId": "Transports_GET", + "description": "This method retrieves the information of the platform's current time which corresponds to the get platform time procedure", + "operationId": "TimingCurrentTime_GET", "tags": [ - "transports" + "timing" ], "responses": { "200": { - "$ref": "#/components/responses/Transports.200" + "$ref": "#/components/responses/TimingCurrentTime.200" }, "400": { "$ref": "#/components/responses/Error.400" @@ -646,7 +410,7 @@ "description": "Empty schema" }, "AppTerminationNotification.Links": { - "description": "List of hyperlinks related to the resource.", + "description": "Object containing hyperlinks related to the resource.", "type": "object", "required": [ "subscription" @@ -672,7 +436,7 @@ "example": "AppTerminationNotification" }, "AppTerminationNotification": { - "description": "This type represents the information that the mobile edge platform notifies the subscribed application instance about the corresponding application instance termination/stop.", + "description": "This type represents the information that the MEC platform notifies the subscribed application instance about the corresponding application instance termination/stop.", "type": "object", "required": [ "notificationType", @@ -697,12 +461,12 @@ "example": "ID1" }, "AppTerminationNotificationSubscription.CallbackReference": { - "description": "URI selected by the mobile edge application instance to receive notifications on the subscribed mobile edge application instance management information. This shall be included in both the request and the response.", + "description": "URI selected by the MEC application instance to receive notifications on the subscribed MEC application instance management information. This shall be included in both the request and the response.", "type": "string", "format": "uri" }, "AppTerminationNotificationSubscription": { - "description": "This type represents the information that the mobile edge platform notifies the subscribed application instance about the corresponding application instance termination/stop.", + "description": "This type represents the information that the MEC platform notifies the subscribed application instance about the corresponding application instance termination/stop.", "type": "object", "required": [ "subscriptionType", @@ -730,52 +494,8 @@ "type": "string", "example": "AppTerminationNotificationSubscription" }, - "CategoryRef.Href": { - "description": "Reference of the catalogue", - "type": "string", - "example": "catItem1" - }, - "CategoryRef.Id": { - "description": "Unique identifier of the category", - "type": "string", - "example": "id12345" - }, - "CategoryRef.Name": { - "description": "Name of the category, example values include RNI, Location & Bandwidth Management", - "type": "string", - "example": "RNI" - }, - "CategoryRef.Version": { - "description": "Category version", - "type": "string", - "example": "version1" - }, - "CategoryRef": { - "description": "This type represents the category reference", - "type": "object", - "required": [ - "href", - "id", - "name", - "version" - ], - "properties": { - "href": { - "$ref": "#/components/schemas/CategoryRef.Href" - }, - "id": { - "$ref": "#/components/schemas/CategoryRef.Id" - }, - "name": { - "$ref": "#/components/schemas/CategoryRef.Name" - }, - "version": { - "$ref": "#/components/schemas/CategoryRef.Version" - } - } - }, "CurrentTime": { - "description": "This type represents the information provided by the mobile edge platform in response to the Get Platform Time Request message.", + "description": "This type represents the information provided by the MEC platform in response to the Get Platform Time Request message.", "type": "object", "required": [ "nanoSeconds", @@ -920,83 +640,6 @@ } } }, - "EndPointInfo.Address.Host": { - "description": "Host portion of the address", - "type": "string", - "example": "192.0.2.0" - }, - "EndPointInfo.Address_Port": { - "description": "Port portion of the address", - "type": "integer", - "format": "uint32", - "example": 8080 - }, - "EndPointInfo.Address": { - "description": "A IP address and port pair", - "type": "object", - "required": [ - "host", - "port" - ], - "properties": { - "host": { - "$ref": "#/components/schemas/EndPointInfo.Address.Host" - }, - "port": { - "$ref": "#/components/schemas/EndPointInfo.Address_Port" - } - } - }, - "EndPointInfo.Addresses": { - "description": "Entry point information of the service as one or more pairs of IP address and port", - "type": "object", - "required": [ - "addresses" - ], - "properties": { - "addresses": { - "type": "array", - "minItems": 0, - "items": { - "$ref": "#/components/schemas/EndPointInfo.Address" - } - } - } - }, - "EndPointInfo.Alternative": { - "description": "Entry point information of the service in a format defined by an implementation, or in an external specification.", - "type": "object", - "required": [ - "alternative" - ], - "properties": { - "alternative": { - "type": "object" - } - } - }, - "EndPointInfo.Uri": { - "description": "Entry point information of the service", - "type": "string", - "format": "uri", - "example": "/meMp1/service/EntryPoint" - }, - "EndPointInfo.Uris": { - "description": "Entry point information of the service as string, formatted according to URI syntax", - "type": "object", - "required": [ - "uris" - ], - "properties": { - "uris": { - "type": "array", - "minItems": 0, - "items": { - "$ref": "#/components/schemas/EndPointInfo.Uri" - } - } - } - }, "LinkType": { "description": "This type represents a type of link and may be referenced from data structures", "type": "object", @@ -1019,9 +662,9 @@ "description": "URI referring to a resource", "type": "string", "format": "uri", - "example": "/meMp1/example" + "example": "/mecAppSuptApi/example" }, - "Mp1SubscriptionLinkList.Links": { + "MecAppSuptApiSubscriptionLinkList.Links": { "description": "Self-referring URI.", "type": "object", "required": [ @@ -1035,12 +678,12 @@ "description": "The MEC application instance's subscriptions", "type": "array", "items": { - "$ref": "#/components/schemas/Mp1SubscriptionLinkList.Subscription" + "$ref": "#/components/schemas/MecAppSuptApiSubscriptionLinkList.Subscription" } } } }, - "Mp1SubscriptionLinkList.Subscription": { + "MecAppSuptApiSubscriptionLinkList.Subscription": { "description": "A link to a subscription.", "type": "object", "required": [ @@ -1052,24 +695,20 @@ "$ref": "#/components/schemas/Href" }, "rel": { - "description": "The values are as defined in the \"subscriptionType\" attribute for each different Mp1 event subscription data type.", - "type": "string", - "enum": [ - "AppTerminationNotificationSubscription", - "SerAvailabilityNotificationSubscription" - ] + "description": "The values shall be set to AppTerminationNotificationSubscription.", + "type": "string" } } }, - "Mp1SubscriptionLinkList": { - "description": "This type represents a list of links related to currently existing subscriptions for a mobile edge application instance. This information is returned when sending a request to receive current subscriptions.", + "MecAppSuptApiSubscriptionLinkList": { + "description": "This type represents a list of links related to currently existing subscriptions for a MEC application instance. This information is returned when sending a request to receive current subscriptions.", "type": "object", "required": [ "_links" ], "properties": { "_links": { - "$ref": "#/components/schemas/Mp1SubscriptionLinkList.Links" + "$ref": "#/components/schemas/MecAppSuptApiSubscriptionLinkList.Links" } } }, @@ -1080,335 +719,54 @@ "$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.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" - }, - "Problem.status": { - "type": "integer", - "format": "uint32", - "description": "The HTTP status code for this occurrence of the problem" - }, - "Problem.title": { - "type": "string", - "description": "A short, human-readable summary of the problem type" - }, - "Problem.type": { - "type": "string", - "format": "uri", - "description": "A URI reference according to IETF RFC 3986 that identifies the problem type" - }, - "SecurityInfo.OAuth2Info.GrantTypes": { - "description": "List of supported OAuth 2.0 grant types", - "type": "string", - "enum": [ - "OAUTH2_AUTHORIZATION_CODE", - "OAUTH2_IMPLICIT_GRANT", - "OAUTH2_RESOURCE_OWNER", - "OAUTH2_CLIENT_CREDENTIALS" - ], - "example": "OAUTH2_CLIENT_CREDENTIALS" - }, - "SecurityInfo.OAuth2Info.TokenEndpoint": { - "description": "The token endpoint", - "type": "string", - "format": "uri", - "example": "/meMp1/security/TokenEndPoint" - }, - "SecurityInfo.OAuth2Info": { - "description": "Parameters related to use of OAuth 2.0", - "required": [ - "grantTypes", - "tokenEndpoint" - ], - "properties": { - "grantTypes": { - "description": "List of supported OAuth 2.0 grant types.", - "type": "array", - "minItems": 1, - "maxItems": 4, - "items": { - "$ref": "#/components/schemas/SecurityInfo.OAuth2Info.GrantTypes" - } - }, - "tokenEndpoint": { - "$ref": "#/components/schemas/SecurityInfo.OAuth2Info.TokenEndpoint" - } - }, - "type": "object" - }, - "SecurityInfo": { - "description": "This type represents security information related to a transport", - "type": "object", - "properties": { - "oAuth2Info": { - "$ref": "#/components/schemas/SecurityInfo.OAuth2Info" - } - } - }, - "Self": { - "description": "Self-referring URI.", - "type": "object", - "required": [ - "self" - ], - "properties": { - "self": { - "$ref": "#/components/schemas/LinkType" - } - }, - "readOnly": true - }, - "SerAvailabilityNotificationSubscription.CallbackReference": { - "description": "URI selected by the mobile edge application instance to receive notifications on the subscribed mobile edge service availability information. This shall be included in both the request and the response.", - "type": "string", - "format": "uri" - }, - "SerAvailabilityNotificationSubscription": { - "description": "This type represents a subscription to the notifications from the mobile edge platform regarding the availability of a mobile edge service or a list of mobile edge services.", - "type": "object", - "required": [ - "subscriptionType", - "callbackReference", - "_links", - "filteringCriteria" - ], - "properties": { - "subscriptionType": { - "$ref": "#/components/schemas/SerAvailabilityNotificationSubscription.SubscriptionType" - }, - "callbackReference": { - "$ref": "#/components/schemas/SerAvailabilityNotificationSubscription.CallbackReference" - }, - "_links": { - "$ref": "#/components/schemas/Self" - }, - "filteringCriteria": { - "$ref": "#/components/schemas/ServiceInfo" - } - } - }, - "SerAvailabilityNotificationSubscription.SubscriptionType": { - "description": "Shall be set to SerAvailabilityNotificationSubscription.", - "type": "string", - "example": "SerAvailabilityNotificationSubscription" - }, - "ServiceAvailabilityNotification": { - "description": "This type represents the service availability information.", - "type": "object", - "required": [ - "notificationType", - "services", - "_links" - ], - "properties": { - "notificationType": { - "$ref": "#/components/schemas/SerAvailabilityNotificationSubscription.SubscriptionType" - }, - "services": { - "type": "array", - "items": { - "$ref": "#/components/schemas/ServiceInfo" - } - }, - "_links": { - "$ref": "#/components/schemas/Subscription" - } - } - }, - "SerializerTypes": { - "description": "The enumeration SerializerTypes represents types of serializers", - "type": "string", - "enum": [ - "JSON", - "XML", - "PROTOBUF3" - ], - "example": "JSON" - }, - "LocalityTypes": { - "description": "The scope of locality as expressed by \"consumedLocalOnly\" and \"isLocal\". If absent, defaults to MEC_HOST", - "type": "string", - "enum": [ - "MEC_SYSTEM", - "MEC_HOST", - "NFVI_POP", - "ZONE", - "ZONE_GROUP", - "NFVI_NODE" - ], - "example": "MEC_SYSTEM" - }, - "ServiceInfo.SerInstanceId": { - "description": "Identifier of the service instance assigned by the MEPM / mobile edge platform.", - "type": "string", - "readOnly": true, - "example": "ServiceInstance123" - }, - "ServiceInfo.SerName": { - "description": "The name of the service. This is how the service producing mobile edge application identifies the service instance it produces.", - "type": "string", - "example": "ExampleService" - }, - "ServiceInfo.State": { - "description": "Contains the state", - "type": "string", - "enum": [ - "ACTIVE", - "INACTIVE" - ], - "example": "ACTIVE" - }, - "ServiceInfo.TransportId": { - "description": "Identifier of the platform-provided transport to be used by the service. Valid identifiers may be obtained using the \"Transport information query\" procedure. May be present in POST requests to signal the use of a platform-provided transport for the service, and shall be absent otherwise.", - "type": "string", - "writeOnly": true, - "example": "Rest1" - }, - "ServiceInfo.Version": { - "description": "Service version", - "type": "string", - "example": "ServiceVersion1" - }, - "ServiceInfo.ConsumedLocalOnly": { - "description": "Indicate whether the service can only be consumed by the MEC applications located in the same locality (as defined by scopeOfLocality) as this service instance.", - "type": "boolean", - "example": false - }, - "ServiceInfo.IsLocal": { - "description": "Indicate whether the service is located in the same locality (as defined by scopeOfLocality) as the consuming MEC application.", - "type": "boolean", - "example": true - }, - "ServiceInfo.Post": { - "description": "This type represents the general information of a mobile edge service.", - "type": "object", - "required": [ - "serName", - "version", - "state", - "serializer" - ], - "oneOf": [ - { - "required": [ - "transportId" - ] - }, - { - "required": [ - "transportInfo" - ] - } - ], - "properties": { - "serInstanceId": { - "$ref": "#/components/schemas/ServiceInfo.SerInstanceId" - }, - "serName": { - "$ref": "#/components/schemas/ServiceInfo.SerName" - }, - "serCategory": { - "$ref": "#/components/schemas/CategoryRef" - }, - "version": { - "$ref": "#/components/schemas/ServiceInfo.Version" - }, - "state": { - "$ref": "#/components/schemas/ServiceInfo.State" - }, - "transportId": { - "$ref": "#/components/schemas/ServiceInfo.TransportId" - }, - "transportInfo": { - "$ref": "#/components/schemas/TransportInfo" - }, - "serializer": { - "$ref": "#/components/schemas/SerializerTypes" - }, - "scopeOfLocality": { - "$ref": "#/components/schemas/LocalityTypes" - }, - "consumedLocalOnly": { - "$ref": "#/components/schemas/ServiceInfo.ConsumedLocalOnly" - }, - "isLocal": { - "$ref": "#/components/schemas/ServiceInfo.IsLocal" - } - } - }, - "ServiceInfo": { - "description": "This type represents the general information of a mobile edge service.", - "type": "object", - "required": [ - "serName", - "version", - "state", - "transportInfo", - "serializer" - ], - "properties": { - "serInstanceId": { - "$ref": "#/components/schemas/ServiceInfo.SerInstanceId" - }, - "serName": { - "$ref": "#/components/schemas/ServiceInfo.SerName" - }, - "serCategory": { - "$ref": "#/components/schemas/CategoryRef" - }, - "version": { - "$ref": "#/components/schemas/ServiceInfo.Version" - }, - "state": { - "$ref": "#/components/schemas/ServiceInfo.State" - }, - "transportInfo": { - "$ref": "#/components/schemas/TransportInfo" - }, - "serializer": { - "$ref": "#/components/schemas/SerializerTypes" + "$ref": "#/components/schemas/Problem.title" }, - "scopeOfLocality": { - "$ref": "#/components/schemas/LocalityTypes" + "status": { + "$ref": "#/components/schemas/Problem.status" }, - "consumedLocalOnly": { - "$ref": "#/components/schemas/ServiceInfo.ConsumedLocalOnly" + "detail": { + "$ref": "#/components/schemas/Problem.detail" }, - "isLocal": { - "$ref": "#/components/schemas/ServiceInfo.IsLocal" + "instance": { + "$ref": "#/components/schemas/Problem.instance" } } }, - "Subscription": { - "description": "A link to the related subscription", + "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" + }, + "Problem.status": { + "type": "integer", + "format": "uint32", + "description": "The HTTP status code for this occurrence of the problem" + }, + "Problem.title": { + "type": "string", + "description": "A short, human-readable summary of the problem type" + }, + "Problem.type": { + "type": "string", + "format": "uri", + "description": "A URI reference according to IETF RFC 3986 that identifies the problem type" + }, + "Self": { + "description": "Self-referring URI.", "type": "object", "required": [ - "subscription" + "self" ], "properties": { - "subscription": { + "self": { "$ref": "#/components/schemas/LinkType" } - } + }, + "readOnly": true }, "TimingCaps.NtpServers.AuthenticationKeyNum": { "description": "Authentication key number", @@ -1554,7 +912,7 @@ } }, "TimingCaps": { - "description": "This type represents the information provided by the mobile edge platform in response to the Timing capabilities Query message.", + "description": "This type represents the information provided by the MEC platform in response to the Timing capabilities Query message.", "type": "object", "properties": { "timeStamp": { @@ -1789,103 +1147,6 @@ } } }, - "TransportInfo.Description": { - "description": "Human-readable description of this transport", - "type": "string", - "example": "REST API" - }, - "TransportInfo.Id": { - "description": "The identifier of this transport", - "type": "string", - "example": "TransId12345" - }, - "TransportInfo.ImplSpecificInfo": { - "description": "Additional implementation specific details of the transport", - "type": "object" - }, - "TransportInfo.Name": { - "description": "The name of this transport", - "type": "string", - "example": "REST" - }, - "TransportInfo.Protocol": { - "description": "The name of the protocol used. Shall be set to HTTP for a REST API.", - "type": "string", - "example": "HTTP" - }, - "TransportInfo.Version": { - "description": "The version of the protocol used", - "type": "string", - "example": "2.0" - }, - "TransportInfo": { - "description": "This type represents the general information of a mobile edge service.", - "type": "object", - "required": [ - "id", - "name", - "type", - "protocol", - "version", - "endpoint", - "security" - ], - "properties": { - "id": { - "$ref": "#/components/schemas/TransportInfo.Id" - }, - "name": { - "$ref": "#/components/schemas/TransportInfo.Name" - }, - "description": { - "$ref": "#/components/schemas/TransportInfo.Description" - }, - "type": { - "$ref": "#/components/schemas/TransportTypes" - }, - "protocol": { - "$ref": "#/components/schemas/TransportInfo.Protocol" - }, - "version": { - "$ref": "#/components/schemas/TransportInfo.Version" - }, - "endpoint": { - "description": "This type represents information about a transport endpoint", - "type": "object", - "oneOf": [ - { - "$ref": "#/components/schemas/EndPointInfo.Uris" - }, - { - "$ref": "#/components/schemas/EndPointInfo.Addresses" - }, - { - "$ref": "#/components/schemas/EndPointInfo.Alternative" - } - ] - }, - "security": { - "$ref": "#/components/schemas/SecurityInfo" - }, - "implSpecificInfo": { - "$ref": "#/components/schemas/TransportInfo.ImplSpecificInfo" - } - } - }, - "TransportTypes": { - "description": "The enumeration TransportTypes represents types of transports", - "type": "string", - "enum": [ - "REST_HTTP", - "MB_TOPIC_BASED", - "MB_ROUTING", - "MB_PUBSUB", - "RPC", - "RPC_STREAMING", - "WEBSOCKET" - ], - "example": "REST_HTTP" - }, "TunnelInfo.TunnelDstAddress": { "description": "Destination address of the tunnel", "type": "string", @@ -1927,7 +1188,7 @@ "parameters": { "Path.AppInstanceId": { "name": "appInstanceId", - "description": "Represents a mobile edge application instance. Note that the appInstanceId is allocated by the mobile edge platform manager.", + "description": "Represents a MEC application instance. Note that the appInstanceId is allocated by the MEC platform manager.", "in": "path", "required": true, "schema": { @@ -1945,29 +1206,7 @@ }, "Path.SubscriptionId": { "name": "subscriptionId", - "description": "Represents a subscription to the notifications from the mobile edge platform.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - "Path.SubscriptionType": { - "name": "subscriptionType", - "description": "Represents a subscription type to the notifications from the mobile edge platform.", - "in": "path", - "required": true, - "schema": { - "type": "string", - "enum": [ - "AppTerminationNotificationSubscription", - "SerAvailabilityNotificationSubscription" - ] - } - }, - "Path.ServiceId": { - "name": "serviceId", - "description": "Represents a mobile edge service instance.", + "description": "Represents a subscription to the notifications from the MEC platform.", "in": "path", "required": true, "schema": { @@ -1982,66 +1221,6 @@ "schema": { "type": "string" } - }, - "Query.Ser_category_id": { - "name": "ser_category_id", - "description": "A mobile edge application instance may use ser_category_id as an input parameter to query the availability of a list of mobile edge service instances in a serCategory. Either \"ser_instance_id\" or \"ser_name\" or \"ser_category_id\" or none of them shall be present.", - "in": "query", - "required": false, - "schema": { - "type": "string" - } - }, - "Query.Ser_instance_id": { - "name": "ser_instance_id", - "description": "A mobile edge application instance may use multiple ser_instance_ids as an input parameter to query the availability of a list of mobile edge service instances. Either \"ser_instance_id\" or \"ser_name\" or \"ser_category_id\" or none of them shall be present.", - "in": "query", - "required": false, - "schema": { - "type": "array", - "items": { - "type": "string" - } - } - }, - "Query.Ser_name": { - "name": "ser_name", - "description": "A mobile edge application instance may use multiple ser_names as an input parameter to query the availability of a list of mobile edge service instances. Either \"ser_instance_id\" or \"ser_name\" or \"ser_category_id\" or none of them shall be present.", - "in": "query", - "required": false, - "schema": { - "type": "array", - "items": { - "type": "string" - } - } - }, - "Query.LocalityTypes": { - "name": "scope_of_locality", - "description": "A MEC application instance may use scope_of_locality as an input parameter to query the availability of a list of MEC service instances with a certain scope of locality.", - "in": "query", - "required": false, - "schema": { - "type": "string" - } - }, - "Query.Is_local": { - "name": "is_local", - "description": "Indicate whether the service is located in the same locality (as defined by scopeOfLocality) as the consuming MEC application.", - "in": "query", - "required": false, - "schema": { - "type": "boolean" - } - }, - "Query.Consumed_local_only": { - "name": "consumed_local_only", - "description": "Indicate whether the service can only be consumed by the MEC applications located in the same locality (as defined by scopeOfLocality) as this service instance.", - "in": "query", - "required": false, - "schema": { - "type": "boolean" - } } }, "responses": { @@ -2092,21 +1271,21 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/Mp1SubscriptionLinkList" + "$ref": "#/components/schemas/MecAppSuptApiSubscriptionLinkList" } } }, "links": { - "getIndividualMeMp1SubscriptionLinkList": { - "$ref": "#/components/links/GetIndividualMeMp1SubscriptionLinkList" + "getIndividualmecAppSuptApiSubscriptionLinkList": { + "$ref": "#/components/links/GetIndividualmecAppSuptApiSubscriptionLinkList" }, - "delIndividualMeMp1SubscriptionLinkList": { - "$ref": "#/components/links/DelIndividualMeMp1SubscriptionLinkList" + "delIndividualmecAppSuptApiSubscriptionLinkList": { + "$ref": "#/components/links/DelIndividualmecAppSuptApiSubscriptionLinkList" } } }, "ApplicationsSubscriptions.201": { - "description": "Entity body in the request contains a subscription to the mobile edge service availability notifications that is to be created.", + "description": "Entity body in the request contains a subscription to the MEC service availability notifications that is to be created.", "headers": { "location": { "description": "The resource URI of the created resource", @@ -2119,23 +1298,16 @@ "content": { "application/json": { "schema": { - "oneOf": [ - { - "$ref": "#/components/schemas/AppTerminationNotificationSubscription" - }, - { - "$ref": "#/components/schemas/SerAvailabilityNotificationSubscription" - } - ] + "$ref": "#/components/schemas/AppTerminationNotificationSubscription" } } }, "links": { - "getIndividualMeMp1Subscription": { - "$ref": "#/components/links/GetIndividualMeMp1Subscription" + "getIndividualmecAppSuptApiSubscription": { + "$ref": "#/components/links/GetIndividualmecAppSuptApiSubscription" }, - "delIndividualMeMp1Subscription": { - "$ref": "#/components/links/DelIndividualMeMp1Subscription" + "delIndividualmecAppSuptApiSubscription": { + "$ref": "#/components/links/DelIndividualmecAppSuptApiSubscription" } } }, @@ -2144,14 +1316,7 @@ "content": { "application/json": { "schema": { - "oneOf": [ - { - "$ref": "#/components/schemas/AppTerminationNotificationSubscription" - }, - { - "$ref": "#/components/schemas/SerAvailabilityNotificationSubscription" - } - ] + "$ref": "#/components/schemas/AppTerminationNotificationSubscription" } } } @@ -2198,80 +1363,6 @@ } } }, - "Services.200": { - "description": "It is used to indicate nonspecific success. The response body contains a representation of the resource.", - "content": { - "application/json": { - "schema": { - "type": "array", - "minItems": 0, - "items": { - "$ref": "#/components/schemas/ServiceInfo" - } - }, - "examples": { - "ServiceInfoList": { - "$ref": "#/components/examples/ServiceInfoList" - } - } - } - }, - "links": { - "getIndividualMeService": { - "$ref": "#/components/links/GetIndividualMeService" - }, - "putIndividualMeService": { - "$ref": "#/components/links/PutIndividualMeService" - } - } - }, - "Services.201": { - "description": "Upon success, the HTTP response shall include a Location HTTP header that contains the resource URI of the created resource.", - "headers": { - "location": { - "description": "The resource URI of the created resource", - "schema": { - "type": "string", - "format": "uri" - } - } - }, - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ServiceInfo" - }, - "examples": { - "ServiceInfo": { - "$ref": "#/components/examples/ServiceInfo" - } - } - } - }, - "links": { - "getIndividualMeService": { - "$ref": "#/components/links/GetIndividualMeService" - }, - "putIndividualMeService": { - "$ref": "#/components/links/PutIndividualMeService" - } - } - }, - "ServicesServiceId.200": { - "description": "It is used to indicate nonspecific success. The response body contains a representation of the resource.", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ServiceInfo" - }, - "examples": { - "ServiceInfo": { - "$ref": "#/components/examples/ServiceInfo" - } - } - } - } - }, "TimingCurrentTime.200": { "description": "It is used to indicate nonspecific success. The response body contains a representation of the resource.", "content": { @@ -2292,25 +1383,6 @@ } } }, - "Transports.200": { - "description": "It is used to indicate nonspecific success. The response body contains a representation of the resource.", - "content": { - "application/json": { - "schema": { - "type": "array", - "minItems": 0, - "items": { - "$ref": "#/components/schemas/TransportInfo" - } - } - } - }, - "links": { - "getTransportInfo": { - "$ref": "#/components/links/GetTransportInfo" - } - } - }, "Error.400": { "description": "Bad Request. It is used to indicate that incorrect parameters were passed to the request.", "content": { @@ -2428,18 +1500,11 @@ "content": { "application/json": { "schema": { - "oneOf": [ - { - "$ref": "#/components/schemas/AppTerminationNotificationSubscription" - }, - { - "$ref": "#/components/schemas/SerAvailabilityNotificationSubscription" - } - ] + "$ref": "#/components/schemas/AppTerminationNotificationSubscription" } } }, - "description": "Entity body in the request contains a subscription to the mobile edge application termination notifications that is to be created.", + "description": "Entity body in the request contains a subscription to the MEC application termination notifications that is to be created.", "required": true }, "ApplicationsTrafficRule": { @@ -2453,39 +1518,6 @@ "description": "One or more updated attributes that are allowed to be changed", "required": true }, - "Services": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ServiceInfo" - } - } - }, - "description": "New ServiceInfo with updated \"state\" is included as entity body of the request", - "required": true - }, - "Services.Post": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ServiceInfo.Post" - } - } - }, - "description": "New ServiceInfo with updated \"state\" is included as entity body of the request", - "required": true - }, - "ServicesServiceId": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ServiceInfo" - } - } - }, - "description": "New ServiceInfo with updated \"state\" is included as entity body of the request", - "required": true - }, "AppTerminationNotification": { "content": { "application/json": { @@ -2495,16 +1527,6 @@ } }, "required": true - }, - "ServiceAvailabilityNotification": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ServiceAvailabilityNotification" - } - } - }, - "required": true } }, "callbacks": { @@ -2514,7 +1536,7 @@ "description": "Represents the information that the MEP notifies the subscribed application instance about the corresponding application instance termination/stop", "operationId": "AppTerminationNotification_POST", "tags": [ - "callback" + "callbacks" ], "requestBody": { "$ref": "#/components/requestBodies/AppTerminationNotification" @@ -2526,42 +1548,9 @@ } } } - }, - "ServiceAvailabilityNotification": { - "{$request.body#/callbackReference}": { - "post": { - "description": "'Represents the service availability information that is used in the following cases - when the MEC platform announces the newly available\n services to the authorized relevant MEC applications (e.g. \n the applications that indicate the services as \"optional\" \n or \"required\") that are subscribed to the corresponding \n service availability notifications\n- when the MEC platform notifies the authorized relevant applications that are subscribed to the corresponding service availability notifications about the service availability changes.'", - "operationId": "ServiceAvailabilityNotification_POST", - "tags": [ - "callback" - ], - "requestBody": { - "$ref": "#/components/requestBodies/ServiceAvailabilityNotification" - }, - "responses": { - "200": { - "description": "Expected responses from callback consumer, if it accepts the callback" - } - } - } - } } }, "links": { - "GetIndividualMeService": { - "operationId": "ServicesServiceId_GET", - "description": "The `serviceId` value returned in the response can be used as the `serviceId` parameter in `GET /services/{serviceId}`", - "parameters": { - "serviceId": "$response.body#/serviceId" - } - }, - "PutIndividualMeService": { - "operationId": "ServicesServiceId_PUT", - "description": "The `serviceId` value returned in the response can be used as the `serviceId` parameter in `PUT /services/{serviceId}`", - "parameters": { - "serviceId": "$response.body#/serviceId" - } - }, "GetIndividualMeDNSRule": { "operationId": "ApplicationsDnsRule_GET", "description": "The `dnsRuleId` value returned in the response can be used as the `dnsRuleId` parameter in `GET /applications/{appInstanceId}/dns_rules/{dnsRuleId}`", @@ -2590,42 +1579,35 @@ "trafficRuleId": "$response.body#/trafficRuleId" } }, - "GetTransportInfo": { - "operationId": "AppServices_POST", - "description": "The `id` value returned in the response can be used as the `transportId` parameter in `POST /applications/{appInstanceId}/services`. The first transport is provided as the link as wildcards are not supported", - "parameters": { - "transportId": "$response.body#/0/id" - } - }, - "GetIndividualMeMp1Subscription": { + "GetIndividualmecAppSuptApiSubscription": { "operationId": "ApplicationsSubscription_GET", "description": "The `subscriptionId` value returned in the response can be used as the `subscriptionId` parameter in `GET /applications/{appInstanceId}/subscriptions/{subscriptionId}`", "parameters": { - "description": "regex = \\/mp1\\/v1\\/applications\\/.*\\/subscriptions\\/.*\\/(.*);subscriptionId = href.match(regex)[1];// where \"href\" is an attribute within the subscription attribute within the _links attribute", + "description": "regex = \\/mec_app_support\\/v1\\/applications\\/.*\\/subscriptions\\/.*\\/(.*);subscriptionId = href.match(regex)[1];// where \"href\" is an attribute within the subscription attribute within the _links attribute", "subscriptionId": "TBC" } }, - "DelIndividualMeMp1Subscription": { + "DelIndividualmecAppSuptApiSubscription": { "operationId": "ApplicationsSubscription_DELETE", "description": "The `subscriptionId` value returned in the response can be used as the `subscriptionId` parameter in `DELETE /applications/{appInstanceId}/subscriptions/{subscriptionId}`", "parameters": { - "description": "regex = \\/mp1\\/v1\\/applications\\/.*\\/subscriptions\\/(.*);subscriptionId = href.match(regex)[1];// where \"href\" is an attribute within the subscription attribute within the _links attribute", + "description": "regex = \\/mec_app_support\\/v1\\/applications\\/.*\\/subscriptions\\/(.*);subscriptionId = href.match(regex)[1];// where \"href\" is an attribute within the subscription attribute within the _links attribute", "subscriptionId": "TBC" } }, - "GetIndividualMeMp1SubscriptionLinkList": { + "GetIndividualmecAppSuptApiSubscriptionLinkList": { "operationId": "ApplicationsSubscription_GET", "description": "The `subscriptionId` value returned in the response can be used as the `subscriptionId` parameter in `GET /applications/{appInstanceId}/subscriptions/{subscriptionId}`", "parameters": { - "description": "regex = \\/mp1\\/v1\\/applications\\/.*\\/subscriptions\\/(.*);subscriptionId = href.match(regex)[1];// where \"href\" is an attribute within the subscription attribute within the _links attribute", + "description": "regex = \\/mec_app_support\\/v1\\/applications\\/.*\\/subscriptions\\/(.*);subscriptionId = href.match(regex)[1];// where \"href\" is an attribute within the subscription attribute within the _links attribute", "subscriptionId": "TBC" } }, - "DelIndividualMeMp1SubscriptionLinkList": { + "DelIndividualmecAppSuptApiSubscriptionLinkList": { "operationId": "ApplicationsSubscription_DELETE", "description": "The `subscriptionId` value returned in the response can be used as the `subscriptionId` parameter in `DELETE /applications/{appInstanceId}/subscriptions/{subscriptionId}`", "parameters": { - "description": "regex = \\/mp1\\/v1\\/applications\\/.*\\/subscriptions\\/(.*);subscriptionId = href.match(regex)[1];// where \"href\" is an attribute within the subscription attribute within the _links attribute", + "description": "regex = \\/mec_app_support\\/v1\\/applications\\/.*\\/subscriptions\\/(.*);subscriptionId = href.match(regex)[1];// where \"href\" is an attribute within the subscription attribute within the _links attribute", "subscriptionId": "TBC" } } @@ -2661,83 +1643,6 @@ } ] }, - "ServiceInfo": { - "value": { - "serInstanceId": "ServiceInstance123", - "serName": "ExampleService", - "serCategory": { - "href": "catItem1", - "id": "id12345", - "name": "RNI", - "version": "version1" - }, - "version": "ServiceVersion1", - "state": "ACTIVE", - "transportInfo": { - "id": "TransId12345", - "name": "REST", - "description": "REST API", - "type": "REST_HTTP", - "protocol": "HTTP", - "version": "2.0", - "endpoint": { - "uris": [ - "/meMp1/service/EntryPoint" - ] - }, - "security": { - "oAuth2Info": { - "grantTypes": [ - "OAUTH2_CLIENT_CREDENTIALS" - ], - "tokenEndpoint": "/meMp1/security/TokenEndPoint" - } - } - }, - "serializer": "JSON" - } - }, - "ServiceInfoList": { - "value": [ - { - "serInstanceId": "ServiceInstance123", - "serName": "ExampleService", - "serCategory": { - "href": "catItem1", - "id": "id12345", - "name": "RNI", - "version": "version1" - }, - "version": "ServiceVersion1", - "state": "ACTIVE", - "transportInfo": { - "id": "TransId12345", - "name": "REST", - "description": "REST API", - "type": "REST_HTTP", - "protocol": "HTTP", - "version": "2.0", - "endpoint": { - "addresses": [ - { - "host": "192.0.2.0", - "port": 8080 - } - ] - }, - "security": { - "oAuth2Info": { - "grantTypes": [ - "OAUTH2_CLIENT_CREDENTIALS" - ], - "tokenEndpoint": "/meMp1/security/TokenEndPoint" - } - } - }, - "serializer": "JSON" - } - ] - }, "TrafficRule": { "value": { "trafficRuleId": "TrafficRule123", diff --git a/MecServiceMgmtApi.json b/MecServiceMgmtApi.json new file mode 100644 index 0000000..0d92395 --- /dev/null +++ b/MecServiceMgmtApi.json @@ -0,0 +1,1551 @@ +{ + "openapi": "3.0.2", + "servers": [ + { + "url": "http://127.0.0.1:8081/mec_service_mgmt/v1" + }, + { + "url": "https://127.0.0.1:8081/mec_service_mgmt/v1" + } + ], + "info": { + "title": "MEC Service Management API", + "version": "2.0.9", + "description": "The ETSI MEC ISG MEC011 MEC Service Management API described using OpenAPI", + "license": { + "name": "ETSI Forge copyright notice", + "url": "https://forge.etsi.org/etsi-forge-copyright-notice.txt" + }, + "contact": { + "email": "cti_support@etsi.org" + } + }, + "externalDocs": { + "description": "ETSI GS MEC011 Application Enablement API, V2.0.9", + "url": "https://docbox.etsi.org/ISG/MEC/70-Draft/0011v211Plat.App.Enabl/MEC-0011v211Plat.App.Enablv209.zip" + }, + "tags": [ + { + "name": "appSubscriptions" + }, + { + "name": "appServices" + }, + { + "name": "services" + }, + { + "name": "transports" + }, + { + "name": "callbacks" + } + ], + "paths": { + "/services": { + "get": { + "description": "This method retrieves information about a list of mecService resources. This method is typically used in \"service availability query\" procedure", + "operationId": "Services_GET", + "tags": [ + "services" + ], + "parameters": [ + { + "$ref": "#/components/parameters/Query.Ser_instance_id" + }, + { + "$ref": "#/components/parameters/Query.Ser_name" + }, + { + "$ref": "#/components/parameters/Query.Ser_category_id" + }, + { + "$ref": "#/components/parameters/Query.Consumed_local_only" + }, + { + "$ref": "#/components/parameters/Query.Is_local" + }, + { + "$ref": "#/components/parameters/Query.LocalityTypes" + } + ], + "responses": { + "200": { + "$ref": "#/components/responses/Services.200" + }, + "400": { + "$ref": "#/components/responses/Error.400" + }, + "403": { + "$ref": "#/components/responses/Error.403" + }, + "404": { + "$ref": "#/components/responses/Error.404" + } + } + } + }, + "/services/{serviceId}": { + "parameters": [ + { + "$ref": "#/components/parameters/Path.ServiceId" + } + ], + "get": { + "description": "This method retrieves information about a mecService resource. This method is typically used in \"service availability query\" procedure", + "operationId": "ServicesServiceId_GET", + "tags": [ + "services" + ], + "responses": { + "200": { + "$ref": "#/components/responses/ServicesServiceId.200" + }, + "400": { + "$ref": "#/components/responses/Error.400" + }, + "403": { + "$ref": "#/components/responses/Error.403" + }, + "404": { + "$ref": "#/components/responses/Error.404" + } + } + } + }, + "/applications/{appInstanceId}/services": { + "parameters": [ + { + "$ref": "#/components/parameters/Path.AppInstanceId" + } + ], + "get": { + "description": "This method retrieves information about a list of mecService resources. This method is typically used in \"service availability query\" procedure", + "operationId": "AppServices_GET", + "tags": [ + "appServices" + ], + "parameters": [ + { + "$ref": "#/components/parameters/Query.Ser_instance_id" + }, + { + "$ref": "#/components/parameters/Query.Ser_name" + }, + { + "$ref": "#/components/parameters/Query.Ser_category_id" + }, + { + "$ref": "#/components/parameters/Query.Consumed_local_only" + }, + { + "$ref": "#/components/parameters/Query.Is_local" + }, + { + "$ref": "#/components/parameters/Query.LocalityTypes" + } + ], + "responses": { + "200": { + "$ref": "#/components/responses/Services.200" + }, + "400": { + "$ref": "#/components/responses/Error.400" + }, + "403": { + "$ref": "#/components/responses/Error.403" + }, + "404": { + "$ref": "#/components/responses/Error.404" + } + } + }, + "post": { + "description": "This method is used to create a mecService resource. This method is typically used in \"service availability update and new service registration\" procedure", + "operationId": "AppServices_POST", + "tags": [ + "appServices" + ], + "responses": { + "201": { + "$ref": "#/components/responses/Services.201" + }, + "400": { + "$ref": "#/components/responses/Error.400" + }, + "403": { + "$ref": "#/components/responses/Error.403" + }, + "404": { + "$ref": "#/components/responses/Error.404" + } + }, + "requestBody": { + "$ref": "#/components/requestBodies/Services.Post" + } + } + }, + "/applications/{appInstanceId}/services/{serviceId}": { + "parameters": [ + { + "$ref": "#/components/parameters/Path.AppInstanceId" + }, + { + "$ref": "#/components/parameters/Path.ServiceId" + } + ], + "get": { + "description": "This method retrieves information about a mecService resource. This method is typically used in \"service availability query\" procedure", + "operationId": "AppServicesServiceId_GET", + "tags": [ + "appServices" + ], + "responses": { + "200": { + "$ref": "#/components/responses/ServicesServiceId.200" + }, + "400": { + "$ref": "#/components/responses/Error.400" + }, + "403": { + "$ref": "#/components/responses/Error.403" + }, + "404": { + "$ref": "#/components/responses/Error.404" + } + } + }, + "put": { + "description": "This method updates the information about a mecService resource", + "operationId": "AppServicesServiceId_PUT", + "tags": [ + "appServices" + ], + "responses": { + "200": { + "$ref": "#/components/responses/ServicesServiceId.200" + }, + "400": { + "$ref": "#/components/responses/Error.400" + }, + "403": { + "$ref": "#/components/responses/Error.403" + }, + "404": { + "$ref": "#/components/responses/Error.404" + }, + "412": { + "$ref": "#/components/responses/Error.412" + } + }, + "requestBody": { + "$ref": "#/components/requestBodies/ServicesServiceId" + } + } + }, + "/applications/{appInstanceId}/subscriptions": { + "parameters": [ + { + "$ref": "#/components/parameters/Path.AppInstanceId" + } + ], + "get": { + "description": "The GET method may be used to request information about all subscriptions for this requestor. Upon success, the response contains entity body with all the subscriptions for the requestor.", + "operationId": "ApplicationsSubscriptions_GET", + "tags": [ + "appSubscriptions" + ], + "responses": { + "200": { + "$ref": "#/components/responses/ApplicationsSubscriptions.200" + }, + "400": { + "$ref": "#/components/responses/Error.400" + }, + "403": { + "$ref": "#/components/responses/Error.403" + }, + "404": { + "$ref": "#/components/responses/Error.404" + } + } + }, + "post": { + "description": "The POST method may be used to create a new subscription. One example use case is to create a new subscription to the MEC service availability notifications. Upon success, the response contains entity body describing the created subscription.", + "operationId": "ApplicationsSubscriptions_POST", + "tags": [ + "appSubscriptions" + ], + "responses": { + "201": { + "$ref": "#/components/responses/ApplicationsSubscriptions.201" + }, + "400": { + "$ref": "#/components/responses/Error.400" + }, + "403": { + "$ref": "#/components/responses/Error.403" + }, + "404": { + "$ref": "#/components/responses/Error.404" + } + }, + "requestBody": { + "$ref": "#/components/requestBodies/ApplicationsSubscriptions" + }, + "callbacks": { + "serviceAvailabilityNotification": { + "$ref": "#/components/callbacks/ServiceAvailabilityNotification" + } + } + } + }, + "/applications/{appInstanceId}/subscriptions/{subscriptionId}": { + "parameters": [ + { + "$ref": "#/components/parameters/Path.AppInstanceId" + }, + { + "$ref": "#/components/parameters/Path.SubscriptionId" + } + ], + "get": { + "description": "The GET method requests information about a subscription for this requestor. Upon success, the response contains entity body with the subscription for the requestor.", + "operationId": "ApplicationsSubscription_GET", + "tags": [ + "appSubscriptions" + ], + "responses": { + "200": { + "$ref": "#/components/responses/ApplicationsSubscription.200" + }, + "400": { + "$ref": "#/components/responses/Error.400" + }, + "403": { + "$ref": "#/components/responses/Error.403" + }, + "404": { + "$ref": "#/components/responses/Error.404" + } + } + }, + "delete": { + "description": "This method deletes a mecSrvMgmtSubscription. This method is typically used in \"Unsubscribing from service availability event notifications\" procedure.", + "operationId": "ApplicationsSubscription_DELETE", + "tags": [ + "appSubscriptions" + ], + "responses": { + "204": { + "description": "No Content" + }, + "403": { + "$ref": "#/components/responses/Error.403" + }, + "404": { + "$ref": "#/components/responses/Error.404" + } + } + } + }, + "/transports": { + "get": { + "description": "This method retrieves information about a list of available transports. This method is typically used by a service-producing application to discover transports provided by the MEC platform in the \"transport information query\" procedure", + "operationId": "Transports_GET", + "tags": [ + "transports" + ], + "responses": { + "200": { + "$ref": "#/components/responses/Transports.200" + }, + "400": { + "$ref": "#/components/responses/Error.400" + }, + "403": { + "$ref": "#/components/responses/Error.403" + }, + "404": { + "$ref": "#/components/responses/Error.404" + } + } + } + } + }, + "components": { + "schemas": { + "Empty": { + "description": "Empty schema" + }, + "CategoryRef.Href": { + "description": "Reference of the catalogue", + "type": "string", + "example": "catItem1" + }, + "CategoryRef.Id": { + "description": "Unique identifier of the category", + "type": "string", + "example": "id12345" + }, + "CategoryRef.Name": { + "description": "Name of the category, example values include RNI, Location & Bandwidth Management", + "type": "string", + "example": "RNI" + }, + "CategoryRef.Version": { + "description": "Category version", + "type": "string", + "example": "version1" + }, + "CategoryRef": { + "description": "This type represents the category reference", + "type": "object", + "required": [ + "href", + "id", + "name", + "version" + ], + "properties": { + "href": { + "$ref": "#/components/schemas/CategoryRef.Href" + }, + "id": { + "$ref": "#/components/schemas/CategoryRef.Id" + }, + "name": { + "$ref": "#/components/schemas/CategoryRef.Name" + }, + "version": { + "$ref": "#/components/schemas/CategoryRef.Version" + } + } + }, + "EndPointInfo.Address.Host": { + "description": "Host portion of the address", + "type": "string", + "example": "192.0.2.0" + }, + "EndPointInfo.Address_Port": { + "description": "Port portion of the address", + "type": "integer", + "format": "uint32", + "example": 8080 + }, + "EndPointInfo.Address": { + "description": "A IP address and port pair", + "type": "object", + "required": [ + "host", + "port" + ], + "properties": { + "host": { + "$ref": "#/components/schemas/EndPointInfo.Address.Host" + }, + "port": { + "$ref": "#/components/schemas/EndPointInfo.Address_Port" + } + } + }, + "EndPointInfo.Addresses": { + "description": "Entry point information of the service as one or more pairs of IP address and port", + "type": "object", + "required": [ + "addresses" + ], + "properties": { + "addresses": { + "type": "array", + "minItems": 0, + "items": { + "$ref": "#/components/schemas/EndPointInfo.Address" + } + } + } + }, + "EndPointInfo.Alternative": { + "description": "Entry point information of the service in a format defined by an implementation, or in an external specification.", + "type": "object", + "required": [ + "alternative" + ], + "properties": { + "alternative": { + "type": "object" + } + } + }, + "EndPointInfo.Uri": { + "description": "Entry point information of the service", + "type": "string", + "format": "uri", + "example": "/mecSerMgmtApi/service/EntryPoint" + }, + "EndPointInfo.Uris": { + "description": "Entry point information of the service as string, formatted according to URI syntax", + "type": "object", + "required": [ + "uris" + ], + "properties": { + "uris": { + "type": "array", + "minItems": 0, + "items": { + "$ref": "#/components/schemas/EndPointInfo.Uri" + } + } + } + }, + "LinkType": { + "description": "This type represents a type of link and may be referenced from data structures", + "type": "object", + "properties": { + "href": { + "$ref": "#/components/schemas/Href" + } + } + }, + "Href": { + "description": "URI referring to a resource", + "type": "string", + "format": "uri", + "example": "/mecSerMgmtApi/example" + }, + "MecServiceMgmtApiSubscriptionLinkList.Links": { + "description": "Self-referring URI.", + "type": "object", + "required": [ + "self" + ], + "properties": { + "self": { + "$ref": "#/components/schemas/LinkType" + }, + "subscriptions": { + "description": "The MEC application instance's subscriptions", + "type": "array", + "items": { + "$ref": "#/components/schemas/MecServiceMgmtApiSubscriptionLinkList.Subscription" + } + } + } + }, + "MecServiceMgmtApiSubscriptionLinkList.Subscription": { + "description": "A link to a subscription.", + "type": "object", + "required": [ + "href", + "rel" + ], + "properties": { + "href": { + "$ref": "#/components/schemas/Href" + }, + "rel": { + "description": "The value shall be se to SerAvailabilityNotificationSubscription.", + "type": "string" + } + } + }, + "MecServiceMgmtApiSubscriptionLinkList": { + "description": "This type represents a list of links related to currently existing subscriptions for a MEC application instance. This information is returned when sending a request to receive current subscriptions.", + "type": "object", + "required": [ + "_links" + ], + "properties": { + "_links": { + "$ref": "#/components/schemas/MecServiceMgmtApiSubscriptionLinkList.Links" + } + } + }, + "ProblemDetails": { + "type": "object", + "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.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" + }, + "Problem.status": { + "type": "integer", + "format": "uint32", + "description": "The HTTP status code for this occurrence of the problem" + }, + "Problem.title": { + "type": "string", + "description": "A short, human-readable summary of the problem type" + }, + "Problem.type": { + "type": "string", + "format": "uri", + "description": "A URI reference according to IETF RFC 3986 that identifies the problem type" + }, + "SecurityInfo.OAuth2Info.GrantTypes": { + "description": "List of supported OAuth 2.0 grant types", + "type": "string", + "enum": [ + "OAUTH2_AUTHORIZATION_CODE", + "OAUTH2_IMPLICIT_GRANT", + "OAUTH2_RESOURCE_OWNER", + "OAUTH2_CLIENT_CREDENTIALS" + ], + "example": "OAUTH2_CLIENT_CREDENTIALS" + }, + "SecurityInfo.OAuth2Info.TokenEndpoint": { + "description": "The token endpoint", + "type": "string", + "format": "uri", + "example": "/mecSerMgmtApi/security/TokenEndPoint" + }, + "SecurityInfo.OAuth2Info": { + "description": "Parameters related to use of OAuth 2.0", + "required": [ + "grantTypes", + "tokenEndpoint" + ], + "properties": { + "grantTypes": { + "description": "List of supported OAuth 2.0 grant types.", + "type": "array", + "minItems": 1, + "maxItems": 4, + "items": { + "$ref": "#/components/schemas/SecurityInfo.OAuth2Info.GrantTypes" + } + }, + "tokenEndpoint": { + "$ref": "#/components/schemas/SecurityInfo.OAuth2Info.TokenEndpoint" + } + }, + "type": "object" + }, + "SecurityInfo": { + "description": "This type represents security information related to a transport", + "type": "object", + "properties": { + "oAuth2Info": { + "$ref": "#/components/schemas/SecurityInfo.OAuth2Info" + } + } + }, + "Self": { + "description": "Self-referring URI.", + "type": "object", + "required": [ + "self" + ], + "properties": { + "self": { + "$ref": "#/components/schemas/LinkType" + } + }, + "readOnly": true + }, + "SerAvailabilityNotificationSubscription.CallbackReference": { + "description": "URI selected by the MEC application instance to receive notifications on the subscribed MEC service availability information. This shall be included in both the request and the response.", + "type": "string", + "format": "uri" + }, + "SerAvailabilityNotificationSubscription": { + "description": "This type represents a subscription to the notifications from the MEC platform regarding the availability of a MEC service or a list of MEC services.", + "type": "object", + "required": [ + "subscriptionType", + "callbackReference", + "_links", + "filteringCriteria" + ], + "properties": { + "subscriptionType": { + "$ref": "#/components/schemas/SerAvailabilityNotificationSubscription.SubscriptionType" + }, + "callbackReference": { + "$ref": "#/components/schemas/SerAvailabilityNotificationSubscription.CallbackReference" + }, + "_links": { + "$ref": "#/components/schemas/Self" + }, + "filteringCriteria": { + "$ref": "#/components/schemas/ServiceInfo" + } + } + }, + "SerAvailabilityNotificationSubscription.SubscriptionType": { + "description": "Shall be set to SerAvailabilityNotificationSubscription.", + "type": "string", + "example": "SerAvailabilityNotificationSubscription" + }, + "ServiceAvailabilityNotification": { + "description": "This type represents the service availability information.", + "type": "object", + "required": [ + "notificationType", + "services", + "_links" + ], + "properties": { + "notificationType": { + "$ref": "#/components/schemas/SerAvailabilityNotificationSubscription.SubscriptionType" + }, + "services": { + "type": "array", + "items": { + "$ref": "#/components/schemas/ServiceInfo" + } + }, + "_links": { + "$ref": "#/components/schemas/Subscription" + } + } + }, + "SerializerTypes": { + "description": "The enumeration SerializerTypes represents types of serializers", + "type": "string", + "enum": [ + "JSON", + "XML", + "PROTOBUF3" + ], + "example": "JSON" + }, + "LocalityTypes": { + "description": "The scope of locality as expressed by \"consumedLocalOnly\" and \"isLocal\". If absent, defaults to MEC_HOST", + "type": "string", + "enum": [ + "MEC_SYSTEM", + "MEC_HOST", + "NFVI_POP", + "ZONE", + "ZONE_GROUP", + "NFVI_NODE" + ], + "example": "MEC_SYSTEM" + }, + "ServiceInfo.SerInstanceId": { + "description": "Identifier of the service instance assigned by the MEC platform.", + "type": "string", + "readOnly": true, + "example": "ServiceInstance123" + }, + "ServiceInfo.SerName": { + "description": "The name of the service. This is how the service producing MEC application identifies the service instance it produces.", + "type": "string", + "example": "ExampleService" + }, + "ServiceInfo.State": { + "description": "Contains the state", + "type": "string", + "enum": [ + "ACTIVE", + "INACTIVE" + ], + "example": "ACTIVE" + }, + "ServiceInfo.TransportId": { + "description": "Identifier of the platform-provided transport to be used by the service. Valid identifiers may be obtained using the \"Transport information query\" procedure. May be present in POST requests to signal the use of a platform-provided transport for the service, and shall be absent otherwise.", + "type": "string", + "writeOnly": true, + "example": "Rest1" + }, + "ServiceInfo.Version": { + "description": "Service version", + "type": "string", + "example": "ServiceVersion1" + }, + "ServiceInfo.ConsumedLocalOnly": { + "description": "Indicate whether the service can only be consumed by the MEC applications located in the same locality (as defined by scopeOfLocality) as this service instance.", + "type": "boolean", + "example": false + }, + "ServiceInfo.IsLocal": { + "description": "Indicate whether the service is located in the same locality (as defined by scopeOfLocality) as the consuming MEC application.", + "type": "boolean", + "example": true + }, + "ServiceInfo.Post": { + "description": "This type represents the general information of a MEC service.", + "type": "object", + "required": [ + "serName", + "version", + "state", + "serializer" + ], + "oneOf": [ + { + "required": [ + "transportId" + ] + }, + { + "required": [ + "transportInfo" + ] + } + ], + "properties": { + "serInstanceId": { + "$ref": "#/components/schemas/ServiceInfo.SerInstanceId" + }, + "serName": { + "$ref": "#/components/schemas/ServiceInfo.SerName" + }, + "serCategory": { + "$ref": "#/components/schemas/CategoryRef" + }, + "version": { + "$ref": "#/components/schemas/ServiceInfo.Version" + }, + "state": { + "$ref": "#/components/schemas/ServiceInfo.State" + }, + "transportId": { + "$ref": "#/components/schemas/ServiceInfo.TransportId" + }, + "transportInfo": { + "$ref": "#/components/schemas/TransportInfo" + }, + "serializer": { + "$ref": "#/components/schemas/SerializerTypes" + }, + "scopeOfLocality": { + "$ref": "#/components/schemas/LocalityTypes" + }, + "consumedLocalOnly": { + "$ref": "#/components/schemas/ServiceInfo.ConsumedLocalOnly" + }, + "isLocal": { + "$ref": "#/components/schemas/ServiceInfo.IsLocal" + } + } + }, + "ServiceInfo": { + "description": "This type represents the general information of a MEC service.", + "type": "object", + "required": [ + "serName", + "version", + "state", + "transportInfo", + "serializer" + ], + "properties": { + "serInstanceId": { + "$ref": "#/components/schemas/ServiceInfo.SerInstanceId" + }, + "serName": { + "$ref": "#/components/schemas/ServiceInfo.SerName" + }, + "serCategory": { + "$ref": "#/components/schemas/CategoryRef" + }, + "version": { + "$ref": "#/components/schemas/ServiceInfo.Version" + }, + "state": { + "$ref": "#/components/schemas/ServiceInfo.State" + }, + "transportInfo": { + "$ref": "#/components/schemas/TransportInfo" + }, + "serializer": { + "$ref": "#/components/schemas/SerializerTypes" + }, + "scopeOfLocality": { + "$ref": "#/components/schemas/LocalityTypes" + }, + "consumedLocalOnly": { + "$ref": "#/components/schemas/ServiceInfo.ConsumedLocalOnly" + }, + "isLocal": { + "$ref": "#/components/schemas/ServiceInfo.IsLocal" + } + } + }, + "Subscription": { + "description": "A link to the related subscription", + "type": "object", + "required": [ + "subscription" + ], + "properties": { + "subscription": { + "$ref": "#/components/schemas/LinkType" + } + } + }, + "TransportInfo.Description": { + "description": "Human-readable description of this transport", + "type": "string", + "example": "REST API" + }, + "TransportInfo.Id": { + "description": "The identifier of this transport", + "type": "string", + "example": "TransId12345" + }, + "TransportInfo.ImplSpecificInfo": { + "description": "Additional implementation specific details of the transport", + "type": "object" + }, + "TransportInfo.Name": { + "description": "The name of this transport", + "type": "string", + "example": "REST" + }, + "TransportInfo.Protocol": { + "description": "The name of the protocol used. Shall be set to HTTP for a REST API.", + "type": "string", + "example": "HTTP" + }, + "TransportInfo.Version": { + "description": "The version of the protocol used", + "type": "string", + "example": "2.0" + }, + "TransportInfo": { + "description": "This type represents the general information of a MEC service.", + "type": "object", + "required": [ + "id", + "name", + "type", + "protocol", + "version", + "endpoint", + "security" + ], + "properties": { + "id": { + "$ref": "#/components/schemas/TransportInfo.Id" + }, + "name": { + "$ref": "#/components/schemas/TransportInfo.Name" + }, + "description": { + "$ref": "#/components/schemas/TransportInfo.Description" + }, + "type": { + "$ref": "#/components/schemas/TransportTypes" + }, + "protocol": { + "$ref": "#/components/schemas/TransportInfo.Protocol" + }, + "version": { + "$ref": "#/components/schemas/TransportInfo.Version" + }, + "endpoint": { + "description": "This type represents information about a transport endpoint", + "type": "object", + "oneOf": [ + { + "$ref": "#/components/schemas/EndPointInfo.Uris" + }, + { + "$ref": "#/components/schemas/EndPointInfo.Addresses" + }, + { + "$ref": "#/components/schemas/EndPointInfo.Alternative" + } + ] + }, + "security": { + "$ref": "#/components/schemas/SecurityInfo" + }, + "implSpecificInfo": { + "$ref": "#/components/schemas/TransportInfo.ImplSpecificInfo" + } + } + }, + "TransportTypes": { + "description": "The enumeration TransportTypes represents types of transports", + "type": "string", + "enum": [ + "REST_HTTP", + "MB_TOPIC_BASED", + "MB_ROUTING", + "MB_PUBSUB", + "RPC", + "RPC_STREAMING", + "WEBSOCKET" + ], + "example": "REST_HTTP" + } + }, + "parameters": { + "Path.AppInstanceId": { + "name": "appInstanceId", + "description": "Represents a MEC application instance. Note that the appInstanceId is allocated by the MEC platform manager.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + "Path.SubscriptionId": { + "name": "subscriptionId", + "description": "Represents a subscription to the notifications from the MEC platform.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + "Path.ServiceId": { + "name": "serviceId", + "description": "Represents a MEC service instance.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + "Query.Ser_category_id": { + "name": "ser_category_id", + "description": "A MEC application instance may use ser_category_id as an input parameter to query the availability of a list of MEC service instances in a serCategory. Either \"ser_instance_id\" or \"ser_name\" or \"ser_category_id\" or none of them shall be present.", + "in": "query", + "required": false, + "schema": { + "type": "string" + } + }, + "Query.Ser_instance_id": { + "name": "ser_instance_id", + "description": "A MEC application instance may use multiple ser_instance_ids as an input parameter to query the availability of a list of MEC service instances. Either \"ser_instance_id\" or \"ser_name\" or \"ser_category_id\" or none of them shall be present.", + "in": "query", + "required": false, + "schema": { + "type": "array", + "items": { + "type": "string" + } + } + }, + "Query.Ser_name": { + "name": "ser_name", + "description": "A MEC application instance may use multiple ser_names as an input parameter to query the availability of a list of MEC service instances. Either \"ser_instance_id\" or \"ser_name\" or \"ser_category_id\" or none of them shall be present.", + "in": "query", + "required": false, + "schema": { + "type": "array", + "items": { + "type": "string" + } + } + }, + "Query.LocalityTypes": { + "name": "scope_of_locality", + "description": "A MEC application instance may use scope_of_locality as an input parameter to query the availability of a list of MEC service instances with a certain scope of locality.", + "in": "query", + "required": false, + "schema": { + "type": "string" + } + }, + "Query.Is_local": { + "name": "is_local", + "description": "Indicate whether the service is located in the same locality (as defined by scopeOfLocality) as the consuming MEC application.", + "in": "query", + "required": false, + "schema": { + "type": "boolean" + } + }, + "Query.Consumed_local_only": { + "name": "consumed_local_only", + "description": "Indicate whether the service can only be consumed by the MEC applications located in the same locality (as defined by scopeOfLocality) as this service instance.", + "in": "query", + "required": false, + "schema": { + "type": "boolean" + } + } + }, + "responses": { + "ApplicationsSubscriptions.200": { + "description": "Upon success, a response body containing the list of links to the requested subscriptions is returned.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/MecServiceMgmtApiSubscriptionLinkList" + } + } + }, + "links": { + "getIndividualmecSerMgmtApiSubscriptionLinkList": { + "$ref": "#/components/links/GetIndividualmecSerMgmtApiSubscriptionLinkList" + }, + "delIndividualmecSerMgmtApiSubscriptionLinkList": { + "$ref": "#/components/links/DelIndividualmecSerMgmtApiSubscriptionLinkList" + } + } + }, + "ApplicationsSubscriptions.201": { + "description": "Entity body in the request contains a subscription to the MEC service availability notifications that is to be created.", + "headers": { + "location": { + "description": "The resource URI of the created resource", + "schema": { + "type": "string", + "format": "uri" + } + } + }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SerAvailabilityNotificationSubscription" + } + } + }, + "links": { + "getIndividualmecSerMgmtApiSubscription": { + "$ref": "#/components/links/GetIndividualmecSerMgmtApiSubscription" + }, + "delIndividualmecSerMgmtApiSubscription": { + "$ref": "#/components/links/DelIndividualmecSerMgmtApiSubscription" + } + } + }, + "ApplicationsSubscription.200": { + "description": "Upon success, a response body containing the requested subscription is returned.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SerAvailabilityNotificationSubscription" + } + } + } + }, + "Services.200": { + "description": "It is used to indicate nonspecific success. The response body contains a representation of the resource.", + "content": { + "application/json": { + "schema": { + "type": "array", + "minItems": 0, + "items": { + "$ref": "#/components/schemas/ServiceInfo" + } + }, + "examples": { + "ServiceInfoList": { + "$ref": "#/components/examples/ServiceInfoList" + } + } + } + }, + "links": { + "getIndividualmecService": { + "$ref": "#/components/links/GetIndividualmecService" + }, + "putIndividualmecService": { + "$ref": "#/components/links/PutIndividualmecService" + } + } + }, + "Services.201": { + "description": "Upon success, the HTTP response shall include a Location HTTP header that contains the resource URI of the created resource.", + "headers": { + "location": { + "description": "The resource URI of the created resource", + "schema": { + "type": "string", + "format": "uri" + } + } + }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ServiceInfo" + }, + "examples": { + "ServiceInfo": { + "$ref": "#/components/examples/ServiceInfo" + } + } + } + }, + "links": { + "getIndividualmecService": { + "$ref": "#/components/links/GetIndividualmecService" + }, + "putIndividualmecService": { + "$ref": "#/components/links/PutIndividualmecService" + } + } + }, + "ServicesServiceId.200": { + "description": "It is used to indicate nonspecific success. The response body contains a representation of the resource.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ServiceInfo" + }, + "examples": { + "ServiceInfo": { + "$ref": "#/components/examples/ServiceInfo" + } + } + } + } + }, + "Transports.200": { + "description": "It is used to indicate nonspecific success. The response body contains a representation of the resource.", + "content": { + "application/json": { + "schema": { + "type": "array", + "minItems": 0, + "items": { + "$ref": "#/components/schemas/TransportInfo" + } + } + } + }, + "links": { + "getTransportInfo": { + "$ref": "#/components/links/GetTransportInfo" + } + } + }, + "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" + } + } + } + }, + "Error.409": { + "description": "Conflict. The operation cannot be executed currently, due to a conflict with the state of the resource. Typically, this is because the application instance resource is in NOT_INSTANTIATED state.", + "content": { + "application/problem+json": { + "schema": { + "$ref": "#/components/schemas/ProblemDetails" + } + }, + "text/plain": { + "schema": { + "$ref": "#/components/schemas/Empty" + } + } + } + }, + "Error.412": { + "description": "Precondition Failed. It is used when a condition has failed during conditional requests, e.g. when using ETags to avoid write conflicts.", + "content": { + "application/problem+json": { + "schema": { + "$ref": "#/components/schemas/ProblemDetails" + } + }, + "text/plain": { + "schema": { + "$ref": "#/components/schemas/Empty" + } + } + } + }, + "Error.429": { + "description": "Too Many Requests. It is used when a rate limiter has triggered.", + "content": { + "application/problem+json": { + "schema": { + "$ref": "#/components/schemas/ProblemDetails" + } + }, + "text/plain": { + "schema": { + "$ref": "#/components/schemas/Empty" + } + } + } + } + }, + "requestBodies": { + "ApplicationsSubscriptions": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SerAvailabilityNotificationSubscription" + } + } + }, + "description": "Entity body in the request contains a subscription to the MEC application termination notifications that is to be created.", + "required": true + }, + "Services": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ServiceInfo" + } + } + }, + "description": "New ServiceInfo with updated \"state\" is included as entity body of the request", + "required": true + }, + "Services.Post": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ServiceInfo.Post" + } + } + }, + "description": "New ServiceInfo with updated \"state\" is included as entity body of the request", + "required": true + }, + "ServicesServiceId": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ServiceInfo" + } + } + }, + "description": "New ServiceInfo with updated \"state\" is included as entity body of the request", + "required": true + }, + "ServiceAvailabilityNotification": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ServiceAvailabilityNotification" + } + } + }, + "required": true + } + }, + "callbacks": { + "ServiceAvailabilityNotification": { + "{$request.body#/callbackReference}": { + "post": { + "description": "'Represents the service availability information that is used in the following cases - when the MEC platform announces the newly available\n services to the authorized relevant MEC applications (e.g. \n the applications that indicate the services as \"optional\" \n or \"required\") that are subscribed to the corresponding \n service availability notifications\n- when the MEC platform notifies the authorized relevant applications that are subscribed to the corresponding service availability notifications about the service availability changes.'", + "operationId": "ServiceAvailabilityNotification_POST", + "tags": [ + "callbacks" + ], + "requestBody": { + "$ref": "#/components/requestBodies/ServiceAvailabilityNotification" + }, + "responses": { + "200": { + "description": "Expected responses from callback consumer, if it accepts the callback" + } + } + } + } + } + }, + "links": { + "GetIndividualmecService": { + "operationId": "ServicesServiceId_GET", + "description": "The `serviceId` value returned in the response can be used as the `serviceId` parameter in `GET /services/{serviceId}`", + "parameters": { + "serviceId": "$response.body#/serviceId" + } + }, + "PutIndividualmecService": { + "operationId": "ServicesServiceId_PUT", + "description": "The `serviceId` value returned in the response can be used as the `serviceId` parameter in `PUT /services/{serviceId}`", + "parameters": { + "serviceId": "$response.body#/serviceId" + } + }, + "GetTransportInfo": { + "operationId": "AppServices_POST", + "description": "The `id` value returned in the response can be used as the `transportId` parameter in `POST /applications/{appInstanceId}/services`. The first transport is provided as the link as wildcards are not supported", + "parameters": { + "transportId": "$response.body#/0/id" + } + }, + "GetIndividualmecSerMgmtApiSubscription": { + "operationId": "ApplicationsSubscription_GET", + "description": "The `subscriptionId` value returned in the response can be used as the `subscriptionId` parameter in `GET /applications/{appInstanceId}/subscriptions/{subscriptionId}`", + "parameters": { + "description": "regex = \\/mec_service_mgmt\\/v1\\/applications\\/.*\\/subscriptions\\/.*\\/(.*);subscriptionId = href.match(regex)[1];// where \"href\" is an attribute within the subscription attribute within the _links attribute", + "subscriptionId": "TBC" + } + }, + "DelIndividualmecSerMgmtApiSubscription": { + "operationId": "ApplicationsSubscription_DELETE", + "description": "The `subscriptionId` value returned in the response can be used as the `subscriptionId` parameter in `DELETE /applications/{appInstanceId}/subscriptions/{subscriptionId}`", + "parameters": { + "description": "regex = \\/mec_service_mgmt\\/v1\\/applications\\/.*\\/subscriptions\\/(.*);subscriptionId = href.match(regex)[1];// where \"href\" is an attribute within the subscription attribute within the _links attribute", + "subscriptionId": "TBC" + } + }, + "GetIndividualmecSerMgmtApiSubscriptionLinkList": { + "operationId": "ApplicationsSubscription_GET", + "description": "The `subscriptionId` value returned in the response can be used as the `subscriptionId` parameter in `GET /applications/{appInstanceId}/subscriptions/{subscriptionId}`", + "parameters": { + "description": "regex = \\/mec_service_mgmt\\/v1\\/applications\\/.*\\/subscriptions\\/(.*);subscriptionId = href.match(regex)[1];// where \"href\" is an attribute within the subscription attribute within the _links attribute", + "subscriptionId": "TBC" + } + }, + "DelIndividualmecSerMgmtApiSubscriptionLinkList": { + "operationId": "ApplicationsSubscription_DELETE", + "description": "The `subscriptionId` value returned in the response can be used as the `subscriptionId` parameter in `DELETE /applications/{appInstanceId}/subscriptions/{subscriptionId}`", + "parameters": { + "description": "regex = \\/mec_service_mgmt\\/v1\\/applications\\/.*\\/subscriptions\\/(.*);subscriptionId = href.match(regex)[1];// where \"href\" is an attribute within the subscription attribute within the _links attribute", + "subscriptionId": "TBC" + } + } + }, + "examples": { + "ServiceInfo": { + "value": { + "serInstanceId": "ServiceInstance123", + "serName": "ExampleService", + "serCategory": { + "href": "catItem1", + "id": "id12345", + "name": "RNI", + "version": "version1" + }, + "version": "ServiceVersion1", + "state": "ACTIVE", + "transportInfo": { + "id": "TransId12345", + "name": "REST", + "description": "REST API", + "type": "REST_HTTP", + "protocol": "HTTP", + "version": "2.0", + "endpoint": { + "uris": [ + "/mecSerMgmtApi/service/EntryPoint" + ] + }, + "security": { + "oAuth2Info": { + "grantTypes": [ + "OAUTH2_CLIENT_CREDENTIALS" + ], + "tokenEndpoint": "/mecSerMgmtApi/security/TokenEndPoint" + } + } + }, + "serializer": "JSON" + } + }, + "ServiceInfoList": { + "value": [ + { + "serInstanceId": "ServiceInstance123", + "serName": "ExampleService", + "serCategory": { + "href": "catItem1", + "id": "id12345", + "name": "RNI", + "version": "version1" + }, + "version": "ServiceVersion1", + "state": "ACTIVE", + "transportInfo": { + "id": "TransId12345", + "name": "REST", + "description": "REST API", + "type": "REST_HTTP", + "protocol": "HTTP", + "version": "2.0", + "endpoint": { + "addresses": [ + { + "host": "192.0.2.0", + "port": 8080 + } + ] + }, + "security": { + "oAuth2Info": { + "grantTypes": [ + "OAUTH2_CLIENT_CREDENTIALS" + ], + "tokenEndpoint": "/mecSerMgmtApi/security/TokenEndPoint" + } + } + }, + "serializer": "JSON" + } + ] + } + } + } +} \ No newline at end of file diff --git a/Mp1.yaml b/Mp1.yaml deleted file mode 100644 index bdea187..0000000 --- a/Mp1.yaml +++ /dev/null @@ -1,2124 +0,0 @@ -openapi: 3.0.2 -servers: - - url: 'http://127.0.0.1:8081/mp1/v1' - - url: 'https://127.0.0.1:8081/mp1/v1' -info: - title: Mp1 API - version: 2.0.8 - description: The ETSI MEC ISG MEC011 Application Enablement API described using OpenAPI - license: - name: ETSI Forge copyright notice - url: 'https://forge.etsi.org/etsi-forge-copyright-notice.txt' - contact: - email: cti_support@etsi.org -externalDocs: - description: 'ETSI GS MEC011 Application Enablement API, V2.0.8' - url: >- - https://docbox.etsi.org/ISG/MEC/70-Draft/0011v211Plat.App.Enabl/MEC-0011v211Plat.App.Enablv208.zip -tags: - - name: appTrafficRules - - name: appDnsRules - - name: appSubscriptions - - name: appConfirmTermination - - name: appServices - - name: services - - name: timing - - name: transports - - name: callbacks -paths: - '/applications/{appInstanceId}/confirm_termination': - parameters: - - $ref: '#/components/parameters/Path.AppInstanceId' - post: - description: >- - This method is used to confirm the application level termination - of an application instance. - operationId: ApplicationsConfirmTermination_POST - tags: - - appConfirmTermination - responses: - '204': - description: No Content - '401': - $ref: '#/components/responses/Error.401' - '403': - $ref: '#/components/responses/Error.403' - '404': - $ref: '#/components/responses/Error.404' - '409': - $ref: '#/components/responses/Error.409' - '429': - $ref: '#/components/responses/Error.429' - '/applications/{appInstanceId}/dns_rules': - parameters: - - $ref: '#/components/parameters/Path.AppInstanceId' - get: - description: >- - This method retrieves information about all the DNS rules associated - with a mobile edge application instance. - operationId: ApplicationsDnsRules_GET - tags: - - appDnsRules - responses: - '200': - $ref: '#/components/responses/ApplicationsDnsRules.200' - '400': - $ref: '#/components/responses/Error.400' - '403': - $ref: '#/components/responses/Error.403' - '404': - $ref: '#/components/responses/Error.404' - '/applications/{appInstanceId}/dns_rules/{dnsRuleId}': - parameters: - - $ref: '#/components/parameters/Path.AppInstanceId' - - $ref: '#/components/parameters/Path.DnsRuleId' - get: - description: >- - This method retrieves information about a DNS rule associated with a - mobile edge application instance. - operationId: ApplicationsDnsRule_GET - tags: - - appDnsRules - responses: - '200': - $ref: '#/components/responses/ApplicationsDnsRule.200' - '400': - $ref: '#/components/responses/Error.400' - '403': - $ref: '#/components/responses/Error.403' - '404': - $ref: '#/components/responses/Error.404' - put: - description: 'This method activates, de-activates or updates a traffic rule.' - operationId: ApplicationsDnsRule_PUT - tags: - - appDnsRules - responses: - '200': - $ref: '#/components/responses/ApplicationsDnsRule.200' - '400': - $ref: '#/components/responses/Error.400' - '403': - $ref: '#/components/responses/Error.403' - '404': - $ref: '#/components/responses/Error.404' - '412': - $ref: '#/components/responses/Error.412' - requestBody: - $ref: '#/components/requestBodies/ApplicationsDnsRule' - '/applications/{appInstanceId}/subscriptions': - parameters: - - $ref: '#/components/parameters/Path.AppInstanceId' - get: - description: >- - The GET method may be used to request information about all - subscriptions for this requestor. Upon success, the response contains - entity body with all the subscriptions for the requestor. - operationId: ApplicationsSubscriptions_GET - tags: - - appSubscriptions - responses: - '200': - $ref: '#/components/responses/ApplicationsSubscriptions.200' - '400': - $ref: '#/components/responses/Error.400' - '403': - $ref: '#/components/responses/Error.403' - '404': - $ref: '#/components/responses/Error.404' - post: - description: >- - The POST method may be used to create a new subscription. One example - use case is to create a new subscription to the mobile edge service - availability notifications. Upon success, the response contains entity - body describing the created subscription. - operationId: ApplicationsSubscriptions_POST - tags: - - appSubscriptions - responses: - '201': - $ref: '#/components/responses/ApplicationsSubscriptions.201' - '400': - $ref: '#/components/responses/Error.400' - '403': - $ref: '#/components/responses/Error.403' - '404': - $ref: '#/components/responses/Error.404' - requestBody: - $ref: '#/components/requestBodies/ApplicationsSubscriptions' - callbacks: - appTerminationNotification: - $ref: '#/components/callbacks/AppTerminationNotification' - serviceAvailabilityNotification: - $ref: '#/components/callbacks/ServiceAvailabilityNotification' - '/applications/{appInstanceId}/subscriptions/{subscriptionId}': - parameters: - - $ref: '#/components/parameters/Path.AppInstanceId' - - $ref: '#/components/parameters/Path.SubscriptionId' - get: - description: >- - The GET method requests information about a subscription for this - requestor. Upon success, the response contains entity body with the - subscription for the requestor. - operationId: ApplicationsSubscription_GET - tags: - - appSubscriptions - responses: - '200': - $ref: '#/components/responses/ApplicationsSubscription.200' - '400': - $ref: '#/components/responses/Error.400' - '403': - $ref: '#/components/responses/Error.403' - '404': - $ref: '#/components/responses/Error.404' - delete: - description: >- - This method deletes a meMp1Subscription. This method is typically used - in "Unsubscribing from service availability event notifications" - procedure. - operationId: ApplicationsSubscription_DELETE - tags: - - appSubscriptions - responses: - '204': - description: No Content - '403': - $ref: '#/components/responses/Error.403' - '404': - $ref: '#/components/responses/Error.404' - '/applications/{appInstanceId}/traffic_rules': - parameters: - - $ref: '#/components/parameters/Path.AppInstanceId' - get: - description: >- - This method retrieves information about all the traffic rules associated - with a mobile edge application instance. - operationId: ApplicationsTrafficRules_GET - tags: - - appTrafficRules - responses: - '200': - $ref: '#/components/responses/ApplicationsTrafficRules.200' - '400': - $ref: '#/components/responses/Error.400' - '403': - $ref: '#/components/responses/Error.403' - '404': - $ref: '#/components/responses/Error.404' - '/applications/{appInstanceId}/traffic_rules/{trafficRuleId}': - parameters: - - $ref: '#/components/parameters/Path.AppInstanceId' - - $ref: '#/components/parameters/Path.TrafficRuleId' - get: - description: >- - This method retrieves information about all the traffic rules associated - with a mobile edge application instance. - operationId: ApplicationsTrafficRule_GET - tags: - - appTrafficRules - responses: - '200': - $ref: '#/components/responses/ApplicationsTrafficRule.200' - '400': - $ref: '#/components/responses/Error.400' - '403': - $ref: '#/components/responses/Error.403' - '404': - $ref: '#/components/responses/Error.404' - put: - description: >- - This method retrieves information about all the traffic rules associated - with a mobile edge application instance. - operationId: ApplicationsTrafficRule_PUT - tags: - - appTrafficRules - responses: - '200': - $ref: '#/components/responses/ApplicationsTrafficRule.200' - '400': - $ref: '#/components/responses/Error.400' - '403': - $ref: '#/components/responses/Error.403' - '404': - $ref: '#/components/responses/Error.404' - '412': - $ref: '#/components/responses/Error.412' - requestBody: - $ref: '#/components/requestBodies/ApplicationsTrafficRule' - '/applications/{appInstanceId}/services': - parameters: - - $ref: '#/components/parameters/Path.AppInstanceId' - get: - description: >- - This method retrieves information about a list of meService resources. - This method is typically used in "service availability query" procedure - operationId: AppServices_GET - tags: - - appServices - parameters: - - $ref: '#/components/parameters/Query.Ser_instance_id' - - $ref: '#/components/parameters/Query.Ser_name' - - $ref: '#/components/parameters/Query.Ser_category_id' - - $ref: '#/components/parameters/Query.Consumed_local_only' - - $ref: '#/components/parameters/Query.Is_local' - - $ref: '#/components/parameters/Query.LocalityTypes' - responses: - '200': - $ref: '#/components/responses/Services.200' - '400': - $ref: '#/components/responses/Error.400' - '403': - $ref: '#/components/responses/Error.403' - '404': - $ref: '#/components/responses/Error.404' - post: - description: >- - This method is used to create a meService resource. This method is - typically used in "service availability update and new service - registration" procedure - operationId: AppServices_POST - tags: - - appServices - responses: - '201': - $ref: '#/components/responses/Services.201' - '400': - $ref: '#/components/responses/Error.400' - '403': - $ref: '#/components/responses/Error.403' - '404': - $ref: '#/components/responses/Error.404' - requestBody: - $ref: '#/components/requestBodies/Services.Post' - '/applications/{appInstanceId}/services/{serviceId}': - parameters: - - $ref: '#/components/parameters/Path.AppInstanceId' - - $ref: '#/components/parameters/Path.ServiceId' - get: - description: >- - This method retrieves information about a meService resource. This - method is typically used in "service availability query" procedure - operationId: AppServicesServiceId_GET - tags: - - appServices - responses: - '200': - $ref: '#/components/responses/ServicesServiceId.200' - '400': - $ref: '#/components/responses/Error.400' - '403': - $ref: '#/components/responses/Error.403' - '404': - $ref: '#/components/responses/Error.404' - put: - description: This method updates the information about a meService resource - operationId: AppServicesServiceId_PUT - tags: - - appServices - responses: - '200': - $ref: '#/components/responses/ServicesServiceId.200' - '400': - $ref: '#/components/responses/Error.400' - '403': - $ref: '#/components/responses/Error.403' - '404': - $ref: '#/components/responses/Error.404' - '412': - $ref: '#/components/responses/Error.412' - requestBody: - $ref: '#/components/requestBodies/ServicesServiceId' - '/services': - get: - description: >- - This method retrieves information about a list of meService resources. - This method is typically used in "service availability query" procedure - operationId: Services_GET - tags: - - services - parameters: - - $ref: '#/components/parameters/Query.Ser_instance_id' - - $ref: '#/components/parameters/Query.Ser_name' - - $ref: '#/components/parameters/Query.Ser_category_id' - - $ref: '#/components/parameters/Query.Consumed_local_only' - - $ref: '#/components/parameters/Query.Is_local' - - $ref: '#/components/parameters/Query.LocalityTypes' - responses: - '200': - $ref: '#/components/responses/Services.200' - '400': - $ref: '#/components/responses/Error.400' - '403': - $ref: '#/components/responses/Error.403' - '404': - $ref: '#/components/responses/Error.404' - '/services/{serviceId}': - parameters: - - $ref: '#/components/parameters/Path.ServiceId' - get: - description: >- - This method retrieves information about a meService resource. This - method is typically used in "service availability query" procedure - operationId: ServicesServiceId_GET - tags: - - services - responses: - '200': - $ref: '#/components/responses/ServicesServiceId.200' - '400': - $ref: '#/components/responses/Error.400' - '403': - $ref: '#/components/responses/Error.403' - '404': - $ref: '#/components/responses/Error.404' - '/timing/current_time': - get: - description: >- - This method retrieves the information of the platform's current time - which corresponds to the get platform time procedure - operationId: TimingCurrentTime_GET - tags: - - timing - responses: - '200': - $ref: '#/components/responses/TimingCurrentTime.200' - '400': - $ref: '#/components/responses/Error.400' - '403': - $ref: '#/components/responses/Error.403' - '404': - $ref: '#/components/responses/Error.404' - '/timing/timing_caps': - get: - description: >- - This method retrieves the information of the platform's timing - capabilities which corresponds to the timing capabilities query - operationId: TimingCaps_GET - tags: - - timing - responses: - '200': - $ref: '#/components/responses/TimingCaps.200' - '400': - $ref: '#/components/responses/Error.400' - '403': - $ref: '#/components/responses/Error.403' - '404': - $ref: '#/components/responses/Error.404' - '/transports': - get: - description: >- - This method retrieves information about a list of available transports. - This method is typically used by a service-producing application to - discover transports provided by the mobile edge platform in the - "transport information query" procedure - operationId: Transports_GET - tags: - - transports - responses: - '200': - $ref: '#/components/responses/Transports.200' - '400': - $ref: '#/components/responses/Error.400' - '403': - $ref: '#/components/responses/Error.403' - '404': - $ref: '#/components/responses/Error.404' -components: - schemas: - Empty: - description: Empty schema - AppTerminationNotification.Links: - description: >- - List of hyperlinks related to the resource. - type: object - required: - - subscription - properties: - subscription: - $ref: '#/components/schemas/LinkType' - confirmTermination: - $ref: '#/components/schemas/LinkType.ConfirmTermination' - AppTerminationNotification.MaxGracefulTimeout: - description: >- - Maximum timeout value in seconds for graceful termination or graceful - stop of an application instance. - type: integer - format: uint32 - example: 10 - AppTerminationNotification.NotificationType: - description: Shall be set to AppTerminationNotification. - type: string - example: 'AppTerminationNotification' - AppTerminationNotification: - description: >- - This type represents the information that the mobile edge platform - notifies the subscribed application instance about the corresponding - application instance termination/stop. - type: object - required: - - notificationType - - maxGracefulTimeout - - _links - properties: - notificationType: - $ref: '#/components/schemas/AppTerminationNotification.NotificationType' - maxGracefulTimeout: - $ref: '#/components/schemas/AppTerminationNotification.MaxGracefulTimeout' - _links: - $ref: '#/components/schemas/AppTerminationNotification.Links' - AppTerminationNotificationSubscription.AppInstanceId: - description: It is used as the filtering criterion for the subscribed events. - type: string - example: 'ID1' - AppTerminationNotificationSubscription.CallbackReference: - description: >- - URI selected by the mobile edge application instance to receive - notifications on the subscribed mobile edge application instance - management information. This shall be included in both the request and - the response. - type: string - format: uri - AppTerminationNotificationSubscription: - description: >- - This type represents the information that the mobile edge platform - notifies the subscribed application instance about the corresponding - application instance termination/stop. - type: object - required: - - subscriptionType - - callbackReference - - _links - - appInstanceId - properties: - subscriptionType: - $ref: >- - #/components/schemas/AppTerminationNotificationSubscription.SubscriptionType - callbackReference: - $ref: >- - #/components/schemas/AppTerminationNotificationSubscription.CallbackReference - _links: - $ref: '#/components/schemas/Self' - appInstanceId: - $ref: >- - #/components/schemas/AppTerminationNotificationSubscription.AppInstanceId - AppTerminationNotificationSubscription.SubscriptionType: - description: Shall be set to AppTerminationNotificationSubscription. - type: string - example: 'AppTerminationNotificationSubscription' - CategoryRef.Href: - description: Reference of the catalogue - type: string - example: 'catItem1' - CategoryRef.Id: - description: Unique identifier of the category - type: string - example: 'id12345' - CategoryRef.Name: - description: Name of the category, example values include RNI, Location & Bandwidth Management - type: string - example: 'RNI' - CategoryRef.Version: - description: Category version - type: string - example: 'version1' - CategoryRef: - description: This type represents the category reference - type: object - required: - - href - - id - - name - - version - properties: - href: - $ref: '#/components/schemas/CategoryRef.Href' - id: - $ref: '#/components/schemas/CategoryRef.Id' - name: - $ref: '#/components/schemas/CategoryRef.Name' - version: - $ref: '#/components/schemas/CategoryRef.Version' - CurrentTime: - description: >- - This type represents the information provided by the mobile edge - platform in response to the Get Platform Time Request message. - type: object - required: - - nanoSeconds - - seconds - - timeSourceStatus - properties: - seconds: - type: integer - format: uint32 - description: >- - The seconds part of the time. Time is defined as Unix-time since - January 1, 1970, 00:00:00 UTC - example: 1577836800 - nanoSeconds: - type: integer - format: uint32 - description: >- - The nanoseconds part of the time. Time is defined as Unix-time since - January 1, 1970, 00:00:00 UTC - example: 0 - timeSourceStatus: - type: string - enum: - - TRACEABLE - - NONTRACEABLE - description: >- - Platform Time Source status. 1 = TRACEABLE - time source is locked - to the UTC time source. 2 = NONTRACEABLE - time source is not locked - to the UTC time source - example: 'TRACEABLE' - DestinationInterface.InterfaceType: - description: Type of the interface - type: string - enum: - - TUNNEL - - MAC - - IP - example: 'TUNNEL' - DestinationInterface.IpAddress: - description: IP address of the remote destination - type: string - example: '192.0.2.0' - DestinationInterface.MacAddress: - description: Source address identifies the MAC address of the interface - type: string - example: '02-00-00-00-00-00' - DestinationInterface: - description: This type represents the destination interface. - type: object - required: - - interfaceType - properties: - interfaceType: - $ref: '#/components/schemas/DestinationInterface.InterfaceType' - tunnelInfo: - $ref: '#/components/schemas/TunnelInfo' - srcMacAddress: - $ref: '#/components/schemas/DestinationInterface.MacAddress' - dstMacAddress: - $ref: '#/components/schemas/DestinationInterface.MacAddress' - dstIpAddress: - $ref: '#/components/schemas/DestinationInterface.IpAddress' - DnsRule.DomainName: - description: FQDN resolved by the DNS rule - type: string - example: 'www.example.com' - DnsRule.Id: - description: Identifies the DNS Rule - type: string - example: 'dnsRule1' - DnsRule.IpAddress: - description: IP address associated with the FQDN resolved by the DNS rule - type: string - example: '192.0.2.0' - DnsRule.IpAddressType: - description: IP address type - type: string - enum: - - IP_V6 - - IP_V4 - example: 'IP_V6' - DnsRule.State: - description: DNS rule state - type: string - enum: - - ACTIVE - - INACTIVE - example: 'ACTIVE' - DnsRule.Ttl: - description: Time to live value - type: integer - format: uint32 - example: '?' - DnsRule: - description: This type represents the general information of a DNS rule. - type: object - required: - - dnsRuleId - - domainName - - ipAddressType - - ipAddress - - state - properties: - dnsRuleId: - $ref: '#/components/schemas/DnsRule.Id' - domainName: - $ref: '#/components/schemas/DnsRule.DomainName' - ipAddressType: - $ref: '#/components/schemas/DnsRule.IpAddressType' - ipAddress: - $ref: '#/components/schemas/DnsRule.IpAddress' - ttl: - $ref: '#/components/schemas/DnsRule.Ttl' - state: - $ref: '#/components/schemas/DnsRule.State' - EndPointInfo.Address.Host: - description: Host portion of the address - type: string - example: '192.0.2.0' - EndPointInfo.Address_Port: - description: Port portion of the address - type: integer - format: uint32 - example: 8080 - EndPointInfo.Address: - description: A IP address and port pair - type: object - required: - - host - - port - properties: - host: - $ref: '#/components/schemas/EndPointInfo.Address.Host' - port: - $ref: '#/components/schemas/EndPointInfo.Address_Port' - EndPointInfo.Addresses: - description: >- - Entry point information of the service as one or more pairs of IP - address and port - type: object - required: - - addresses - properties: - addresses: - type: array - minItems: 0 - items: - $ref: '#/components/schemas/EndPointInfo.Address' - EndPointInfo.Alternative: - description: >- - Entry point information of the service in a format defined by an - implementation, or in an external specification. - type: object - required: - - alternative - properties: - alternative: - type: object - EndPointInfo.Uri: - description: Entry point information of the service - type: string - format: uri - example: '/meMp1/service/EntryPoint' - EndPointInfo.Uris: - description: >- - Entry point information of the service as string, formatted according to - URI syntax - type: object - required: - - uris - properties: - uris: - type: array - minItems: 0 - items: - $ref: '#/components/schemas/EndPointInfo.Uri' - LinkType: - description: This type represents a type of link and may be referenced from data structures - type: object - properties: - href: - $ref: '#/components/schemas/Href' - LinkType.ConfirmTermination: - description: >- - Link to the task resource where to confirm termination in case the - application is ready to be terminated before expiry of the timeout. - type: object - properties: - href: - $ref: '#/components/schemas/Href' - Href: - description: URI referring to a resource - type: string - format: uri - example: '/meMp1/example' - Mp1SubscriptionLinkList.Links: - description: Self-referring URI. - type: object - required: - - self - properties: - self: - $ref: '#/components/schemas/LinkType' - subscriptions: - description: The MEC application instance's subscriptions - type: array - items: - $ref: '#/components/schemas/Mp1SubscriptionLinkList.Subscription' - Mp1SubscriptionLinkList.Subscription: - description: A link to a subscription. - type: object - required: - - href - - rel - properties: - href: - $ref: '#/components/schemas/Href' - rel: - description: >- - The values are as defined in the "subscriptionType" attribute for - each different Mp1 event subscription data type. - type: string - enum: - - AppTerminationNotificationSubscription - - SerAvailabilityNotificationSubscription - Mp1SubscriptionLinkList: - description: >- - This type represents a list of links related to currently existing - subscriptions for a mobile edge application instance. This information - is returned when sending a request to receive current subscriptions. - type: object - required: - - _links - properties: - _links: - $ref: '#/components/schemas/Mp1SubscriptionLinkList.Links' - ProblemDetails: - type: object - 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.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 - Problem.status: - type: integer - format: uint32 - description: The HTTP status code for this occurrence of the problem - Problem.title: - type: string - description: 'A short, human-readable summary of the problem type' - Problem.type: - type: string - format: uri - description: >- - A URI reference according to IETF RFC 3986 that identifies the problem - type - SecurityInfo.OAuth2Info.GrantTypes: - description: List of supported OAuth 2.0 grant types - type: string - enum: - - OAUTH2_AUTHORIZATION_CODE - - OAUTH2_IMPLICIT_GRANT - - OAUTH2_RESOURCE_OWNER - - OAUTH2_CLIENT_CREDENTIALS - example: 'OAUTH2_CLIENT_CREDENTIALS' - SecurityInfo.OAuth2Info.TokenEndpoint: - description: The token endpoint - type: string - format: uri - example: '/meMp1/security/TokenEndPoint' - SecurityInfo.OAuth2Info: - description: Parameters related to use of OAuth 2.0 - required: - - grantTypes - - tokenEndpoint - properties: - grantTypes: - description: >- - List of supported OAuth 2.0 grant types. - type: array - minItems: 1 - maxItems: 4 - items: - $ref: '#/components/schemas/SecurityInfo.OAuth2Info.GrantTypes' - tokenEndpoint: - $ref: '#/components/schemas/SecurityInfo.OAuth2Info.TokenEndpoint' - type: object - SecurityInfo: - description: This type represents security information related to a transport - type: object - properties: - oAuth2Info: - $ref: '#/components/schemas/SecurityInfo.OAuth2Info' - Self: - description: Self-referring URI. - type: object - required: - - self - properties: - self: - $ref: '#/components/schemas/LinkType' - readOnly: true - SerAvailabilityNotificationSubscription.CallbackReference: - description: >- - URI selected by the mobile edge application instance to receive - notifications on the subscribed mobile edge service availability - information. This shall be included in both the request and the - response. - type: string - format: uri - SerAvailabilityNotificationSubscription: - description: >- - This type represents a subscription to the notifications from the mobile - edge platform regarding the availability of a mobile edge service or a - list of mobile edge services. - type: object - required: - - subscriptionType - - callbackReference - - _links - - filteringCriteria - properties: - subscriptionType: - $ref: >- - #/components/schemas/SerAvailabilityNotificationSubscription.SubscriptionType - callbackReference: - $ref: >- - #/components/schemas/SerAvailabilityNotificationSubscription.CallbackReference - _links: - $ref: '#/components/schemas/Self' - filteringCriteria: - $ref: '#/components/schemas/ServiceInfo' - SerAvailabilityNotificationSubscription.SubscriptionType: - description: Shall be set to SerAvailabilityNotificationSubscription. - type: string - example: 'SerAvailabilityNotificationSubscription' - ServiceAvailabilityNotification: - description: >- - This type represents the service availability information. - type: object - required: - - notificationType - - services - - _links - properties: - notificationType: - $ref: >- - #/components/schemas/SerAvailabilityNotificationSubscription.SubscriptionType - services: - type: array - items: - $ref: '#/components/schemas/ServiceInfo' - _links: - $ref: '#/components/schemas/Subscription' - SerializerTypes: - description: The enumeration SerializerTypes represents types of serializers - type: string - enum: - - JSON - - XML - - PROTOBUF3 - example: 'JSON' - LocalityTypes: - description: The scope of locality as expressed by "consumedLocalOnly" and "isLocal". If absent, defaults to MEC_HOST - type: string - enum: - - MEC_SYSTEM - - MEC_HOST - - NFVI_POP - - ZONE - - ZONE_GROUP - - NFVI_NODE - example: 'MEC_SYSTEM' - ServiceInfo.SerInstanceId: - description: >- - Identifier of the service instance assigned by the MEPM / mobile edge - platform. - type: string - readOnly: true - example: 'ServiceInstance123' - ServiceInfo.SerName: - description: >- - The name of the service. This is how the service producing mobile edge - application identifies the service instance it produces. - type: string - example: 'ExampleService' - ServiceInfo.State: - description: Contains the state - type: string - enum: - - ACTIVE - - INACTIVE - example: 'ACTIVE' - ServiceInfo.TransportId: - description: >- - Identifier of the platform-provided transport to be used by the service. - Valid identifiers may be obtained using the "Transport information - query" procedure. May be present in POST requests to signal the use of a - platform-provided transport for the service, and shall be absent - otherwise. - type: string - writeOnly: true - example: 'Rest1' - ServiceInfo.Version: - description: Service version - type: string - example: 'ServiceVersion1' - ServiceInfo.ConsumedLocalOnly: - description: >- - Indicate whether the service can only be consumed by the MEC applications - located in the same locality (as defined by scopeOfLocality) as this - service instance. - type: boolean - example: false - ServiceInfo.IsLocal: - description: >- - Indicate whether the service is located in the same locality (as defined - by scopeOfLocality) as the consuming MEC application. - type: boolean - example: true - ServiceInfo.Post: - description: This type represents the general information of a mobile edge service. - type: object - required: - - serName - - version - - state - - serializer - oneOf: - - required: [transportId] - - required: [transportInfo] - properties: - serInstanceId: - $ref: '#/components/schemas/ServiceInfo.SerInstanceId' - serName: - $ref: '#/components/schemas/ServiceInfo.SerName' - serCategory: - $ref: '#/components/schemas/CategoryRef' - version: - $ref: '#/components/schemas/ServiceInfo.Version' - state: - $ref: '#/components/schemas/ServiceInfo.State' - transportId: - $ref: '#/components/schemas/ServiceInfo.TransportId' - transportInfo: - $ref: '#/components/schemas/TransportInfo' - serializer: - $ref: '#/components/schemas/SerializerTypes' - scopeOfLocality: - $ref: '#/components/schemas/LocalityTypes' - consumedLocalOnly: - $ref: '#/components/schemas/ServiceInfo.ConsumedLocalOnly' - isLocal: - $ref: '#/components/schemas/ServiceInfo.IsLocal' - ServiceInfo: - description: This type represents the general information of a mobile edge service. - type: object - required: - - serName - - version - - state - - transportInfo - - serializer - properties: - serInstanceId: - $ref: '#/components/schemas/ServiceInfo.SerInstanceId' - serName: - $ref: '#/components/schemas/ServiceInfo.SerName' - serCategory: - $ref: '#/components/schemas/CategoryRef' - version: - $ref: '#/components/schemas/ServiceInfo.Version' - state: - $ref: '#/components/schemas/ServiceInfo.State' - transportInfo: - $ref: '#/components/schemas/TransportInfo' - serializer: - $ref: '#/components/schemas/SerializerTypes' - scopeOfLocality: - $ref: '#/components/schemas/LocalityTypes' - consumedLocalOnly: - $ref: '#/components/schemas/ServiceInfo.ConsumedLocalOnly' - isLocal: - $ref: '#/components/schemas/ServiceInfo.IsLocal' - Subscription: - description: A link to the related subscription - type: object - required: - - subscription - properties: - subscription: - $ref: '#/components/schemas/LinkType' - TimingCaps.NtpServers.AuthenticationKeyNum: - description: Authentication key number - type: integer - format: uint32 - example: 1 - TimingCaps.NtpServers.AuthenticationOption: - description: NTP authentication option - type: string - enum: - - NONE - - SYMMETRIC_KEY - - AUTO_KEY - example: 'NONE' - TimingCaps.NtpServers.DelayReqMaxRate: - description: Acceptable maximum rate of the Delay_Req messages in packets per second - type: integer - format: uint32 - example: 10 - TimingCaps.NtpServers.LocalPriority: - description: NTP server local priority - type: integer - format: uint32 - example: 1 - TimingCaps.NtpServers.MaxPollingInterval: - description: >- - Maximum poll interval for NTP messages, in seconds as a power of two. - Range 3...17 - type: integer - format: uint32 - example: 17 - TimingCaps.NtpServers.MinPollingInterval: - description: >- - Minimum poll interval for NTP messages, in seconds as a power of two. - Range 3...17 - type: integer - format: uint32 - example: 3 - TimingCaps.NtpServers.NtpServerAddr: - description: NTP server address - type: string - example: '192.0.2.0' - TimingCaps.NtpServers.NtpServerAddrType: - description: Address type of NTP server - type: string - enum: - - IP_ADDRESS - - DNS_NAME - example: 'IP_ADDRESS' - TimingCaps.NtpServers_PtpMasterIpAddress: - description: PTP Master IP Address - type: string - example: '192.0.2.0' - TimingCaps.NtpServers_PtpMasterLocalPriority: - description: PTP Master local priority - type: integer - format: uint32 - example: 1 - TimingCaps.NtpServers: - description: NTP server detail. - type: object - required: - - ntpServerAddrType - - ntpServerAddr - - minPollingInterval - - maxPollingInterval - - localPriority - - authenticationOption - - authenticationKeyNum - properties: - ntpServerAddrType: - $ref: '#/components/schemas/TimingCaps.NtpServers.NtpServerAddrType' - ntpServerAddr: - $ref: '#/components/schemas/TimingCaps.NtpServers.NtpServerAddr' - minPollingInterval: - $ref: '#/components/schemas/TimingCaps.NtpServers.MinPollingInterval' - maxPollingInterval: - $ref: '#/components/schemas/TimingCaps.NtpServers.MaxPollingInterval' - localPriority: - $ref: '#/components/schemas/TimingCaps.NtpServers.LocalPriority' - authenticationOption: - $ref: '#/components/schemas/TimingCaps.NtpServers.AuthenticationOption' - authenticationKeyNum: - $ref: '#/components/schemas/TimingCaps.NtpServers.AuthenticationKeyNum' - TimingCaps_PtpMasters: - description: NTP server detail. - type: object - required: - - ptpMasterIpAddress - - ptpMasterLocalPriority - - delayReqMaxRate - properties: - ptpMasterIpAddress: - $ref: '#/components/schemas/TimingCaps.NtpServers_PtpMasterIpAddress' - ptpMasterLocalPriority: - $ref: '#/components/schemas/TimingCaps.NtpServers_PtpMasterLocalPriority' - delayReqMaxRate: - $ref: '#/components/schemas/TimingCaps.NtpServers.DelayReqMaxRate' - TimingCaps.TimeStamp: - description: time - type: object - required: - - nanoSeconds - - seconds - properties: - seconds: - type: integer - format: uint32 - description: >- - The seconds part of the time. Time is defined as Unix-time since - January 1, 1970, 00:00:00 UTC - example: 1577836800 - nanoSeconds: - type: integer - format: uint32 - description: >- - The nanoseconds part of the time. Time is defined as Unix-time since - January 1, 1970, 00:00:00 UTC - example: 0 - TimingCaps: - description: >- - This type represents the information provided by the mobile edge - platform in response to the Timing capabilities Query message. - type: object - properties: - timeStamp: - $ref: '#/components/schemas/TimingCaps.TimeStamp' - ntpServers: - description: Available NTP servers - type: array - items: - $ref: '#/components/schemas/TimingCaps.NtpServers' - ptpMasters: - description: Available PTP Masters - type: array - items: - $ref: '#/components/schemas/TimingCaps_PtpMasters' - TrafficFilter.Address: - description: Identify the traffic ip address. - type: string - example: '192.168.1.1' - TrafficFilter.DSCP: - description: >- - Used to match all IPv4 packets that have the same Differentiated - Services Code Point (DSCP) - type: integer - format: uint32 - example: 0 - TrafficFilter.Port: - description: A port - type: string - example: '8080' - TrafficFilter.Protocol: - description: Protocol of the traffic filter - type: string - example: '?' - TrafficFilter.QCI: - description: >- - Used to match all packets that have the same Quality Class Indicator - (QCI). - type: integer - format: uint32 - example: 1 - TrafficFilter.TC: - description: Used to match all IPv6 packets that have the same Traffic Class. - type: integer - format: uint32 - example: 1 - TrafficFilter.Token: - description: Used for token based traffic rule - type: string - example: '?' - TrafficFilter.TunnelAddress: - description: Used for GTP tunnel based traffic rule - type: string - example: '?' - TrafficFilter.TunnelPort: - description: Used for GTP tunnel based traffic rule - type: string - example: '?' - TrafficFilter: - description: This type represents the traffic filter. - type: object - properties: - srcAddress: - description: >- - An IP address or a range of IP address. For IPv4, the IP address - could be an IP address plus mask, or an individual IP address, or a - range of IP addresses. For IPv6, the IP address could be an IP - prefix, or a range of IP prefixes. - type: array - items: - $ref: '#/components/schemas/TrafficFilter.Address' - dstAddress: - description: >- - An IP address or a range of IP address. For IPv4, the IP address - could be an IP address plus mask, or an individual IP address, or a - range of IP addresses. For IPv6, the IP address could be an IP - prefix, or a range of IP prefixes. - type: array - items: - $ref: '#/components/schemas/TrafficFilter.Address' - srcPort: - description: A port or a range of ports - type: array - items: - $ref: '#/components/schemas/TrafficFilter.Port' - dstPort: - description: A port or a range of ports - type: array - items: - $ref: '#/components/schemas/TrafficFilter.Port' - protocol: - description: Specify the protocol of the traffic filter - type: array - items: - $ref: '#/components/schemas/TrafficFilter.Protocol' - token: - description: Used for token based traffic rule - type: array - items: - $ref: '#/components/schemas/TrafficFilter.Token' - srcTunnelAddress: - description: Used for GTP tunnel based traffic rule - type: array - items: - $ref: '#/components/schemas/TrafficFilter.TunnelAddress' - tgtTunnelAddress: - description: Used for GTP tunnel based traffic rule - type: array - items: - $ref: '#/components/schemas/TrafficFilter.TunnelAddress' - srcTunnelPort: - description: Used for GTP tunnel based traffic rule - type: array - items: - $ref: '#/components/schemas/TrafficFilter.TunnelPort' - dstTunnelPort: - description: Used for GTP tunnel based traffic rule - type: array - items: - $ref: '#/components/schemas/TrafficFilter.TunnelPort' - qCI: - $ref: '#/components/schemas/TrafficFilter.QCI' - dSCP: - $ref: '#/components/schemas/TrafficFilter.DSCP' - tC: - $ref: '#/components/schemas/TrafficFilter.TC' - TrafficRule.Action: - description: >- - The action of the ME host data plane when a packet matches the - trafficFilter - type: string - enum: - - DROP - - FORWARD_DECAPSULATED - - FORWARD_AS_IS - - PASSTHROUGH - - DUPLICATE_DECAPSULATED - - DUPLICATE_AS_IS - example: 'DROP' - TrafficRule.FilterType: - description: >- - Definition of filter per FLOW or PACKET. If flow the filter match - UE->EPC packet and the reverse packet is handled in the same context - type: string - enum: - - FLOW - - PACKET - example: FLOW - TrafficRule.Id: - description: Identify the traffic rule. - type: string - example: 'TrafficRule1' - TrafficRule_Priority: - description: >- - Priority of this traffic rule. If traffic rule conflicts, the one with - higher priority take precedence - type: integer - format: uint32 - example: 1 - TrafficRule.State: - description: Contains the traffic rule state - type: string - enum: - - ACTIVE - - INACTIVE - example: 'ACTIVE' - TrafficRule: - description: This type represents the general information of a traffic rule. - type: object - required: - - trafficRuleId - - filterType - - priority - - trafficFilter - - action - - state - properties: - trafficRuleId: - $ref: '#/components/schemas/TrafficRule.Id' - filterType: - $ref: '#/components/schemas/TrafficRule.FilterType' - priority: - $ref: '#/components/schemas/TrafficRule_Priority' - trafficFilter: - type: array - items: - $ref: '#/components/schemas/TrafficFilter' - action: - $ref: '#/components/schemas/TrafficRule.Action' - dstInterface: - $ref: '#/components/schemas/DestinationInterface' - state: - $ref: '#/components/schemas/TrafficRule.State' - TransportInfo.Description: - description: Human-readable description of this transport - type: string - example: 'REST API' - TransportInfo.Id: - description: The identifier of this transport - type: string - example: 'TransId12345' - TransportInfo.ImplSpecificInfo: - description: Additional implementation specific details of the transport - type: object - TransportInfo.Name: - description: The name of this transport - type: string - example: 'REST' - TransportInfo.Protocol: - description: The name of the protocol used. Shall be set to HTTP for a REST API. - type: string - example: 'HTTP' - TransportInfo.Version: - description: The version of the protocol used - type: string - example: '2.0' - TransportInfo: - description: This type represents the general information of a mobile edge service. - type: object - required: - - id - - name - - type - - protocol - - version - - endpoint - - security - properties: - id: - $ref: '#/components/schemas/TransportInfo.Id' - name: - $ref: '#/components/schemas/TransportInfo.Name' - description: - $ref: '#/components/schemas/TransportInfo.Description' - type: - $ref: '#/components/schemas/TransportTypes' - protocol: - $ref: '#/components/schemas/TransportInfo.Protocol' - version: - $ref: '#/components/schemas/TransportInfo.Version' - endpoint: - description: This type represents information about a transport endpoint - type: object - oneOf: - - $ref: '#/components/schemas/EndPointInfo.Uris' - - $ref: '#/components/schemas/EndPointInfo.Addresses' - - $ref: '#/components/schemas/EndPointInfo.Alternative' - security: - $ref: '#/components/schemas/SecurityInfo' - implSpecificInfo: - $ref: '#/components/schemas/TransportInfo.ImplSpecificInfo' - TransportTypes: - description: The enumeration TransportTypes represents types of transports - type: string - enum: - - REST_HTTP - - MB_TOPIC_BASED - - MB_ROUTING - - MB_PUBSUB - - RPC - - RPC_STREAMING - - WEBSOCKET - example: 'REST_HTTP' - TunnelInfo.TunnelDstAddress: - description: Destination address of the tunnel - type: string - example: '?' - TunnelInfo.TunnelSrcAddress: - description: Source address of the tunnel - type: string - example: '?' - TunnelInfo.TunnelType: - description: This type represents the tunnel information. - type: string - enum: - - GTP_U - - GRE - example: 'GTP_U' - TunnelInfo: - description: This type represents the tunnel information. - type: object - required: - - tunnelType - properties: - tunnelType: - $ref: '#/components/schemas/TunnelInfo.TunnelType' - tunnelDstAddress: - $ref: '#/components/schemas/TunnelInfo.TunnelDstAddress' - tunnelSrcAddress: - $ref: '#/components/schemas/TunnelInfo.TunnelSrcAddress' - parameters: - Path.AppInstanceId: - name: appInstanceId - description: >- - Represents a mobile edge application instance. Note that the - appInstanceId is allocated by the mobile edge platform manager. - in: path - required: true - schema: - type: string - Path.DnsRuleId: - name: dnsRuleId - description: Represents a DNS rule. - in: path - required: true - schema: - type: string - Path.SubscriptionId: - name: subscriptionId - description: >- - Represents a subscription to the notifications from the mobile edge - platform. - in: path - required: true - schema: - type: string - Path.SubscriptionType: - name: subscriptionType - description: >- - Represents a subscription type to the notifications from the mobile edge - platform. - in: path - required: true - schema: - type: string - enum: - - AppTerminationNotificationSubscription - - SerAvailabilityNotificationSubscription - Path.ServiceId: - name: serviceId - description: Represents a mobile edge service instance. - in: path - required: true - schema: - type: string - Path.TrafficRuleId: - name: trafficRuleId - description: Represents a traffic rule. - in: path - required: true - schema: - type: string - Query.Ser_category_id: - name: ser_category_id - description: >- - A mobile edge application instance may use ser_category_id as an input - parameter to query the availability of a list of mobile edge service - instances in a serCategory. Either "ser_instance_id" or "ser_name" or - "ser_category_id" or none of them shall be present. - in: query - required: false - schema: - type: string - Query.Ser_instance_id: - name: ser_instance_id - description: >- - A mobile edge application instance may use multiple ser_instance_ids as - an input parameter to query the availability of a list of mobile edge - service instances. Either "ser_instance_id" or "ser_name" or - "ser_category_id" or none of them shall be present. - in: query - required: false - schema: - type: array - items: - type: string - Query.Ser_name: - name: ser_name - description: >- - A mobile edge application instance may use multiple ser_names as an - input parameter to query the availability of a list of mobile edge - service instances. Either "ser_instance_id" or "ser_name" or - "ser_category_id" or none of them shall be present. - in: query - required: false - schema: - type: array - items: - type: string - Query.LocalityTypes: - name: scope_of_locality - description: >- - A MEC application instance may use scope_of_locality as an input - parameter to query the availability of a list of MEC service instances - with a certain scope of locality. - in: query - required: false - schema: - type: string - Query.Is_local: - name: is_local - description: >- - Indicate whether the service is located in the same locality (as - defined by scopeOfLocality) as the consuming MEC application. - in: query - required: false - schema: - type: boolean - Query.Consumed_local_only: - name: consumed_local_only - description: >- - Indicate whether the service can only be consumed by the MEC - applications located in the same locality (as defined by - scopeOfLocality) as this service instance. - in: query - required: false - schema: - type: boolean - responses: - ApplicationsDnsRules.200: - description: >- - It is used to indicate nonspecific success. The response body - contains a representation of the resource. - content: - application/json: - schema: - type: array - minItems: 0 - items: - $ref: '#/components/schemas/DnsRule' - examples: - DnsRules: - $ref: '#/components/examples/DnsRules' - links: - getIndividualMeDNSRule: - $ref: '#/components/links/GetIndividualMeDNSRule' - putIndividualMeDNSRule: - $ref: '#/components/links/PutIndividualMeDNSRule' - ApplicationsDnsRule.200: - description: >- - It is used to indicate nonspecific success. The response body - contains a representation of the resource. - content: - application/json: - schema: - $ref: '#/components/schemas/DnsRule' - examples: - DnsRule: - $ref: '#/components/examples/DnsRule' - ApplicationsSubscriptions.200: - description: >- - Upon success, a response body containing the list of links to the - requested subscriptions is returned. - content: - application/json: - schema: - $ref: '#/components/schemas/Mp1SubscriptionLinkList' - links: - getIndividualMeMp1SubscriptionLinkList: - $ref: '#/components/links/GetIndividualMeMp1SubscriptionLinkList' - delIndividualMeMp1SubscriptionLinkList: - $ref: '#/components/links/DelIndividualMeMp1SubscriptionLinkList' - ApplicationsSubscriptions.201: - description: >- - Entity body in the request contains a subscription to the mobile - edge service availability notifications that is to be created. - headers: - location: - description: The resource URI of the created resource - schema: - type: string - format: uri - content: - application/json: - schema: - oneOf: - - $ref: '#/components/schemas/AppTerminationNotificationSubscription' - - $ref: '#/components/schemas/SerAvailabilityNotificationSubscription' - links: - getIndividualMeMp1Subscription: - $ref: '#/components/links/GetIndividualMeMp1Subscription' - delIndividualMeMp1Subscription: - $ref: '#/components/links/DelIndividualMeMp1Subscription' - ApplicationsSubscription.200: - description: >- - Upon success, a response body containing the requested subscription - is returned. - content: - application/json: - schema: - oneOf: - - $ref: '#/components/schemas/AppTerminationNotificationSubscription' - - $ref: '#/components/schemas/SerAvailabilityNotificationSubscription' - ApplicationsTrafficRules.200: - description: >- - It is used to indicate nonspecific success. The response body - contains a representation of the resource. - content: - application/json: - schema: - type: array - minItems: 0 - items: - $ref: '#/components/schemas/TrafficRule' - examples: - TrafficRules: - $ref: '#/components/examples/TrafficRules' - links: - getIndividualMeTrafficRule: - $ref: '#/components/links/GetIndividualMeTrafficRule' - putIndividualMeTrafficRule: - $ref: '#/components/links/PutIndividualMeTrafficRule' - ApplicationsTrafficRule.200: - description: >- - It is used to indicate nonspecific success. The response body - contains a representation of the resource. - content: - application/json: - schema: - $ref: '#/components/schemas/TrafficRule' - examples: - TrafficRule: - $ref: '#/components/examples/TrafficRule' - Services.200: - description: >- - It is used to indicate nonspecific success. The response body - contains a representation of the resource. - content: - application/json: - schema: - type: array - minItems: 0 - items: - $ref: '#/components/schemas/ServiceInfo' - examples: - ServiceInfoList: - $ref: '#/components/examples/ServiceInfoList' - links: - getIndividualMeService: - $ref: '#/components/links/GetIndividualMeService' - putIndividualMeService: - $ref: '#/components/links/PutIndividualMeService' - Services.201: - description: >- - Upon success, the HTTP response shall include a Location HTTP header - that contains the resource URI of the created resource. - headers: - location: - description: The resource URI of the created resource - schema: - type: string - format: uri - content: - application/json: - schema: - $ref: '#/components/schemas/ServiceInfo' - examples: - ServiceInfo: - $ref: '#/components/examples/ServiceInfo' - links: - getIndividualMeService: - $ref: '#/components/links/GetIndividualMeService' - putIndividualMeService: - $ref: '#/components/links/PutIndividualMeService' - ServicesServiceId.200: - description: >- - It is used to indicate nonspecific success. The response body - contains a representation of the resource. - content: - application/json: - schema: - $ref: '#/components/schemas/ServiceInfo' - examples: - ServiceInfo: - $ref: '#/components/examples/ServiceInfo' - TimingCurrentTime.200: - description: >- - It is used to indicate nonspecific success. The response body - contains a representation of the resource. - content: - application/json: - schema: - $ref: '#/components/schemas/CurrentTime' - TimingCaps.200: - description: >- - It is used to indicate nonspecific success. The response body - contains a representation of the resource. - content: - application/json: - schema: - $ref: '#/components/schemas/TimingCaps' - Transports.200: - description: >- - It is used to indicate nonspecific success. The response body - contains a representation of the resource. - content: - application/json: - schema: - type: array - minItems: 0 - items: - $ref: '#/components/schemas/TransportInfo' - links: - getTransportInfo: - $ref: '#/components/links/GetTransportInfo' - 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' - Error.409: - description: >- - Conflict. - The operation cannot be executed currently, due to a conflict with - the state of the resource. Typically, this is because the application - instance resource is in NOT_INSTANTIATED state. - content: - application/problem+json: - schema: - $ref: '#/components/schemas/ProblemDetails' - text/plain: - schema: - $ref: '#/components/schemas/Empty' - Error.412: - description: >- - Precondition Failed. - It is used when a condition has failed during conditional requests, - e.g. when using ETags to avoid write conflicts. - content: - application/problem+json: - schema: - $ref: '#/components/schemas/ProblemDetails' - text/plain: - schema: - $ref: '#/components/schemas/Empty' - Error.429: - description: >- - Too Many Requests. - It is used when a rate limiter has triggered. - content: - application/problem+json: - schema: - $ref: '#/components/schemas/ProblemDetails' - text/plain: - schema: - $ref: '#/components/schemas/Empty' - requestBodies: - ApplicationsDnsRule: - content: - application/json: - schema: - $ref: '#/components/schemas/DnsRule' - description: The updated state is included in the entity body of the request. - required: true - ApplicationsSubscriptions: - content: - application/json: - schema: - oneOf: - - $ref: '#/components/schemas/AppTerminationNotificationSubscription' - - $ref: '#/components/schemas/SerAvailabilityNotificationSubscription' - description: >- - Entity body in the request contains a subscription to the mobile edge - application termination notifications that is to be created. - required: true - ApplicationsTrafficRule: - content: - application/json: - schema: - $ref: '#/components/schemas/TrafficRule' - description: One or more updated attributes that are allowed to be changed - required: true - Services: - content: - application/json: - schema: - $ref: '#/components/schemas/ServiceInfo' - description: >- - New ServiceInfo with updated "state" is included as entity body of the - request - required: true - Services.Post: - content: - application/json: - schema: - $ref: '#/components/schemas/ServiceInfo.Post' - description: >- - New ServiceInfo with updated "state" is included as entity body of the - request - required: true - ServicesServiceId: - content: - application/json: - schema: - $ref: '#/components/schemas/ServiceInfo' - description: >- - New ServiceInfo with updated "state" is included as entity body of the - request - required: true - AppTerminationNotification: - content: - application/json: - schema: - $ref: '#/components/schemas/AppTerminationNotification' - required: true - ServiceAvailabilityNotification: - content: - application/json: - schema: - $ref: '#/components/schemas/ServiceAvailabilityNotification' - required: true - callbacks: - AppTerminationNotification: - '{$request.body#/callbackReference}': - post: - description: >- - Represents the information that the MEP notifies the - subscribed application instance about the corresponding - application instance termination/stop - operationId: AppTerminationNotification_POST - tags: - - callback - requestBody: - $ref: '#/components/requestBodies/AppTerminationNotification' - responses: - '200': - description: Expected responses from callback consumer, if it accepts the callback - ServiceAvailabilityNotification: - '{$request.body#/callbackReference}': - post: - description: >- - 'Represents the service availability information that - is used in the following cases - - when the MEC platform announces the newly available - services to the authorized relevant MEC applications (e.g. - the applications that indicate the services as "optional" - or "required") that are subscribed to the corresponding - service availability notifications - - when the MEC platform notifies the authorized relevant - applications that are subscribed to the corresponding - service availability notifications about the service availability changes.' - operationId: ServiceAvailabilityNotification_POST - tags: - - callback - requestBody: - $ref: '#/components/requestBodies/ServiceAvailabilityNotification' - responses: - '200': - description: Expected responses from callback consumer, if it accepts the callback - links: - GetIndividualMeService: - operationId: ServicesServiceId_GET - description: The `serviceId` value returned in the response can be used as the `serviceId` parameter in `GET /services/{serviceId}` - parameters: - serviceId: '$response.body#/serviceId' - PutIndividualMeService: - operationId: ServicesServiceId_PUT - description: The `serviceId` value returned in the response can be used as the `serviceId` parameter in `PUT /services/{serviceId}` - parameters: - serviceId: '$response.body#/serviceId' - GetIndividualMeDNSRule: - operationId: ApplicationsDnsRule_GET - description: The `dnsRuleId` value returned in the response can be used as the `dnsRuleId` parameter in `GET /applications/{appInstanceId}/dns_rules/{dnsRuleId}` - parameters: - dnsRuleId: '$response.body#/dnsRuleId' - PutIndividualMeDNSRule: - operationId: ApplicationsDnsRule_PUT - description: The `dnsRuleId` value returned in the response can be used as the `dnsRuleId` parameter in `PUT /applications/{appInstanceId}/dns_rules/{dnsRuleId}` - parameters: - dnsRuleId: '$response.body#/dnsRuleId' - GetIndividualMeTrafficRule: - operationId: ApplicationsTrafficRule_GET - description: The `trafficRuleId` value returned in the response can be used as the `trafficRuleId` parameter in `GET /applications/{appInstanceId}/traffic_rules/{trafficRuleId}` - parameters: - trafficRuleId: '$response.body#/trafficRuleId' - PutIndividualMeTrafficRule: - operationId: ApplicationsTrafficRule_PUT - description: The `trafficRuleId` value returned in the response can be used as the `trafficRuleId` parameter in `PUT /applications/{appInstanceId}/traffic_rules/{trafficRuleId}` - parameters: - trafficRuleId: '$response.body#/trafficRuleId' - GetTransportInfo: - operationId: AppServices_POST - description: The `id` value returned in the response can be used as the `transportId` parameter in `POST /applications/{appInstanceId}/services`. The first transport is provided as the link as wildcards are not supported - parameters: - transportId: '$response.body#/0/id' - GetIndividualMeMp1Subscription: - operationId: ApplicationsSubscription_GET - description: The `subscriptionId` value returned in the response can be used as the `subscriptionId` parameter in `GET /applications/{appInstanceId}/subscriptions/{subscriptionId}` - parameters: - description: regex = \/mp1\/v1\/applications\/.*\/subscriptions\/.*\/(.*);subscriptionId = href.match(regex)[1];// where "href" is an attribute within the subscription attribute within the _links attribute - subscriptionId: 'TBC' - DelIndividualMeMp1Subscription: - operationId: ApplicationsSubscription_DELETE - description: The `subscriptionId` value returned in the response can be used as the `subscriptionId` parameter in `DELETE /applications/{appInstanceId}/subscriptions/{subscriptionId}` - parameters: - description: regex = \/mp1\/v1\/applications\/.*\/subscriptions\/(.*);subscriptionId = href.match(regex)[1];// where "href" is an attribute within the subscription attribute within the _links attribute - subscriptionId: 'TBC' - GetIndividualMeMp1SubscriptionLinkList: - operationId: ApplicationsSubscription_GET - description: The `subscriptionId` value returned in the response can be used as the `subscriptionId` parameter in `GET /applications/{appInstanceId}/subscriptions/{subscriptionId}` - parameters: - description: regex = \/mp1\/v1\/applications\/.*\/subscriptions\/(.*);subscriptionId = href.match(regex)[1];// where "href" is an attribute within the subscription attribute within the _links attribute - subscriptionId: 'TBC' - DelIndividualMeMp1SubscriptionLinkList: - operationId: ApplicationsSubscription_DELETE - description: The `subscriptionId` value returned in the response can be used as the `subscriptionId` parameter in `DELETE /applications/{appInstanceId}/subscriptions/{subscriptionId}` - parameters: - description: regex = \/mp1\/v1\/applications\/.*\/subscriptions\/(.*);subscriptionId = href.match(regex)[1];// where "href" is an attribute within the subscription attribute within the _links attribute - subscriptionId: 'TBC' - examples: - DnsRule: - value: - dnsRuleId: 'DnsRule1' - domainName: 'www.example.com' - ipAddressType: 'IP_V4' - ipAddress: '146.241.7.3' - ttl: 300 - state: 'ACTIVE' - DnsRules: - value: - - dnsRuleId: 'DnsRule1' - domainName: 'www.example.com' - ipAddressType: 'IP_V4' - ipAddress: '146.241.7.3' - ttl: 300 - state: 'ACTIVE' - - dnsRuleId: 'DnsRule2' - domainName: 'www.example.com' - ipAddressType: 'IP_V4' - ipAddress: '146.241.7.4' - ttl: 300 - state: 'INACTIVE' - ServiceInfo: - value: - serInstanceId: 'ServiceInstance123' - serName: 'ExampleService' - serCategory: - href: 'catItem1' - id: 'id12345' - name: 'RNI' - version: 'version1' - version: 'ServiceVersion1' - state: 'ACTIVE' - transportInfo: - id: 'TransId12345' - name: 'REST' - description: 'REST API' - type: 'REST_HTTP' - protocol: 'HTTP' - version: '2.0' - endpoint: - uris: - - '/meMp1/service/EntryPoint' - security: - oAuth2Info: - grantTypes: - - 'OAUTH2_CLIENT_CREDENTIALS' - tokenEndpoint: '/meMp1/security/TokenEndPoint' - serializer: 'JSON' - ServiceInfoList: - value: - - serInstanceId: 'ServiceInstance123' - serName: 'ExampleService' - serCategory: - href: 'catItem1' - id: 'id12345' - name: 'RNI' - version: 'version1' - version: 'ServiceVersion1' - state: 'ACTIVE' - transportInfo: - id: 'TransId12345' - name: 'REST' - description: 'REST API' - type: 'REST_HTTP' - protocol: 'HTTP' - version: '2.0' - endpoint: - addresses: - - host: '192.0.2.0' - port: 8080 - security: - oAuth2Info: - grantTypes: - - 'OAUTH2_CLIENT_CREDENTIALS' - tokenEndpoint: '/meMp1/security/TokenEndPoint' - serializer: 'JSON' - TrafficRule: - value: - trafficRuleId: 'TrafficRule123' - serName: 'ExampleService' - filterType: 'FLOW' - priority: 1 - trafficFilter: - - srcAddress: - - '192.168.2.0/24' - - '192.168.3.0/24' - dstAddress: - - '192.127.4.100/32' - dstPort: - - '80' - action: 'FORWARD_DECAPSULATED' - dstInterface: - interfaceType: 'IP' - dstIpAddress: '20.1.1.1' - state: 'ACTIVE' - TrafficRules: - value: - - trafficRuleId: 'TrafficRule123' - serName: 'ExampleService' - filterType: 'FLOW' - priority: 1 - trafficFilter: - - srcAddress: - - '192.168.2.0/24' - - '192.168.3.0/24' - dstAddress: - - '192.127.4.100/32' - dstPort: - - '80' - action: 'FORWARD_DECAPSULATED' - dstInterface: - interfaceType: 'IP' - dstIpAddress: '20.1.1.1' - state: 'ACTIVE' \ No newline at end of file -- GitLab From 1ba59e805a8db00dfb162001e0048903406d544c Mon Sep 17 00:00:00 2001 From: featherstone Date: Fri, 21 Jun 2019 12:09:02 +0100 Subject: [PATCH 14/21] Updated to align with GS MEC-011 v2.0.9 - added yaml files --- MecAppSupportApi.yaml | 1297 ++++++++++++++++++++++++++++++++++++++++ MecServiceMgmtApi.yaml | 1171 ++++++++++++++++++++++++++++++++++++ 2 files changed, 2468 insertions(+) create mode 100644 MecAppSupportApi.yaml create mode 100644 MecServiceMgmtApi.yaml diff --git a/MecAppSupportApi.yaml b/MecAppSupportApi.yaml new file mode 100644 index 0000000..764139d --- /dev/null +++ b/MecAppSupportApi.yaml @@ -0,0 +1,1297 @@ +openapi: 3.0.2 +servers: + - url: 'http://127.0.0.1:8081/mec_app_support/v1' + - url: 'https://127.0.0.1:8081/mec_app_support/v1' +info: + title: MEC Application Support API + version: 2.0.9 + description: The ETSI MEC ISG MEC011 MEC Application Support API described using OpenAPI + license: + name: ETSI Forge copyright notice + url: 'https://forge.etsi.org/etsi-forge-copyright-notice.txt' + contact: + email: cti_support@etsi.org +externalDocs: + description: 'ETSI GS MEC011 Application Enablement API, V2.0.9' + url: >- + https://docbox.etsi.org/ISG/MEC/70-Draft/0011v211Plat.App.Enabl/MEC-0011v211Plat.App.Enablv209.zip +tags: + - name: appTrafficRules + - name: appDnsRules + - name: appSubscriptions + - name: appConfirmTermination + - name: timing + - name: callbacks +paths: + '/applications/{appInstanceId}/traffic_rules': + parameters: + - $ref: '#/components/parameters/Path.AppInstanceId' + get: + description: >- + This method retrieves information about all the traffic rules associated + with a MEC application instance. + operationId: ApplicationsTrafficRules_GET + tags: + - appTrafficRules + responses: + '200': + $ref: '#/components/responses/ApplicationsTrafficRules.200' + '400': + $ref: '#/components/responses/Error.400' + '403': + $ref: '#/components/responses/Error.403' + '404': + $ref: '#/components/responses/Error.404' + '/applications/{appInstanceId}/traffic_rules/{trafficRuleId}': + parameters: + - $ref: '#/components/parameters/Path.AppInstanceId' + - $ref: '#/components/parameters/Path.TrafficRuleId' + get: + description: >- + This method retrieves information about all the traffic rules associated + with a MEC application instance. + operationId: ApplicationsTrafficRule_GET + tags: + - appTrafficRules + responses: + '200': + $ref: '#/components/responses/ApplicationsTrafficRule.200' + '400': + $ref: '#/components/responses/Error.400' + '403': + $ref: '#/components/responses/Error.403' + '404': + $ref: '#/components/responses/Error.404' + put: + description: >- + This method retrieves information about all the traffic rules associated + with a MEC application instance. + operationId: ApplicationsTrafficRule_PUT + tags: + - appTrafficRules + responses: + '200': + $ref: '#/components/responses/ApplicationsTrafficRule.200' + '400': + $ref: '#/components/responses/Error.400' + '403': + $ref: '#/components/responses/Error.403' + '404': + $ref: '#/components/responses/Error.404' + '412': + $ref: '#/components/responses/Error.412' + requestBody: + $ref: '#/components/requestBodies/ApplicationsTrafficRule' + '/applications/{appInstanceId}/dns_rules': + parameters: + - $ref: '#/components/parameters/Path.AppInstanceId' + get: + description: >- + This method retrieves information about all the DNS rules associated + with a MEC application instance. + operationId: ApplicationsDnsRules_GET + tags: + - appDnsRules + responses: + '200': + $ref: '#/components/responses/ApplicationsDnsRules.200' + '400': + $ref: '#/components/responses/Error.400' + '403': + $ref: '#/components/responses/Error.403' + '404': + $ref: '#/components/responses/Error.404' + '/applications/{appInstanceId}/dns_rules/{dnsRuleId}': + parameters: + - $ref: '#/components/parameters/Path.AppInstanceId' + - $ref: '#/components/parameters/Path.DnsRuleId' + get: + description: >- + This method retrieves information about a DNS rule associated with a + MEC application instance. + operationId: ApplicationsDnsRule_GET + tags: + - appDnsRules + responses: + '200': + $ref: '#/components/responses/ApplicationsDnsRule.200' + '400': + $ref: '#/components/responses/Error.400' + '403': + $ref: '#/components/responses/Error.403' + '404': + $ref: '#/components/responses/Error.404' + put: + description: 'This method activates, de-activates or updates a traffic rule.' + operationId: ApplicationsDnsRule_PUT + tags: + - appDnsRules + responses: + '200': + $ref: '#/components/responses/ApplicationsDnsRule.200' + '400': + $ref: '#/components/responses/Error.400' + '403': + $ref: '#/components/responses/Error.403' + '404': + $ref: '#/components/responses/Error.404' + '412': + $ref: '#/components/responses/Error.412' + requestBody: + $ref: '#/components/requestBodies/ApplicationsDnsRule' + '/applications/{appInstanceId}/subscriptions': + parameters: + - $ref: '#/components/parameters/Path.AppInstanceId' + get: + description: >- + The GET method may be used to request information about all + subscriptions for this requestor. Upon success, the response contains + entity body with all the subscriptions for the requestor. + operationId: ApplicationsSubscriptions_GET + tags: + - appSubscriptions + responses: + '200': + $ref: '#/components/responses/ApplicationsSubscriptions.200' + '400': + $ref: '#/components/responses/Error.400' + '403': + $ref: '#/components/responses/Error.403' + '404': + $ref: '#/components/responses/Error.404' + post: + description: >- + The POST method may be used to create a new subscription. One example + use case is to create a new subscription to the MEC service + availability notifications. Upon success, the response contains entity + body describing the created subscription. + operationId: ApplicationsSubscriptions_POST + tags: + - appSubscriptions + responses: + '201': + $ref: '#/components/responses/ApplicationsSubscriptions.201' + '400': + $ref: '#/components/responses/Error.400' + '403': + $ref: '#/components/responses/Error.403' + '404': + $ref: '#/components/responses/Error.404' + requestBody: + $ref: '#/components/requestBodies/ApplicationsSubscriptions' + callbacks: + appTerminationNotification: + $ref: '#/components/callbacks/AppTerminationNotification' + '/applications/{appInstanceId}/subscriptions/{subscriptionId}': + parameters: + - $ref: '#/components/parameters/Path.AppInstanceId' + - $ref: '#/components/parameters/Path.SubscriptionId' + get: + description: >- + The GET method requests information about a subscription for this + requestor. Upon success, the response contains entity body with the + subscription for the requestor. + operationId: ApplicationsSubscription_GET + tags: + - appSubscriptions + responses: + '200': + $ref: '#/components/responses/ApplicationsSubscription.200' + '400': + $ref: '#/components/responses/Error.400' + '403': + $ref: '#/components/responses/Error.403' + '404': + $ref: '#/components/responses/Error.404' + delete: + description: >- + This method deletes a mecAppSuptApiSubscription. This method is typically used + in "Unsubscribing from service availability event notifications" + procedure. + operationId: ApplicationsSubscription_DELETE + tags: + - appSubscriptions + responses: + '204': + description: No Content + '403': + $ref: '#/components/responses/Error.403' + '404': + $ref: '#/components/responses/Error.404' + '/applications/{appInstanceId}/confirm_termination': + parameters: + - $ref: '#/components/parameters/Path.AppInstanceId' + post: + description: >- + This method is used to confirm the application level termination + of an application instance. + operationId: ApplicationsConfirmTermination_POST + tags: + - appConfirmTermination + responses: + '204': + description: No Content + '401': + $ref: '#/components/responses/Error.401' + '403': + $ref: '#/components/responses/Error.403' + '404': + $ref: '#/components/responses/Error.404' + '409': + $ref: '#/components/responses/Error.409' + '429': + $ref: '#/components/responses/Error.429' + '/timing/timing_caps': + get: + description: >- + This method retrieves the information of the platform's timing + capabilities which corresponds to the timing capabilities query + operationId: TimingCaps_GET + tags: + - timing + responses: + '200': + $ref: '#/components/responses/TimingCaps.200' + '400': + $ref: '#/components/responses/Error.400' + '403': + $ref: '#/components/responses/Error.403' + '404': + $ref: '#/components/responses/Error.404' + '/timing/current_time': + get: + description: >- + This method retrieves the information of the platform's current time + which corresponds to the get platform time procedure + operationId: TimingCurrentTime_GET + tags: + - timing + responses: + '200': + $ref: '#/components/responses/TimingCurrentTime.200' + '400': + $ref: '#/components/responses/Error.400' + '403': + $ref: '#/components/responses/Error.403' + '404': + $ref: '#/components/responses/Error.404' +components: + schemas: + Empty: + description: Empty schema + AppTerminationNotification.Links: + description: >- + Object containing hyperlinks related to the resource. + type: object + required: + - subscription + properties: + subscription: + $ref: '#/components/schemas/LinkType' + confirmTermination: + $ref: '#/components/schemas/LinkType.ConfirmTermination' + AppTerminationNotification.MaxGracefulTimeout: + description: >- + Maximum timeout value in seconds for graceful termination or graceful + stop of an application instance. + type: integer + format: uint32 + example: 10 + AppTerminationNotification.NotificationType: + description: Shall be set to AppTerminationNotification. + type: string + example: 'AppTerminationNotification' + AppTerminationNotification: + description: >- + This type represents the information that the MEC platform + notifies the subscribed application instance about the corresponding + application instance termination/stop. + type: object + required: + - notificationType + - maxGracefulTimeout + - _links + properties: + notificationType: + $ref: '#/components/schemas/AppTerminationNotification.NotificationType' + maxGracefulTimeout: + $ref: '#/components/schemas/AppTerminationNotification.MaxGracefulTimeout' + _links: + $ref: '#/components/schemas/AppTerminationNotification.Links' + AppTerminationNotificationSubscription.AppInstanceId: + description: It is used as the filtering criterion for the subscribed events. + type: string + example: 'ID1' + AppTerminationNotificationSubscription.CallbackReference: + description: >- + URI selected by the MEC application instance to receive + notifications on the subscribed MEC application instance + management information. This shall be included in both the request and + the response. + type: string + format: uri + AppTerminationNotificationSubscription: + description: >- + This type represents the information that the MEC platform + notifies the subscribed application instance about the corresponding + application instance termination/stop. + type: object + required: + - subscriptionType + - callbackReference + - _links + - appInstanceId + properties: + subscriptionType: + $ref: >- + #/components/schemas/AppTerminationNotificationSubscription.SubscriptionType + callbackReference: + $ref: >- + #/components/schemas/AppTerminationNotificationSubscription.CallbackReference + _links: + $ref: '#/components/schemas/Self' + appInstanceId: + $ref: >- + #/components/schemas/AppTerminationNotificationSubscription.AppInstanceId + AppTerminationNotificationSubscription.SubscriptionType: + description: Shall be set to AppTerminationNotificationSubscription. + type: string + example: 'AppTerminationNotificationSubscription' + CurrentTime: + description: >- + This type represents the information provided by the MEC + platform in response to the Get Platform Time Request message. + type: object + required: + - nanoSeconds + - seconds + - timeSourceStatus + properties: + seconds: + type: integer + format: uint32 + description: >- + The seconds part of the time. Time is defined as Unix-time since + January 1, 1970, 00:00:00 UTC + example: 1577836800 + nanoSeconds: + type: integer + format: uint32 + description: >- + The nanoseconds part of the time. Time is defined as Unix-time since + January 1, 1970, 00:00:00 UTC + example: 0 + timeSourceStatus: + type: string + enum: + - TRACEABLE + - NONTRACEABLE + description: >- + Platform Time Source status. 1 = TRACEABLE - time source is locked + to the UTC time source. 2 = NONTRACEABLE - time source is not locked + to the UTC time source + example: 'TRACEABLE' + DestinationInterface.InterfaceType: + description: Type of the interface + type: string + enum: + - TUNNEL + - MAC + - IP + example: 'TUNNEL' + DestinationInterface.IpAddress: + description: IP address of the remote destination + type: string + example: '192.0.2.0' + DestinationInterface.MacAddress: + description: Source address identifies the MAC address of the interface + type: string + example: '02-00-00-00-00-00' + DestinationInterface: + description: This type represents the destination interface. + type: object + required: + - interfaceType + properties: + interfaceType: + $ref: '#/components/schemas/DestinationInterface.InterfaceType' + tunnelInfo: + $ref: '#/components/schemas/TunnelInfo' + srcMacAddress: + $ref: '#/components/schemas/DestinationInterface.MacAddress' + dstMacAddress: + $ref: '#/components/schemas/DestinationInterface.MacAddress' + dstIpAddress: + $ref: '#/components/schemas/DestinationInterface.IpAddress' + DnsRule.DomainName: + description: FQDN resolved by the DNS rule + type: string + example: 'www.example.com' + DnsRule.Id: + description: Identifies the DNS Rule + type: string + example: 'dnsRule1' + DnsRule.IpAddress: + description: IP address associated with the FQDN resolved by the DNS rule + type: string + example: '192.0.2.0' + DnsRule.IpAddressType: + description: IP address type + type: string + enum: + - IP_V6 + - IP_V4 + example: 'IP_V6' + DnsRule.State: + description: DNS rule state + type: string + enum: + - ACTIVE + - INACTIVE + example: 'ACTIVE' + DnsRule.Ttl: + description: Time to live value + type: integer + format: uint32 + example: '?' + DnsRule: + description: This type represents the general information of a DNS rule. + type: object + required: + - dnsRuleId + - domainName + - ipAddressType + - ipAddress + - state + properties: + dnsRuleId: + $ref: '#/components/schemas/DnsRule.Id' + domainName: + $ref: '#/components/schemas/DnsRule.DomainName' + ipAddressType: + $ref: '#/components/schemas/DnsRule.IpAddressType' + ipAddress: + $ref: '#/components/schemas/DnsRule.IpAddress' + ttl: + $ref: '#/components/schemas/DnsRule.Ttl' + state: + $ref: '#/components/schemas/DnsRule.State' + LinkType: + description: This type represents a type of link and may be referenced from data structures + type: object + properties: + href: + $ref: '#/components/schemas/Href' + LinkType.ConfirmTermination: + description: >- + Link to the task resource where to confirm termination in case the + application is ready to be terminated before expiry of the timeout. + type: object + properties: + href: + $ref: '#/components/schemas/Href' + Href: + description: URI referring to a resource + type: string + format: uri + example: '/mecAppSuptApi/example' + MecAppSuptApiSubscriptionLinkList.Links: + description: Self-referring URI. + type: object + required: + - self + properties: + self: + $ref: '#/components/schemas/LinkType' + subscriptions: + description: The MEC application instance's subscriptions + type: array + items: + $ref: '#/components/schemas/MecAppSuptApiSubscriptionLinkList.Subscription' + MecAppSuptApiSubscriptionLinkList.Subscription: + description: A link to a subscription. + type: object + required: + - href + - rel + properties: + href: + $ref: '#/components/schemas/Href' + rel: + description: >- + The values shall be set to AppTerminationNotificationSubscription. + type: string + MecAppSuptApiSubscriptionLinkList: + description: >- + This type represents a list of links related to currently existing + subscriptions for a MEC application instance. This information + is returned when sending a request to receive current subscriptions. + type: object + required: + - _links + properties: + _links: + $ref: '#/components/schemas/MecAppSuptApiSubscriptionLinkList.Links' + ProblemDetails: + type: object + 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.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 + Problem.status: + type: integer + format: uint32 + description: The HTTP status code for this occurrence of the problem + Problem.title: + type: string + description: 'A short, human-readable summary of the problem type' + Problem.type: + type: string + format: uri + description: >- + A URI reference according to IETF RFC 3986 that identifies the problem + type + Self: + description: Self-referring URI. + type: object + required: + - self + properties: + self: + $ref: '#/components/schemas/LinkType' + readOnly: true + TimingCaps.NtpServers.AuthenticationKeyNum: + description: Authentication key number + type: integer + format: uint32 + example: 1 + TimingCaps.NtpServers.AuthenticationOption: + description: NTP authentication option + type: string + enum: + - NONE + - SYMMETRIC_KEY + - AUTO_KEY + example: 'NONE' + TimingCaps.NtpServers.DelayReqMaxRate: + description: Acceptable maximum rate of the Delay_Req messages in packets per second + type: integer + format: uint32 + example: 10 + TimingCaps.NtpServers.LocalPriority: + description: NTP server local priority + type: integer + format: uint32 + example: 1 + TimingCaps.NtpServers.MaxPollingInterval: + description: >- + Maximum poll interval for NTP messages, in seconds as a power of two. + Range 3...17 + type: integer + format: uint32 + example: 17 + TimingCaps.NtpServers.MinPollingInterval: + description: >- + Minimum poll interval for NTP messages, in seconds as a power of two. + Range 3...17 + type: integer + format: uint32 + example: 3 + TimingCaps.NtpServers.NtpServerAddr: + description: NTP server address + type: string + example: '192.0.2.0' + TimingCaps.NtpServers.NtpServerAddrType: + description: Address type of NTP server + type: string + enum: + - IP_ADDRESS + - DNS_NAME + example: 'IP_ADDRESS' + TimingCaps.NtpServers_PtpMasterIpAddress: + description: PTP Master IP Address + type: string + example: '192.0.2.0' + TimingCaps.NtpServers_PtpMasterLocalPriority: + description: PTP Master local priority + type: integer + format: uint32 + example: 1 + TimingCaps.NtpServers: + description: NTP server detail. + type: object + required: + - ntpServerAddrType + - ntpServerAddr + - minPollingInterval + - maxPollingInterval + - localPriority + - authenticationOption + - authenticationKeyNum + properties: + ntpServerAddrType: + $ref: '#/components/schemas/TimingCaps.NtpServers.NtpServerAddrType' + ntpServerAddr: + $ref: '#/components/schemas/TimingCaps.NtpServers.NtpServerAddr' + minPollingInterval: + $ref: '#/components/schemas/TimingCaps.NtpServers.MinPollingInterval' + maxPollingInterval: + $ref: '#/components/schemas/TimingCaps.NtpServers.MaxPollingInterval' + localPriority: + $ref: '#/components/schemas/TimingCaps.NtpServers.LocalPriority' + authenticationOption: + $ref: '#/components/schemas/TimingCaps.NtpServers.AuthenticationOption' + authenticationKeyNum: + $ref: '#/components/schemas/TimingCaps.NtpServers.AuthenticationKeyNum' + TimingCaps_PtpMasters: + description: NTP server detail. + type: object + required: + - ptpMasterIpAddress + - ptpMasterLocalPriority + - delayReqMaxRate + properties: + ptpMasterIpAddress: + $ref: '#/components/schemas/TimingCaps.NtpServers_PtpMasterIpAddress' + ptpMasterLocalPriority: + $ref: '#/components/schemas/TimingCaps.NtpServers_PtpMasterLocalPriority' + delayReqMaxRate: + $ref: '#/components/schemas/TimingCaps.NtpServers.DelayReqMaxRate' + TimingCaps.TimeStamp: + description: time + type: object + required: + - nanoSeconds + - seconds + properties: + seconds: + type: integer + format: uint32 + description: >- + The seconds part of the time. Time is defined as Unix-time since + January 1, 1970, 00:00:00 UTC + example: 1577836800 + nanoSeconds: + type: integer + format: uint32 + description: >- + The nanoseconds part of the time. Time is defined as Unix-time since + January 1, 1970, 00:00:00 UTC + example: 0 + TimingCaps: + description: >- + This type represents the information provided by the MEC + platform in response to the Timing capabilities Query message. + type: object + properties: + timeStamp: + $ref: '#/components/schemas/TimingCaps.TimeStamp' + ntpServers: + description: Available NTP servers + type: array + items: + $ref: '#/components/schemas/TimingCaps.NtpServers' + ptpMasters: + description: Available PTP Masters + type: array + items: + $ref: '#/components/schemas/TimingCaps_PtpMasters' + TrafficFilter.Address: + description: Identify the traffic ip address. + type: string + example: '192.168.1.1' + TrafficFilter.DSCP: + description: >- + Used to match all IPv4 packets that have the same Differentiated + Services Code Point (DSCP) + type: integer + format: uint32 + example: 0 + TrafficFilter.Port: + description: A port + type: string + example: '8080' + TrafficFilter.Protocol: + description: Protocol of the traffic filter + type: string + example: '?' + TrafficFilter.QCI: + description: >- + Used to match all packets that have the same Quality Class Indicator + (QCI). + type: integer + format: uint32 + example: 1 + TrafficFilter.TC: + description: Used to match all IPv6 packets that have the same Traffic Class. + type: integer + format: uint32 + example: 1 + TrafficFilter.Token: + description: Used for token based traffic rule + type: string + example: '?' + TrafficFilter.TunnelAddress: + description: Used for GTP tunnel based traffic rule + type: string + example: '?' + TrafficFilter.TunnelPort: + description: Used for GTP tunnel based traffic rule + type: string + example: '?' + TrafficFilter: + description: This type represents the traffic filter. + type: object + properties: + srcAddress: + description: >- + An IP address or a range of IP address. For IPv4, the IP address + could be an IP address plus mask, or an individual IP address, or a + range of IP addresses. For IPv6, the IP address could be an IP + prefix, or a range of IP prefixes. + type: array + items: + $ref: '#/components/schemas/TrafficFilter.Address' + dstAddress: + description: >- + An IP address or a range of IP address. For IPv4, the IP address + could be an IP address plus mask, or an individual IP address, or a + range of IP addresses. For IPv6, the IP address could be an IP + prefix, or a range of IP prefixes. + type: array + items: + $ref: '#/components/schemas/TrafficFilter.Address' + srcPort: + description: A port or a range of ports + type: array + items: + $ref: '#/components/schemas/TrafficFilter.Port' + dstPort: + description: A port or a range of ports + type: array + items: + $ref: '#/components/schemas/TrafficFilter.Port' + protocol: + description: Specify the protocol of the traffic filter + type: array + items: + $ref: '#/components/schemas/TrafficFilter.Protocol' + token: + description: Used for token based traffic rule + type: array + items: + $ref: '#/components/schemas/TrafficFilter.Token' + srcTunnelAddress: + description: Used for GTP tunnel based traffic rule + type: array + items: + $ref: '#/components/schemas/TrafficFilter.TunnelAddress' + tgtTunnelAddress: + description: Used for GTP tunnel based traffic rule + type: array + items: + $ref: '#/components/schemas/TrafficFilter.TunnelAddress' + srcTunnelPort: + description: Used for GTP tunnel based traffic rule + type: array + items: + $ref: '#/components/schemas/TrafficFilter.TunnelPort' + dstTunnelPort: + description: Used for GTP tunnel based traffic rule + type: array + items: + $ref: '#/components/schemas/TrafficFilter.TunnelPort' + qCI: + $ref: '#/components/schemas/TrafficFilter.QCI' + dSCP: + $ref: '#/components/schemas/TrafficFilter.DSCP' + tC: + $ref: '#/components/schemas/TrafficFilter.TC' + TrafficRule.Action: + description: >- + The action of the ME host data plane when a packet matches the + trafficFilter + type: string + enum: + - DROP + - FORWARD_DECAPSULATED + - FORWARD_AS_IS + - PASSTHROUGH + - DUPLICATE_DECAPSULATED + - DUPLICATE_AS_IS + example: 'DROP' + TrafficRule.FilterType: + description: >- + Definition of filter per FLOW or PACKET. If flow the filter match + UE->EPC packet and the reverse packet is handled in the same context + type: string + enum: + - FLOW + - PACKET + example: FLOW + TrafficRule.Id: + description: Identify the traffic rule. + type: string + example: 'TrafficRule1' + TrafficRule_Priority: + description: >- + Priority of this traffic rule. If traffic rule conflicts, the one with + higher priority take precedence + type: integer + format: uint32 + example: 1 + TrafficRule.State: + description: Contains the traffic rule state + type: string + enum: + - ACTIVE + - INACTIVE + example: 'ACTIVE' + TrafficRule: + description: This type represents the general information of a traffic rule. + type: object + required: + - trafficRuleId + - filterType + - priority + - trafficFilter + - action + - state + properties: + trafficRuleId: + $ref: '#/components/schemas/TrafficRule.Id' + filterType: + $ref: '#/components/schemas/TrafficRule.FilterType' + priority: + $ref: '#/components/schemas/TrafficRule_Priority' + trafficFilter: + type: array + items: + $ref: '#/components/schemas/TrafficFilter' + action: + $ref: '#/components/schemas/TrafficRule.Action' + dstInterface: + $ref: '#/components/schemas/DestinationInterface' + state: + $ref: '#/components/schemas/TrafficRule.State' + TunnelInfo.TunnelDstAddress: + description: Destination address of the tunnel + type: string + example: '?' + TunnelInfo.TunnelSrcAddress: + description: Source address of the tunnel + type: string + example: '?' + TunnelInfo.TunnelType: + description: This type represents the tunnel information. + type: string + enum: + - GTP_U + - GRE + example: 'GTP_U' + TunnelInfo: + description: This type represents the tunnel information. + type: object + required: + - tunnelType + properties: + tunnelType: + $ref: '#/components/schemas/TunnelInfo.TunnelType' + tunnelDstAddress: + $ref: '#/components/schemas/TunnelInfo.TunnelDstAddress' + tunnelSrcAddress: + $ref: '#/components/schemas/TunnelInfo.TunnelSrcAddress' + parameters: + Path.AppInstanceId: + name: appInstanceId + description: >- + Represents a MEC application instance. Note that the + appInstanceId is allocated by the MEC platform manager. + in: path + required: true + schema: + type: string + Path.DnsRuleId: + name: dnsRuleId + description: Represents a DNS rule. + in: path + required: true + schema: + type: string + Path.SubscriptionId: + name: subscriptionId + description: >- + Represents a subscription to the notifications from the MEC + platform. + in: path + required: true + schema: + type: string + Path.TrafficRuleId: + name: trafficRuleId + description: Represents a traffic rule. + in: path + required: true + schema: + type: string + responses: + ApplicationsDnsRules.200: + description: >- + It is used to indicate nonspecific success. The response body + contains a representation of the resource. + content: + application/json: + schema: + type: array + minItems: 0 + items: + $ref: '#/components/schemas/DnsRule' + examples: + DnsRules: + $ref: '#/components/examples/DnsRules' + links: + getIndividualMeDNSRule: + $ref: '#/components/links/GetIndividualMeDNSRule' + putIndividualMeDNSRule: + $ref: '#/components/links/PutIndividualMeDNSRule' + ApplicationsDnsRule.200: + description: >- + It is used to indicate nonspecific success. The response body + contains a representation of the resource. + content: + application/json: + schema: + $ref: '#/components/schemas/DnsRule' + examples: + DnsRule: + $ref: '#/components/examples/DnsRule' + ApplicationsSubscriptions.200: + description: >- + Upon success, a response body containing the list of links to the + requested subscriptions is returned. + content: + application/json: + schema: + $ref: '#/components/schemas/MecAppSuptApiSubscriptionLinkList' + links: + getIndividualmecAppSuptApiSubscriptionLinkList: + $ref: '#/components/links/GetIndividualmecAppSuptApiSubscriptionLinkList' + delIndividualmecAppSuptApiSubscriptionLinkList: + $ref: '#/components/links/DelIndividualmecAppSuptApiSubscriptionLinkList' + ApplicationsSubscriptions.201: + description: >- + Entity body in the request contains a subscription to the + MEC service availability notifications that is to be created. + headers: + location: + description: The resource URI of the created resource + schema: + type: string + format: uri + content: + application/json: + schema: + $ref: '#/components/schemas/AppTerminationNotificationSubscription' + links: + getIndividualmecAppSuptApiSubscription: + $ref: '#/components/links/GetIndividualmecAppSuptApiSubscription' + delIndividualmecAppSuptApiSubscription: + $ref: '#/components/links/DelIndividualmecAppSuptApiSubscription' + ApplicationsSubscription.200: + description: >- + Upon success, a response body containing the requested subscription + is returned. + content: + application/json: + schema: + $ref: '#/components/schemas/AppTerminationNotificationSubscription' + ApplicationsTrafficRules.200: + description: >- + It is used to indicate nonspecific success. The response body + contains a representation of the resource. + content: + application/json: + schema: + type: array + minItems: 0 + items: + $ref: '#/components/schemas/TrafficRule' + examples: + TrafficRules: + $ref: '#/components/examples/TrafficRules' + links: + getIndividualMeTrafficRule: + $ref: '#/components/links/GetIndividualMeTrafficRule' + putIndividualMeTrafficRule: + $ref: '#/components/links/PutIndividualMeTrafficRule' + ApplicationsTrafficRule.200: + description: >- + It is used to indicate nonspecific success. The response body + contains a representation of the resource. + content: + application/json: + schema: + $ref: '#/components/schemas/TrafficRule' + examples: + TrafficRule: + $ref: '#/components/examples/TrafficRule' + TimingCurrentTime.200: + description: >- + It is used to indicate nonspecific success. The response body + contains a representation of the resource. + content: + application/json: + schema: + $ref: '#/components/schemas/CurrentTime' + TimingCaps.200: + description: >- + It is used to indicate nonspecific success. The response body + contains a representation of the resource. + content: + application/json: + schema: + $ref: '#/components/schemas/TimingCaps' + 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' + Error.409: + description: >- + Conflict. + The operation cannot be executed currently, due to a conflict with + the state of the resource. Typically, this is because the application + instance resource is in NOT_INSTANTIATED state. + content: + application/problem+json: + schema: + $ref: '#/components/schemas/ProblemDetails' + text/plain: + schema: + $ref: '#/components/schemas/Empty' + Error.412: + description: >- + Precondition Failed. + It is used when a condition has failed during conditional requests, + e.g. when using ETags to avoid write conflicts. + content: + application/problem+json: + schema: + $ref: '#/components/schemas/ProblemDetails' + text/plain: + schema: + $ref: '#/components/schemas/Empty' + Error.429: + description: >- + Too Many Requests. + It is used when a rate limiter has triggered. + content: + application/problem+json: + schema: + $ref: '#/components/schemas/ProblemDetails' + text/plain: + schema: + $ref: '#/components/schemas/Empty' + requestBodies: + ApplicationsDnsRule: + content: + application/json: + schema: + $ref: '#/components/schemas/DnsRule' + description: The updated state is included in the entity body of the request. + required: true + ApplicationsSubscriptions: + content: + application/json: + schema: + $ref: '#/components/schemas/AppTerminationNotificationSubscription' + description: >- + Entity body in the request contains a subscription to the MEC + application termination notifications that is to be created. + required: true + ApplicationsTrafficRule: + content: + application/json: + schema: + $ref: '#/components/schemas/TrafficRule' + description: One or more updated attributes that are allowed to be changed + required: true + AppTerminationNotification: + content: + application/json: + schema: + $ref: '#/components/schemas/AppTerminationNotification' + required: true + callbacks: + AppTerminationNotification: + '{$request.body#/callbackReference}': + post: + description: >- + Represents the information that the MEP notifies the + subscribed application instance about the corresponding + application instance termination/stop + operationId: AppTerminationNotification_POST + tags: + - callbacks + requestBody: + $ref: '#/components/requestBodies/AppTerminationNotification' + responses: + '200': + description: Expected responses from callback consumer, if it accepts the callback + links: + GetIndividualMeDNSRule: + operationId: ApplicationsDnsRule_GET + description: The `dnsRuleId` value returned in the response can be used as the `dnsRuleId` parameter in `GET /applications/{appInstanceId}/dns_rules/{dnsRuleId}` + parameters: + dnsRuleId: '$response.body#/dnsRuleId' + PutIndividualMeDNSRule: + operationId: ApplicationsDnsRule_PUT + description: The `dnsRuleId` value returned in the response can be used as the `dnsRuleId` parameter in `PUT /applications/{appInstanceId}/dns_rules/{dnsRuleId}` + parameters: + dnsRuleId: '$response.body#/dnsRuleId' + GetIndividualMeTrafficRule: + operationId: ApplicationsTrafficRule_GET + description: The `trafficRuleId` value returned in the response can be used as the `trafficRuleId` parameter in `GET /applications/{appInstanceId}/traffic_rules/{trafficRuleId}` + parameters: + trafficRuleId: '$response.body#/trafficRuleId' + PutIndividualMeTrafficRule: + operationId: ApplicationsTrafficRule_PUT + description: The `trafficRuleId` value returned in the response can be used as the `trafficRuleId` parameter in `PUT /applications/{appInstanceId}/traffic_rules/{trafficRuleId}` + parameters: + trafficRuleId: '$response.body#/trafficRuleId' + GetIndividualmecAppSuptApiSubscription: + operationId: ApplicationsSubscription_GET + description: The `subscriptionId` value returned in the response can be used as the `subscriptionId` parameter in `GET /applications/{appInstanceId}/subscriptions/{subscriptionId}` + parameters: + description: regex = \/mec_app_support\/v1\/applications\/.*\/subscriptions\/.*\/(.*);subscriptionId = href.match(regex)[1];// where "href" is an attribute within the subscription attribute within the _links attribute + subscriptionId: 'TBC' + DelIndividualmecAppSuptApiSubscription: + operationId: ApplicationsSubscription_DELETE + description: The `subscriptionId` value returned in the response can be used as the `subscriptionId` parameter in `DELETE /applications/{appInstanceId}/subscriptions/{subscriptionId}` + parameters: + description: regex = \/mec_app_support\/v1\/applications\/.*\/subscriptions\/(.*);subscriptionId = href.match(regex)[1];// where "href" is an attribute within the subscription attribute within the _links attribute + subscriptionId: 'TBC' + GetIndividualmecAppSuptApiSubscriptionLinkList: + operationId: ApplicationsSubscription_GET + description: The `subscriptionId` value returned in the response can be used as the `subscriptionId` parameter in `GET /applications/{appInstanceId}/subscriptions/{subscriptionId}` + parameters: + description: regex = \/mec_app_support\/v1\/applications\/.*\/subscriptions\/(.*);subscriptionId = href.match(regex)[1];// where "href" is an attribute within the subscription attribute within the _links attribute + subscriptionId: 'TBC' + DelIndividualmecAppSuptApiSubscriptionLinkList: + operationId: ApplicationsSubscription_DELETE + description: The `subscriptionId` value returned in the response can be used as the `subscriptionId` parameter in `DELETE /applications/{appInstanceId}/subscriptions/{subscriptionId}` + parameters: + description: regex = \/mec_app_support\/v1\/applications\/.*\/subscriptions\/(.*);subscriptionId = href.match(regex)[1];// where "href" is an attribute within the subscription attribute within the _links attribute + subscriptionId: 'TBC' + examples: + DnsRule: + value: + dnsRuleId: 'DnsRule1' + domainName: 'www.example.com' + ipAddressType: 'IP_V4' + ipAddress: '146.241.7.3' + ttl: 300 + state: 'ACTIVE' + DnsRules: + value: + - dnsRuleId: 'DnsRule1' + domainName: 'www.example.com' + ipAddressType: 'IP_V4' + ipAddress: '146.241.7.3' + ttl: 300 + state: 'ACTIVE' + - dnsRuleId: 'DnsRule2' + domainName: 'www.example.com' + ipAddressType: 'IP_V4' + ipAddress: '146.241.7.4' + ttl: 300 + state: 'INACTIVE' + TrafficRule: + value: + trafficRuleId: 'TrafficRule123' + serName: 'ExampleService' + filterType: 'FLOW' + priority: 1 + trafficFilter: + - srcAddress: + - '192.168.2.0/24' + - '192.168.3.0/24' + dstAddress: + - '192.127.4.100/32' + dstPort: + - '80' + action: 'FORWARD_DECAPSULATED' + dstInterface: + interfaceType: 'IP' + dstIpAddress: '20.1.1.1' + state: 'ACTIVE' + TrafficRules: + value: + - trafficRuleId: 'TrafficRule123' + serName: 'ExampleService' + filterType: 'FLOW' + priority: 1 + trafficFilter: + - srcAddress: + - '192.168.2.0/24' + - '192.168.3.0/24' + dstAddress: + - '192.127.4.100/32' + dstPort: + - '80' + action: 'FORWARD_DECAPSULATED' + dstInterface: + interfaceType: 'IP' + dstIpAddress: '20.1.1.1' + state: 'ACTIVE' \ No newline at end of file diff --git a/MecServiceMgmtApi.yaml b/MecServiceMgmtApi.yaml new file mode 100644 index 0000000..f339d63 --- /dev/null +++ b/MecServiceMgmtApi.yaml @@ -0,0 +1,1171 @@ +openapi: 3.0.2 +servers: + - url: 'http://127.0.0.1:8081/mec_service_mgmt/v1' + - url: 'https://127.0.0.1:8081/mec_service_mgmt/v1' +info: + title: MEC Service Management API + version: 2.0.9 + description: The ETSI MEC ISG MEC011 MEC Service Management API described using OpenAPI + license: + name: ETSI Forge copyright notice + url: 'https://forge.etsi.org/etsi-forge-copyright-notice.txt' + contact: + email: cti_support@etsi.org +externalDocs: + description: 'ETSI GS MEC011 Application Enablement API, V2.0.9' + url: >- + https://docbox.etsi.org/ISG/MEC/70-Draft/0011v211Plat.App.Enabl/MEC-0011v211Plat.App.Enablv209.zip +tags: + - name: appSubscriptions + - name: appServices + - name: services + - name: transports + - name: callbacks +paths: + '/services': + get: + description: >- + This method retrieves information about a list of mecService resources. + This method is typically used in "service availability query" procedure + operationId: Services_GET + tags: + - services + parameters: + - $ref: '#/components/parameters/Query.Ser_instance_id' + - $ref: '#/components/parameters/Query.Ser_name' + - $ref: '#/components/parameters/Query.Ser_category_id' + - $ref: '#/components/parameters/Query.Consumed_local_only' + - $ref: '#/components/parameters/Query.Is_local' + - $ref: '#/components/parameters/Query.LocalityTypes' + responses: + '200': + $ref: '#/components/responses/Services.200' + '400': + $ref: '#/components/responses/Error.400' + '403': + $ref: '#/components/responses/Error.403' + '404': + $ref: '#/components/responses/Error.404' + '/services/{serviceId}': + parameters: + - $ref: '#/components/parameters/Path.ServiceId' + get: + description: >- + This method retrieves information about a mecService resource. This + method is typically used in "service availability query" procedure + operationId: ServicesServiceId_GET + tags: + - services + responses: + '200': + $ref: '#/components/responses/ServicesServiceId.200' + '400': + $ref: '#/components/responses/Error.400' + '403': + $ref: '#/components/responses/Error.403' + '404': + $ref: '#/components/responses/Error.404' + '/applications/{appInstanceId}/services': + parameters: + - $ref: '#/components/parameters/Path.AppInstanceId' + get: + description: >- + This method retrieves information about a list of mecService resources. + This method is typically used in "service availability query" procedure + operationId: AppServices_GET + tags: + - appServices + parameters: + - $ref: '#/components/parameters/Query.Ser_instance_id' + - $ref: '#/components/parameters/Query.Ser_name' + - $ref: '#/components/parameters/Query.Ser_category_id' + - $ref: '#/components/parameters/Query.Consumed_local_only' + - $ref: '#/components/parameters/Query.Is_local' + - $ref: '#/components/parameters/Query.LocalityTypes' + responses: + '200': + $ref: '#/components/responses/Services.200' + '400': + $ref: '#/components/responses/Error.400' + '403': + $ref: '#/components/responses/Error.403' + '404': + $ref: '#/components/responses/Error.404' + post: + description: >- + This method is used to create a mecService resource. This method is + typically used in "service availability update and new service + registration" procedure + operationId: AppServices_POST + tags: + - appServices + responses: + '201': + $ref: '#/components/responses/Services.201' + '400': + $ref: '#/components/responses/Error.400' + '403': + $ref: '#/components/responses/Error.403' + '404': + $ref: '#/components/responses/Error.404' + requestBody: + $ref: '#/components/requestBodies/Services.Post' + '/applications/{appInstanceId}/services/{serviceId}': + parameters: + - $ref: '#/components/parameters/Path.AppInstanceId' + - $ref: '#/components/parameters/Path.ServiceId' + get: + description: >- + This method retrieves information about a mecService resource. This + method is typically used in "service availability query" procedure + operationId: AppServicesServiceId_GET + tags: + - appServices + responses: + '200': + $ref: '#/components/responses/ServicesServiceId.200' + '400': + $ref: '#/components/responses/Error.400' + '403': + $ref: '#/components/responses/Error.403' + '404': + $ref: '#/components/responses/Error.404' + put: + description: This method updates the information about a mecService resource + operationId: AppServicesServiceId_PUT + tags: + - appServices + responses: + '200': + $ref: '#/components/responses/ServicesServiceId.200' + '400': + $ref: '#/components/responses/Error.400' + '403': + $ref: '#/components/responses/Error.403' + '404': + $ref: '#/components/responses/Error.404' + '412': + $ref: '#/components/responses/Error.412' + requestBody: + $ref: '#/components/requestBodies/ServicesServiceId' + '/applications/{appInstanceId}/subscriptions': + parameters: + - $ref: '#/components/parameters/Path.AppInstanceId' + get: + description: >- + The GET method may be used to request information about all + subscriptions for this requestor. Upon success, the response contains + entity body with all the subscriptions for the requestor. + operationId: ApplicationsSubscriptions_GET + tags: + - appSubscriptions + responses: + '200': + $ref: '#/components/responses/ApplicationsSubscriptions.200' + '400': + $ref: '#/components/responses/Error.400' + '403': + $ref: '#/components/responses/Error.403' + '404': + $ref: '#/components/responses/Error.404' + post: + description: >- + The POST method may be used to create a new subscription. One example + use case is to create a new subscription to the MEC service + availability notifications. Upon success, the response contains entity + body describing the created subscription. + operationId: ApplicationsSubscriptions_POST + tags: + - appSubscriptions + responses: + '201': + $ref: '#/components/responses/ApplicationsSubscriptions.201' + '400': + $ref: '#/components/responses/Error.400' + '403': + $ref: '#/components/responses/Error.403' + '404': + $ref: '#/components/responses/Error.404' + requestBody: + $ref: '#/components/requestBodies/ApplicationsSubscriptions' + callbacks: + serviceAvailabilityNotification: + $ref: '#/components/callbacks/ServiceAvailabilityNotification' + '/applications/{appInstanceId}/subscriptions/{subscriptionId}': + parameters: + - $ref: '#/components/parameters/Path.AppInstanceId' + - $ref: '#/components/parameters/Path.SubscriptionId' + get: + description: >- + The GET method requests information about a subscription for this + requestor. Upon success, the response contains entity body with the + subscription for the requestor. + operationId: ApplicationsSubscription_GET + tags: + - appSubscriptions + responses: + '200': + $ref: '#/components/responses/ApplicationsSubscription.200' + '400': + $ref: '#/components/responses/Error.400' + '403': + $ref: '#/components/responses/Error.403' + '404': + $ref: '#/components/responses/Error.404' + delete: + description: >- + This method deletes a mecSrvMgmtSubscription. This method is typically used + in "Unsubscribing from service availability event notifications" + procedure. + operationId: ApplicationsSubscription_DELETE + tags: + - appSubscriptions + responses: + '204': + description: No Content + '403': + $ref: '#/components/responses/Error.403' + '404': + $ref: '#/components/responses/Error.404' + '/transports': + get: + description: >- + This method retrieves information about a list of available transports. + This method is typically used by a service-producing application to + discover transports provided by the MEC platform in the + "transport information query" procedure + operationId: Transports_GET + tags: + - transports + responses: + '200': + $ref: '#/components/responses/Transports.200' + '400': + $ref: '#/components/responses/Error.400' + '403': + $ref: '#/components/responses/Error.403' + '404': + $ref: '#/components/responses/Error.404' +components: + schemas: + Empty: + description: Empty schema + CategoryRef.Href: + description: Reference of the catalogue + type: string + example: 'catItem1' + CategoryRef.Id: + description: Unique identifier of the category + type: string + example: 'id12345' + CategoryRef.Name: + description: Name of the category, example values include RNI, Location & Bandwidth Management + type: string + example: 'RNI' + CategoryRef.Version: + description: Category version + type: string + example: 'version1' + CategoryRef: + description: This type represents the category reference + type: object + required: + - href + - id + - name + - version + properties: + href: + $ref: '#/components/schemas/CategoryRef.Href' + id: + $ref: '#/components/schemas/CategoryRef.Id' + name: + $ref: '#/components/schemas/CategoryRef.Name' + version: + $ref: '#/components/schemas/CategoryRef.Version' + EndPointInfo.Address.Host: + description: Host portion of the address + type: string + example: '192.0.2.0' + EndPointInfo.Address_Port: + description: Port portion of the address + type: integer + format: uint32 + example: 8080 + EndPointInfo.Address: + description: A IP address and port pair + type: object + required: + - host + - port + properties: + host: + $ref: '#/components/schemas/EndPointInfo.Address.Host' + port: + $ref: '#/components/schemas/EndPointInfo.Address_Port' + EndPointInfo.Addresses: + description: >- + Entry point information of the service as one or more pairs of IP + address and port + type: object + required: + - addresses + properties: + addresses: + type: array + minItems: 0 + items: + $ref: '#/components/schemas/EndPointInfo.Address' + EndPointInfo.Alternative: + description: >- + Entry point information of the service in a format defined by an + implementation, or in an external specification. + type: object + required: + - alternative + properties: + alternative: + type: object + EndPointInfo.Uri: + description: Entry point information of the service + type: string + format: uri + example: '/mecSerMgmtApi/service/EntryPoint' + EndPointInfo.Uris: + description: >- + Entry point information of the service as string, formatted according to + URI syntax + type: object + required: + - uris + properties: + uris: + type: array + minItems: 0 + items: + $ref: '#/components/schemas/EndPointInfo.Uri' + LinkType: + description: This type represents a type of link and may be referenced from data structures + type: object + properties: + href: + $ref: '#/components/schemas/Href' + Href: + description: URI referring to a resource + type: string + format: uri + example: '/mecSerMgmtApi/example' + MecServiceMgmtApiSubscriptionLinkList.Links: + description: Self-referring URI. + type: object + required: + - self + properties: + self: + $ref: '#/components/schemas/LinkType' + subscriptions: + description: The MEC application instance's subscriptions + type: array + items: + $ref: '#/components/schemas/MecServiceMgmtApiSubscriptionLinkList.Subscription' + MecServiceMgmtApiSubscriptionLinkList.Subscription: + description: A link to a subscription. + type: object + required: + - href + - rel + properties: + href: + $ref: '#/components/schemas/Href' + rel: + description: >- + The value shall be se to SerAvailabilityNotificationSubscription. + type: string + MecServiceMgmtApiSubscriptionLinkList: + description: >- + This type represents a list of links related to currently existing + subscriptions for a MEC application instance. This information + is returned when sending a request to receive current subscriptions. + type: object + required: + - _links + properties: + _links: + $ref: '#/components/schemas/MecServiceMgmtApiSubscriptionLinkList.Links' + ProblemDetails: + type: object + 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.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 + Problem.status: + type: integer + format: uint32 + description: The HTTP status code for this occurrence of the problem + Problem.title: + type: string + description: 'A short, human-readable summary of the problem type' + Problem.type: + type: string + format: uri + description: >- + A URI reference according to IETF RFC 3986 that identifies the problem + type + SecurityInfo.OAuth2Info.GrantTypes: + description: List of supported OAuth 2.0 grant types + type: string + enum: + - OAUTH2_AUTHORIZATION_CODE + - OAUTH2_IMPLICIT_GRANT + - OAUTH2_RESOURCE_OWNER + - OAUTH2_CLIENT_CREDENTIALS + example: 'OAUTH2_CLIENT_CREDENTIALS' + SecurityInfo.OAuth2Info.TokenEndpoint: + description: The token endpoint + type: string + format: uri + example: '/mecSerMgmtApi/security/TokenEndPoint' + SecurityInfo.OAuth2Info: + description: Parameters related to use of OAuth 2.0 + required: + - grantTypes + - tokenEndpoint + properties: + grantTypes: + description: >- + List of supported OAuth 2.0 grant types. + type: array + minItems: 1 + maxItems: 4 + items: + $ref: '#/components/schemas/SecurityInfo.OAuth2Info.GrantTypes' + tokenEndpoint: + $ref: '#/components/schemas/SecurityInfo.OAuth2Info.TokenEndpoint' + type: object + SecurityInfo: + description: This type represents security information related to a transport + type: object + properties: + oAuth2Info: + $ref: '#/components/schemas/SecurityInfo.OAuth2Info' + Self: + description: Self-referring URI. + type: object + required: + - self + properties: + self: + $ref: '#/components/schemas/LinkType' + readOnly: true + SerAvailabilityNotificationSubscription.CallbackReference: + description: >- + URI selected by the MEC application instance to receive + notifications on the subscribed MEC service availability + information. This shall be included in both the request and the + response. + type: string + format: uri + SerAvailabilityNotificationSubscription: + description: >- + This type represents a subscription to the notifications from the + MEC platform regarding the availability of a MEC service or a + list of MEC services. + type: object + required: + - subscriptionType + - callbackReference + - _links + - filteringCriteria + properties: + subscriptionType: + $ref: >- + #/components/schemas/SerAvailabilityNotificationSubscription.SubscriptionType + callbackReference: + $ref: >- + #/components/schemas/SerAvailabilityNotificationSubscription.CallbackReference + _links: + $ref: '#/components/schemas/Self' + filteringCriteria: + $ref: '#/components/schemas/ServiceInfo' + SerAvailabilityNotificationSubscription.SubscriptionType: + description: Shall be set to SerAvailabilityNotificationSubscription. + type: string + example: 'SerAvailabilityNotificationSubscription' + ServiceAvailabilityNotification: + description: >- + This type represents the service availability information. + type: object + required: + - notificationType + - services + - _links + properties: + notificationType: + $ref: >- + #/components/schemas/SerAvailabilityNotificationSubscription.SubscriptionType + services: + type: array + items: + $ref: '#/components/schemas/ServiceInfo' + _links: + $ref: '#/components/schemas/Subscription' + SerializerTypes: + description: The enumeration SerializerTypes represents types of serializers + type: string + enum: + - JSON + - XML + - PROTOBUF3 + example: 'JSON' + LocalityTypes: + description: The scope of locality as expressed by "consumedLocalOnly" and "isLocal". If absent, defaults to MEC_HOST + type: string + enum: + - MEC_SYSTEM + - MEC_HOST + - NFVI_POP + - ZONE + - ZONE_GROUP + - NFVI_NODE + example: 'MEC_SYSTEM' + ServiceInfo.SerInstanceId: + description: >- + Identifier of the service instance assigned by the MEC platform. + type: string + readOnly: true + example: 'ServiceInstance123' + ServiceInfo.SerName: + description: >- + The name of the service. This is how the service producing MEC + application identifies the service instance it produces. + type: string + example: 'ExampleService' + ServiceInfo.State: + description: Contains the state + type: string + enum: + - ACTIVE + - INACTIVE + example: 'ACTIVE' + ServiceInfo.TransportId: + description: >- + Identifier of the platform-provided transport to be used by the service. + Valid identifiers may be obtained using the "Transport information + query" procedure. May be present in POST requests to signal the use of a + platform-provided transport for the service, and shall be absent + otherwise. + type: string + writeOnly: true + example: 'Rest1' + ServiceInfo.Version: + description: Service version + type: string + example: 'ServiceVersion1' + ServiceInfo.ConsumedLocalOnly: + description: >- + Indicate whether the service can only be consumed by the MEC applications + located in the same locality (as defined by scopeOfLocality) as this + service instance. + type: boolean + example: false + ServiceInfo.IsLocal: + description: >- + Indicate whether the service is located in the same locality (as defined + by scopeOfLocality) as the consuming MEC application. + type: boolean + example: true + ServiceInfo.Post: + description: This type represents the general information of a MEC service. + type: object + required: + - serName + - version + - state + - serializer + oneOf: + - required: [transportId] + - required: [transportInfo] + properties: + serInstanceId: + $ref: '#/components/schemas/ServiceInfo.SerInstanceId' + serName: + $ref: '#/components/schemas/ServiceInfo.SerName' + serCategory: + $ref: '#/components/schemas/CategoryRef' + version: + $ref: '#/components/schemas/ServiceInfo.Version' + state: + $ref: '#/components/schemas/ServiceInfo.State' + transportId: + $ref: '#/components/schemas/ServiceInfo.TransportId' + transportInfo: + $ref: '#/components/schemas/TransportInfo' + serializer: + $ref: '#/components/schemas/SerializerTypes' + scopeOfLocality: + $ref: '#/components/schemas/LocalityTypes' + consumedLocalOnly: + $ref: '#/components/schemas/ServiceInfo.ConsumedLocalOnly' + isLocal: + $ref: '#/components/schemas/ServiceInfo.IsLocal' + ServiceInfo: + description: This type represents the general information of a MEC service. + type: object + required: + - serName + - version + - state + - transportInfo + - serializer + properties: + serInstanceId: + $ref: '#/components/schemas/ServiceInfo.SerInstanceId' + serName: + $ref: '#/components/schemas/ServiceInfo.SerName' + serCategory: + $ref: '#/components/schemas/CategoryRef' + version: + $ref: '#/components/schemas/ServiceInfo.Version' + state: + $ref: '#/components/schemas/ServiceInfo.State' + transportInfo: + $ref: '#/components/schemas/TransportInfo' + serializer: + $ref: '#/components/schemas/SerializerTypes' + scopeOfLocality: + $ref: '#/components/schemas/LocalityTypes' + consumedLocalOnly: + $ref: '#/components/schemas/ServiceInfo.ConsumedLocalOnly' + isLocal: + $ref: '#/components/schemas/ServiceInfo.IsLocal' + Subscription: + description: A link to the related subscription + type: object + required: + - subscription + properties: + subscription: + $ref: '#/components/schemas/LinkType' + TransportInfo.Description: + description: Human-readable description of this transport + type: string + example: 'REST API' + TransportInfo.Id: + description: The identifier of this transport + type: string + example: 'TransId12345' + TransportInfo.ImplSpecificInfo: + description: Additional implementation specific details of the transport + type: object + TransportInfo.Name: + description: The name of this transport + type: string + example: 'REST' + TransportInfo.Protocol: + description: The name of the protocol used. Shall be set to HTTP for a REST API. + type: string + example: 'HTTP' + TransportInfo.Version: + description: The version of the protocol used + type: string + example: '2.0' + TransportInfo: + description: This type represents the general information of a MEC service. + type: object + required: + - id + - name + - type + - protocol + - version + - endpoint + - security + properties: + id: + $ref: '#/components/schemas/TransportInfo.Id' + name: + $ref: '#/components/schemas/TransportInfo.Name' + description: + $ref: '#/components/schemas/TransportInfo.Description' + type: + $ref: '#/components/schemas/TransportTypes' + protocol: + $ref: '#/components/schemas/TransportInfo.Protocol' + version: + $ref: '#/components/schemas/TransportInfo.Version' + endpoint: + description: This type represents information about a transport endpoint + type: object + oneOf: + - $ref: '#/components/schemas/EndPointInfo.Uris' + - $ref: '#/components/schemas/EndPointInfo.Addresses' + - $ref: '#/components/schemas/EndPointInfo.Alternative' + security: + $ref: '#/components/schemas/SecurityInfo' + implSpecificInfo: + $ref: '#/components/schemas/TransportInfo.ImplSpecificInfo' + TransportTypes: + description: The enumeration TransportTypes represents types of transports + type: string + enum: + - REST_HTTP + - MB_TOPIC_BASED + - MB_ROUTING + - MB_PUBSUB + - RPC + - RPC_STREAMING + - WEBSOCKET + example: 'REST_HTTP' + parameters: + Path.AppInstanceId: + name: appInstanceId + description: >- + Represents a MEC application instance. Note that the + appInstanceId is allocated by the MEC platform manager. + in: path + required: true + schema: + type: string + Path.SubscriptionId: + name: subscriptionId + description: >- + Represents a subscription to the notifications from the MEC + platform. + in: path + required: true + schema: + type: string + Path.ServiceId: + name: serviceId + description: Represents a MEC service instance. + in: path + required: true + schema: + type: string + Query.Ser_category_id: + name: ser_category_id + description: >- + A MEC application instance may use ser_category_id as an input + parameter to query the availability of a list of MEC service + instances in a serCategory. Either "ser_instance_id" or "ser_name" or + "ser_category_id" or none of them shall be present. + in: query + required: false + schema: + type: string + Query.Ser_instance_id: + name: ser_instance_id + description: >- + A MEC application instance may use multiple ser_instance_ids as + an input parameter to query the availability of a list of MEC + service instances. Either "ser_instance_id" or "ser_name" or + "ser_category_id" or none of them shall be present. + in: query + required: false + schema: + type: array + items: + type: string + Query.Ser_name: + name: ser_name + description: >- + A MEC application instance may use multiple ser_names as an + input parameter to query the availability of a list of MEC + service instances. Either "ser_instance_id" or "ser_name" or + "ser_category_id" or none of them shall be present. + in: query + required: false + schema: + type: array + items: + type: string + Query.LocalityTypes: + name: scope_of_locality + description: >- + A MEC application instance may use scope_of_locality as an input + parameter to query the availability of a list of MEC service instances + with a certain scope of locality. + in: query + required: false + schema: + type: string + Query.Is_local: + name: is_local + description: >- + Indicate whether the service is located in the same locality (as + defined by scopeOfLocality) as the consuming MEC application. + in: query + required: false + schema: + type: boolean + Query.Consumed_local_only: + name: consumed_local_only + description: >- + Indicate whether the service can only be consumed by the MEC + applications located in the same locality (as defined by + scopeOfLocality) as this service instance. + in: query + required: false + schema: + type: boolean + responses: + ApplicationsSubscriptions.200: + description: >- + Upon success, a response body containing the list of links to the + requested subscriptions is returned. + content: + application/json: + schema: + $ref: '#/components/schemas/MecServiceMgmtApiSubscriptionLinkList' + links: + getIndividualmecSerMgmtApiSubscriptionLinkList: + $ref: '#/components/links/GetIndividualmecSerMgmtApiSubscriptionLinkList' + delIndividualmecSerMgmtApiSubscriptionLinkList: + $ref: '#/components/links/DelIndividualmecSerMgmtApiSubscriptionLinkList' + ApplicationsSubscriptions.201: + description: >- + Entity body in the request contains a subscription to the MEC + service availability notifications that is to be created. + headers: + location: + description: The resource URI of the created resource + schema: + type: string + format: uri + content: + application/json: + schema: + $ref: '#/components/schemas/SerAvailabilityNotificationSubscription' + links: + getIndividualmecSerMgmtApiSubscription: + $ref: '#/components/links/GetIndividualmecSerMgmtApiSubscription' + delIndividualmecSerMgmtApiSubscription: + $ref: '#/components/links/DelIndividualmecSerMgmtApiSubscription' + ApplicationsSubscription.200: + description: >- + Upon success, a response body containing the requested subscription + is returned. + content: + application/json: + schema: + $ref: '#/components/schemas/SerAvailabilityNotificationSubscription' + Services.200: + description: >- + It is used to indicate nonspecific success. The response body + contains a representation of the resource. + content: + application/json: + schema: + type: array + minItems: 0 + items: + $ref: '#/components/schemas/ServiceInfo' + examples: + ServiceInfoList: + $ref: '#/components/examples/ServiceInfoList' + links: + getIndividualmecService: + $ref: '#/components/links/GetIndividualmecService' + putIndividualmecService: + $ref: '#/components/links/PutIndividualmecService' + Services.201: + description: >- + Upon success, the HTTP response shall include a Location HTTP header + that contains the resource URI of the created resource. + headers: + location: + description: The resource URI of the created resource + schema: + type: string + format: uri + content: + application/json: + schema: + $ref: '#/components/schemas/ServiceInfo' + examples: + ServiceInfo: + $ref: '#/components/examples/ServiceInfo' + links: + getIndividualmecService: + $ref: '#/components/links/GetIndividualmecService' + putIndividualmecService: + $ref: '#/components/links/PutIndividualmecService' + ServicesServiceId.200: + description: >- + It is used to indicate nonspecific success. The response body + contains a representation of the resource. + content: + application/json: + schema: + $ref: '#/components/schemas/ServiceInfo' + examples: + ServiceInfo: + $ref: '#/components/examples/ServiceInfo' + Transports.200: + description: >- + It is used to indicate nonspecific success. The response body + contains a representation of the resource. + content: + application/json: + schema: + type: array + minItems: 0 + items: + $ref: '#/components/schemas/TransportInfo' + links: + getTransportInfo: + $ref: '#/components/links/GetTransportInfo' + 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' + Error.409: + description: >- + Conflict. + The operation cannot be executed currently, due to a conflict with + the state of the resource. Typically, this is because the application + instance resource is in NOT_INSTANTIATED state. + content: + application/problem+json: + schema: + $ref: '#/components/schemas/ProblemDetails' + text/plain: + schema: + $ref: '#/components/schemas/Empty' + Error.412: + description: >- + Precondition Failed. + It is used when a condition has failed during conditional requests, + e.g. when using ETags to avoid write conflicts. + content: + application/problem+json: + schema: + $ref: '#/components/schemas/ProblemDetails' + text/plain: + schema: + $ref: '#/components/schemas/Empty' + Error.429: + description: >- + Too Many Requests. + It is used when a rate limiter has triggered. + content: + application/problem+json: + schema: + $ref: '#/components/schemas/ProblemDetails' + text/plain: + schema: + $ref: '#/components/schemas/Empty' + requestBodies: + ApplicationsSubscriptions: + content: + application/json: + schema: + $ref: '#/components/schemas/SerAvailabilityNotificationSubscription' + description: >- + Entity body in the request contains a subscription to the MEC + application termination notifications that is to be created. + required: true + Services: + content: + application/json: + schema: + $ref: '#/components/schemas/ServiceInfo' + description: >- + New ServiceInfo with updated "state" is included as entity body of the + request + required: true + Services.Post: + content: + application/json: + schema: + $ref: '#/components/schemas/ServiceInfo.Post' + description: >- + New ServiceInfo with updated "state" is included as entity body of the + request + required: true + ServicesServiceId: + content: + application/json: + schema: + $ref: '#/components/schemas/ServiceInfo' + description: >- + New ServiceInfo with updated "state" is included as entity body of the + request + required: true + ServiceAvailabilityNotification: + content: + application/json: + schema: + $ref: '#/components/schemas/ServiceAvailabilityNotification' + required: true + callbacks: + ServiceAvailabilityNotification: + '{$request.body#/callbackReference}': + post: + description: >- + 'Represents the service availability information that + is used in the following cases + - when the MEC platform announces the newly available + services to the authorized relevant MEC applications (e.g. + the applications that indicate the services as "optional" + or "required") that are subscribed to the corresponding + service availability notifications + - when the MEC platform notifies the authorized relevant + applications that are subscribed to the corresponding + service availability notifications about the service availability changes.' + operationId: ServiceAvailabilityNotification_POST + tags: + - callbacks + requestBody: + $ref: '#/components/requestBodies/ServiceAvailabilityNotification' + responses: + '200': + description: Expected responses from callback consumer, if it accepts the callback + links: + GetIndividualmecService: + operationId: ServicesServiceId_GET + description: The `serviceId` value returned in the response can be used as the `serviceId` parameter in `GET /services/{serviceId}` + parameters: + serviceId: '$response.body#/serviceId' + PutIndividualmecService: + operationId: ServicesServiceId_PUT + description: The `serviceId` value returned in the response can be used as the `serviceId` parameter in `PUT /services/{serviceId}` + parameters: + serviceId: '$response.body#/serviceId' + GetTransportInfo: + operationId: AppServices_POST + description: The `id` value returned in the response can be used as the `transportId` parameter in `POST /applications/{appInstanceId}/services`. The first transport is provided as the link as wildcards are not supported + parameters: + transportId: '$response.body#/0/id' + GetIndividualmecSerMgmtApiSubscription: + operationId: ApplicationsSubscription_GET + description: The `subscriptionId` value returned in the response can be used as the `subscriptionId` parameter in `GET /applications/{appInstanceId}/subscriptions/{subscriptionId}` + parameters: + description: regex = \/mec_service_mgmt\/v1\/applications\/.*\/subscriptions\/.*\/(.*);subscriptionId = href.match(regex)[1];// where "href" is an attribute within the subscription attribute within the _links attribute + subscriptionId: 'TBC' + DelIndividualmecSerMgmtApiSubscription: + operationId: ApplicationsSubscription_DELETE + description: The `subscriptionId` value returned in the response can be used as the `subscriptionId` parameter in `DELETE /applications/{appInstanceId}/subscriptions/{subscriptionId}` + parameters: + description: regex = \/mec_service_mgmt\/v1\/applications\/.*\/subscriptions\/(.*);subscriptionId = href.match(regex)[1];// where "href" is an attribute within the subscription attribute within the _links attribute + subscriptionId: 'TBC' + GetIndividualmecSerMgmtApiSubscriptionLinkList: + operationId: ApplicationsSubscription_GET + description: The `subscriptionId` value returned in the response can be used as the `subscriptionId` parameter in `GET /applications/{appInstanceId}/subscriptions/{subscriptionId}` + parameters: + description: regex = \/mec_service_mgmt\/v1\/applications\/.*\/subscriptions\/(.*);subscriptionId = href.match(regex)[1];// where "href" is an attribute within the subscription attribute within the _links attribute + subscriptionId: 'TBC' + DelIndividualmecSerMgmtApiSubscriptionLinkList: + operationId: ApplicationsSubscription_DELETE + description: The `subscriptionId` value returned in the response can be used as the `subscriptionId` parameter in `DELETE /applications/{appInstanceId}/subscriptions/{subscriptionId}` + parameters: + description: regex = \/mec_service_mgmt\/v1\/applications\/.*\/subscriptions\/(.*);subscriptionId = href.match(regex)[1];// where "href" is an attribute within the subscription attribute within the _links attribute + subscriptionId: 'TBC' + examples: + ServiceInfo: + value: + serInstanceId: 'ServiceInstance123' + serName: 'ExampleService' + serCategory: + href: 'catItem1' + id: 'id12345' + name: 'RNI' + version: 'version1' + version: 'ServiceVersion1' + state: 'ACTIVE' + transportInfo: + id: 'TransId12345' + name: 'REST' + description: 'REST API' + type: 'REST_HTTP' + protocol: 'HTTP' + version: '2.0' + endpoint: + uris: + - '/mecSerMgmtApi/service/EntryPoint' + security: + oAuth2Info: + grantTypes: + - 'OAUTH2_CLIENT_CREDENTIALS' + tokenEndpoint: '/mecSerMgmtApi/security/TokenEndPoint' + serializer: 'JSON' + ServiceInfoList: + value: + - serInstanceId: 'ServiceInstance123' + serName: 'ExampleService' + serCategory: + href: 'catItem1' + id: 'id12345' + name: 'RNI' + version: 'version1' + version: 'ServiceVersion1' + state: 'ACTIVE' + transportInfo: + id: 'TransId12345' + name: 'REST' + description: 'REST API' + type: 'REST_HTTP' + protocol: 'HTTP' + version: '2.0' + endpoint: + addresses: + - host: '192.0.2.0' + port: 8080 + security: + oAuth2Info: + grantTypes: + - 'OAUTH2_CLIENT_CREDENTIALS' + tokenEndpoint: '/mecSerMgmtApi/security/TokenEndPoint' + serializer: 'JSON' \ No newline at end of file -- GitLab From aa2671ee0b59ef0def60572c4c84e0d38e8e75e4 Mon Sep 17 00:00:00 2001 From: kharim Date: Tue, 23 Jul 2019 19:17:07 +0530 Subject: [PATCH 15/21] Updated to GS version 2.0.10 Signed-off-by: kharim --- MecServiceMgmtApi.json | 181 +++++++++++++++++++++++++++++++---------- MecServiceMgmtApi.yaml | 159 +++++++++++++++++++++++++++--------- 2 files changed, 259 insertions(+), 81 deletions(-) diff --git a/MecServiceMgmtApi.json b/MecServiceMgmtApi.json index 0d92395..08bdd64 100644 --- a/MecServiceMgmtApi.json +++ b/MecServiceMgmtApi.json @@ -10,7 +10,7 @@ ], "info": { "title": "MEC Service Management API", - "version": "2.0.9", + "version": "2.0.10", "description": "The ETSI MEC ISG MEC011 MEC Service Management API described using OpenAPI", "license": { "name": "ETSI Forge copyright notice", @@ -21,8 +21,8 @@ } }, "externalDocs": { - "description": "ETSI GS MEC011 Application Enablement API, V2.0.9", - "url": "https://docbox.etsi.org/ISG/MEC/70-Draft/0011v211Plat.App.Enabl/MEC-0011v211Plat.App.Enablv209.zip" + "description": "ETSI GS MEC011 Application Enablement API, V2.0.10", + "url": "https://docbox.etsi.org/ISG/MEC/70-Draft/0011v211Plat.App.Enabl/MEC-0011v211Plat.App.Enablv2010.zip" }, "tags": [ { @@ -66,7 +66,7 @@ "$ref": "#/components/parameters/Query.Is_local" }, { - "$ref": "#/components/parameters/Query.LocalityTypes" + "$ref": "#/components/parameters/Query.LocalityType" } ], "responses": { @@ -142,7 +142,7 @@ "$ref": "#/components/parameters/Query.Is_local" }, { - "$ref": "#/components/parameters/Query.LocalityTypes" + "$ref": "#/components/parameters/Query.LocalityType" } ], "responses": { @@ -422,6 +422,14 @@ } } }, + "CategoryRefs": { + "description": "Categories of services about which to report events.", + "type": "array", + "minItems": 0, + "items": { + "type": "string" + } + }, "EndPointInfo.Address.Host": { "description": "Host portion of the address", "type": "string", @@ -605,8 +613,8 @@ "format": "uri", "description": "A URI reference according to IETF RFC 3986 that identifies the problem type" }, - "SecurityInfo.OAuth2Info.GrantTypes": { - "description": "List of supported OAuth 2.0 grant types", + "SecurityInfo.OAuth2Info.GrantType": { + "description": "OAuth 2.0 grant type", "type": "string", "enum": [ "OAUTH2_AUTHORIZATION_CODE", @@ -616,6 +624,15 @@ ], "example": "OAUTH2_CLIENT_CREDENTIALS" }, + "SecurityInfo.OAuth2Info.GrantTypes": { + "description": "List of supported OAuth 2.0 grant types.", + "type": "array", + "minItems": 1, + "maxItems": 4, + "items": { + "$ref": "#/components/schemas/SecurityInfo.OAuth2Info.GrantType" + } + }, "SecurityInfo.OAuth2Info.TokenEndpoint": { "description": "The token endpoint", "type": "string", @@ -630,13 +647,7 @@ ], "properties": { "grantTypes": { - "description": "List of supported OAuth 2.0 grant types.", - "type": "array", - "minItems": 1, - "maxItems": 4, - "items": { - "$ref": "#/components/schemas/SecurityInfo.OAuth2Info.GrantTypes" - } + "$ref": "#/components/schemas/SecurityInfo.OAuth2Info.GrantTypes" }, "tokenEndpoint": { "$ref": "#/components/schemas/SecurityInfo.OAuth2Info.TokenEndpoint" @@ -677,8 +688,7 @@ "required": [ "subscriptionType", "callbackReference", - "_links", - "filteringCriteria" + "_links" ], "properties": { "subscriptionType": { @@ -691,7 +701,35 @@ "$ref": "#/components/schemas/Self" }, "filteringCriteria": { - "$ref": "#/components/schemas/ServiceInfo" + "$ref": "#/components/schemas/SerAvailabilityNotificationSubscription.FilteringCriteria" + } + } + }, + "SerAvailabilityNotificationSubscription.FilteringCriteria": { + "description": "Filtering criteria to match services for which events are requested to be reported. If absent, matches all services. All child attributes are combined with the logical \"AND\" operation.", + "type": "object", + "not": { + "required": [ + "serInstanceIds", + "serNames", + "serCategories" + ] + }, + "properties": { + "serInstanceIds": { + "$ref": "#/components/schemas/SerInstanceIds" + }, + "serNames": { + "$ref": "#/components/schemas/SerNames" + }, + "serCategories": { + "$ref": "#/components/schemas/CategoryRefs" + }, + "states": { + "$ref": "#/components/schemas/ServiceStates" + }, + "isLocal": { + "$ref": "#/components/schemas/ServiceInfo.IsLocal" } } }, @@ -705,17 +743,17 @@ "type": "object", "required": [ "notificationType", - "services", + "serviceReferences", "_links" ], "properties": { "notificationType": { "$ref": "#/components/schemas/SerAvailabilityNotificationSubscription.SubscriptionType" }, - "services": { + "serviceReferences": { "type": "array", "items": { - "$ref": "#/components/schemas/ServiceInfo" + "$ref": "#/components/schemas/ServiceAvailabilityNotification.ServiceReferences" } }, "_links": { @@ -723,8 +761,45 @@ } } }, - "SerializerTypes": { - "description": "The enumeration SerializerTypes represents types of serializers", + "ServiceAvailabilityNotification.ServiceReferences": { + "description": "List of links to services whose availability has changed.", + "type": "object", + "required": [ + "serName", + "serInstanceId", + "state", + "changeType" + ], + "properties": { + "link": { + "$ref": "#/components/schemas/LinkType" + }, + "serName": { + "$ref": "#/components/schemas/ServiceInfo.SerName" + }, + "serInstanceId": { + "$ref": "#/components/schemas/ServiceInfo.SerInstanceId" + }, + "state": { + "$ref": "#/components/schemas/ServiceState" + }, + "changeType": { + "$ref": "#/components/schemas/ServiceAvailabilityNotification.ChangeType" + } + } + }, + "ServiceAvailabilityNotification.ChangeType": { + "description": "Type of the change. Valid values:\n ADDED: The service was newly added.\n REMOVED: The service was removed.\n STATE_CHANGED: Only the state of the service was changed. \n ATTRIBUTES_CHANGED: At least one attribute of the service other than state was changed. The change may or may not include changing the state.", + "type": "string", + "enum": [ + "ADDED", + "REMOVED", + "STATE_CHANGED", + "ATTRIBUTES_CHANGED" + ] + }, + "SerializerType": { + "description": "The enumeration represents types of serializers", "type": "string", "enum": [ "JSON", @@ -733,7 +808,7 @@ ], "example": "JSON" }, - "LocalityTypes": { + "LocalityType": { "description": "The scope of locality as expressed by \"consumedLocalOnly\" and \"isLocal\". If absent, defaults to MEC_HOST", "type": "string", "enum": [ @@ -746,25 +821,49 @@ ], "example": "MEC_SYSTEM" }, + "ServiceState": { + "description": "This enumeration defines the possible states of a service.", + "type": "string", + "enum": [ + "ACTIVE", + "INACTIVE" + ], + "example": "ACTIVE" + }, + "ServiceStates": { + "description": "States of the services about which to report events. If the event is a state change, this filter represents the state after the change.", + "type": "array", + "minItems": 0, + "items": { + "$ref": "#/components/schemas/ServiceState" + } + }, "ServiceInfo.SerInstanceId": { "description": "Identifier of the service instance assigned by the MEC platform.", "type": "string", "readOnly": true, "example": "ServiceInstance123" }, + "SerInstanceIds": { + "description": "Identifiers of service instances about which to report events.", + "type": "array", + "minItems": 0, + "items": { + "$ref": "#/components/schemas/ServiceInfo.SerInstanceId" + } + }, "ServiceInfo.SerName": { "description": "The name of the service. This is how the service producing MEC application identifies the service instance it produces.", "type": "string", "example": "ExampleService" }, - "ServiceInfo.State": { - "description": "Contains the state", - "type": "string", - "enum": [ - "ACTIVE", - "INACTIVE" - ], - "example": "ACTIVE" + "SerNames": { + "description": "Names of services about which to report events.", + "type": "array", + "minItems": 0, + "items": { + "$ref": "#/components/schemas/ServiceInfo.SerName" + } }, "ServiceInfo.TransportId": { "description": "Identifier of the platform-provided transport to be used by the service. Valid identifiers may be obtained using the \"Transport information query\" procedure. May be present in POST requests to signal the use of a platform-provided transport for the service, and shall be absent otherwise.", @@ -822,7 +921,7 @@ "$ref": "#/components/schemas/ServiceInfo.Version" }, "state": { - "$ref": "#/components/schemas/ServiceInfo.State" + "$ref": "#/components/schemas/ServiceState" }, "transportId": { "$ref": "#/components/schemas/ServiceInfo.TransportId" @@ -831,10 +930,10 @@ "$ref": "#/components/schemas/TransportInfo" }, "serializer": { - "$ref": "#/components/schemas/SerializerTypes" + "$ref": "#/components/schemas/SerializerType" }, "scopeOfLocality": { - "$ref": "#/components/schemas/LocalityTypes" + "$ref": "#/components/schemas/LocalityType" }, "consumedLocalOnly": { "$ref": "#/components/schemas/ServiceInfo.ConsumedLocalOnly" @@ -868,16 +967,16 @@ "$ref": "#/components/schemas/ServiceInfo.Version" }, "state": { - "$ref": "#/components/schemas/ServiceInfo.State" + "$ref": "#/components/schemas/ServiceState" }, "transportInfo": { "$ref": "#/components/schemas/TransportInfo" }, "serializer": { - "$ref": "#/components/schemas/SerializerTypes" + "$ref": "#/components/schemas/SerializerType" }, "scopeOfLocality": { - "$ref": "#/components/schemas/LocalityTypes" + "$ref": "#/components/schemas/LocalityType" }, "consumedLocalOnly": { "$ref": "#/components/schemas/ServiceInfo.ConsumedLocalOnly" @@ -951,7 +1050,7 @@ "$ref": "#/components/schemas/TransportInfo.Description" }, "type": { - "$ref": "#/components/schemas/TransportTypes" + "$ref": "#/components/schemas/TransportType" }, "protocol": { "$ref": "#/components/schemas/TransportInfo.Protocol" @@ -982,8 +1081,8 @@ } } }, - "TransportTypes": { - "description": "The enumeration TransportTypes represents types of transports", + "TransportType": { + "description": "The enumeration TransportType represents types of transports", "type": "string", "enum": [ "REST_HTTP", @@ -1058,7 +1157,7 @@ } } }, - "Query.LocalityTypes": { + "Query.LocalityType": { "name": "scope_of_locality", "description": "A MEC application instance may use scope_of_locality as an input parameter to query the availability of a list of MEC service instances with a certain scope of locality.", "in": "query", diff --git a/MecServiceMgmtApi.yaml b/MecServiceMgmtApi.yaml index f339d63..fb116e6 100644 --- a/MecServiceMgmtApi.yaml +++ b/MecServiceMgmtApi.yaml @@ -4,7 +4,7 @@ servers: - url: 'https://127.0.0.1:8081/mec_service_mgmt/v1' info: title: MEC Service Management API - version: 2.0.9 + version: 2.0.10 description: The ETSI MEC ISG MEC011 MEC Service Management API described using OpenAPI license: name: ETSI Forge copyright notice @@ -12,9 +12,9 @@ info: contact: email: cti_support@etsi.org externalDocs: - description: 'ETSI GS MEC011 Application Enablement API, V2.0.9' + description: 'ETSI GS MEC011 Application Enablement API, V2.0.10' url: >- - https://docbox.etsi.org/ISG/MEC/70-Draft/0011v211Plat.App.Enabl/MEC-0011v211Plat.App.Enablv209.zip + https://docbox.etsi.org/ISG/MEC/70-Draft/0011v211Plat.App.Enabl/MEC-0011v211Plat.App.Enablv2010.zip tags: - name: appSubscriptions - name: appServices @@ -36,7 +36,7 @@ paths: - $ref: '#/components/parameters/Query.Ser_category_id' - $ref: '#/components/parameters/Query.Consumed_local_only' - $ref: '#/components/parameters/Query.Is_local' - - $ref: '#/components/parameters/Query.LocalityTypes' + - $ref: '#/components/parameters/Query.LocalityType' responses: '200': $ref: '#/components/responses/Services.200' @@ -81,7 +81,7 @@ paths: - $ref: '#/components/parameters/Query.Ser_category_id' - $ref: '#/components/parameters/Query.Consumed_local_only' - $ref: '#/components/parameters/Query.Is_local' - - $ref: '#/components/parameters/Query.LocalityTypes' + - $ref: '#/components/parameters/Query.LocalityType' responses: '200': $ref: '#/components/responses/Services.200' @@ -283,6 +283,12 @@ components: $ref: '#/components/schemas/CategoryRef.Name' version: $ref: '#/components/schemas/CategoryRef.Version' + CategoryRefs: + description: Categories of services about which to report events. + type: array + minItems: 0 + items: + type: string EndPointInfo.Address.Host: description: Host portion of the address type: string @@ -425,8 +431,8 @@ components: description: >- A URI reference according to IETF RFC 3986 that identifies the problem type - SecurityInfo.OAuth2Info.GrantTypes: - description: List of supported OAuth 2.0 grant types + SecurityInfo.OAuth2Info.GrantType: + description: OAuth 2.0 grant type type: string enum: - OAUTH2_AUTHORIZATION_CODE @@ -434,6 +440,14 @@ components: - OAUTH2_RESOURCE_OWNER - OAUTH2_CLIENT_CREDENTIALS example: 'OAUTH2_CLIENT_CREDENTIALS' + SecurityInfo.OAuth2Info.GrantTypes: + description: >- + List of supported OAuth 2.0 grant types. + type: array + minItems: 1 + maxItems: 4 + items: + $ref: '#/components/schemas/SecurityInfo.OAuth2Info.GrantType' SecurityInfo.OAuth2Info.TokenEndpoint: description: The token endpoint type: string @@ -446,13 +460,7 @@ components: - tokenEndpoint properties: grantTypes: - description: >- - List of supported OAuth 2.0 grant types. - type: array - minItems: 1 - maxItems: 4 - items: - $ref: '#/components/schemas/SecurityInfo.OAuth2Info.GrantTypes' + $ref: '#/components/schemas/SecurityInfo.OAuth2Info.GrantTypes' tokenEndpoint: $ref: '#/components/schemas/SecurityInfo.OAuth2Info.TokenEndpoint' type: object @@ -489,7 +497,6 @@ components: - subscriptionType - callbackReference - _links - - filteringCriteria properties: subscriptionType: $ref: >- @@ -500,7 +507,27 @@ components: _links: $ref: '#/components/schemas/Self' filteringCriteria: - $ref: '#/components/schemas/ServiceInfo' + $ref: >- + #/components/schemas/SerAvailabilityNotificationSubscription.FilteringCriteria + SerAvailabilityNotificationSubscription.FilteringCriteria: + description: >- + Filtering criteria to match services for which events are requested to be reported. + If absent, matches all services. All child attributes are combined with the logical + "AND" operation. + type: object + not: + required: [serInstanceIds, serNames, serCategories] + properties: + serInstanceIds: + $ref: '#/components/schemas/SerInstanceIds' + serNames: + $ref: '#/components/schemas/SerNames' + serCategories: + $ref: '#/components/schemas/CategoryRefs' + states: + $ref: '#/components/schemas/ServiceStates' + isLocal: + $ref: '#/components/schemas/ServiceInfo.IsLocal' SerAvailabilityNotificationSubscription.SubscriptionType: description: Shall be set to SerAvailabilityNotificationSubscription. type: string @@ -511,27 +538,59 @@ components: type: object required: - notificationType - - services + - serviceReferences - _links properties: notificationType: $ref: >- #/components/schemas/SerAvailabilityNotificationSubscription.SubscriptionType - services: + serviceReferences: type: array items: - $ref: '#/components/schemas/ServiceInfo' + $ref: '#/components/schemas/ServiceAvailabilityNotification.ServiceReferences' _links: $ref: '#/components/schemas/Subscription' - SerializerTypes: - description: The enumeration SerializerTypes represents types of serializers + ServiceAvailabilityNotification.ServiceReferences: + description: List of links to services whose availability has changed. + type: object + required: + - serName + - serInstanceId + - state + - changeType + properties: + link: + $ref: '#/components/schemas/LinkType' + serName: + $ref: '#/components/schemas/ServiceInfo.SerName' + serInstanceId: + $ref: '#/components/schemas/ServiceInfo.SerInstanceId' + state: + $ref: '#/components/schemas/ServiceState' + changeType: + $ref: '#/components/schemas/ServiceAvailabilityNotification.ChangeType' + ServiceAvailabilityNotification.ChangeType: + description: >- + Type of the change. Valid values: + ADDED: The service was newly added. + REMOVED: The service was removed. + STATE_CHANGED: Only the state of the service was changed. + ATTRIBUTES_CHANGED: At least one attribute of the service other than state was changed. The change may or may not include changing the state. + type: string + enum: + - ADDED + - REMOVED + - STATE_CHANGED + - ATTRIBUTES_CHANGED + SerializerType: + description: The enumeration represents types of serializers type: string enum: - JSON - XML - PROTOBUF3 example: 'JSON' - LocalityTypes: + LocalityType: description: The scope of locality as expressed by "consumedLocalOnly" and "isLocal". If absent, defaults to MEC_HOST type: string enum: @@ -542,25 +601,45 @@ components: - ZONE_GROUP - NFVI_NODE example: 'MEC_SYSTEM' + ServiceState: + description: This enumeration defines the possible states of a service. + type: string + enum: + - ACTIVE + - INACTIVE + example: 'ACTIVE' + ServiceStates: + description: >- + States of the services about which to report events. If the event is + a state change, this filter represents the state after the change. + type: array + minItems: 0 + items: + $ref: '#/components/schemas/ServiceState' ServiceInfo.SerInstanceId: description: >- Identifier of the service instance assigned by the MEC platform. type: string readOnly: true example: 'ServiceInstance123' + SerInstanceIds: + description: Identifiers of service instances about which to report events. + type: array + minItems: 0 + items: + $ref: '#/components/schemas/ServiceInfo.SerInstanceId' ServiceInfo.SerName: description: >- The name of the service. This is how the service producing MEC application identifies the service instance it produces. type: string example: 'ExampleService' - ServiceInfo.State: - description: Contains the state - type: string - enum: - - ACTIVE - - INACTIVE - example: 'ACTIVE' + SerNames: + description: Names of services about which to report events. + type: array + minItems: 0 + items: + $ref: '#/components/schemas/ServiceInfo.SerName' ServiceInfo.TransportId: description: >- Identifier of the platform-provided transport to be used by the service. @@ -609,15 +688,15 @@ components: version: $ref: '#/components/schemas/ServiceInfo.Version' state: - $ref: '#/components/schemas/ServiceInfo.State' + $ref: '#/components/schemas/ServiceState' transportId: $ref: '#/components/schemas/ServiceInfo.TransportId' transportInfo: $ref: '#/components/schemas/TransportInfo' serializer: - $ref: '#/components/schemas/SerializerTypes' + $ref: '#/components/schemas/SerializerType' scopeOfLocality: - $ref: '#/components/schemas/LocalityTypes' + $ref: '#/components/schemas/LocalityType' consumedLocalOnly: $ref: '#/components/schemas/ServiceInfo.ConsumedLocalOnly' isLocal: @@ -641,13 +720,13 @@ components: version: $ref: '#/components/schemas/ServiceInfo.Version' state: - $ref: '#/components/schemas/ServiceInfo.State' + $ref: '#/components/schemas/ServiceState' transportInfo: $ref: '#/components/schemas/TransportInfo' serializer: - $ref: '#/components/schemas/SerializerTypes' + $ref: '#/components/schemas/SerializerType' scopeOfLocality: - $ref: '#/components/schemas/LocalityTypes' + $ref: '#/components/schemas/LocalityType' consumedLocalOnly: $ref: '#/components/schemas/ServiceInfo.ConsumedLocalOnly' isLocal: @@ -702,7 +781,7 @@ components: description: $ref: '#/components/schemas/TransportInfo.Description' type: - $ref: '#/components/schemas/TransportTypes' + $ref: '#/components/schemas/TransportType' protocol: $ref: '#/components/schemas/TransportInfo.Protocol' version: @@ -718,8 +797,8 @@ components: $ref: '#/components/schemas/SecurityInfo' implSpecificInfo: $ref: '#/components/schemas/TransportInfo.ImplSpecificInfo' - TransportTypes: - description: The enumeration TransportTypes represents types of transports + TransportType: + description: The enumeration TransportType represents types of transports type: string enum: - REST_HTTP @@ -793,7 +872,7 @@ components: type: array items: type: string - Query.LocalityTypes: + Query.LocalityType: name: scope_of_locality description: >- A MEC application instance may use scope_of_locality as an input @@ -1062,7 +1141,7 @@ components: the applications that indicate the services as "optional" or "required") that are subscribed to the corresponding service availability notifications - - when the MEC platform notifies the authorized relevant + - when the MEC platform notifies the authorized relevant applications that are subscribed to the corresponding service availability notifications about the service availability changes.' operationId: ServiceAvailabilityNotification_POST -- GitLab From 17c81b30cd697a825dcb603b70f7dcec7c860428 Mon Sep 17 00:00:00 2001 From: kharim Date: Sun, 28 Jul 2019 12:25:20 +0530 Subject: [PATCH 16/21] Updated to GS version 2.0.11 Signed-off-by: kharim --- MecAppSupportApi.json | 48 ++++++++++++++++++++++++++++++++++++++---- MecAppSupportApi.yaml | 34 +++++++++++++++++++++++++++--- MecServiceMgmtApi.json | 2 +- MecServiceMgmtApi.yaml | 2 +- 4 files changed, 77 insertions(+), 9 deletions(-) diff --git a/MecAppSupportApi.json b/MecAppSupportApi.json index 8878fa0..f257373 100644 --- a/MecAppSupportApi.json +++ b/MecAppSupportApi.json @@ -10,7 +10,7 @@ ], "info": { "title": "MEC Application Support API", - "version": "2.0.9", + "version": "2.0.11", "description": "The ETSI MEC ISG MEC011 MEC Application Support API described using OpenAPI", "license": { "name": "ETSI Forge copyright notice", @@ -339,6 +339,9 @@ "204": { "description": "No Content" }, + "400": { + "$ref": "#/components/responses/Error.400" + }, "401": { "$ref": "#/components/responses/Error.401" }, @@ -354,6 +357,9 @@ "429": { "$ref": "#/components/responses/Error.429" } + }, + "requestBody": { + "$ref": "#/components/requestBodies/ApplicationsConfirmTermination" } } }, @@ -409,6 +415,18 @@ "Empty": { "description": "Empty schema" }, + "AppTerminationConfirmation": { + "description": "This type represents the information that the MEC application instance provides to the MEC platform when informing it that the application has completed its application level related terminate/stop actions, e.g. retention of application state in the case of stop.", + "type": "object", + "required": [ + "operationAction" + ], + "properties": { + "operationAction": { + "$ref": "#/components/schemas/OperationActionType" + } + } + }, "AppTerminationNotification.Links": { "description": "Object containing hyperlinks related to the resource.", "type": "object", @@ -440,6 +458,7 @@ "type": "object", "required": [ "notificationType", + "operationAction", "maxGracefulTimeout", "_links" ], @@ -447,6 +466,9 @@ "notificationType": { "$ref": "#/components/schemas/AppTerminationNotification.NotificationType" }, + "operationAction": { + "$ref": "#/components/schemas/OperationActionType" + }, "maxGracefulTimeout": { "$ref": "#/components/schemas/AppTerminationNotification.MaxGracefulTimeout" }, @@ -712,6 +734,15 @@ } } }, + "OperationActionType": { + "description": "Operation that is being performed on the MEC application instance.", + "type": "string", + "enum": [ + "STOPPING", + "TERMINATING" + ], + "example": "TERMINATING" + }, "ProblemDetails": { "type": "object", "properties": { @@ -1073,10 +1104,10 @@ "enum": [ "DROP", "FORWARD_DECAPSULATED", - "FORWARD_AS_IS", + "FORWARD_ENCAPSULATED", "PASSTHROUGH", "DUPLICATE_DECAPSULATED", - "DUPLICATE_AS_IS" + "DUPLICATE_ENCAPSULATED" ], "example": "DROP" }, @@ -1285,7 +1316,7 @@ } }, "ApplicationsSubscriptions.201": { - "description": "Entity body in the request contains a subscription to the MEC service availability notifications that is to be created.", + "description": "Entity body in the request contains a subscription to the MEC service availability notifications that is to be created.", "headers": { "location": { "description": "The resource URI of the created resource", @@ -1485,6 +1516,15 @@ } }, "requestBodies": { + "ApplicationsConfirmTermination": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/AppTerminationConfirmation" + } + } + } + }, "ApplicationsDnsRule": { "content": { "application/json": { diff --git a/MecAppSupportApi.yaml b/MecAppSupportApi.yaml index 764139d..a0fd2ea 100644 --- a/MecAppSupportApi.yaml +++ b/MecAppSupportApi.yaml @@ -4,7 +4,7 @@ servers: - url: 'https://127.0.0.1:8081/mec_app_support/v1' info: title: MEC Application Support API - version: 2.0.9 + version: 2.0.11 description: The ETSI MEC ISG MEC011 MEC Application Support API described using OpenAPI license: name: ETSI Forge copyright notice @@ -231,6 +231,8 @@ paths: responses: '204': description: No Content + '400': + $ref: '#/components/responses/Error.400' '401': $ref: '#/components/responses/Error.401' '403': @@ -241,6 +243,8 @@ paths: $ref: '#/components/responses/Error.409' '429': $ref: '#/components/responses/Error.429' + requestBody: + $ref: '#/components/requestBodies/ApplicationsConfirmTermination' '/timing/timing_caps': get: description: >- @@ -279,6 +283,15 @@ components: schemas: Empty: description: Empty schema + AppTerminationConfirmation: + description: >- + This type represents the information that the MEC application instance provides to the MEC platform when informing it that the application has completed its application level related terminate/stop actions, e.g. retention of application state in the case of stop. + type: object + required: + - operationAction + properties: + operationAction: + $ref: '#/components/schemas/OperationActionType' AppTerminationNotification.Links: description: >- Object containing hyperlinks related to the resource. @@ -309,11 +322,14 @@ components: type: object required: - notificationType + - operationAction - maxGracefulTimeout - _links properties: notificationType: $ref: '#/components/schemas/AppTerminationNotification.NotificationType' + operationAction: + $ref: '#/components/schemas/OperationActionType' maxGracefulTimeout: $ref: '#/components/schemas/AppTerminationNotification.MaxGracefulTimeout' _links: @@ -532,6 +548,13 @@ components: properties: _links: $ref: '#/components/schemas/MecAppSuptApiSubscriptionLinkList.Links' + OperationActionType: + description: Operation that is being performed on the MEC application instance. + type: string + enum: + - STOPPING + - TERMINATING + example: 'TERMINATING' ProblemDetails: type: object properties: @@ -829,10 +852,10 @@ components: enum: - DROP - FORWARD_DECAPSULATED - - FORWARD_AS_IS + - FORWARD_ENCAPSULATED - PASSTHROUGH - DUPLICATE_DECAPSULATED - - DUPLICATE_AS_IS + - DUPLICATE_ENCAPSULATED example: 'DROP' TrafficRule.FilterType: description: >- @@ -1144,6 +1167,11 @@ components: schema: $ref: '#/components/schemas/Empty' requestBodies: + ApplicationsConfirmTermination: + content: + application/json: + schema: + $ref: '#/components/schemas/AppTerminationConfirmation' ApplicationsDnsRule: content: application/json: diff --git a/MecServiceMgmtApi.json b/MecServiceMgmtApi.json index 08bdd64..6d64d22 100644 --- a/MecServiceMgmtApi.json +++ b/MecServiceMgmtApi.json @@ -10,7 +10,7 @@ ], "info": { "title": "MEC Service Management API", - "version": "2.0.10", + "version": "2.0.11", "description": "The ETSI MEC ISG MEC011 MEC Service Management API described using OpenAPI", "license": { "name": "ETSI Forge copyright notice", diff --git a/MecServiceMgmtApi.yaml b/MecServiceMgmtApi.yaml index fb116e6..516a9aa 100644 --- a/MecServiceMgmtApi.yaml +++ b/MecServiceMgmtApi.yaml @@ -4,7 +4,7 @@ servers: - url: 'https://127.0.0.1:8081/mec_service_mgmt/v1' info: title: MEC Service Management API - version: 2.0.10 + version: 2.0.11 description: The ETSI MEC ISG MEC011 MEC Service Management API described using OpenAPI license: name: ETSI Forge copyright notice -- GitLab From adfbadbcb178889e9fc1cbc404533d4dc739a2a1 Mon Sep 17 00:00:00 2001 From: Walter Featherstone Date: Mon, 12 Aug 2019 13:27:57 +0200 Subject: [PATCH 17/21] Update the Navigate and Edit API links --- README.md | 6 ++++-- 1 file changed, 4 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 1a41884..ac4e9c2 100644 --- a/README.md +++ b/README.md @@ -5,8 +5,10 @@ This repository contains OpenAPIs descriptions for the interfaces specified in E ## Online resources * [Specification document](https://docbox.etsi.org/ISG/MEC/70-Draft/0011v211Plat.App.Enabl/MEC-0011v211Plat.App.Enablv208.zip) -* [Navigate the API in the browser](https://forge.etsi.org/swagger/ui/?url=https://forge.etsi.org/gitlab/mec/gs011-app-enablement-api/raw/develop/Mp1.yaml). -* [Edit the API online](https://forge.etsi.org/swagger/editor/?url=https://forge.etsi.org/gitlab/mec/gs011-app-enablement-api/raw/develop/Mp1.yaml). +* [Navigate the MEC Application Support API in the browser](https://forge.etsi.org/swagger/ui/?url=https://forge.etsi.org/rep/mec/gs011-app-enablement-api/raw/develop/MecAppSupportApi.yaml). +* [Navigate the MEC Service Management API in the browser](https://forge.etsi.org/swagger/ui/?url=https://forge.etsi.org/rep/mec/gs011-app-enablement-api/raw/develop/MecServiceMgmtApi.yaml). +* [Edit the MEC Application Support API online](https://forge.etsi.org/swagger/editor/?url=https://forge.etsi.org/rep/mec/gs011-app-enablement-api/raw/develop/MecAppSupportApi.yaml). +* [Edit the MEC Service Management API online](https://forge.etsi.org/swagger/editor/?url=https://forge.etsi.org/rep/mec/gs011-app-enablement-api/raw/develop/MecServiceMgmtApi.yaml). -- GitLab From c85c20e81f67508b5042300004b3111873cd6376 Mon Sep 17 00:00:00 2001 From: ETSI CTI Date: Tue, 13 Aug 2019 18:27:59 +0200 Subject: [PATCH 18/21] Licensing information --- COPYRIGHT | 14 -------------- LICENSE | 23 +++++++++++++++++++++++ README.md | 18 +++--------------- 3 files changed, 26 insertions(+), 29 deletions(-) delete mode 100644 COPYRIGHT create mode 100644 LICENSE diff --git a/COPYRIGHT b/COPYRIGHT deleted file mode 100644 index 8574ed4..0000000 --- a/COPYRIGHT +++ /dev/null @@ -1,14 +0,0 @@ -ETSI FORGE COPYRIGHT STATEMENT - -Copyright (c) ETSI 2017. - -This software is subject to copyrights owned by ETSI. Non-exclusive permission -is hereby granted, free of charge, to copy, reproduce and amend this file -under the following conditions: It is provided "as is", without warranty of any -kind, expressed or implied. - -ETSI shall never be liable for any claim, damages, or other liability arising -from its use or inability of use.This permission does not apply to any documentation -associated with this file for which ETSI keeps all rights reserved. The present -copyright notice shall be included in all copies of whole or part of this -software and shall not imply any sub-license right. diff --git a/LICENSE b/LICENSE new file mode 100644 index 0000000..4436d6d --- /dev/null +++ b/LICENSE @@ -0,0 +1,23 @@ +Copyright 2019 ETSI + +Redistribution and use in source and binary forms, with or without +modification, are permitted provided that the following conditions are met: +1. Redistributions of source code must retain the above copyright notice, + this list of conditions and the following disclaimer. +2. Redistributions in binary form must reproduce the above copyright notice, + this list of conditions and the following disclaimer in the documentation + and/or other materials provided with the distribution. +3. Neither the name of the copyright holder nor the names of its contributors + may be used to endorse or promote products derived from this software without + specific prior written permission. + +THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND +ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED +WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. +IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, +INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, +BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, +DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF +LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE +OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED +OF THE POSSIBILITY OF SUCH DAMAGE. \ No newline at end of file diff --git a/README.md b/README.md index ac4e9c2..c6d22ef 100644 --- a/README.md +++ b/README.md @@ -10,19 +10,7 @@ This repository contains OpenAPIs descriptions for the interfaces specified in E * [Edit the MEC Application Support API online](https://forge.etsi.org/swagger/editor/?url=https://forge.etsi.org/rep/mec/gs011-app-enablement-api/raw/develop/MecAppSupportApi.yaml). * [Edit the MEC Service Management API online](https://forge.etsi.org/swagger/editor/?url=https://forge.etsi.org/rep/mec/gs011-app-enablement-api/raw/develop/MecServiceMgmtApi.yaml). +## License - -## ETSI Forge Copyright statement - -Copyright (c) ETSI 2019. - -This software is subject to copyrights owned by ETSI. Non-exclusive permission -is hereby granted, free of charge, to copy, reproduce and amend this file -under the following conditions: It is provided "as is", without warranty of any -kind, expressed or implied. - -ETSI shall never be liable for any claim, damages, or other liability arising -from its use or inability of use.This permission does not apply to any documentation -associated with this file for which ETSI keeps all rights reserved. The present -copyright notice shall be included in all copies of whole or part of this -software and shall not imply any sub-license right. +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. \ No newline at end of file -- GitLab From e5c689b7fb9af910c4f6a07bfa6e40575e2ed159 Mon Sep 17 00:00:00 2001 From: ETSI CTI Date: Tue, 17 Sep 2019 10:58:31 +0200 Subject: [PATCH 19/21] Update license information --- MecAppSupportApi.json | 6 +++--- MecAppSupportApi.yaml | 6 +++--- MecServiceMgmtApi.json | 6 +++--- MecServiceMgmtApi.yaml | 6 +++--- 4 files changed, 12 insertions(+), 12 deletions(-) diff --git a/MecAppSupportApi.json b/MecAppSupportApi.json index f257373..941fee6 100644 --- a/MecAppSupportApi.json +++ b/MecAppSupportApi.json @@ -13,8 +13,8 @@ "version": "2.0.11", "description": "The ETSI MEC ISG MEC011 MEC Application Support API described using OpenAPI", "license": { - "name": "ETSI Forge copyright notice", - "url": "https://forge.etsi.org/etsi-forge-copyright-notice.txt" + "name": "BSD-3-Clause", + "url": "https://forge.etsi.org/legal-matters" }, "contact": { "email": "cti_support@etsi.org" @@ -1743,4 +1743,4 @@ } } } -} \ No newline at end of file +} diff --git a/MecAppSupportApi.yaml b/MecAppSupportApi.yaml index a0fd2ea..e3f07a0 100644 --- a/MecAppSupportApi.yaml +++ b/MecAppSupportApi.yaml @@ -7,8 +7,8 @@ info: version: 2.0.11 description: The ETSI MEC ISG MEC011 MEC Application Support API described using OpenAPI license: - name: ETSI Forge copyright notice - url: 'https://forge.etsi.org/etsi-forge-copyright-notice.txt' + name: BSD-3-Clause + url: 'https://forge.etsi.org/legal-matters' contact: email: cti_support@etsi.org externalDocs: @@ -1322,4 +1322,4 @@ components: dstInterface: interfaceType: 'IP' dstIpAddress: '20.1.1.1' - state: 'ACTIVE' \ No newline at end of file + state: 'ACTIVE' diff --git a/MecServiceMgmtApi.json b/MecServiceMgmtApi.json index 6d64d22..2f00d24 100644 --- a/MecServiceMgmtApi.json +++ b/MecServiceMgmtApi.json @@ -13,8 +13,8 @@ "version": "2.0.11", "description": "The ETSI MEC ISG MEC011 MEC Service Management API described using OpenAPI", "license": { - "name": "ETSI Forge copyright notice", - "url": "https://forge.etsi.org/etsi-forge-copyright-notice.txt" + "name": "BSD-3-Clause", + "url": "https://forge.etsi.org/legal-matters" }, "contact": { "email": "cti_support@etsi.org" @@ -1647,4 +1647,4 @@ } } } -} \ No newline at end of file +} diff --git a/MecServiceMgmtApi.yaml b/MecServiceMgmtApi.yaml index 516a9aa..8270e25 100644 --- a/MecServiceMgmtApi.yaml +++ b/MecServiceMgmtApi.yaml @@ -7,8 +7,8 @@ info: version: 2.0.11 description: The ETSI MEC ISG MEC011 MEC Service Management API described using OpenAPI license: - name: ETSI Forge copyright notice - url: 'https://forge.etsi.org/etsi-forge-copyright-notice.txt' + name: BSD-3-Clause + url: 'https://forge.etsi.org/legal-matters' contact: email: cti_support@etsi.org externalDocs: @@ -1247,4 +1247,4 @@ components: grantTypes: - 'OAUTH2_CLIENT_CREDENTIALS' tokenEndpoint: '/mecSerMgmtApi/security/TokenEndPoint' - serializer: 'JSON' \ No newline at end of file + serializer: 'JSON' -- GitLab From 387ddb674d4ec47c19799ec8f28048b1ef77d65f Mon Sep 17 00:00:00 2001 From: "zakkir.kharim" Date: Sun, 8 Dec 2019 21:40:35 +0530 Subject: [PATCH 20/21] Updated to Published version 2.1.1 Signed-off-by: zakkir.kharim --- MecAppSupportApi.json | 86 +++++++++++++++++++++++++++++++++++++----- MecAppSupportApi.yaml | 67 ++++++++++++++++++++++++++------ MecServiceMgmtApi.json | 50 +++++++++++++++++++++--- MecServiceMgmtApi.yaml | 40 +++++++++++++++++--- 4 files changed, 211 insertions(+), 32 deletions(-) diff --git a/MecAppSupportApi.json b/MecAppSupportApi.json index f257373..4f642b8 100644 --- a/MecAppSupportApi.json +++ b/MecAppSupportApi.json @@ -10,7 +10,7 @@ ], "info": { "title": "MEC Application Support API", - "version": "2.0.11", + "version": "2.1.1", "description": "The ETSI MEC ISG MEC011 MEC Application Support API described using OpenAPI", "license": { "name": "ETSI Forge copyright notice", @@ -21,8 +21,8 @@ } }, "externalDocs": { - "description": "ETSI GS MEC011 Application Enablement API, V2.0.9", - "url": "https://docbox.etsi.org/ISG/MEC/70-Draft/0011v211Plat.App.Enabl/MEC-0011v211Plat.App.Enablv209.zip" + "description": "ETSI GS MEC011 Application Enablement API, V2.1.1", + "url": "https://www.etsi.org/deliver/etsi_gs/MEC/001_099/011/02.01.01_60/gs_MEC011v020101p.pdf" }, "tags": [ { @@ -37,6 +37,9 @@ { "name": "appConfirmTermination" }, + { + "name": "appConfirmReady" + }, { "name": "timing" }, @@ -339,9 +342,6 @@ "204": { "description": "No Content" }, - "400": { - "$ref": "#/components/responses/Error.400" - }, "401": { "$ref": "#/components/responses/Error.401" }, @@ -363,6 +363,43 @@ } } }, + "/applications/{appInstanceId}/confirm_ready": { + "parameters": [ + { + "$ref": "#/components/parameters/Path.AppInstanceId" + } + ], + "post": { + "description": "This method may be used by the MEC application instance to notify the MEC platform that it is up and running. ", + "operationId": "ApplicationsConfirmReady_POST", + "tags": [ + "appConfirmReady" + ], + "responses": { + "204": { + "description": "No Content" + }, + "401": { + "$ref": "#/components/responses/Error.401" + }, + "403": { + "$ref": "#/components/responses/Error.403" + }, + "404": { + "$ref": "#/components/responses/Error.404" + }, + "409": { + "$ref": "#/components/responses/Error.409" + }, + "429": { + "$ref": "#/components/responses/Error.429" + } + }, + "requestBody": { + "$ref": "#/components/requestBodies/ApplicationsConfirmReady" + } + } + }, "/timing/timing_caps": { "get": { "description": "This method retrieves the information of the platform's timing capabilities which corresponds to the timing capabilities query", @@ -415,6 +452,18 @@ "Empty": { "description": "Empty schema" }, + "AppReadyConfirmation": { + "description": "This type represents the information that the MEC application instance indicates to the MEC platform that it is up and running.", + "type": "object", + "required": [ + "indication" + ], + "properties": { + "indication": { + "$ref": "#/components/schemas/ReadyIndicationType" + } + } + }, "AppTerminationConfirmation": { "description": "This type represents the information that the MEC application instance provides to the MEC platform when informing it that the application has completed its application level related terminate/stop actions, e.g. retention of application state in the case of stop.", "type": "object", @@ -569,7 +618,7 @@ "example": "02-00-00-00-00-00" }, "DestinationInterface": { - "description": "This type represents the destination interface.", + "description": "This type represents the destination interface. If the action is FORWARD_DECAPSULATED, FORWARD_ENCAPSULATED or PASSTHROUGH one value shall be provided. If the action is DUPLICATE_DECAPSULATED or DUPLICATE_ENCAPSULATED, two values shall be provided. If the action is DROP, no value shall be provided.", "type": "object", "required": [ "interfaceType" @@ -617,7 +666,7 @@ "example": "IP_V6" }, "DnsRule.State": { - "description": "DNS rule state", + "description": "DNS rule state. This attribute may be updated using HTTP PUT method", "type": "string", "enum": [ "ACTIVE", @@ -786,6 +835,14 @@ "format": "uri", "description": "A URI reference according to IETF RFC 3986 that identifies the problem type" }, + "ReadyIndicationType": { + "description": "Indication about the MEC application instance.", + "type": "string", + "enum": [ + "READY" + ], + "example": "READY" + }, "Self": { "description": "Self-referring URI.", "type": "object", @@ -1099,7 +1156,7 @@ } }, "TrafficRule.Action": { - "description": "The action of the ME host data plane when a packet matches the trafficFilter", + "description": "The action of the MEC host data plane when a packet matches the trafficFilter\n ", "type": "string", "enum": [ "DROP", @@ -1132,7 +1189,7 @@ "example": 1 }, "TrafficRule.State": { - "description": "Contains the traffic rule state", + "description": "Contains the traffic rule state. This attribute may be updated using HTTP PUT method", "type": "string", "enum": [ "ACTIVE", @@ -1516,6 +1573,15 @@ } }, "requestBodies": { + "ApplicationsConfirmReady": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/AppReadyConfirmation" + } + } + } + }, "ApplicationsConfirmTermination": { "content": { "application/json": { diff --git a/MecAppSupportApi.yaml b/MecAppSupportApi.yaml index a0fd2ea..556f9f2 100644 --- a/MecAppSupportApi.yaml +++ b/MecAppSupportApi.yaml @@ -4,7 +4,7 @@ servers: - url: 'https://127.0.0.1:8081/mec_app_support/v1' info: title: MEC Application Support API - version: 2.0.11 + version: 2.1.1 description: The ETSI MEC ISG MEC011 MEC Application Support API described using OpenAPI license: name: ETSI Forge copyright notice @@ -12,14 +12,15 @@ info: contact: email: cti_support@etsi.org externalDocs: - description: 'ETSI GS MEC011 Application Enablement API, V2.0.9' + description: 'ETSI GS MEC011 Application Enablement API, V2.1.1' url: >- - https://docbox.etsi.org/ISG/MEC/70-Draft/0011v211Plat.App.Enabl/MEC-0011v211Plat.App.Enablv209.zip + https://www.etsi.org/deliver/etsi_gs/MEC/001_099/011/02.01.01_60/gs_MEC011v020101p.pdf tags: - name: appTrafficRules - name: appDnsRules - name: appSubscriptions - name: appConfirmTermination + - name: appConfirmReady - name: timing - name: callbacks paths: @@ -231,8 +232,8 @@ paths: responses: '204': description: No Content - '400': - $ref: '#/components/responses/Error.400' + + '401': $ref: '#/components/responses/Error.401' '403': @@ -245,6 +246,30 @@ paths: $ref: '#/components/responses/Error.429' requestBody: $ref: '#/components/requestBodies/ApplicationsConfirmTermination' + '/applications/{appInstanceId}/confirm_ready': + parameters: + - $ref: '#/components/parameters/Path.AppInstanceId' + post: + description: >- + This method may be used by the MEC application instance to notify the MEC platform that it is up and running. + operationId: ApplicationsConfirmReady_POST + tags: + - appConfirmReady + responses: + '204': + description: No Content + '401': + $ref: '#/components/responses/Error.401' + '403': + $ref: '#/components/responses/Error.403' + '404': + $ref: '#/components/responses/Error.404' + '409': + $ref: '#/components/responses/Error.409' + '429': + $ref: '#/components/responses/Error.429' + requestBody: + $ref: '#/components/requestBodies/ApplicationsConfirmReady' '/timing/timing_caps': get: description: >- @@ -283,6 +308,15 @@ components: schemas: Empty: description: Empty schema + AppReadyConfirmation: + description: >- + This type represents the information that the MEC application instance indicates to the MEC platform that it is up and running. + type: object + required: + - indication + properties: + indication: + $ref: '#/components/schemas/ReadyIndicationType' AppTerminationConfirmation: description: >- This type represents the information that the MEC application instance provides to the MEC platform when informing it that the application has completed its application level related terminate/stop actions, e.g. retention of application state in the case of stop. @@ -424,7 +458,7 @@ components: type: string example: '02-00-00-00-00-00' DestinationInterface: - description: This type represents the destination interface. + description: This type represents the destination interface. If the action is FORWARD_DECAPSULATED, FORWARD_ENCAPSULATED or PASSTHROUGH one value shall be provided. If the action is DUPLICATE_DECAPSULATED or DUPLICATE_ENCAPSULATED, two values shall be provided. If the action is DROP, no value shall be provided. type: object required: - interfaceType @@ -459,7 +493,7 @@ components: - IP_V4 example: 'IP_V6' DnsRule.State: - description: DNS rule state + description: DNS rule state. This attribute may be updated using HTTP PUT method type: string enum: - ACTIVE @@ -588,6 +622,12 @@ components: description: >- A URI reference according to IETF RFC 3986 that identifies the problem type + ReadyIndicationType: + description: Indication about the MEC application instance. + type: string + enum: + - READY + example: 'READY' Self: description: Self-referring URI. type: object @@ -846,8 +886,8 @@ components: $ref: '#/components/schemas/TrafficFilter.TC' TrafficRule.Action: description: >- - The action of the ME host data plane when a packet matches the - trafficFilter + The action of the MEC host data plane when a packet matches the trafficFilter + type: string enum: - DROP @@ -878,7 +918,7 @@ components: format: uint32 example: 1 TrafficRule.State: - description: Contains the traffic rule state + description: Contains the traffic rule state. This attribute may be updated using HTTP PUT method type: string enum: - ACTIVE @@ -1167,6 +1207,11 @@ components: schema: $ref: '#/components/schemas/Empty' requestBodies: + ApplicationsConfirmReady: + content: + application/json: + schema: + $ref: '#/components/schemas/AppReadyConfirmation' ApplicationsConfirmTermination: content: application/json: @@ -1322,4 +1367,4 @@ components: dstInterface: interfaceType: 'IP' dstIpAddress: '20.1.1.1' - state: 'ACTIVE' \ No newline at end of file + state: 'ACTIVE' diff --git a/MecServiceMgmtApi.json b/MecServiceMgmtApi.json index 6d64d22..169d092 100644 --- a/MecServiceMgmtApi.json +++ b/MecServiceMgmtApi.json @@ -10,7 +10,7 @@ ], "info": { "title": "MEC Service Management API", - "version": "2.0.11", + "version": "2.1.1", "description": "The ETSI MEC ISG MEC011 MEC Service Management API described using OpenAPI", "license": { "name": "ETSI Forge copyright notice", @@ -21,8 +21,8 @@ } }, "externalDocs": { - "description": "ETSI GS MEC011 Application Enablement API, V2.0.10", - "url": "https://docbox.etsi.org/ISG/MEC/70-Draft/0011v211Plat.App.Enabl/MEC-0011v211Plat.App.Enablv2010.zip" + "description": "ETSI GS MEC011 Application Enablement API, V2.1.1", + "url": "https://www.etsi.org/deliver/etsi_gs/MEC/001_099/011/02.01.01_60/gs_MEC011v020101p.pdf" }, "tags": [ { @@ -81,6 +81,9 @@ }, "404": { "$ref": "#/components/responses/Error.404" + }, + "414": { + "$ref": "#/components/responses/Error.414" } } } @@ -157,6 +160,9 @@ }, "404": { "$ref": "#/components/responses/Error.404" + }, + "414": { + "$ref": "#/components/responses/Error.414" } } }, @@ -241,6 +247,24 @@ "requestBody": { "$ref": "#/components/requestBodies/ServicesServiceId" } + }, + "delete": { + "description": "This method deletes a mecService resource. This method is typically used in the service deregistration procedure. ", + "operationId": "AppServicesServiceId_DELETE", + "tags": [ + "appServices" + ], + "responses": { + "204": { + "description": "No Content" + }, + "403": { + "$ref": "#/components/responses/Error.403" + }, + "404": { + "$ref": "#/components/responses/Error.404" + } + } } }, "/applications/{appInstanceId}/subscriptions": { @@ -381,7 +405,8 @@ "CategoryRef.Href": { "description": "Reference of the catalogue", "type": "string", - "example": "catItem1" + "format": "uri", + "example": "/example/catalogue1" }, "CategoryRef.Id": { "description": "Unique identifier of the category", @@ -427,7 +452,7 @@ "type": "array", "minItems": 0, "items": { - "type": "string" + "$ref": "#/components/schemas/CategoryRef" } }, "EndPointInfo.Address.Host": { @@ -1419,6 +1444,21 @@ } } }, + "Error.414": { + "description": "It is used to indicate that the server is refusing to process the request because the request URI is longer than the server is willing or able to process.", + "content": { + "application/problem+json": { + "schema": { + "$ref": "#/components/schemas/ProblemDetails" + } + }, + "text/plain": { + "schema": { + "$ref": "#/components/schemas/Empty" + } + } + } + }, "Error.429": { "description": "Too Many Requests. It is used when a rate limiter has triggered.", "content": { diff --git a/MecServiceMgmtApi.yaml b/MecServiceMgmtApi.yaml index 516a9aa..0e785c9 100644 --- a/MecServiceMgmtApi.yaml +++ b/MecServiceMgmtApi.yaml @@ -4,7 +4,7 @@ servers: - url: 'https://127.0.0.1:8081/mec_service_mgmt/v1' info: title: MEC Service Management API - version: 2.0.11 + version: 2.1.1 description: The ETSI MEC ISG MEC011 MEC Service Management API described using OpenAPI license: name: ETSI Forge copyright notice @@ -12,9 +12,9 @@ info: contact: email: cti_support@etsi.org externalDocs: - description: 'ETSI GS MEC011 Application Enablement API, V2.0.10' + description: 'ETSI GS MEC011 Application Enablement API, V2.1.1' url: >- - https://docbox.etsi.org/ISG/MEC/70-Draft/0011v211Plat.App.Enabl/MEC-0011v211Plat.App.Enablv2010.zip + https://www.etsi.org/deliver/etsi_gs/MEC/001_099/011/02.01.01_60/gs_MEC011v020101p.pdf tags: - name: appSubscriptions - name: appServices @@ -46,6 +46,8 @@ paths: $ref: '#/components/responses/Error.403' '404': $ref: '#/components/responses/Error.404' + '414': + $ref: '#/components/responses/Error.414' '/services/{serviceId}': parameters: - $ref: '#/components/parameters/Path.ServiceId' @@ -91,6 +93,8 @@ paths: $ref: '#/components/responses/Error.403' '404': $ref: '#/components/responses/Error.404' + '414': + $ref: '#/components/responses/Error.414' post: description: >- This method is used to create a mecService resource. This method is @@ -148,6 +152,19 @@ paths: $ref: '#/components/responses/Error.412' requestBody: $ref: '#/components/requestBodies/ServicesServiceId' + delete: + description: >- + This method deletes a mecService resource. This method is typically used in the service deregistration procedure. + operationId: AppServicesServiceId_DELETE + tags: + - appServices + responses: + '204': + description: No Content + '403': + $ref: '#/components/responses/Error.403' + '404': + $ref: '#/components/responses/Error.404' '/applications/{appInstanceId}/subscriptions': parameters: - $ref: '#/components/parameters/Path.AppInstanceId' @@ -253,7 +270,8 @@ components: CategoryRef.Href: description: Reference of the catalogue type: string - example: 'catItem1' + format: uri + example: '/example/catalogue1' CategoryRef.Id: description: Unique identifier of the category type: string @@ -287,8 +305,8 @@ components: description: Categories of services about which to report events. type: array minItems: 0 - items: - type: string + items: + $ref: '#/components/schemas/CategoryRef' EndPointInfo.Address.Host: description: Host portion of the address type: string @@ -1075,6 +1093,16 @@ components: text/plain: schema: $ref: '#/components/schemas/Empty' + Error.414: + description: >- + It is used to indicate that the server is refusing to process the request because the request URI is longer than the server is willing or able to process. + content: + application/problem+json: + schema: + $ref: '#/components/schemas/ProblemDetails' + text/plain: + schema: + $ref: '#/components/schemas/Empty' Error.429: description: >- Too Many Requests. -- GitLab From 04cda9c97c4f92f32c18f96ba7e29a5eaa912c1c Mon Sep 17 00:00:00 2001 From: "zakkir.kharim" Date: Sun, 8 Dec 2019 22:00:01 +0530 Subject: [PATCH 21/21] Updated to Published version 2.1.1 Signed-off-by: zakkir.kharim --- README.md | 7 ++++--- 1 file changed, 4 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index 1a41884..6813f22 100644 --- a/README.md +++ b/README.md @@ -4,9 +4,10 @@ This repository contains OpenAPIs descriptions for the interfaces specified in E ## Online resources -* [Specification document](https://docbox.etsi.org/ISG/MEC/70-Draft/0011v211Plat.App.Enabl/MEC-0011v211Plat.App.Enablv208.zip) -* [Navigate the API in the browser](https://forge.etsi.org/swagger/ui/?url=https://forge.etsi.org/gitlab/mec/gs011-app-enablement-api/raw/develop/Mp1.yaml). -* [Edit the API online](https://forge.etsi.org/swagger/editor/?url=https://forge.etsi.org/gitlab/mec/gs011-app-enablement-api/raw/develop/Mp1.yaml). +* [Specification document](https://www.etsi.org/deliver/etsi_gs/MEC/001_099/011/02.01.01_60/gs_MEC011v020101p.pdf) +* [Navigate the MEC Application Support API in the browser](https://forge.etsi.org/swagger/ui/?url=https://forge.etsi.org/gitlab/mec/gs011-app-enablement-api/raw/develop/MecAppSupportApi.yaml). +* [Navigate the MEC Service Management API in the browser](https://forge.etsi.org/swagger/ui/?url=https://forge.etsi.org/gitlab/mec/gs011-app-enablement-api/raw/develop_2.1.1/Mp1.yaml). +* [Edit the API online](https://forge.etsi.org/swagger/editor/?url=https://forge.etsi.org/gitlab/mec/gs011-app-enablement-api/raw/develop_2.1.1/MecServiceMgmtApi.yaml). -- GitLab