UEAppInterfaceApi.json 18.7 KB
Newer Older
1
{
Walter Featherstone's avatar
Walter Featherstone committed
2
  "openapi": "3.0.2",
3
4
  "info": {
    "title": "UE Application Interface API",
Walter Featherstone's avatar
Walter Featherstone committed
5
6
    "version": "1.1.1",
    "description": "The ETSI MEC ISG MEC016 UE Application Interface API described using OpenAPI",
7
8
9
    "license": {
      "name": "ETSI Forge copyright notice",
      "url": "https://forge.etsi.org/etsi-forge-copyright-notice.txt"
Walter Featherstone's avatar
Walter Featherstone committed
10
11
12
    },
    "contact": {
      "email": "cti_support@etsi.org"
13
14
15
    }
  },
  "externalDocs": {
16
17
    "description": "ETSI GS MEC016 UE Application Interface API, V1.1.1",
    "url": "http://www.etsi.org/deliver/etsi_gs/MEC/001_099/016/01.01.01_60/gs_MEC016v010101p.pdf"
18
19
20
21
22
23
24
25
  },
  "security": [
    {
      "OauthSecurity": [
        "all"
      ]
    }
  ],
Walter Featherstone's avatar
Walter Featherstone committed
26
27
28
  "servers": [
    {
      "url": "http://127.0.0.1:8081/mx2/v1"
29
    },
Walter Featherstone's avatar
Walter Featherstone committed
30
31
32
33
34
35
36
    {
      "url": "https://127.0.0.1:8081/mx2/v1"
    }
  ],
  "tags": [
    {
      "name": "appList"
37
    },
Walter Featherstone's avatar
Walter Featherstone committed
38
39
    {
      "name": "appContext"
40
    }
Walter Featherstone's avatar
Walter Featherstone committed
41
  ],
42
43
44
  "paths": {
    "/app_list": {
      "get": {
Walter Featherstone's avatar
Walter Featherstone committed
45
46
47
48
        "description": "Used to query information about the available MEC applications.",
        "operationId": "AppList_GET",
        "tags": [
          "appList"
49
50
51
        ],
        "parameters": [
          {
Walter Featherstone's avatar
Walter Featherstone committed
52
            "$ref": "#/components/parameters/Query.AppName"
53
54
          },
          {
Walter Featherstone's avatar
Walter Featherstone committed
55
            "$ref": "#/components/parameters/Query.AppProvider"
56
57
          },
          {
Walter Featherstone's avatar
Walter Featherstone committed
58
            "$ref": "#/components/parameters/Query.AppSoftVersion"
59
60
          },
          {
Walter Featherstone's avatar
Walter Featherstone committed
61
            "$ref": "#/components/parameters/Query.ServiceCont"
62
63
          },
          {
Walter Featherstone's avatar
Walter Featherstone committed
64
            "$ref": "#/components/parameters/Query.VendorId"
65
66
67
68
          }
        ],
        "responses": {
          "200": {
Walter Featherstone's avatar
Walter Featherstone committed
69
            "$ref": "#/components/responses/AppList"
70
71
          },
          "400": {
Walter Featherstone's avatar
Walter Featherstone committed
72
            "$ref": "#/components/responses/Error.400"
73
74
          },
          "401": {
Walter Featherstone's avatar
Walter Featherstone committed
75
            "$ref": "#/components/responses/Error.401"
76
77
          },
          "403": {
Walter Featherstone's avatar
Walter Featherstone committed
78
            "$ref": "#/components/responses/Error.403"
79
80
          },
          "404": {
Walter Featherstone's avatar
Walter Featherstone committed
81
            "$ref": "#/components/responses/Error.404"
82
          }
83
        }
84
      }
85
    },
86
87
88
    "/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.",
Walter Featherstone's avatar
Walter Featherstone committed
89
90
91
        "operationId": "AppContext_POST",
        "tags": [
          "appContext"
92
        ],
Walter Featherstone's avatar
Walter Featherstone committed
93
94
95
        "requestBody": {
          "$ref": "#/components/requestBodies/AppContext"
        },
96
97
        "responses": {
          "201": {
Walter Featherstone's avatar
Walter Featherstone committed
98
            "$ref": "#/components/responses/AppContext"
99
100
          },
          "400": {
Walter Featherstone's avatar
Walter Featherstone committed
101
            "$ref": "#/components/responses/Error.400"
102
103
          },
          "401": {
Walter Featherstone's avatar
Walter Featherstone committed
104
            "$ref": "#/components/responses/Error.401"
105
106
          },
          "403": {
Walter Featherstone's avatar
Walter Featherstone committed
107
            "$ref": "#/components/responses/Error.403"
108
109
          },
          "404": {
Walter Featherstone's avatar
Walter Featherstone committed
110
            "$ref": "#/components/responses/Error.404"
111
          }
112
        }
113
      }
114
    },
115
    "/app_contexts/{contextId}": {
Walter Featherstone's avatar
Walter Featherstone committed
116
117
118
119
120
      "parameters": [
        {
          "$ref": "#/components/parameters/Path.ContextId"
        }
      ],
121
122
      "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.",
Walter Featherstone's avatar
Walter Featherstone committed
123
124
125
        "operationId": "AppContextId_PUT",
        "tags": [
          "appContext"
126
        ],
Walter Featherstone's avatar
Walter Featherstone committed
127
128
129
        "requestBody": {
          "$ref": "#/components/requestBodies/AppContext"
        },
130
131
        "responses": {
          "204": {
Walter Featherstone's avatar
Walter Featherstone committed
132
            "description": "No Content."
133
134
          },
          "400": {
Walter Featherstone's avatar
Walter Featherstone committed
135
            "$ref": "#/components/responses/Error.400"
136
137
          },
          "401": {
Walter Featherstone's avatar
Walter Featherstone committed
138
            "$ref": "#/components/responses/Error.401"
139
140
          },
          "403": {
Walter Featherstone's avatar
Walter Featherstone committed
141
            "$ref": "#/components/responses/Error.403"
142
143
          },
          "404": {
Walter Featherstone's avatar
Walter Featherstone committed
144
            "$ref": "#/components/responses/Error.404"
145
146
147
148
149
          }
        }
      },
      "delete": {
        "description": "The DELETE method is used to delete the resource that represents the existing application context.",
Walter Featherstone's avatar
Walter Featherstone committed
150
151
152
        "operationId": "AppContextId_DEL",
        "tags": [
          "appContext"
153
154
155
        ],
        "responses": {
          "204": {
Walter Featherstone's avatar
Walter Featherstone committed
156
            "description": "No Content"
157
158
          },
          "400": {
Walter Featherstone's avatar
Walter Featherstone committed
159
            "$ref": "#/components/responses/Error.400"
160
161
          },
          "401": {
Walter Featherstone's avatar
Walter Featherstone committed
162
            "$ref": "#/components/responses/Error.401"
163
164
          },
          "403": {
Walter Featherstone's avatar
Walter Featherstone committed
165
            "$ref": "#/components/responses/Error.403"
166
167
          },
          "404": {
Walter Featherstone's avatar
Walter Featherstone committed
168
            "$ref": "#/components/responses/Error.404"
169
170
171
172
173
          }
        }
      }
    }
  },
Walter Featherstone's avatar
Walter Featherstone committed
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
  "components": {
    "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"
244
245
246
        }
      }
    },
Walter Featherstone's avatar
Walter Featherstone committed
247
248
249
250
251
252
253
254
255
    "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": {
            "schema": {
              "$ref": "#/components/schemas/AppContext"
            }
          }
256
        },
Walter Featherstone's avatar
Walter Featherstone committed
257
        "required": true
258
259
      }
    },
Walter Featherstone's avatar
Walter Featherstone committed
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
    "responses": {
      "AppContext": {
        "description": "The response body contains the Application Context as it was created by the MEC system",
        "content": {
          "application/json": {
            "schema": {
              "$ref": "#/components/schemas/AppContext"
            }
          }
        }
      },
      "AppList": {
        "description": "The response body contains the ApplicationList resource available for the querying UE application",
        "content": {
          "application/json": {
            "schema": {
              "$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": {
            "schema": {
              "$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": {
            "schema": {
              "$ref": "#/components/schemas/ProblemDetails"
            }
          },
          "text/plain": {
            "schema": {
              "$ref": "#/components/schemas/Empty"
            }
          }
        }
      },
      "Error.403": {
        "description": "Forbidden. The operation is not allowed given the current status of the resource. ",
        "content": {
          "application/problem+json": {
            "schema": {
              "$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": {
            "schema": {
              "$ref": "#/components/schemas/ProblemDetails"
            }
          },
          "text/plain": {
            "schema": {
              "$ref": "#/components/schemas/Empty"
            }
          }
334
335
336
        }
      }
    },
Walter Featherstone's avatar
Walter Featherstone committed
337
338
339
340
341
342
343
344
345
346
    "securitySchemes": {
      "OauthSecurity": {
        "type": "oauth2",
        "flows": {
          "clientCredentials": {
            "tokenUrl": "https://oauth.exampleAPI/token",
            "scopes": {
              "all": "Single oauth2 scope for API"
            }
          }
347
348
349
        }
      }
    },
Walter Featherstone's avatar
Walter Featherstone committed
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
    "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": {
          "appInfo": {
            "$ref": "#/components/schemas/AppInfo"
          },
          "vendorSpecificExt": {
            "$ref": "#/components/schemas/VendorSpecificExt"
          }
        }
      },
      "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/RequiredAppInfo"
          }
        }
      },
      "NotificationEvent": {
        "description": "The parameters used in the method \"Receiving notification events\".",
        "type": "object",
        "required": [
          "referenceURI"
        ],
        "properties": {
          "referenceURI": {
            "$ref": "#/components/schemas/ReferenceURL"
          }
        }
      },
      "VendorSpecificExtList": {
        "description": "Extension for vendor specific information.",
        "type": "array",
        "minItems": 0,
        "items": {
          "$ref": "#/components/schemas/VendorSpecificExt"
        }
      },
      "VendorSpecificExt": {
        "description": "Extension for vendor-specific information",
454
455
456
457
458
        "required": [
          "vendorId"
        ],
        "properties": {
          "vendorId": {
Walter Featherstone's avatar
Walter Featherstone committed
459
            "$ref": "#/components/schemas/VendorId"
460
461
          }
        }
Walter Featherstone's avatar
Walter Featherstone committed
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
      },
      "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"
      },
      "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 this vendor specific extension is not defined",
        "type": "string"
      },
      "AppInfo": {
        "description": "User applications available for the UE application",
        "type": "array",
        "items": {
          "$ref": "#/components/schemas/AppInfoList"
        }
      },
      "AppInfoList": {
483
484
485
486
487
488
489
490
        "type": "object",
        "required": [
          "appName",
          "appProvider",
          "appDescription"
        ],
        "properties": {
          "appName": {
Walter Featherstone's avatar
Walter Featherstone committed
491
            "$ref": "#/components/schemas/AppName"
492
493
          },
          "appProvider": {
Walter Featherstone's avatar
Walter Featherstone committed
494
            "$ref": "#/components/schemas/AppProvider"
495
496
          },
          "appSoftVersion": {
Walter Featherstone's avatar
Walter Featherstone committed
497
            "$ref": "#/components/schemas/AppSoftVersion"
498
499
          },
          "appDescription": {
Walter Featherstone's avatar
Walter Featherstone committed
500
            "$ref": "#/components/schemas/AppDescription"
501
502
          },
          "appCharcs": {
Walter Featherstone's avatar
Walter Featherstone committed
503
            "$ref": "#/components/schemas/AppCharcs"
504
505
          }
        }
Walter Featherstone's avatar
Walter Featherstone committed
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
      },
      "RequiredAppInfo": {
        "description": "Included in the request",
        "type": "object",
        "required": [
          "appName",
          "appProvider",
          "referenceURL"
        ],
        "properties": {
          "appName": {
            "$ref": "#/components/schemas/AppName"
          },
          "appProvider": {
            "$ref": "#/components/schemas/AppProvider"
          },
          "appSoftVersion": {
            "$ref": "#/components/schemas/AppSoftVersion"
          },
          "appDescription": {
            "$ref": "#/components/schemas/AppDescription"
          },
          "referenceURL": {
            "$ref": "#/components/schemas/ReferenceURL"
          },
          "appPackageSource": {
            "$ref": "#/components/schemas/AppPackageSource"
          }
534
        }
Walter Featherstone's avatar
Walter Featherstone committed
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
      },
      "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": "#/components/schemas/Memory"
          },
          "storage": {
            "$ref": "#/components/schemas/Storage"
          },
          "latency": {
            "$ref": "#/components/schemas/Latency"
          },
          "bandwidth": {
            "$ref": "#/components/schemas/Bandwidth"
          },
          "serviceCont": {
            "$ref": "#/components/schemas/ServiceCont"
          }
555
        }
Walter Featherstone's avatar
Walter Featherstone committed
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
      },
      "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 mobile edge 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"
        ]
      },
      "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"
      },
      "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 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 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",
        "format": "uri"
615
      }
616
    }
617
618
  }
}