From 387ddb674d4ec47c19799ec8f28048b1ef77d65f Mon Sep 17 00:00:00 2001 From: "zakkir.kharim" Date: Sun, 8 Dec 2019 21:40:35 +0530 Subject: [PATCH] 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