description:PUT HTTP method shall comply with the URI query parameters, request and response data structures, and response codes, as specified in tables 7.2.8.3.2-1 and 7.2.8.3.2-2.
description:PUT HTTP method shall comply with the URI query parameters, request and response data structures, and response codes, as specified in tables 7.2.10.3.2-1 and 7.2.10.3.2-2.
description:Indicates successful resource creation for registration of the MEC application instance to the MEC platform. The resource URI shall be returned in the HTTP Location header field.
description:Indicates successful resource creation for registration of the MEC application instance to the MEC platform. The resource URI shall be returned in the HTTP Location header field. appInstanceId shall be present in the newly created AppInfo resource.
description:Priority of this traffic rule within the range 0 to 255. If traffic rules conflict, the one with higher priority take precedence. See note 1.
description:Describes the destination interface information. 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. See note 2. If the action is DROP, no value shall be provided.
description:Describes the destination interface information. 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. See note 2. If the action is DROP, no value shall be provided.
$ref:'#/components/schemas/DestinationInterface'
state:
type:string
@@ -961,11 +1016,11 @@ components:
type:object
properties:
seconds:
description:The seconds part of the Time. Time is defined as Unix-time since January 1, 1970, 00:00:00 UTC
description:The seconds part of the Time. Time is defined as Unix-time since January 1, 1970, 00:00:00 UTC.
type:integer
format:uint32
nanoSeconds:
description:The nanoseconds part of the Time. Time is defined as Unix-time since January 1, 1970, 00:00:00 UTC
description:The nanoseconds part of the Time. Time is defined as Unix-time since January 1, 1970, 00:00:00 UTC.
description:Describes services a MEC application may use if available. ServiceDependency is defined in ETSI GSMEC 010-2 [4]. It shall not be provided if an AppD is available.
description:The list of geographical and topological areas that the application server serves. ServiceArea is defined in ETSI TS 129 558 [i.11]. See note 3.
description:Service characteristics provided by the application server. More information can be found in ETSI TS 123 558 [i.12] clause 8.2.5. EASServiceKPI is defined in ETSI TS 129 558 [i.11]. See note 3.
description:Can be mapped to EAS profile as defined in ETSI TS 129 558 [19]. More information can be found in the informative Annex C. See note 1 and note 2.
description:Can be mapped to EAS profile as defined in ETSI TS 129 558 [i.11]. More information can be found in Annex C. See notes 1 and 2.
Changes for MecServiceMgmtApi.yaml: 280 added lines, 112 removed lines.
Original line number
Diff line number
Diff line
@@ -10,24 +10,24 @@ info:
license:
name:BSD-3-Clause
url:https://forge.etsi.org/legal-matters
version:3.1.1
version:3.2.1
servers:
-url:https://localhost:8081/mec_service_mgmt/v1
paths:
/services:
get:
summary:Retrieve information about a list of mecService resources of an application instance.
summary:Retrieve information about a list of mecService resources.
description:This method retrieves information about a list of mecService resources. This method is typically used in "service availability query" procedure as described in clause 5.2.5. Figure 8.2.3.3.1-1 shows the example message flows using GET method.
description:Upon success, a response message content containing an array of the mecServices is returned.
@@ -47,7 +47,7 @@ paths:
$ref:'#/components/responses/414'
/services/{serviceId}:
get:
summary:Retrieve information about a mecService resource of an application instance.
summary:Retrieve information about a mecService resource.
description:This method retrieves information about a mecService resource. This method is typically used in "service availability query" procedure as described in clause 5.2.5.
description:It is used to indicate nonspecific success. The response message content contains a representation of the resource.
content:
application/json:
schema:
type:object
properties:
ServiceLivenessInfo:
$ref:'#/components/schemas/ServiceLivenessInfo'
'400':
$ref:'#/components/responses/400'
'404':
$ref:'#/components/responses/404'
'403':
$ref:'#/components/responses/403'
parameters:[]
patch:
summary:Send a "heartbeat" message related to a MEC service instance.
description:The MEC application instance that provides MEC service shall send a PATCH request to the resource URI representing the liveness of the service instance.
description:Enumeration representing possible states of a MEC service instance.
ServiceChange:
type:string
enum:
-ADDED
-REMOVED
-STATE_CHANGED
-ATTRIBUTES_CHANGED
description:Enumeration representing changes to a MEC service.
SerInstanceId:
description:Identifier of the service instance assigned by the MEPM/MEC platform. For the uniqueness of the identifier across the MEC system, UUID format [i.7] is recommended.Shall be absent in POST requests, and present otherwise
SerName:
@@ -581,7 +626,7 @@ components:
type:object
properties:
href:
description:URI referring to a resource
description:URI referring to a resource.
type:string
format:uri
required:
@@ -591,19 +636,19 @@ components:
type:object
properties:
serInstanceId:
description:0..1
description:Identifier of the service instance assigned by the MEPM/MEC platform. For the uniqueness of the identifier across the MEC system, UUID format [i.7] is recommended. Shall be absent in POST requests, and present otherwise.
$ref:'#/components/schemas/SerInstanceId'
serName:
description:'1'
description:The name of the service. This is how the service producing MEC application identifies the service instance it produces.
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. See note 2.
description:Parameters related to use of OAuth 2.0. Shall be present in case OAuth 2.0 (see IETF RFC 6749 [13]) is supported to secure the provision of the service over the transport, as specified in clause 6.16 of ETSI GS MEC 009 [5].
description:Parameters related to use of OAuth 2.0. Shall be present in case OAuth 2.0 (see IETF RFC 6749 [13]) is supported to secure the provision of the service over the transport.
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, as defined in LocalityType in table 8.1.6.5-1. scope_of_locality corresponds to scopeOfLocality defined in table 8.1.2.2-1.
name:scope_of_locality
in:query
required:false
x-exportParamName:Query.Scope_of_locality
x-exportParamName:Query.scope_of_locality
schema:
$ref:'#/components/schemas/LocalityType'
Query.Consumed_local_only:
Query.consumed_local_only:
description:A MEC application instance may use consumed_local_only as an input parameter to query the availability of a list of MEC service instances that can be consumed only locally. consumed_local_only corresponds to consumedLocalOnly defined in table 8.1.2.2-1.
name:consumed_local_only
in:query
required:false
x-exportParamName:Query.Consumed_local_only
x-exportParamName:Query.consumed_local_only
schema:
type:boolean
Query.Is_local:
description:A MEC application instance may use is_local as an input parameter to query the availability of a list of MEC service instances in the local MEC host or in local and remote MEC hosts. is_local corresponds to isLocal defined in table8.1.2.2-1.