UEAppInterfaceApi.json 20.9 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
41
42
    },
    {
      "name": "callback"
43
    }
Walter Featherstone's avatar
Walter Featherstone committed
44
  ],
45
46
47
  "paths": {
    "/app_list": {
      "get": {
Walter Featherstone's avatar
Walter Featherstone committed
48
49
50
51
        "description": "Used to query information about the available MEC applications.",
        "operationId": "AppList_GET",
        "tags": [
          "appList"
52
53
54
        ],
        "parameters": [
          {
Walter Featherstone's avatar
Walter Featherstone committed
55
            "$ref": "#/components/parameters/Query.AppName"
56
57
          },
          {
Walter Featherstone's avatar
Walter Featherstone committed
58
            "$ref": "#/components/parameters/Query.AppProvider"
59
60
          },
          {
Walter Featherstone's avatar
Walter Featherstone committed
61
            "$ref": "#/components/parameters/Query.AppSoftVersion"
62
63
          },
          {
Walter Featherstone's avatar
Walter Featherstone committed
64
            "$ref": "#/components/parameters/Query.ServiceCont"
65
66
          },
          {
Walter Featherstone's avatar
Walter Featherstone committed
67
            "$ref": "#/components/parameters/Query.VendorId"
68
69
70
71
          }
        ],
        "responses": {
          "200": {
Walter Featherstone's avatar
Walter Featherstone committed
72
            "$ref": "#/components/responses/AppList"
73
74
          },
          "400": {
Walter Featherstone's avatar
Walter Featherstone committed
75
            "$ref": "#/components/responses/Error.400"
76
77
          },
          "401": {
Walter Featherstone's avatar
Walter Featherstone committed
78
            "$ref": "#/components/responses/Error.401"
79
80
          },
          "403": {
Walter Featherstone's avatar
Walter Featherstone committed
81
            "$ref": "#/components/responses/Error.403"
82
83
          },
          "404": {
Walter Featherstone's avatar
Walter Featherstone committed
84
            "$ref": "#/components/responses/Error.404"
85
          }
86
        }
87
      }
88
    },
89
90
91
    "/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
92
93
94
        "operationId": "AppContext_POST",
        "tags": [
          "appContext"
95
        ],
Walter Featherstone's avatar
Walter Featherstone committed
96
97
98
        "requestBody": {
          "$ref": "#/components/requestBodies/AppContext"
        },
99
100
        "responses": {
          "201": {
Walter Featherstone's avatar
Walter Featherstone committed
101
            "$ref": "#/components/responses/AppContext"
102
103
          },
          "400": {
Walter Featherstone's avatar
Walter Featherstone committed
104
            "$ref": "#/components/responses/Error.400"
105
106
          },
          "401": {
Walter Featherstone's avatar
Walter Featherstone committed
107
            "$ref": "#/components/responses/Error.401"
108
109
          },
          "403": {
Walter Featherstone's avatar
Walter Featherstone committed
110
            "$ref": "#/components/responses/Error.403"
111
112
          },
          "404": {
Walter Featherstone's avatar
Walter Featherstone committed
113
            "$ref": "#/components/responses/Error.404"
114
          }
115
116
117
118
119
        },
        "callbacks": {
          "referenceURI": {
            "$ref": "#/components/callbacks/NotificationEvent"
          }
120
        }
121
      }
122
    },
123
    "/app_contexts/{contextId}": {
Walter Featherstone's avatar
Walter Featherstone committed
124
125
126
127
128
      "parameters": [
        {
          "$ref": "#/components/parameters/Path.ContextId"
        }
      ],
129
130
      "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
131
132
133
        "operationId": "AppContextId_PUT",
        "tags": [
          "appContext"
134
        ],
Walter Featherstone's avatar
Walter Featherstone committed
135
136
137
        "requestBody": {
          "$ref": "#/components/requestBodies/AppContext"
        },
138
139
        "responses": {
          "204": {
Walter Featherstone's avatar
Walter Featherstone committed
140
            "description": "No Content."
141
142
          },
          "400": {
Walter Featherstone's avatar
Walter Featherstone committed
143
            "$ref": "#/components/responses/Error.400"
144
145
          },
          "401": {
Walter Featherstone's avatar
Walter Featherstone committed
146
            "$ref": "#/components/responses/Error.401"
147
148
          },
          "403": {
Walter Featherstone's avatar
Walter Featherstone committed
149
            "$ref": "#/components/responses/Error.403"
150
151
          },
          "404": {
Walter Featherstone's avatar
Walter Featherstone committed
152
            "$ref": "#/components/responses/Error.404"
153
          }
154
155
156
157
158
        },
        "callbacks": {
          "referenceURI": {
            "$ref": "#/components/callbacks/NotificationEvent"
          }
159
160
161
162
        }
      },
      "delete": {
        "description": "The DELETE method is used to delete the resource that represents the existing application context.",
Walter Featherstone's avatar
Walter Featherstone committed
163
164
165
        "operationId": "AppContextId_DEL",
        "tags": [
          "appContext"
166
167
168
        ],
        "responses": {
          "204": {
Walter Featherstone's avatar
Walter Featherstone committed
169
            "description": "No Content"
170
171
          },
          "400": {
Walter Featherstone's avatar
Walter Featherstone committed
172
            "$ref": "#/components/responses/Error.400"
173
174
          },
          "401": {
Walter Featherstone's avatar
Walter Featherstone committed
175
            "$ref": "#/components/responses/Error.401"
176
177
          },
          "403": {
Walter Featherstone's avatar
Walter Featherstone committed
178
            "$ref": "#/components/responses/Error.403"
179
180
          },
          "404": {
Walter Featherstone's avatar
Walter Featherstone committed
181
            "$ref": "#/components/responses/Error.404"
182
183
184
185
186
          }
        }
      }
    }
  },
Walter Featherstone's avatar
Walter Featherstone committed
187
  "components": {
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
    "callbacks": {
      "NotificationEvent": {
        "{$request.body#/callbackReference}": {
          "post": {
            "description": "Used by the UALCMP to inform the UE 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"
        }
      }
    },
Walter Featherstone's avatar
Walter Featherstone committed
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
    "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"
294
295
296
        }
      }
    },
Walter Featherstone's avatar
Walter Featherstone committed
297
298
299
300
301
302
303
304
305
    "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"
            }
          }
306
        },
Walter Featherstone's avatar
Walter Featherstone committed
307
        "required": true
308
309
310
311
312
313
314
315
316
317
318
      },
      "NotificationEvent": {
        "description": "Sent by the UALCMP to the UE application.",
        "content": {
          "application/json": {
            "schema": {
              "$ref": "#/components/schemas/NotificationEvent"
            }
          }
        },
        "required": true
319
320
      }
    },
Walter Featherstone's avatar
Walter Featherstone committed
321
322
323
324
325
326
327
328
329
    "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"
            }
          }
330
331
332
333
334
335
336
337
        },
        "links": {
          "putAppContext": {
            "$ref": "#/components/links/PutAppContext"
          },
          "delAppContext": {
            "$ref": "#/components/links/DelAppContext"
          }
Walter Featherstone's avatar
Walter Featherstone committed
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
        }
      },
      "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"
            }
          }
403
404
405
        }
      }
    },
Walter Featherstone's avatar
Walter Featherstone committed
406
407
408
409
410
411
412
413
414
415
    "securitySchemes": {
      "OauthSecurity": {
        "type": "oauth2",
        "flows": {
          "clientCredentials": {
            "tokenUrl": "https://oauth.exampleAPI/token",
            "scopes": {
              "all": "Single oauth2 scope for API"
            }
          }
416
417
418
        }
      }
    },
Walter Featherstone's avatar
Walter Featherstone committed
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
    "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",
484
          "callbackReference",
Walter Featherstone's avatar
Walter Featherstone committed
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
          "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",
524
525
526
527
528
        "required": [
          "vendorId"
        ],
        "properties": {
          "vendorId": {
Walter Featherstone's avatar
Walter Featherstone committed
529
            "$ref": "#/components/schemas/VendorId"
530
531
          }
        }
Walter Featherstone's avatar
Walter Featherstone committed
532
533
534
      },
      "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.",
535
536
        "type": "string",
        "readOnly": true
Walter Featherstone's avatar
Walter Featherstone committed
537
538
539
      },
      "AssociateUeAppId": {
        "description": "Uniquely identifies the UE application. Included in the request. The length of the value shall not exceed 32 characters.",
540
541
        "type": "string",
        "writeOnly": true
Walter Featherstone's avatar
Walter Featherstone committed
542
543
544
545
546
547
548
549
550
551
552
553
554
      },
      "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": {
555
556
557
558
559
560
561
562
        "type": "object",
        "required": [
          "appName",
          "appProvider",
          "appDescription"
        ],
        "properties": {
          "appName": {
Walter Featherstone's avatar
Walter Featherstone committed
563
            "$ref": "#/components/schemas/AppName"
564
565
          },
          "appProvider": {
Walter Featherstone's avatar
Walter Featherstone committed
566
            "$ref": "#/components/schemas/AppProvider"
567
568
          },
          "appSoftVersion": {
Walter Featherstone's avatar
Walter Featherstone committed
569
            "$ref": "#/components/schemas/AppSoftVersion"
570
571
          },
          "appDescription": {
Walter Featherstone's avatar
Walter Featherstone committed
572
            "$ref": "#/components/schemas/AppDescription"
573
574
          },
          "appCharcs": {
Walter Featherstone's avatar
Walter Featherstone committed
575
            "$ref": "#/components/schemas/AppCharcs"
576
577
          }
        }
Walter Featherstone's avatar
Walter Featherstone committed
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
      },
      "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"
          }
606
        }
Walter Featherstone's avatar
Walter Featherstone committed
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
      },
      "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"
          }
627
        }
Walter Featherstone's avatar
Walter Featherstone committed
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
      },
      "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": {
645
        "description": "The required connection bandwidth in kbit/s for the use of the MEC application instance",
Walter Featherstone's avatar
Walter Featherstone committed
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
        "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",
676
677
        "format": "uri",
        "writeOnly": true
Walter Featherstone's avatar
Walter Featherstone committed
678
679
680
681
      },
      "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",
682
683
        "format": "uri",
        "readOnly": true
Walter Featherstone's avatar
Walter Featherstone committed
684
685
686
687
688
      },
      "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"
689
      }
690
    }
691
692
  }
}