Newer
Older
description: >-
The ETSI MEC ISG MEC016 UE Application Interface API described using OpenAPI
name: BSD-3-Clause
url: https://forge.etsi.org/legal-matters
ETSI GS MEC016 UE Application Interface API, V2.1.1
url: https://www.etsi.org/deliver/etsi_gs/MEC/001_099/016/02.01.01_60/gs_MEC016v020101p.pdf
security:
- OauthSecurity:
- all
- url: http://127.0.0.1:8081/mx2/v2
- url: https://127.0.0.1:8081/mx2/v2
tags:
- name: appList
- name: appContext
description: >-
Used to query information about the available
MEC applications.
operationId: AppList_GET
tags:
- appList
- $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"
"200":
$ref: '#/components/responses/AppList'
"400":
$ref: '#/components/responses/Error.400'
"401":
$ref: '#/components/responses/Error.401'
"403":
$ref: '#/components/responses/Error.403'
"404":
$ref: '#/components/responses/Error.404'
"/app_contexts":
description: >-
The POST method can be used to create a new application context. Upon
success, the response contains entity body describing the created
application context.
operationId: AppContext_POST
tags:
- appContext
requestBody:
$ref: "#/components/requestBodies/AppContext"
"201":
$ref: '#/components/responses/AppContext'
"400":
$ref: '#/components/responses/Error.400'
"401":
$ref: '#/components/responses/Error.401'
"403":
$ref: '#/components/responses/Error.403'
"404":
$ref: '#/components/responses/Error.404'
callbacks:
referenceURI:
$ref: '#/components/callbacks/NotificationEvent'
"/app_contexts/{contextId}":
parameters:
- $ref: "#/components/parameters/Path.ContextId"
description: >-
The PUT method is used to update the callback reference of the existing
application context. Upon successful operation, the target resource is
updated with new callback reference.
operationId: AppContextId_PUT
tags:
- appContext
requestBody:
$ref: "#/components/requestBodies/AppContext"
responses:
"204":
description: No Content.
"400":
$ref: '#/components/responses/Error.400'
"401":
$ref: '#/components/responses/Error.401'
"403":
$ref: '#/components/responses/Error.403'
"404":
$ref: '#/components/responses/Error.404'
callbacks:
referenceURI:
$ref: '#/components/callbacks/NotificationEvent'
delete:
description: >-
The DELETE method is used to delete the resource that represents the
existing application context.
operationId: AppContextId_DEL
tags:
- appContext
"204":
description: No Content
"400":
$ref: '#/components/responses/Error.400'
"401":
$ref: '#/components/responses/Error.401'
"403":
$ref: '#/components/responses/Error.403'
"404":
$ref: '#/components/responses/Error.404'
components:
callbacks:
NotificationEvent:
'{$request.body#/callbackReference}':
post:
description: >-
Used by the UALCMP to inform the Device application of
a modification to reference URI of the user application.
operationId: NotificationEvent_POST
tags:
- callback
requestBody:
$ref: '#/components/requestBodies/NotificationEvent'
responses:
'204':
description: No Content.
links:
PutAppContext:
operationId: AppContextId_PUT
description: The `contextId` value returned in the response can be used as the `contextId` parameter in `PUT /app_contexts/{contextId}`
parameters:
contextId: '$response.body#/contextId'
DelAppContext:
operationId: AppContextId_DEL
description: The `contextId` value returned in the response can be used as the `contextId` parameter in `DELETE /app_contexts/{contextId}`
parameters:
contextId: '$response.body#/contextId'
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
parameters:
Query.AppName:
name: appName
in: query
description: >-
Name to identify the MEC application
required: false
schema:
type: array
items:
type: string
Query.AppProvider:
name: appProvider
in: query
description: >-
Provider of the MEC application
required: false
schema:
type: array
items:
type: string
Query.AppSoftVersion:
name: appSoftVersion
in: query
description: >-
Software version of the MEC application
required: false
schema:
type: array
items:
type: string
Query.ServiceCont:
name: serviceCont
in: query
description: >-
Required service continuity mode for this application
required: false
schema:
type: string
enum:
- SERVICE_CONTINUITY_NOT_REQUIRED
- SERVICE_CONTINUITY_REQUIRED
Query.VendorId:
name: vendorId
in: query
description: Vendor identifier
required: false
schema:
type: array
items:
type: string
Path.ContextId:
name: contextId
in: path
description: >-
Uniquely identifies the application context in the MEC system.
It is assigned by the MEC system and included in the response to
an AppContext create.
required: true
schema:
type: string
requestBodies:
AppContext:
description: >-
Uniquely identifies the application context in the MEC system.
It is assigned by the MEC system and included in the response to
an AppContext create.
content:
application/json:
$ref: "#/components/schemas/AppContext"
required: true
Sent by the UALCMP to the Device application.
content:
application/json:
schema:
$ref: "#/components/schemas/NotificationEvent"
required: true
responses:
AppContext:
description: >-
The response body contains the Application Context as it was created
by the MEC system
content:
application/json:
links:
putAppContext:
$ref: "#/components/links/PutAppContext"
delAppContext:
$ref: "#/components/links/DelAppContext"
AppList:
description: >-
The response body contains the ApplicationList resource available
$ref: "#/components/schemas/ApplicationList"
Error.400:
description: >-
Bad Request.
It is used to indicate that incorrect parameters were passed to the request.
content:
application/problem+json:
$ref: '#/components/schemas/ProblemDetails'
text/plain:
schema:
$ref: '#/components/schemas/Empty'
Error.401:
description: >-
Unauthorized.
It is used when the client did not submit the appropriate credentials.
content:
application/problem+json:
$ref: '#/components/schemas/ProblemDetails'
text/plain:
$ref: '#/components/schemas/Empty'
Error.403:
description: >-
Forbidden.
The operation is not allowed given the current status of the resource.
content:
application/problem+json:
$ref: '#/components/schemas/ProblemDetails'
Error.404:
description: >-
Not Found.
It is used when a client provided a URI that cannot be mapped
to a valid resource URI.
content:
application/problem+json:
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
$ref: '#/components/schemas/ProblemDetails'
text/plain:
schema:
$ref: '#/components/schemas/Empty'
securitySchemes:
OauthSecurity:
type: oauth2
flows:
clientCredentials:
tokenUrl: https://oauth.exampleAPI/token
scopes:
all: Single oauth2 scope for API
schemas:
Empty:
description: Empty schema
ProblemDetails:
type: object
properties:
type:
$ref: "#/components/schemas/Problem.type"
title:
$ref: "#/components/schemas/Problem.title"
status:
$ref: "#/components/schemas/Problem.status"
detail:
$ref: "#/components/schemas/Problem.detail"
instance:
$ref: "#/components/schemas/Problem.instance"
Problem.type:
type: string
format: uri
description: >-
A URI reference according to IETF RFC 3986 that identifies the problem
type
Problem.title:
type: string
description: >-
A short, human-readable summary of the problem type
Problem.status:
type: integer
format: uint32
description: >-
The HTTP status code for this occurrence of the problem
Problem.detail:
type: string
description: >-
A human-readable explanation specific to this occurrence of the problem
Problem.instance:
type: string
format: uri
description: >-
A URI reference that identifies the specific occurrence of the problem
ApplicationList:
description: >-
Information on available applications
type: object
properties:
appList:
$ref: "#/components/schemas/AppList"
vendorSpecificExt:
$ref: "#/components/schemas/VendorSpecificExt"
AppList:
description: >-
List of user applications available to the device application
type: array
minItems: 0
items:
type: object
required:
- appInfo
properties:
appInfo:
$ref: "#/components/schemas/AppInfo"
AppContext:
description: >-
Information on application context created by the MEC system
type: object
required:
- contextId
- associateUeAppId
- appInfo
properties:
contextId:
$ref: "#/components/schemas/ContextId"
associateUeAppId:
$ref: "#/components/schemas/AssociateUeAppId"
callbackReference:
$ref: "#/components/schemas/CallbackReference"
appInfo:
$ref: "#/components/schemas/AppInfoAppContext"
NotificationEvent:
description: >-
The parameters used in the method "Receiving notification events".
type: object
- referenceURI
properties:
referenceURI:
$ref: "#/components/schemas/ReferenceURL"
VendorSpecificExt:
description: >-
Extension for vendor-specific information
required:
- vendorId
properties:
vendorId:
$ref: "#/components/schemas/VendorId"
ContextId:
description: >-
Uniquely identifies the application context in the MEC system.
Assigned by the MEC system and included in the response. The
length of the value shall not exceed 32 characters.
type: string
Uniquely identifies the Device application. Included in the request. The
length of the value shall not exceed 32 characters.
type: string
VendorId:
description: >-
Vendor identifier. The length of the value shall not exceed 32
characters. The rest of the structure of this vendor specific extension
is not defined
type: string
AppInfo:
- appDescription
properties:
appDId:
$ref: "#/components/schemas/AppDId"
appDVersion:
$ref: "#/components/schemas/AppDVersion"
description: Included in the request
type: object
required:
- appName
- appProvider
appDId:
$ref: "#/components/schemas/AppDId"
appName:
$ref: "#/components/schemas/AppName"
appProvider:
$ref: "#/components/schemas/AppProvider"
appSoftVersion:
$ref: "#/components/schemas/AppSoftVersion"
appDVersion:
$ref: "#/components/schemas/AppDVersion"
appDescription:
$ref: "#/components/schemas/AppDescription"
referenceURL:
$ref: "#/components/schemas/ReferenceURL"
appPackageSource:
$ref: "#/components/schemas/AppPackageSource"
AppCharcs:
description: >-
The application characteristics relate to the system resources consumed
by the application. Device application can use this information e.g., for
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
estimating the cost of use of the application or for the expected user
experience
type: object
properties:
memory:
$ref: "#/components/schemas/Memory"
storage:
$ref: "#/components/schemas/Storage"
latency:
$ref: "#/components/schemas/Latency"
bandwidth:
$ref: "#/components/schemas/Bandwidth"
serviceCont:
$ref: "#/components/schemas/ServiceCont"
Memory:
description: >-
The maximum size in Mbytes of the memory resource reserved for 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:
description: >-
Required service continuity mode for this application.
type: string
enum:
- SERVICE_CONTINUITY_NOT_REQUIRED
- SERVICE_CONTINUITY_REQUIRED
example:
SERVICE_CONTINUITY_NOT_REQUIRED
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 010-2.
This attribute shall be globally unique. It shall be present if the
application is one in the ApplicationList.
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 010-2.
type: string
AppDescription:
description: >-
Human readable description of the MEC application. NOTE the
language support may be limited. The length of the value shall not
exceed 128 characters.
type: string
CallbackReference:
description: >-
URI assigned by the Device application to receive application lifecycle
related notifications. Included in the request. This subscription stays
alive for the lifetime of the application context.
type: string
format: uri
ReferenceURL:
description: >-
Address of the user application. Used as the reference URL for the
application. Assigned by the MEC system and included in the
response
type: string
format: uri
AppPackageSource:
description: >-
URI of the application package. Included in the request if the
application is not one in the ApplicationList. appPackageSource 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 010-2
type: string