summary:Retrieve information about a list of mecAppSupportSubscription resources for this subscriber.
description:The GET method may be used to request information about all subscriptions for this requestor. Upon success, the response contains message content with all the subscriptions for the requestor.
description:Upon success, the HTTP response shall include a "Location" HTTP header that contains the resource URI of the created subscription resource.
summary:Retrieve information about a mecAppSupportSubscription resource for this subscriber.
description:The GET method requests information about a subscription for this requestor. Upon success, the response contains message content with the subscription for the requestor.
description:The unique identifier of the appInstanceId.
schema:
type:string
-name:subscriptionId
in:path
required:true
description:The unique identifier of the subscriptionId.
schema:
type:string
delete:
summary:Delete a mecAppSupportSubscription resource.
description:This method deletes a mecAppSupportSubscription. This method is typically used in "Unsubscribing from event notifications" procedure as described in clause 5.2.6.3. Figure 7.2.4.3.5-1 shows the example message flows using DELETE method.
This method retrieves information about all the traffic rules associated
with a MEC application instance.
operationId:ApplicationsTrafficRule_GET
-applicationSupport
responses:
'204':
$ref:'#/components/responses/204'
'404':
$ref:'#/components/responses/404'
'403':
$ref:'#/components/responses/403'
parameters:
-name:appInstanceId
in:path
description:>-
Represents a MEC application instance. Note that the appInstanceId
is allocated by the MEC platform manager.
required:true
style:simple
description:The unique identifier of the appInstanceId.
schema:
type:string
-name:trafficRuleId
-name:subscriptionId
in:path
description:Represents a traffic rule.
required:true
style:simple
description:The unique identifier of the subscriptionId.
schema:
type:string
/timing/timing_caps:
get:
summary:Retrieve information about the mecTimingCaps resource.
description:This method retrieves the information of the platform's timing capabilities which corresponds to the timing capabilities query as described in clause 5.2.10.3. Figure 7.2.5.3.1-1 shows the example message flow for retrieving timing capabilities using GET method.
operationId:TimingTimingcapsGET
tags:
-applicationSupport
responses:
'200':
description:>-
Upon success, a response message content containing the TrafficRules
is returned.
headers:{}
description:It is used to indicate nonspecific success. The response message content contains a representation of the resource.
content:
application/json:
schema:
$ref:'#/components/schemas/TrafficRule'
examples:
TrafficRule:
value:
trafficRuleId:TrafficRule123
filterType:FLOW
priority:1
trafficFilter:
-srcAddress:
-192.127.4.100/32
-192.127.4.101/32
dstAddress:
-192.127.4.102/32
-192.127.4.103/32
srcPort:
-'80'
dstPort:
-'80'
action:FORWARD_DECAPSULATED
dstInterface:
-dstInterface:null
interfaceType:IP
tunnelInfo:tunnel
dstIpAddress:20.1.1.1
state:ACTIVE
type:object
properties:
TimingCaps:
$ref:'#/components/schemas/TimingCaps'
'400':
description:>-
Bad Request. It is used to indicate that incorrect parameters were
passed to the request.
headers:{}
$ref:'#/components/responses/400'
'404':
$ref:'#/components/responses/404'
'403':
$ref:'#/components/responses/403'
parameters:[]
/timing/current_time:
get:
summary:Retrieve information about the mecCurrentTime resource.
description:This method retrieves the information of the platform's current time which corresponds to the get platform time procedure as described in clause 5.2.10.2. Figure 7.2.6.3.1-1 shows message flow for retrieving current time using GET method.
operationId:TimingCurrenttimeGET
tags:
-applicationSupport
responses:
'200':
description:It is used to indicate nonspecific success. The response message content contains a representation of the resource.
content:
application/problem+json:
schema:
$ref:'#/components/schemas/ProblemDetails'
text/plain:
application/json:
schema:
type:object
description:Empty schema
contentMediaType:text/plain
properties:
CurrentTime:
$ref:'#/components/schemas/CurrentTime'
'400':
$ref:'#/components/responses/400'
'404':
$ref:'#/components/responses/404'
'403':
description:>-
Forbidden. The operation is not allowed given the current status of
the resource.
headers:{}
$ref:'#/components/responses/403'
parameters:[]
/applications/{appInstanceId}/traffic_rules:
get:
summary:Retrieve information about a list of mecTrafficRule resources for an application instance.
description:This method retrieves information about all the traffic rules associated with a MEC application instance.
description:Upon success, a response message content containing the TrafficRules is returned.
content:
application/json:
schema:
type:object
description:Empty schema
contentMediaType:text/plain
deprecated:false
put:
tags:
-appTrafficRules
summary:Update traffic rule
description:>-
This method retrieves information about all the traffic rules associated
with a MEC application instance.
operationId:ApplicationsTrafficRule_PUT
properties:
TrafficRule:
$ref:'#/components/schemas/TrafficRule'
'400':
$ref:'#/components/responses/400'
'404':
$ref:'#/components/responses/404'
'403':
$ref:'#/components/responses/403'
parameters:
-name:appInstanceId
in:path
description:>-
Represents a MEC application instance. Note that the appInstanceId
is allocated by the MEC platform manager.
required:true
style:simple
description:The unique identifier of the appInstanceId.
schema:
type:string
-name:trafficRuleId
in:path
description:Represents a traffic rule.
required:true
style:simple
description:The unique identifier of the trafficRuleId.
schema:
type:string
put:
summary:Update the information about a mecTrafficRule resource.
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.
Represents a MEC application instance. Note that the appInstanceId
is allocated by the MEC platform manager.
required:true
style:simple
description:The unique identifier of the appInstanceId.
schema:
type:string
-name:dnsRuleId
in:path
description:Represents a DNS rule.
required:true
style:simple
description:The unique identifier of the dnsRuleId.
schema:
type:string
put:
summary:Update the information about a mecDnsRule resource.
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.
Forbidden. The operation is not allowed given the current status of
the resource.
headers:{}
content:
application/problem+json:
schema:
$ref:'#/components/schemas/ProblemDetails'
$ref:'#/components/responses/403'
'404':
description:>-
Not Found. It is used when a client provided a URI that cannot be
mapped to a valid resource URI.
headers:{}
content:
application/problem+json:
schema:
$ref:'#/components/schemas/ProblemDetails'
text/plain:
schema:
type:object
description:Empty schema
contentMediaType:text/plain
deprecated:false
post:
tags:
-appSubscriptions
summary:Create subscription
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 message content
describing the created subscription.
operationId:ApplicationsSubscriptions_POST
$ref:'#/components/responses/404'
'429':
$ref:'#/components/responses/429'
parameters:
-name:appInstanceId
in:path
description:>-
Represents a MEC application instance. Note that the appInstanceId
is allocated by the MEC platform manager.
required:true
style:simple
description:The unique identifier of the appInstanceId.
schema:
type:string
/applications/{appInstanceId}/confirm_ready:
post:
summary:Confirm the application instance is up and running.
description:The POST method may be used by the MEC application instance to notify the MEC platform that it is up and running. POST HTTP method shall support the URI query parameters, request and response data structures, and response codes, as specified in tables 7.2.12.3.4-1 and 7.2.12.3.4-2.
description:The message content in the request contains the profile of the MEC application instance, calling the MEC platform to register the MEC application instance. .
required:true
style:simple
schema:
type:string
responses:
'200':
description:>-
Upon success, a response message content containing the requested
Bad Request. It is used to indicate that incorrect parameters were
passed to the request.
headers:{}
type:object
properties:
AppInfo:
$ref:'#/components/schemas/AppInfo'
responses:
'201':
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.
content:
application/problem+json:
schema:
$ref:'#/components/schemas/ProblemDetails'
text/plain:
application/json:
schema:
type:object
description:Empty schema
contentMediaType:text/plain
properties:
AppInfo:
$ref:'#/components/schemas/AppInfo'
'400':
$ref:'#/components/responses/400'
'401':
$ref:'#/components/responses/401'
'403':
description:>-
Forbidden. The operation is not allowed given the current status of
the resource.
headers:{}
content:
application/problem+json:
schema:
$ref:'#/components/schemas/ProblemDetails'
$ref:'#/components/responses/403'
'404':
description:>-
Not Found. It is used when a client provided a URI that cannot be
mapped to a valid resource URI.
headers:{}
$ref:'#/components/responses/404'
parameters:[]
/registrations/{appInstanceId}:
get:
summary:Retrieve information about the MEC application instance registration to the MEC platform.
description:The GET method may be used by the MEC application instance to retrieve information about the existing MEC application instance registration to the MEC platform. GET HTTP method shall comply with the URI query parameters, request and response data structures, and response codes, as specified in tables 7.2.14.3.1-1 and 7.2.14.3.1-2.
operationId:RegistrationsGETAppinstanceid
tags:
-applicationSupport
responses:
'200':
description:Upon success, a response message content containing the AppInfo is returned.
content:
application/problem+json:
schema:
$ref:'#/components/schemas/ProblemDetails'
text/plain:
application/json:
schema:
type:object
description:Empty schema
contentMediaType:text/plain
deprecated:false
delete:
tags:
-appSubscriptions
summary:delete subscription
description:>-
This method deletes a mecAppSuptApiSubscription. This method is
typically used in "Unsubscribing from service availability event
notifications" procedure.
operationId:ApplicationsSubscription_DELETE
properties:
AppInfo:
$ref:'#/components/schemas/AppInfo'
'400':
$ref:'#/components/responses/400'
'404':
$ref:'#/components/responses/404'
'403':
$ref:'#/components/responses/403'
parameters:
-name:appInstanceId
in:path
description:>-
Represents a MEC application instance. Note that the appInstanceId
is allocated by the MEC platform manager.
required:true
style:simple
description:The unique identifier of the appInstanceId.
schema:
type:string
-name:subscriptionId
in:path
description:>-
Represents a subscription to the notifications from the MEC
platform.
put:
summary:Update the existing registration of that MEC application instance to the MEC platform.
description:The PUT method may be used by the MEC application instance to update its registration to the MEC platform. PUT HTTP method shall comply with the URI query parameters, request and response data structures, and response codes, as specified in tables 7.2.14.3.2-1 and 7.2.14.3.2-2.
operationId:RegistrationsPUTAppinstanceid
tags:
-applicationSupport
requestBody:
description:Message content in the request contains the profile of the application, calling the MEC platform to update the existing MEC application instance registration.
required:true
style:simple
content:
application/json:
schema:
type:string
type:object
properties:
AppInfo:
$ref:'#/components/schemas/AppInfo'
responses:
'204':
description:No Content
headers:{}
content:{}
'403':
description:>-
Forbidden. The operation is not allowed given the current status of
the resource.
headers:{}
content:
application/problem+json:
schema:
$ref:'#/components/schemas/ProblemDetails'
'404':
description:>-
Not Found. It is used when a client provided a URI that cannot be
mapped to a valid resource URI.
headers:{}
description:Upon success, a response 204 No Content without any response message content is returned.
No Content. The request is acknowledged. The response message
content shall be empty.
headers:{}
content:{}
$ref:'#/components/responses/204'
'400':
$ref:'#/components/responses/400'
'401':
description:>-
Unauthorized. It is used when the client did not submit the
appropriate credentials.
headers:{}
content:
application/problem+json:
schema:
$ref:'#/components/schemas/ProblemDetails'
text/plain:
schema:
type:object
description:Empty schema
contentMediaType:text/plain
$ref:'#/components/responses/401'
'403':
description:>-
Forbidden. The operation is not allowed given the current status of
the resource.
headers:{}
content:
application/problem+json:
schema:
$ref:'#/components/schemas/ProblemDetails'
$ref:'#/components/responses/403'
'404':
description:>-
Not Found. It is used when a client provided a URI that cannot be
mapped to a valid resource URI.
headers:{}
content:
application/problem+json:
schema:
$ref:'#/components/schemas/ProblemDetails'
text/plain:
schema:
type:object
description:Empty schema
contentMediaType:text/plain
'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.
headers:{}
content:
application/problem+json:
schema:
$ref:'#/components/schemas/ProblemDetails'
text/plain:
$ref:'#/components/responses/404'
parameters:
-name:appInstanceId
in:path
required:true
description:The unique identifier of the appInstanceId.
schema:
type:string
components:
schemas:
ProblemDetails:
type:object
description:Empty schema
contentMediaType:text/plain
'429':
description:Too Many Requests. It is used when a rate limiter has triggered.
headers:{}
content:
application/problem+json:
schema:
$ref:'#/components/schemas/ProblemDetails'
text/plain:
schema:
type:object
description:Empty schema
contentMediaType:text/plain
deprecated:false
parameters:[]
'/applications/{appInstanceId}/confirm_ready':
post:
tags:
-appConfirmReady
summary:Confirm ready
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
parameters:
-name:appInstanceId
in:path
description:>-
Represents a MEC application instance. Note that the appInstanceId
is allocated by the MEC platform manager.
required:true
style:simple
schema:
properties:
type:
type:string
requestBody:
description:>-
Message content in the request contains the indication that the
application instance is up and running.
content:
application/json:
schema:
$ref:'#/components/schemas/AppReadyConfirmation'
required:false
responses:
'204':
description:No Content
headers:{}
content:{}
'401':
description:>-
Unauthorized. It is used when the client did not submit the
appropriate credentials.
headers:{}
content:
application/problem+json:
schema:
$ref:'#/components/schemas/ProblemDetails'
text/plain:
schema:
type:object
description:Empty schema
contentMediaType:text/plain
'403':
description:>-
Forbidden. The operation is not allowed given the current status of
the resource.
headers:{}
content:
application/problem+json:
schema:
$ref:'#/components/schemas/ProblemDetails'
'404':
description:>-
Not Found. It is used when a client provided a URI that cannot be
mapped to a valid resource URI.
headers:{}
content:
application/problem+json:
schema:
$ref:'#/components/schemas/ProblemDetails'
text/plain:
schema:
type:object
description:Empty schema
contentMediaType:text/plain
'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.
headers:{}
content:
application/problem+json:
schema:
$ref:'#/components/schemas/ProblemDetails'
text/plain:
schema:
type:object
description:Empty schema
contentMediaType:text/plain
'429':
description:Too Many Requests. It is used when a rate limiter has triggered.
headers:{}
content:
application/problem+json:
schema:
$ref:'#/components/schemas/ProblemDetails'
text/plain:
schema:
type:object
description:Empty schema
contentMediaType:text/plain
deprecated:false
parameters:[]
/registrations:
post:
tags:
-appRegistrations
summary:Create Registrantion
description:>-
The POST method may be used by the MEC application instance to request
its registration to the MEC platform.
operationId:ApplicationsRegistrations_POST
parameters:[]
requestBody:
description:>-
The message content in the request contains the profile of the MEC
application instance, calling the MEC platform to register the MEC
application instance.
content:
application/json:
schema:
$ref:'#/components/schemas/AppInfo'
required:false
responses:
'201':
description:>-
Indicates successful resource creation for registration of the MEC
application instance to the MEC platform.
headers:
location:
description:The resource URI of the created resource
content:
text/plain:
schema:
format:uri
description:A URI reference according to IETF RFC 3986 that identifies the problem type
title:
type:string
description:The resource URI of the created resource
contentMediaType:text/plain
content:
application/json:
schema:
$ref:'#/components/schemas/AppInfo'
'400':
description:>-
Bad Request. It is used to indicate that incorrect parameters were
passed to the request.
headers:{}
content:
application/problem+json:
schema:
$ref:'#/components/schemas/ProblemDetails'
text/plain:
schema:
type:object
description:Empty schema
contentMediaType:text/plain
'401':
description:>-
Unauthorized. It is used when the client did not submit the
appropriate credentials.
headers:{}
content:
application/problem+json:
schema:
$ref:'#/components/schemas/ProblemDetails'
text/plain:
schema:
type:object
description:Empty schema
contentMediaType:text/plain
'403':
description:>-
Forbidden. The operation is not allowed given the current status of
the resource.
headers:{}
content:
application/problem+json:
schema:
$ref:'#/components/schemas/ProblemDetails'
'404':
description:>-
Not Found. It is used when a client provided a URI that cannot be
mapped to a valid resource URI.
headers:{}
content:
application/problem+json:
schema:
$ref:'#/components/schemas/ProblemDetails'
text/plain:
schema:
type:object
description:Empty schema
contentMediaType:text/plain
deprecated:false
parameters:[]
'/registrations/{appInstanceId}':
get:
tags:
-appRegistrations
summary:Get Registration
description:>-
The GET method may be used by the MEC application instance to retrieve
information about the existing MEC application instance registration to
the MEC platform.
operationId:ApplicationsRegistration_GET
parameters:
-name:appInstanceId
in:path
description:>-
Represents a MEC application instance. Note that the appInstanceId
is allocated by the MEC platform manager.
required:true
style:simple
schema:
description:A short, human-readable summary of the problem type
status:
type:integer
format:uint32
description:The HTTP status code for this occurrence of the problem
detail:
type:string
responses:
'200':
description:>-
Upon success, a response message content containing the requested
subscription is returned.
headers:{}
content:
application/json:
schema:
$ref:'#/components/schemas/AppInfo'
'400':
description:>-
Bad Request. It is used to indicate that incorrect parameters were
passed to the request.
headers:{}
content:
application/problem+json:
schema:
$ref:'#/components/schemas/ProblemDetails'
text/plain:
schema:
type:object
description:Empty schema
contentMediaType:text/plain
'403':
description:>-
Forbidden. The operation is not allowed given the current status of
the resource.
headers:{}
content:
application/problem+json:
schema:
$ref:'#/components/schemas/ProblemDetails'
'404':
description:>-
Not Found. It is used when a client provided a URI that cannot be
mapped to a valid resource URI.
headers:{}
content:
application/problem+json:
schema:
$ref:'#/components/schemas/ProblemDetails'
text/plain:
schema:
type:object
description:Empty schema
contentMediaType:text/plain
deprecated:false
put:
tags:
-appRegistrations
summary:Update Registration
description:>-
The PUT method may be used by the MEC application instance to update its
registration to the MEC platform.
operationId:ApplicationsRegistration_PUT
parameters:
-name:appInstanceId
in:path
description:>-
Represents a MEC application instance. Note that the appInstanceId
is allocated by the MEC platform manager.
required:true
style:simple
schema:
description:A human-readable explanation specific to this occurrence of the problem
instance:
type:string
requestBody:
description:>-
Message content in the request contains the profile of the
application, calling the MEC platform to update the existing MEC
application instance registration.
content:
application/json:
schema:
$ref:'#/components/schemas/AppInfo'
required:true
responses:
'204':
description:No Content
headers:{}
content:{}
'400':
description:>-
Bad Request. It is used to indicate that incorrect parameters were
passed to the request.
headers:{}
content:
application/problem+json:
schema:
$ref:'#/components/schemas/ProblemDetails'
text/plain:
schema:
type:object
description:Empty schema
contentMediaType:text/plain
'401':
description:>-
Unauthorized. It is used when the client did not submit the
appropriate credentials.
headers:{}
content:
application/problem+json:
schema:
$ref:'#/components/schemas/ProblemDetails'
text/plain:
schema:
type:object
description:Empty schema
contentMediaType:text/plain
'403':
description:>-
Forbidden. The operation is not allowed given the current status of
the resource.
headers:{}
content:
application/problem+json:
schema:
$ref:'#/components/schemas/ProblemDetails'
'404':
description:>-
Not Found. It is used when a client provided a URI that cannot be
mapped to a valid resource URI.
headers:{}
content:
application/problem+json:
schema:
$ref:'#/components/schemas/ProblemDetails'
text/plain:
schema:
format:uri
description:A URI reference that identifies the specific occurrence of the problem
TransportDescriptor:
x-etsi-ref:6.2.1.19
type:object
description:Empty schema
contentMediaType:text/plain
deprecated:false
delete:
tags:
-appRegistrations
summary:delete registration
description:>-
The DELETE method is used to cancel the existing MEC application
instance registration.
operationId:ApplicationsRegistration_DELETE
parameters:
-name:appInstanceId
in:path
description:>-
Represents a MEC application instance. Note that the appInstanceId
is allocated by the MEC platform manager.
required:true
style:simple
schema:
properties:
name:
description:The name of this transport.
type:string
responses:
'204':
description:No Content
headers:{}
content:{}
'400':
description:>-
Bad Request. It is used to indicate that incorrect parameters were
passed to the request.
headers:{}
content:
application/problem+json:
schema:
$ref:'#/components/schemas/ProblemDetails'
text/plain:
schema:
type:object
description:Empty schema
contentMediaType:text/plain
'401':
description:>-
Unauthorized. It is used when the client did not submit the
appropriate credentials.
headers:{}
content:
application/problem+json:
schema:
$ref:'#/components/schemas/ProblemDetails'
text/plain:
schema:
type:object
description:Empty schema
contentMediaType:text/plain
'403':
description:>-
Forbidden. The operation is not allowed given the current status of
the resource.
headers:{}
content:
application/problem+json:
schema:
$ref:'#/components/schemas/ProblemDetails'
'404':
description:>-
Not Found. It is used when a client provided a URI that cannot be
mapped to a valid resource URI.
headers:{}
content:
application/problem+json:
schema:
$ref:'#/components/schemas/ProblemDetails'
text/plain:
schema:
type:object
description:Empty schema
contentMediaType:text/plain
deprecated:false
parameters:[]
/timing/timing_caps:
get:
tags:
-timing
summary:Retrieve timing capabilities
description:>-
This method retrieves the information of the platform's timing
capabilities which corresponds to the timing capabilities query
operationId:TimingCaps_GET
parameters:[]
responses:
'200':
description:>-
It is used to indicate nonspecific success. The response message
content contains a representation of the resource.
headers:{}
content:
application/json:
schema:
$ref:'#/components/schemas/TimingCaps'
'400':
description:>-
Bad Request. It is used to indicate that incorrect parameters were
passed to the request.
headers:{}
content:
application/problem+json:
schema:
$ref:'#/components/schemas/ProblemDetails'
text/plain:
schema:
type:object
description:Empty schema
contentMediaType:text/plain
'403':
description:>-
Forbidden. The operation is not allowed given the current status of
the resource.
headers:{}
content:
application/problem+json:
schema:
$ref:'#/components/schemas/ProblemDetails'
'404':
description:>-
Not Found. It is used when a client provided a URI that cannot be
mapped to a valid resource URI.
headers:{}
content:
application/problem+json:
schema:
$ref:'#/components/schemas/ProblemDetails'
text/plain:
schema:
type:object
description:Empty schema
contentMediaType:text/plain
deprecated:false
parameters:[]
/timing/current_time:
get:
tags:
-timing
summary:Retrieve current time
description:>-
This method retrieves the information of the platform's current time
which corresponds to the get platform time procedure
operationId:TimingCurrentTime_GET
parameters:[]
responses:
'200':
description:>-
It is used to indicate nonspecific success. The response message
content contains a representation of the resource.
headers:{}
content:
application/json:
schema:
$ref:'#/components/schemas/CurrentTime'
'400':
description:>-
Bad Request. It is used to indicate that incorrect parameters were
passed to the request.
headers:{}
content:
application/problem+json:
schema:
$ref:'#/components/schemas/ProblemDetails'
text/plain:
schema:
type:object
description:Empty schema
contentMediaType:text/plain
'403':
description:>-
Forbidden. The operation is not allowed given the current status of
the resource.
headers:{}
content:
application/problem+json:
schema:
$ref:'#/components/schemas/ProblemDetails'
'404':
description:>-
Not Found. It is used when a client provided a URI that cannot be
mapped to a valid resource URI.
headers:{}
content:
application/problem+json:
schema:
$ref:'#/components/schemas/ProblemDetails'
text/plain:
schema:
description:
description:Human-readable description of this transport.
type:string
type:
description':Type of the transport, as defined in the TransportTypes type in ETSI GS MEC 011 [17].
$ref:'#/components/schemas/TransportTypes'
protocol:
description:The name of the protocol used. Shall be set to "HTTP" for a REST API.
type:string
version:
description:The version of the protocol used.
type:string
security:
description':Information about the security used by the transport in ETSI GS MEC 011 [17].
$ref:'#/components/schemas/SecurityInfo'
implSpecificInfo:
description:Additional implementation specific details of the transport.
type:object
description:Empty schema
contentMediaType:text/plain
deprecated:false
parameters:[]
components:
schemas:
AppReadyConfirmation:
title:AppReadyConfirmation
required:
-indication
-name
-type
-protocol
-version
-security
SecurityInfo:
x-etsi-ref:8.1.5.4
type:object
properties:
indication:
const:READY
type:string
description:Indication about the MEC application instance.
examples:
-READY
description:>-
This type represents the information that the MEC application instance
indicates to the MEC platform that it is up and running.
AppInfo:
title:AppInfo
required:
-appName
oAuth2Info:
$ref:'#/components/schemas/OAuth2Info'
(extensions):
description:Extensions for alternative transport mechanisms. These extensions depend on the actual transport, and are out of scope of the present document. For instance, such extensions may be used to signal the necessary parameters for the client to use TLS-based authorization defined for alternative transports (see ETSI GS MEC 009 [5] for more information).
SerializerType:
x-etsi-ref:8.1.6.3
type:string
enum:
-JSON
-XML
-PROTOBUF3
x-etsi-mec-extensible:true
x-etsi-mec-enumeration-table:
-value:JSON
description:Javascript object notation [9]
-value:XML
description:eXtensible Mark-up Language version 1.1 [10]
-value:PROTOBUF3
description:Protocol buffers version 3 [i.3]
OAuth2Info:
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.
Describes services a MEC application requires to run.
ServiceDependency is defined in ETSI GS MEC 010-2 [4]. It shall not
be provided if an AppD is available.
appServiceOptional:
title:appServiceOptional
type:array
items:
$ref:'#/components/schemas/ServiceDependency'
description:>-
Describes services a MEC application may use if available.
ServiceDependency is defined in ETSI GS MEC 010-2 [4]. It shall not
be provided if an AppD is available.
appFeatureRequired:
title:appFeatureRequired
enum:
-REST_HTTP
-MB_TOPIC_BASED
-MB_ROUTING
-MB_PUBSUB
-RPC
-RPC_STREAMING
-WEBSOCKET
description:The enumeration TransportType represents types of transports.
x-etsi-mec-extensible:true
x-etsi-mec-enumeration-table:
-value:REST_HTTP
description:RESTful API using HTTP (as defined in IETF RFC 9110 [11]).
-value:MB_TOPIC_BASED
description:Topic-based message bus which routes messages to receivers based on subscriptions, if a pattern passed on subscription matches the topic of the message. EXAMPLE MQTT (see [i.4]).
-value:MB_ROUTING
description:Routing-based message bus which routes messages to receivers based on subscriptions, if a key passed on subscription is equal to the key of the message.
-value:MB_PUBSUB
description:Publish-subscribe based message bus which distributes messages to all subscribers.
-value:RPC
description:Remote procedure call. EXAMPLE GRPC (see [i.5]).
-value:RPC_STREAMING
description:Remote procedure call supporting streams of requests and responses. EXAMPLE GRPC (see [i.5]).
-value:WEBSOCKET
description:Websockets as defined in IETF RFC 6455 [12].
description':Information about the transport in this transport binding.
$ref:'#/components/schemas/TransportDescriptor'
serializers:
description:Information about the serializers in this transport binding, as defined in the SerializerType type in ETSI GS MEC 011 [17]. Support for at least one of the entries is required in conjunction with the transport.
type:array
minItems:1
items:
$ref:'#/components/schemas/FeatureDependency'
description:>-
Describes features a MEC application requires to run.
FeatureDependency is defined in ETSI GS MEC 010-2 [4]. It shall not
be provided if an AppD is available.
appFeatureOptional:
title:appFeatureOptional
$ref:'#/components/schemas/SerializerType'
labels:
description:Set of labels that allow to define groups of transport bindings. The mechanism of the grouping is defined below this table.
type:array
minItems:1
items:
$ref:'#/components/schemas/FeatureDependency'
description:>-
Describes features a MEC application may use if available.
FeatureDependency is defined in ETSI GS MEC 010-2 [4]. It shall not
be provided if an AppD is available.
isInsByMec:
type:boolean
description:>-
Indicate whether the application instance is instantiated by the MEC
Management.
Default to FALSE if absent.
examples:
-false
appProfile:
$ref:'#/components/schemas/AppProfile'
description:>-
This type represents the information provided by the MEC application
instance as part of the "application registration request" and
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.
type:integer
trafficFilter:
description:The filter used to identify specific packets that need to be handled by the MEC host.
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
description:DNS rule state. This attribute may be updated using HTTP PUT method
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
type:integer
format:uint32
timeSourceStatus:
type:string
description:Type of the subscription. The values are as defined in the "subscriptionType" attribute for each different Mp1 event subscription data type.
description:The HTTP status code for this occurrence of the problem
contentEncoding:int32
detail:
appCategory:
description:Category of the application.
$ref:'#/components/schemas/CategoryRef'
appDId:
description:The application descriptor identifier. It is managed by the application provider to identify the application descriptor in a globally unique way. Shall be present if the application instance is instantiated by the MEC Management.
type:string
description:>-
A human-readable explanation specific to this occurrence of the
problem
instance:
appInstanceId:
description:Identifier of the application instance. Shall be present if the application instance is instantiated by the MEC Management.
type:string
description:>-
A URI reference that identifies the specific occurrence of the
problem
Self:
title:Self
endpoint:
description:Endpoint information (e.g. URI, FQDN, IP address) of the application server, which is part of the application functionalities. Shall be present when isInsByMec is FALSE. See note 2.
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:Shall be set to "AppTerminationNotificationSubscription".
type:string
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
_links:
$ref:'#/components/schemas/_links1'
appInstanceId:
description:It is used as the filtering criterion for the subscribed events.
Set of labels that allow to define groups of transport bindings. The
mechanism of the grouping is defined below this table.
uris:
description:Entry point information of the service as string, formatted according to URI syntax (see IETF RFC 3986 [8]). Shall be used for REST APIs. See note.
type:array
minItems:0
items:
type:string
minItems:1
fqdn:
description:Fully Qualified Domain Name of the service. See note.
type:array
serializers:
description:>-
Information about the serializers in this transport binding, as
defined in the SerializerType type in ETSI GS MEC 011 [i.4]. Support
for at least one of the entries is required in conjunction with the
The name of the protocol used. Shall be set to "HTTP" for a REST
API.
href:
description:URI referring to the subscription.
type:string
security:
$ref:'#/components/schemas/SecurityInfo'
type:
$ref:'#/components/schemas/TransportType'
version:
description:The version of the protocol used.
format:uri
subscriptionType:
description:Type of the subscription. The values are as defined in the "subscriptionType" attribute for each different Mp1 event subscription data type.
type:string
required:
-type
-protocol
-version
-security
type:object
SerializerType:
title:SerializerType
enum:
-JSON
-XML
-PROTOBUF3
type:string
description:The enumeration represents types of serializers
examples:
-JSON
SecurityInfo:
title:SecurityInfo
-href
-subscriptionType
_links:
description:Object containing hyperlinks related to the resource.
description:Identities of the Application Clients that can be served by the EAS
provId:
type:string
description:Identifier of the ASP that provides the EAS.
examples:
-appProvider1
type:
description:The category or type of EAS.
type:string
scheds:
ntpServerAddr:
description:'1'
type:array
items:
type:string
minItems:1
description:The availability schedule of the EAS.
svcArea:
type:string
description:>-
The list of geographical and topological areas that the EAS serves.
ACs in the UE that are outside the area will not be served.
svcKpi:
type:string
description:Service characteristics provided by the EAS.
permLvl:
minPollingInterval:
description:'1'
type:array
format:uint32
items:
type:string
minItems:1
description:level of service permissions supported by the EAS.
easFeats:
$ref:'#/components/schemas/Uint32'
maxPollingInterval:
description:'1'
type:array
format:uint32
items:
$ref:'#/components/schemas/Uint32'
localPriority:
description:'1'
type:array
format:uint32
items:
$ref:'#/components/schemas/Uint32'
authenticationOption:
description:'1'
type:array
items:
type:string
minItems:1
description:Service features supported by the EAS.
svcContSupp:
authenticationKeyNum:
description:0..1
type:array
format:uint32
items:
$ref:'#/components/schemas/Uint32'
required:
-ntpServerAddrType
-ntpServerAddr
-minPollingInterval
-maxPollingInterval
-localPriority
-authenticationOption
-authenticationKeyNum
PtpMasters:
description:0..N
type:object
properties:
ptpMasterIpAddress:
description:'1'
type:array
items:
type:string
minItems:1
description:The ACR scenarios supported by the EAS for service continuity.
appLocs:
ptpMasterLocalPriority:
description:'1'
type:array
format:uint32
items:
$ref:'#/components/schemas/Uint32'
delayReqMaxRate:
description:'1'
type:array
format:uint32
items:
$ref:'#/components/schemas/Uint32'
required:
-ptpMasterIpAddress
-ptpMasterLocalPriority
-delayReqMaxRate
_links1:
description:Object containing hyperlinks related to the resource. This shall only be included in the HTTP responses.
type:object
properties:
self:
description:Self-referring URI.
$ref:'#/components/schemas/LinkType'
required:
-self
_links2:
description:Object containing hyperlinks related to the resource.
type:object
properties:
subscription:
description:A link to the related subscription.
$ref:'#/components/schemas/LinkType'
confirmTermination:
description:Link to the task resource where to confirm termination/stop in case the application is ready to be terminated, or to be considered stopped by the MEC Platform, before expiry of the timeout.
$ref:'#/components/schemas/LinkType'
required:
-subscription
Addresses:
description:Entry point information of the service as one or more pairs of IP address and port. See note.
type:object
properties:
host:
description:Host portion of the address.
type:string
minItems:1
description:>-
List of DNAI(s) and the N6 traffic information associated with the
EAS.
avlRep:
port:
description:Port portion of the address.
type:integer
description:>-
The period indicating to the EES, how often the EES needs to check
the EAS's availability after a successful registration.