The Mx2 reference point from ETSI GS MEC 016, used by a device-side application to discover which MEC applications are available in the system and to request instantiation or termination of a user application in the edge cloud.
openapi: 3.1.0
jsonSchemaDialect: https://json-schema.org/draft/2020-12/schema
info:
contact:
url: https://forge.etsi.org/rep/mec/gs016-dev-app-api
title: ETSI GS MEC 016 UE Application Interface API
description: The ETSI MEC ISG UE Application Interface API described using OpenAPI.
license:
name: BSD-3-Clause
url: https://forge.etsi.org/legal-matters
version: 2.2.1
servers:
- url: https://localhost/dev_app/v1
paths:
/app_list:
get:
summary: Retrieve available application information.
description: The GET method is used to query information about the available MEC applications.
operationId: ApplistGET
tags:
- dev_app
parameters:
- $ref: '#/components/parameters/Query.Appname'
- $ref: '#/components/parameters/Query.Appprovider'
- $ref: '#/components/parameters/Query.Appsoftversion'
- $ref: '#/components/parameters/Query.Servicecont'
- $ref: '#/components/parameters/Query.Vendorid'
responses:
'200':
description: The response body contains an array of the user applications available to the querying device application.
content:
application/json:
schema:
type: object
properties:
ApplicationList:
$ref: '#/components/schemas/ApplicationList'
'400':
$ref: '#/components/responses/400'
'401':
$ref: '#/components/responses/401'
'404':
$ref: '#/components/responses/404'
'403':
$ref: '#/components/responses/403'
/app_contexts:
post:
summary: For requesting the creation of a new application context.
description: The POST method is used to create a new application context. Upon success, the response contains entity body describing the created application context.
operationId: AppcontextsPOST
tags:
- dev_app
requestBody:
description: Entity body in the request contains the Application Context as requested by the device application.
required: true
content:
application/json:
schema:
type: object
properties:
AppContext:
$ref: '#/components/schemas/AppContext'
responses:
'201':
description: "The response body contains the Application Context as it was created by the MEC system, which includes the reference URI(s) of the associated user application instance(s). \nThe URI of the resource created within the MEC system associated with the request, with its specific application context ID, shall be included in the \"Location\" HTTP header of the response."
content:
application/json:
schema:
type: object
properties:
AppContext:
$ref: '#/components/schemas/AppContext'
'400':
$ref: '#/components/responses/400'
'401':
$ref: '#/components/responses/401'
'404':
$ref: '#/components/responses/404'
'403':
$ref: '#/components/responses/403'
parameters: []
/app_contexts/{contextId}:
put:
summary: For updating the callbackReference and/or appLocation of an existing application context.
description: The PUT method is used to update the callback reference and/or application location constraints of an existing application context. Upon successful operation, the target resource is updated with the new application context information.
operationId: AppcontextsPUTContextid
tags:
- dev_app
requestBody:
description: Only the callbackReference and/or appLocation attribute values are allowed to be updated. Other attributes and their values shall remain untouched.
required: true
content:
application/json:
schema:
type: object
properties:
AppContext:
$ref: '#/components/schemas/AppContext'
responses:
'204':
description: Upon success, a response 204 No Content without any response body is returned.
content:
application/json:
schema:
type: object
properties: {}
'400':
$ref: '#/components/responses/400'
'401':
$ref: '#/components/responses/401'
'404':
$ref: '#/components/responses/404'
'403':
$ref: '#/components/responses/403'
parameters:
- name: contextId
in: path
required: true
description: The unique identifier of the contextId.
schema:
type: string
delete:
summary: For requesting the deletion of an existing application context.
description: The DELETE method is used to delete the resource that represents the existing application context.
operationId: AppcontextsDELETEContextid
tags:
- dev_app
responses:
'204':
$ref: '#/components/responses/204'
'400':
$ref: '#/components/responses/400'
'401':
$ref: '#/components/responses/401'
'404':
$ref: '#/components/responses/404'
'403':
$ref: '#/components/responses/403'
parameters:
- name: contextId
in: path
required: true
description: The unique identifier of the contextId.
schema:
type: string
/obtain_app_loc_availability:
post:
summary: Used to obtain the location constraints for a new application context.
description: The POST method is used to obtain the locations available for instantiation of a specific user application in the MEC system.
operationId: ObtainapplocavailabilityPOST
tags:
- dev_app
requestBody:
description: Entity body in the request contains the user application information for the MEC system to evaluate the locations available for instantiation of that application.
required: true
content:
application/json:
schema:
type: object
properties:
ApplicationLocationAvailability:
$ref: '#/components/schemas/ApplicationLocationAvailability'
responses:
'200':
description: The response body contains the locations available for instantiation of the requested user application in the MEC system.
content:
application/json:
schema:
type: object
properties:
ApplicationLocationAvailability:
$ref: '#/components/schemas/ApplicationLocationAvailability'
'400':
$ref: '#/components/responses/400'
'401':
$ref: '#/components/responses/401'
'404':
$ref: '#/components/responses/404'
'403':
$ref: '#/components/responses/403'
parameters: []
components:
schemas:
ProblemDetails:
type: object
properties:
type:
type: string
format: uri
description: A URI reference according to IETF RFC 3986 that identifies the problem type
title:
type: string
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
description: A human-readable explanation specific to this occurrence of the problem
instance:
type: string
format: uri
description: A URI reference that identifies the specific occurrence of the problem
Polygon:
type: object
properties:
coordinates:
type: array
items:
type: array
items:
type: array
items:
type: number
format: float
minItems: 1
InlineNotification:
oneOf:
- $ref: '#/components/schemas/AddressChangeNotification'
- $ref: '#/components/schemas/ApplicationContextDeleteNotification'
- $ref: '#/components/schemas/ApplicationContextUpdateNotification'
- $ref: '#/components/schemas/ApplicationLocationAvailabilityNotification'
discriminator:
propertyName: notificationType
ApplicationList:
x-etsi-ref: 6.2.2
type: object
properties:
appList:
type: array
items:
$ref: '#/components/schemas/AppList'
description: "|-\n NOTE 1:\tThe vendor specific extension allows submitting information on the application lists that have been made available to the device application of the corresponding vendor.\nNOTE 2:\tThe language support may be limited. The length of the value shall not exceed 128 characters."
AppContext:
x-etsi-ref: 6.2.3
type: object
properties:
contextId:
description: "Uniquely identifies the application context in the MEC system.\nAssigned by the MEC system and shall be present other than in a create request.\n\nThe length of the value shall not exceed 32\_characters."
type: string
associateDevAppId:
description: "Uniquely identifies the device application.\nThe length of the value shall not exceed 32\_characters."
type: string
callbackReference:
description: 'URI assigned by the device application to receive application lifecycle related notifications. Inclusion in the request implies the client supports the pub/sub mechanism and is capable of receiving notifications.
This endpoint shall be maintained for the lifetime of the application context.'
type: string
format: uri
appLocationUpdates:
description: Used by the device application to request to receive notifications at the callbackReference URI relating to location availability for user application instantiation.
type: boolean
appAutoInstantiation:
description: Provides indication to the MEC system that instantiation of the requested application is desired should a requested appLocation become available that was not at the time of the request.
type: boolean
appInfo:
$ref: '#/components/schemas/AppInfo1'
required:
- associateDevAppId
- appInfo
ApplicationLocationAvailability:
x-etsi-ref: 6.2.4
type: object
properties:
associateDevAppId:
description: "Uniquely identifies the device application.\nThe length of the value shall not exceed 32\_characters."
type: string
appInfo:
$ref: '#/components/schemas/AppInfo2'
required:
- associateDevAppId
- appInfo
AddressChangeNotification:
x-etsi-ref: 6.4.2
type: object
properties:
notificationType:
description: Shall be set to "AddressChangeNotification".
type: string
contextId:
description: Uniquely identifies the application context in the MEC system.
type: string
appInstanceId:
description: Identifier of the user application instance.
type: string
referenceURI:
description: 'Address of the user application. Used as the reference URI for the application.
Assigned by the MEC system.'
type: string
format: uri
required:
- notificationType
- contextId
- appInstanceId
- referenceURI
ApplicationContextDeleteNotification:
x-etsi-ref: 6.4.3
type: object
properties:
notificationType:
description: Shall be set to "ApplicationContextDeleteNotification".
type: string
contextId:
description: Uniquely identifies the application context that has been deleted from the MEC system.
type: string
required:
- notificationType
- contextId
ApplicationContextUpdateNotification:
x-etsi-ref: 6.4.4
type: object
properties:
notificationType:
description: Shall be set to "ApplicationContextUpdateNotification".
type: string
contextId:
description: Uniquely identifies the application context in the MEC system.
type: string
userAppInstanceInfo:
type: array
items:
$ref: '#/components/schemas/UserAppInstanceInfo1'
required:
- notificationType
- contextId
- userAppInstanceInfo
ApplicationLocationAvailabilityNotification:
x-etsi-ref: 6.4.5
type: object
properties:
notificationType:
description: Shall be set to "ApplicationLocationAvailabilityNotification".
type: string
contextId:
description: Uniquely identifies the application context in the MEC system.
type: string
availableLocations:
type: array
items:
$ref: '#/components/schemas/AvailableLocations1'
required:
- notificationType
- availableLocations
LocationConstraints:
x-etsi-ref: 6.5.2
type: object
properties:
countryCode:
description: The two-letter ISO 3166 [7] country code in capital letters. Shall be present in case the "area" attribute is absent. May be absent if the "area" attribute is present (see note).
type: string
civicAddressElement:
type: array
items:
$ref: '#/components/schemas/CivicAddressElement'
area:
description: Content of civic address element corresponding to the caType. The format caValue shall comply with section 3.4 of IETF RFC 4776 [6].
$ref: '#/components/schemas/Polygon'
type: object
AppCharcs:
description: 'Characteristics of the application.
As defined below.
The application characteristics relate to the system resources consumed by the application. A device application can use this information e.g. for estimating the cost of use of the application or for the expected user experience.'
type: object
properties:
memory:
description: The maximum size in Mbytes of the memory resource expected to be used by the MEC application instance in the MEC system.
type: integer
format: uint32
storage:
description: The maximum size in Mbytes of the storage resource expected to be used by the MEC application instance in the MEC system.
type: integer
format: uint32
latency:
description: The target round trip time in milliseconds supported by the MEC system for the MEC application instance.
type: integer
format: uint32
bandwidth:
description: 'The required connection bandwidth in kbit/s for the use of the MEC application instance. '
type: integer
format: uint32
serviceCont:
type: integer
description: 'Required service continuity mode for this application.
Permitted values:
0 = SERVICE_CONTINUITY_NOT_REQUIRED.
1 = SERVICE_CONTINUITY_REQUIRED.'
enum:
- 0
- 1
AppInfo:
description: ''
type: object
properties:
appDId:
description: "Identifier of this MEC application descriptor. It is equivalent to the appDId defined in clause 6.2.1.2 of ETSI GS\_MEC\_0102 [1]. This attribute shall be globally unique."
type: string
appName:
description: 'Name of the MEC application.
The length of the value shall not exceed 32 characters.'
type: string
appProvider:
description: 'Provider of the MEC application.
The length of the value shall not exceed 32 characters.'
type: string
appSoftVersion:
description: 'Software version of the MEC application.
The length of the value shall not exceed 32 characters.'
type: string
appDVersion:
description: Identifies the version of the application descriptor. It is equivalent to the appDVersion defined in clause 6.2.1.2 of ETSI GS MEC 0102 [1].
type: string
appDescription:
description: Human readable description of the MEC application (see note 2).
type: string
appLocation:
description: Identifies the locations of the MEC application.
type: array
minItems: 0
items:
$ref: '#/components/schemas/LocationConstraints'
appCharcs:
$ref: '#/components/schemas/AppCharcs'
required:
- appDId
- appName
- appProvider
- appSoftVersion
- appDVersion
- appDescription
VendorSpecificExt:
description: Extension for vendor specific information (see note 1).
type: object
properties:
vendorId:
description: 'Vendor identifier.
The length of the value shall not exceed 32 characters.
The rest of the structure of vendor specific extension is not defined.'
type: string
required:
- vendorId
AppList:
description: 'List of user applications available to the device application.
As defined below.'
type: object
minItems: 0
properties:
appInfo:
$ref: '#/components/schemas/AppInfo'
vendorSpecificExt:
$ref: '#/components/schemas/VendorSpecificExt'
required:
- appInfo
UserAppInstanceInfo:
description: List of user application instance information.
type: object
minItems: 1
properties:
appInstanceId:
description: 'Identifier of the user application instance.
It shall only be included in the response.'
type: string
referenceURI:
description: 'Address of the user application instance.
It shall only be included in the response.'
type: string
format: uri
appLocation:
description: Location of the user application instance. For a user application not provided by the requesting device application it shall match one of the appLocations in ApplicationList.
$ref: '#/components/schemas/LocationConstraints'
type: object
AppInfo1:
description: ''
type: object
properties:
appDId:
description: "Identifier of this MEC application descriptor. This attribute shall be globally unique. It is equivalent to the appDId defined in clause 6.2.1.2 of ETSI GS\_MEC 0102 [1].\nIt shall be present if the application is one in the ApplicationList."
type: string
appName:
description: "Name of the MEC application.\nThe length of the value shall not exceed 32\_characters."
type: string
appProvider:
description: "Provider of the MEC application.\nThe length of the value shall not exceed 32\_characters."
type: string
appSoftVersion:
description: "Software version of the MEC application.\nThe length of the value shall not exceed 32\_characters."
type: string
appDVersion:
description: "Identifies the version of the application descriptor. It\_is equivalent to the appDVersion defined in clause\_6.2.1.2 of ETSI GS MEC 0102 [1]."
type: string
appDescription:
description: "Human readable description of the MEC application.\nThe length of the value shall not exceed 128\_characters."
type: string
userAppInstanceInfo:
type: array
items:
$ref: '#/components/schemas/UserAppInstanceInfo'
appPackageSource:
description: "URI of the application package.\nIncluded in the request if the application is not one in the ApplicationList.\n\nappPackageSource enables on-boarding of the application package into the MEC system. The application package shall comply with the definitions in clause 6.2.1.2 of ETSI GS\_MEC\_0102\_[1]."
type: string
format: uri
required:
- appName
- appProvider
- appDVersion
- userAppInstanceInfo
AvailableLocations:
description: 'MEC application location constraints. '
type: object
minItems: 0
properties:
appLocation:
description: Shall only be included in the response, where it indicates a location constraint available in the MEC system.
$ref: '#/components/schemas/LocationConstraints'
type: object
AppInfo2:
description: ''
type: object
properties:
appName:
description: "Name of the MEC application.\nThe length of the value shall not exceed 32\_characters."
type: string
appProvider:
description: "Provider of the MEC application.\nThe length of the value shall not exceed 32\_characters."
type: string
appSoftVersion:
description: "Software version of the MEC application.\nThe length of the value shall not exceed 32\_characters."
type: string
appDVersion:
description: "Identifies the version of the application descriptor. It is equivalent to the appDVersion defined in clause\_6.2.1.2 of ETSI GS MEC 0102 [1]."
type: string
appDescription:
description: "Human readable description of the MEC application.\nThe length of the value shall not exceed 128\_characters."
type: string
availableLocations:
type: array
items:
$ref: '#/components/schemas/AvailableLocations'
appPackageSource:
description: "URI of the application package. Shall be included in the request.\nThe application package shall comply with the definitions in clause 6.2.1.2 of ETSI GS\_MEC\_0102 [1]."
type: string
format: uri
required:
- appName
- appProvider
- appDVersion
UserAppInstanceInfo1:
description: List of user application instance information.
type: object
minItems: 1
properties:
appInstanceId:
description: Identifier of the user application instance.
type: string
referenceURI:
description: Address of the user application instance.
type: string
format: uri
appLocation:
description: Location of the user application instance.
$ref: '#/components/schemas/LocationConstraints'
type: object
required:
- appInstanceId
- referenceURI
AvailableLocations1:
description: Locations available to the MEC application.
type: object
minItems: 1
properties:
appLocation:
description: ''
$ref: '#/components/schemas/LocationConstraints'
type: object
required:
- appLocation
CivicAddressElement:
description: Zero or more elements comprising the civic address. Shall be absent if the "area" attribute is present.
type: object
minItems: 0
properties:
caType:
description: 'Describe the content type of caValue. The value of caType shall comply with section 3.4 of IETF RFC 4776 [6]. '
type: integer
caValue:
description: ''
type: string
required:
- caType
- caValue
responses:
'200':
description: OK
'204':
description: No Content
'400':
description: 'Bad Request: used to indicate that incorrect parameters were passed to the request.'
content:
application/problem+json:
schema:
$ref: '#/components/schemas/ProblemDetails'
'401':
description: 'Unauthorized: used when the client did not submit credentials.'
content:
application/problem+json:
schema:
$ref: '#/components/schemas/ProblemDetails'
'403':
description: 'Forbidden: operation is not allowed given the current status of the resource.'
content:
application/problem+json:
schema:
$ref: '#/components/schemas/ProblemDetails'
'404':
description: 'Not Found: 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'
parameters:
Query.Appname:
description: Name to identify the MEC application.
name: appname
in: query
required: false
x-exportParamName: Query.Appname
schema:
type: array
items:
type: string
Query.Appprovider:
description: Provider of the MEC application.
name: appprovider
in: query
required: false
x-exportParamName: Query.Appprovider
schema:
type: array
items:
type: string
Query.Appsoftversion:
description: Software version of the MEC application.
name: appsoftversion
in: query
required: false
x-exportParamName: Query.Appsoftversion
schema:
type: array
items:
type: string
Query.Servicecont:
description: 'Required service continuity mode for this application.
Permitted values:
0 = SERVICE_CONTINUITY_NOT_REQUIRED.
1 = SERVICE_CONTINUITY_REQUIRED.'
name: servicecont
in: query
required: false
x-exportParamName: Query.Servicecont
schema:
type: integer
Query.Vendorid:
description: Vendor identifier.
name: vendorid
in: query
required: false
x-exportParamName: Query.Vendorid
schema:
type: array
items:
type: string