Newer
Older
swagger: '2.0'
info:
description: >-
An initial attempt to describe the MEC UE Application Interface API using
OpenAPI
version: 0.3.1
title: UE Application Interface API
license:
name: ETSI Forge copyright notice
url: 'https://forge.etsi.org/etsi-forge-copyright-notice.txt'
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
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
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
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
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
externalDocs:
description: ETSI MEC016 V0.3.1 UE Application Interface API
url: 'https://docbox.etsi.org/ISG/MEC/70-Draft/0016UEAppInterface'
host: '127.0.0.1:8081'
basePath: /mx2/v1
schemes:
- http
- https
consumes:
- application/json
produces:
- application/json
security:
- OauthSecurity:
- all
securityDefinitions:
OauthSecurity:
type: oauth2
flow: application
tokenUrl: 'https://oauth.exampleAPI/token'
scopes:
all: Single oauth2 scope for API
parameters:
Query.AppName:
name: appName
in: query
description: Name to identify the mobile edge application
required: false
type: array
items:
type: string
Query.AppProvider:
name: appProvider
in: query
description: Provider of the mobile edge application
required: false
type: array
items:
type: string
Query.AppSoftVersion:
name: appSoftVersion
in: query
description: Software version of the mobile edge application
required: false
type: array
items:
type: string
Query.ServiceCont:
name: serviceCont
in: query
description: Required service continuity mode for this application
required: false
type: string
enum:
- SERVICE_CONTINUITY_NOT_REQUIRED
- SERVICE_CONTINUITY_REQUIRED
Body.AppContext:
name: appContext
in: body
description: >-
Uniquely identifies the application context in the mobile edge system. It
is assigned by the mobile edge system and included in the response to an
AppContext create.
required: true
schema:
$ref: '#/definitions/AppContext'
Query.VendorId:
name: vendorId
in: query
description: Vendor identifier
required: false
type: array
items:
type: string
Path.ContextId:
name: contextId
in: path
description: >-
Uniquely identifies the application context in the mobile edge system. It
is assigned by the mobile edge system and included in the response to an
AppContext create.
required: true
type: string
paths:
/app_list:
get:
description: >-
The GET method can be used to query information about the available
mobile edge applications.
produces:
- application/json
parameters:
- $ref: '#/parameters/Query.AppName'
- $ref: '#/parameters/Query.AppProvider'
- $ref: '#/parameters/Query.AppSoftVersion'
- $ref: '#/parameters/Query.ServiceCont'
- $ref: '#/parameters/Query.VendorId'
responses:
'200':
description: >-
The response body contains the ApplicationList resource available
for the querying UE application
schema:
required:
- ApplicationList
properties:
ApplicationList:
$ref: '#/definitions/ApplicationList'
'400':
description: Incorrect parameters were passed in the request.More information should be provided in the "detail" attribute of the "ProblemDetails" structure.
schema:
properties:
ProblemDetails:
$ref: '#/definitions/ProblemDetails'
'401':
description: An erroneous or missing bearer token. More information should be provided in the "detail" attribute of the "ProblemDetails" structure.
schema:
properties:
ProblemDetails:
$ref: '#/definitions/ProblemDetails'
'403':
description: >-
The operation is not allowed given the current status of the resource. More information should be provided in the "detail" attribute of the "ProblemDetails" structure.
schema:
required:
- ProblemDetails
properties:
ProblemDetails:
$ref: '#/definitions/ProblemDetails'
'404':
description: >-
The client provided a URI that cannot be mapped to a valid resource URL. More information should be provided in the "detail" attribute of the "ProblemDetails" structure.
schema:
properties:
ProblemDetails:
$ref: '#/definitions/ProblemDetails'
/app_contexts:
post:
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.
produces:
- application/json
parameters:
- $ref: '#/parameters/Body.AppContext'
responses:
'201':
description: >-
The response body contains the Application Context as it was created
by the mobile edge system
schema:
required:
- AppContext
properties:
AppContext:
$ref: '#/definitions/AppContext'
'400':
description: Incorrect parameters were passed in the request.More information should be provided in the "detail" attribute of the "ProblemDetails" structure.
schema:
properties:
ProblemDetails:
$ref: '#/definitions/ProblemDetails'
'401':
description: An erroneous or missing bearer token. More information should be provided in the "detail" attribute of the "ProblemDetails" structure.
schema:
properties:
ProblemDetails:
$ref: '#/definitions/ProblemDetails'
'403':
description: >-
The operation is not allowed given the current status of the resource. More information should be provided in the "detail" attribute of the "ProblemDetails" structure.
schema:
required:
- ProblemDetails
properties:
ProblemDetails:
$ref: '#/definitions/ProblemDetails'
'404':
description: >-
The client provided a URI that cannot be mapped to a valid resource URL. More information should be provided in the "detail" attribute of the "ProblemDetails" structure.
schema:
properties:
ProblemDetails:
$ref: '#/definitions/ProblemDetails'
'/app_contexts/{contextId}':
put:
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.
produces:
- application/json
parameters:
- $ref: '#/parameters/Path.ContextId'
- $ref: '#/parameters/Body.AppContext'
responses:
'204':
description: >-
Upon success, a response 204 No Content without any response body is
returned.
'400':
description: Incorrect parameters were passed in the request.More information should be provided in the "detail" attribute of the "ProblemDetails" structure.
schema:
properties:
ProblemDetails:
$ref: '#/definitions/ProblemDetails'
'401':
description: An erroneous or missing bearer token. More information should be provided in the "detail" attribute of the "ProblemDetails" structure.
schema:
properties:
ProblemDetails:
$ref: '#/definitions/ProblemDetails'
'403':
description: >-
The operation is not allowed given the current status of the resource. More information should be provided in the "detail" attribute of the "ProblemDetails" structure.
schema:
required:
- ProblemDetails
properties:
ProblemDetails:
$ref: '#/definitions/ProblemDetails'
'404':
description: >-
The client provided a URI that cannot be mapped to a valid resource URL. More information should be provided in the "detail" attribute of the "ProblemDetails" structure.
schema:
properties:
ProblemDetails:
$ref: '#/definitions/ProblemDetails'
delete:
description: >-
The DELETE method is used to delete the resource that represents the
existing application context.
produces:
- application/json
parameters:
- $ref: '#/parameters/Path.ContextId'
responses:
'204':
description: >-
Upon success, a response 204 No Content without any response body is
returned.
'400':
description: Incorrect parameters were passed in the request. More information should be provided in the "detail" attribute of the "ProblemDetails" structure.
schema:
properties:
ProblemDetails:
$ref: '#/definitions/ProblemDetails'
'401':
description: An erroneous or missing bearer token. More information should be provided in the "detail" attribute of the "ProblemDetails" structure.
schema:
properties:
ProblemDetails:
$ref: '#/definitions/ProblemDetails'
'403':
description: >-
The operation is not allowed given the current status of the resource. More information should be provided in the "detail" attribute of the "ProblemDetails" structure.
schema:
required:
- ProblemDetails
properties:
ProblemDetails:
$ref: '#/definitions/ProblemDetails'
'404':
description: >-
The client provided a URI that cannot be mapped to a valid resource URL. More information should be provided in the "detail" attribute of the "ProblemDetails" structure.
schema:
properties:
ProblemDetails:
$ref: '#/definitions/ProblemDetails'
definitions:
ProblemDetails:
type: object
properties:
type:
$ref: '#/definitions/Problem.type'
title:
$ref: '#/definitions/Problem.title'
status:
$ref: '#/definitions/Problem.status'
detail:
$ref: '#/definitions/Problem.detail'
instance:
$ref: '#/definitions/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:
appInfo:
$ref: '#/definitions/AppInfo'
vendorSpecificExt:
$ref: '#/definitions/VendorSpecificExt'
AppContext:
description: information on application context created by the mobile edge system
type: object
required:
- contextId
- associateUeAppId
- appInfo
properties:
contextId:
$ref: '#/definitions/ContextId'
associateUeAppId:
$ref: '#/definitions/AssociateUeAppId'
callbackReference:
$ref: '#/definitions/CallbackReference'
appInfo:
$ref: '#/definitions/RequiredAppInfo'
NotificationEvent:
description: the parameters used in the method 'Receiving notification events'.
type: object
required:
- referenceURI
properties:
referenceURI:
$ref: '#/definitions/ReferenceURL'
VendorSpecificExt:
description: Extension for vendor-specific information
type: array
items:
required:
- vendorId
properties:
vendorId:
$ref: '#/definitions/VendorId'
ContextId:
description: >-
Uniquely identifies the application context in the mobile edge system.
Assigned by the mobile edge system and included in the response. The length of the value shall not exceed 32 characters.
type: string
AssociateUeAppId:
description: 'Uniquely identifies the UE 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 vendor specific extension is not defined
type: string
AppInfo:
description: User applications available for the UE application
type: array
items:
type: object
required:
- appName
- appProvider
- appDescription
properties:
appName:
$ref: '#/definitions/AppName'
appProvider:
$ref: '#/definitions/AppProvider'
appSoftVersion:
$ref: '#/definitions/AppSoftVersion'
appDescription:
$ref: '#/definitions/AppDescription'
appCharcs:
$ref: '#/definitions/AppCharcs'
RequiredAppInfo:
description: Included in the request
type: object
required:
- appName
- appProvider
- referenceURL
properties:
appName:
$ref: '#/definitions/AppName'
appProvider:
$ref: '#/definitions/AppProvider'
appSoftVersion:
$ref: '#/definitions/AppSoftVersion'
appDescription:
$ref: '#/definitions/AppDescription'
referenceURL:
$ref: '#/definitions/ReferenceURL'
appPackageSource:
$ref: '#/definitions/AppPackageSource'
AppCharcs:
description: >-
The application characteristics relate to the system resources consumed by
the application. UE 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:
$ref: '#/definitions/Memory'
storage:
$ref: '#/definitions/Storage'
latency:
$ref: '#/definitions/Latency'
bandwidth:
$ref: '#/definitions/Bandwidth'
serviceCont:
$ref: '#/definitions/ServiceCont'
Memory:
description: >-
The maximum size in Mbytes of the memory resource reserved for the mobile
edge application instance in the mobile edge system
type: integer
format: unit32
Storage:
description: >-
The maximum size in Mbytes of the storage resource expected to be used by the mobile edge application instance in the mobile edge system
type: integer
format: unit32
Latency:
description: >-
The target round trip time in milliseconds supported by the mobile edge system for the mobile edge application instance
type: integer
format: unit32
Bandwidth:
description: >-
The required connection bandwidth in kbit/s for the use of the mobile edge
application instance
type: integer
format: unit32
ServiceCont:
description: >-
Required service continuity mode for this application.
type: string
enum:
- SERVICE_CONTINUITY_NOT_REQUIRED
- SERVICE_CONTINUITY_REQUIRED
AppName:
description: >-
Name of the mobile edge application. The length of the value shall not exceed 32 characters.
type: string
AppProvider:
description: Provider of the mobile edge application. The length of the value shall not exceed 32 characters.
type: string
AppSoftVersion:
description: Software version of the mobile edge application. The length of the value shall not exceed 32 characters.
type: string
AppDescription:
description: ->
Human readable description of the mobile edge 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 UE 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 mobile edge 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 mobile edge system. The application package shall comply with the definitions in clause 6.2.1.2 of ETSI GS MEC 010-2 [1]
type: string
format: uri