Commit 387ddb67 authored by zakkir.kharim's avatar zakkir.kharim

Updated to Published version 2.1.1

Signed-off-by: 's avatarzakkir.kharim <zakkir.kharim@gmail.com>
parent 17c81b30
Pipeline #2111 passed with stage
in 0 seconds
...@@ -10,7 +10,7 @@ ...@@ -10,7 +10,7 @@
], ],
"info": { "info": {
"title": "MEC Application Support API", "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", "description": "The ETSI MEC ISG MEC011 MEC Application Support API described using OpenAPI",
"license": { "license": {
"name": "ETSI Forge copyright notice", "name": "ETSI Forge copyright notice",
...@@ -21,8 +21,8 @@ ...@@ -21,8 +21,8 @@
} }
}, },
"externalDocs": { "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" "url": "https://www.etsi.org/deliver/etsi_gs/MEC/001_099/011/02.01.01_60/gs_MEC011v020101p.pdf"
}, },
"tags": [ "tags": [
{ {
...@@ -37,6 +37,9 @@ ...@@ -37,6 +37,9 @@
{ {
"name": "appConfirmTermination" "name": "appConfirmTermination"
}, },
{
"name": "appConfirmReady"
},
{ {
"name": "timing" "name": "timing"
}, },
...@@ -339,9 +342,6 @@ ...@@ -339,9 +342,6 @@
"204": { "204": {
"description": "No Content" "description": "No Content"
}, },
"400": {
"$ref": "#/components/responses/Error.400"
},
"401": { "401": {
"$ref": "#/components/responses/Error.401" "$ref": "#/components/responses/Error.401"
}, },
...@@ -363,6 +363,43 @@ ...@@ -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": { "/timing/timing_caps": {
"get": { "get": {
"description": "This method retrieves the information of the platform's timing capabilities which corresponds to the timing capabilities query", "description": "This method retrieves the information of the platform's timing capabilities which corresponds to the timing capabilities query",
...@@ -415,6 +452,18 @@ ...@@ -415,6 +452,18 @@
"Empty": { "Empty": {
"description": "Empty schema" "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": { "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.", "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", "type": "object",
...@@ -569,7 +618,7 @@ ...@@ -569,7 +618,7 @@
"example": "02-00-00-00-00-00" "example": "02-00-00-00-00-00"
}, },
"DestinationInterface": { "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", "type": "object",
"required": [ "required": [
"interfaceType" "interfaceType"
...@@ -617,7 +666,7 @@ ...@@ -617,7 +666,7 @@
"example": "IP_V6" "example": "IP_V6"
}, },
"DnsRule.State": { "DnsRule.State": {
"description": "DNS rule state", "description": "DNS rule state. This attribute may be updated using HTTP PUT method",
"type": "string", "type": "string",
"enum": [ "enum": [
"ACTIVE", "ACTIVE",
...@@ -786,6 +835,14 @@ ...@@ -786,6 +835,14 @@
"format": "uri", "format": "uri",
"description": "A URI reference according to IETF RFC 3986 that identifies the problem type" "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": { "Self": {
"description": "Self-referring URI.", "description": "Self-referring URI.",
"type": "object", "type": "object",
...@@ -1099,7 +1156,7 @@ ...@@ -1099,7 +1156,7 @@
} }
}, },
"TrafficRule.Action": { "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", "type": "string",
"enum": [ "enum": [
"DROP", "DROP",
...@@ -1132,7 +1189,7 @@ ...@@ -1132,7 +1189,7 @@
"example": 1 "example": 1
}, },
"TrafficRule.State": { "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", "type": "string",
"enum": [ "enum": [
"ACTIVE", "ACTIVE",
...@@ -1516,6 +1573,15 @@ ...@@ -1516,6 +1573,15 @@
} }
}, },
"requestBodies": { "requestBodies": {
"ApplicationsConfirmReady": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/AppReadyConfirmation"
}
}
}
},
"ApplicationsConfirmTermination": { "ApplicationsConfirmTermination": {
"content": { "content": {
"application/json": { "application/json": {
......
...@@ -4,7 +4,7 @@ servers: ...@@ -4,7 +4,7 @@ servers:
- url: 'https://127.0.0.1:8081/mec_app_support/v1' - url: 'https://127.0.0.1:8081/mec_app_support/v1'
info: info:
title: MEC Application Support API 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 description: The ETSI MEC ISG MEC011 MEC Application Support API described using OpenAPI
license: license:
name: ETSI Forge copyright notice name: ETSI Forge copyright notice
...@@ -12,14 +12,15 @@ info: ...@@ -12,14 +12,15 @@ info:
contact: contact:
email: cti_support@etsi.org email: cti_support@etsi.org
externalDocs: externalDocs:
description: 'ETSI GS MEC011 Application Enablement API, V2.0.9' description: 'ETSI GS MEC011 Application Enablement API, V2.1.1'
url: >- 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: tags:
- name: appTrafficRules - name: appTrafficRules
- name: appDnsRules - name: appDnsRules
- name: appSubscriptions - name: appSubscriptions
- name: appConfirmTermination - name: appConfirmTermination
- name: appConfirmReady
- name: timing - name: timing
- name: callbacks - name: callbacks
paths: paths:
...@@ -231,8 +232,8 @@ paths: ...@@ -231,8 +232,8 @@ paths:
responses: responses:
'204': '204':
description: No Content description: No Content
'400':
$ref: '#/components/responses/Error.400'
'401': '401':
$ref: '#/components/responses/Error.401' $ref: '#/components/responses/Error.401'
'403': '403':
...@@ -245,6 +246,30 @@ paths: ...@@ -245,6 +246,30 @@ paths:
$ref: '#/components/responses/Error.429' $ref: '#/components/responses/Error.429'
requestBody: requestBody:
$ref: '#/components/requestBodies/ApplicationsConfirmTermination' $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': '/timing/timing_caps':
get: get:
description: >- description: >-
...@@ -283,6 +308,15 @@ components: ...@@ -283,6 +308,15 @@ components:
schemas: schemas:
Empty: Empty:
description: Empty schema 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: AppTerminationConfirmation:
description: >- 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. 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: ...@@ -424,7 +458,7 @@ components:
type: string type: string
example: '02-00-00-00-00-00' example: '02-00-00-00-00-00'
DestinationInterface: 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 type: object
required: required:
- interfaceType - interfaceType
...@@ -459,7 +493,7 @@ components: ...@@ -459,7 +493,7 @@ components:
- IP_V4 - IP_V4
example: 'IP_V6' example: 'IP_V6'
DnsRule.State: DnsRule.State:
description: DNS rule state description: DNS rule state. This attribute may be updated using HTTP PUT method
type: string type: string
enum: enum:
- ACTIVE - ACTIVE
...@@ -588,6 +622,12 @@ components: ...@@ -588,6 +622,12 @@ components:
description: >- description: >-
A URI reference according to IETF RFC 3986 that identifies the problem A URI reference according to IETF RFC 3986 that identifies the problem
type type
ReadyIndicationType:
description: Indication about the MEC application instance.
type: string
enum:
- READY
example: 'READY'
Self: Self:
description: Self-referring URI. description: Self-referring URI.
type: object type: object
...@@ -846,8 +886,8 @@ components: ...@@ -846,8 +886,8 @@ components:
$ref: '#/components/schemas/TrafficFilter.TC' $ref: '#/components/schemas/TrafficFilter.TC'
TrafficRule.Action: TrafficRule.Action:
description: >- description: >-
The action of the ME host data plane when a packet matches the The action of the MEC host data plane when a packet matches the trafficFilter
trafficFilter
type: string type: string
enum: enum:
- DROP - DROP
...@@ -878,7 +918,7 @@ components: ...@@ -878,7 +918,7 @@ components:
format: uint32 format: uint32
example: 1 example: 1
TrafficRule.State: 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 type: string
enum: enum:
- ACTIVE - ACTIVE
...@@ -1167,6 +1207,11 @@ components: ...@@ -1167,6 +1207,11 @@ components:
schema: schema:
$ref: '#/components/schemas/Empty' $ref: '#/components/schemas/Empty'
requestBodies: requestBodies:
ApplicationsConfirmReady:
content:
application/json:
schema:
$ref: '#/components/schemas/AppReadyConfirmation'
ApplicationsConfirmTermination: ApplicationsConfirmTermination:
content: content:
application/json: application/json:
...@@ -1322,4 +1367,4 @@ components: ...@@ -1322,4 +1367,4 @@ components:
dstInterface: dstInterface:
interfaceType: 'IP' interfaceType: 'IP'
dstIpAddress: '20.1.1.1' dstIpAddress: '20.1.1.1'
state: 'ACTIVE' state: 'ACTIVE'
\ No newline at end of file
...@@ -10,7 +10,7 @@ ...@@ -10,7 +10,7 @@
], ],
"info": { "info": {
"title": "MEC Service Management API", "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", "description": "The ETSI MEC ISG MEC011 MEC Service Management API described using OpenAPI",
"license": { "license": {
"name": "ETSI Forge copyright notice", "name": "ETSI Forge copyright notice",
...@@ -21,8 +21,8 @@ ...@@ -21,8 +21,8 @@
} }
}, },
"externalDocs": { "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" "url": "https://www.etsi.org/deliver/etsi_gs/MEC/001_099/011/02.01.01_60/gs_MEC011v020101p.pdf"
}, },
"tags": [ "tags": [
{ {
...@@ -81,6 +81,9 @@ ...@@ -81,6 +81,9 @@
}, },
"404": { "404": {
"$ref": "#/components/responses/Error.404" "$ref": "#/components/responses/Error.404"
},
"414": {
"$ref": "#/components/responses/Error.414"
} }
} }
} }
...@@ -157,6 +160,9 @@ ...@@ -157,6 +160,9 @@
}, },
"404": { "404": {
"$ref": "#/components/responses/Error.404" "$ref": "#/components/responses/Error.404"
},
"414": {
"$ref": "#/components/responses/Error.414"
} }
} }
}, },
...@@ -241,6 +247,24 @@ ...@@ -241,6 +247,24 @@
"requestBody": { "requestBody": {
"$ref": "#/components/requestBodies/ServicesServiceId" "$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": { "/applications/{appInstanceId}/subscriptions": {
...@@ -381,7 +405,8 @@ ...@@ -381,7 +405,8 @@
"CategoryRef.Href": { "CategoryRef.Href": {
"description": "Reference of the catalogue", "description": "Reference of the catalogue",
"type": "string", "type": "string",
"example": "catItem1" "format": "uri",
"example": "/example/catalogue1"
}, },
"CategoryRef.Id": { "CategoryRef.Id": {
"description": "Unique identifier of the category", "description": "Unique identifier of the category",
...@@ -427,7 +452,7 @@ ...@@ -427,7 +452,7 @@
"type": "array", "type": "array",
"minItems": 0, "minItems": 0,
"items": { "items": {
"type": "string" "$ref": "#/components/schemas/CategoryRef"
} }
}, },
"EndPointInfo.Address.Host": { "EndPointInfo.Address.Host": {
...@@ -1419,6 +1444,21 @@ ...@@ -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": { "Error.429": {
"description": "Too Many Requests. It is used when a rate limiter has triggered.", "description": "Too Many Requests. It is used when a rate limiter has triggered.",
"content": { "content": {
......
...@@ -4,7 +4,7 @@ servers: ...@@ -4,7 +4,7 @@ servers:
- url: 'https://127.0.0.1:8081/mec_service_mgmt/v1' - url: 'https://127.0.0.1:8081/mec_service_mgmt/v1'
info: info:
title: MEC Service Management API 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 description: The ETSI MEC ISG MEC011 MEC Service Management API described using OpenAPI
license: license:
name: ETSI Forge copyright notice name: ETSI Forge copyright notice
...@@ -12,9 +12,9 @@ info: ...@@ -12,9 +12,9 @@ info:
contact: contact:
email: cti_support@etsi.org email: cti_support@etsi.org
externalDocs: externalDocs:
description: 'ETSI GS MEC011 Application Enablement API, V2.0.10' description: 'ETSI GS MEC011 Application Enablement API, V2.1.1'
url: >- 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: tags:
- name: appSubscriptions - name: appSubscriptions
- name: appServices - name: appServices
...@@ -46,6 +46,8 @@ paths: ...@@ -46,6 +46,8 @@ paths:
$ref: '#/components/responses/Error.403' $ref: '#/components/responses/Error.403'
'404': '404':
$ref: '#/components/responses/Error.404' $ref: '#/components/responses/Error.404'
'414':
$ref: '#/components/responses/Error.414'
'/services/{serviceId}': '/services/{serviceId}':
parameters: parameters:
- $ref: '#/components/parameters/Path.ServiceId' - $ref: '#/components/parameters/Path.ServiceId'
...@@ -91,6 +93,8 @@ paths: ...@@ -91,6 +93,8 @@ paths:
$ref: '#/components/responses/Error.403' $ref: '#/components/responses/Error.403'
'404': '404':
$ref: '#/components/responses/Error.404' $ref: '#/components/responses/Error.404'
'414':
$ref: '#/components/responses/Error.414'
post: post:
description: >- description: >-
This method is used to create a mecService resource. This method is This method is used to create a mecService resource. This method is
...@@ -148,6 +152,19 @@ paths: ...@@ -148,6 +152,19 @@ paths:
$ref: '#/components/responses/Error.412' $ref: '#/components/responses/Error.412'
requestBody: requestBody:
$ref: '#/components/requestBodies/ServicesServiceId' $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': '/applications/{appInstanceId}/subscriptions':
parameters: parameters:
- $ref: '#/components/parameters/Path.AppInstanceId' - $ref: '#/components/parameters/Path.AppInstanceId'
...@@ -253,7 +270,8 @@ components: ...@@ -253,7 +270,8 @@ components:
CategoryRef.Href: CategoryRef.Href:
description: Reference of the catalogue description: Reference of the catalogue
type: string type: string
example: 'catItem1' format: uri
example: '/example/catalogue1'
CategoryRef.Id: CategoryRef.Id:
description: Unique identifier of the category description: Unique identifier of the category
type: string type: string
...@@ -287,8 +305,8 @@ components: ...@@ -287,8 +305,8 @@ components:
description: Categories of services about which to report events. description: Categories of services about which to report events.
type: array type: array
minItems: 0 minItems: 0
items: items:
type: string $ref: '#/components/schemas/CategoryRef'
EndPointInfo.Address.Host: EndPointInfo.Address.Host:
description: Host portion of the address description: Host portion of the address
type: string type: string
...@@ -1075,6 +1093,16 @@ components: ...@@ -1075,6 +1093,16 @@ components:
text/plain: text/plain:
schema: schema:
$ref: '#/components/schemas/Empty' $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: Error.429:
description: >- description: >-
Too Many Requests. Too Many Requests.
......
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment