UEAppInterfaceApi.json 42.7 KB
Newer Older
1
{
Michel Roy's avatar
Michel Roy committed
2
  "openapi": "3.0.0",
3
  "info": {
Michel Roy's avatar
Michel Roy committed
4
5
6
    "contact": {
      "url": "https://forge.etsi.org/rep/mec/gs016-dev-app-api"
    },
Michel Roy's avatar
Michel Roy committed
7
8
9
    "title": "ETSI GS MEC 016 Device application interface",
    "version": "2.2.1",
    "description": "The ETSI MEC ISG Device application interface API described using OpenAPI.",
10
    "license": {
ETSI CTI's avatar
ETSI CTI committed
11
12
      "name": "BSD-3-Clause",
      "url": "https://forge.etsi.org/legal-matters"
13
14
15
    }
  },
  "externalDocs": {
Michel Roy's avatar
Michel Roy committed
16
17
    "description": "ETSI GS MEC016 V2.2.1 Device application interface",
    "url": "https://www.etsi.org/deliver/etsi_gs/MEC/001_099/016/02.02.01_60/gs_MEC016v020201p.pdf"
18
  },
Walter Featherstone's avatar
Walter Featherstone committed
19
20
  "servers": [
    {
Michel Roy's avatar
Michel Roy committed
21
22
23
24
25
26
      "url": "https://localhost/dev_app/v1"
    }
  ],
  "tags": [
    {
      "name": "dev_app"
27
    }
Walter Featherstone's avatar
Walter Featherstone committed
28
  ],
29
30
31
  "paths": {
    "/app_list": {
      "get": {
Walter Featherstone's avatar
Walter Featherstone committed
32
        "tags": [
Michel Roy's avatar
Michel Roy committed
33
          "dev_app"
34
        ],
Michel Roy's avatar
Michel Roy committed
35
36
37
        "summary": "Get available application information.",
        "description": "Used to query information about the available MEC applications.",
        "operationId": "meAppListGET",
38
39
        "parameters": [
          {
Michel Roy's avatar
Michel Roy committed
40
            "$ref": "#/components/parameters/Query.appName"
41
42
          },
          {
Michel Roy's avatar
Michel Roy committed
43
            "$ref": "#/components/parameters/Query.appProvider"
44
45
          },
          {
Michel Roy's avatar
Michel Roy committed
46
            "$ref": "#/components/parameters/Query.appSoftVersion"
47
48
          },
          {
Michel Roy's avatar
Michel Roy committed
49
            "$ref": "#/components/parameters/Query.vendorId"
50
51
          },
          {
Michel Roy's avatar
Michel Roy committed
52
            "$ref": "#/components/parameters/Query.serviceCont"
53
54
55
56
          }
        ],
        "responses": {
          "200": {
Michel Roy's avatar
Michel Roy committed
57
58
59
60
61
62
63
64
65
66
67
68
69
            "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"
                    }
                  }
                }
              }
            }
70
71
          },
          "400": {
Michel Roy's avatar
Michel Roy committed
72
            "$ref": "#/components/responses/400"
73
74
          },
          "401": {
Michel Roy's avatar
Michel Roy committed
75
            "$ref": "#/components/responses/401"
76
77
          },
          "403": {
Michel Roy's avatar
Michel Roy committed
78
            "$ref": "#/components/responses/403"
79
80
          },
          "404": {
Michel Roy's avatar
Michel Roy committed
81
            "$ref": "#/components/responses/404"
82
          }
83
        }
84
      }
85
    },
86
87
    "/app_contexts": {
      "post": {
Walter Featherstone's avatar
Walter Featherstone committed
88
        "tags": [
Michel Roy's avatar
Michel Roy committed
89
          "dev_app"
90
        ],
Michel Roy's avatar
Michel Roy committed
91
92
93
        "summary": "Creation of a new application context.",
        "description": "Used to create a new application context. Upon success, the response contains entity body describing the created application context.",
        "operationId": "devAppContextsGET",
Walter Featherstone's avatar
Walter Featherstone committed
94
        "requestBody": {
Michel Roy's avatar
Michel Roy committed
95
96
97
98
99
100
101
102
103
104
105
106
107
108
          "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"
                  }
                }
              }
            }
          }
Walter Featherstone's avatar
Walter Featherstone committed
109
        },
Michel Roy's avatar
Michel Roy committed
110
        "parameters": [],
111
112
        "responses": {
          "201": {
Michel Roy's avatar
Michel Roy committed
113
114
115
116
117
118
119
120
121
122
123
124
125
            "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). The 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"
                    }
                  }
                }
              }
            }
126
127
          },
          "400": {
Michel Roy's avatar
Michel Roy committed
128
            "$ref": "#/components/responses/400"
129
130
          },
          "401": {
Michel Roy's avatar
Michel Roy committed
131
            "$ref": "#/components/responses/401"
132
133
          },
          "403": {
Michel Roy's avatar
Michel Roy committed
134
            "$ref": "#/components/responses/403"
135
136
          },
          "404": {
Michel Roy's avatar
Michel Roy committed
137
            "$ref": "#/components/responses/404"
138
          }
139
140
        },
        "callbacks": {
Michel Roy's avatar
Michel Roy committed
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
          "notification": {
            "{$request.body#/appContext.callbackReference}": {
              "post": {
                "summary": "Callback POST used to send a notification",
                "description": "Notification with content based on subscription type",
                "operationId": "notificationPOST",
                "requestBody": {
                  "description": "Subscription notification",
                  "required": true,
                  "content": {
                    "application/json": {
                      "schema": {
                        "type": "object",
                        "properties": {
                          "notification": {
                            "oneOf": [
                              {
                                "$ref": "#/components/schemas/AddressChangeNotification"
                              },
                              {
                                "$ref": "#/components/schemas/ApplicationContextDeleteNotification"
                              },
                              {
                                "$ref": "#/components/schemas/ApplicationContextUpdateNotification"
                              },
                              {
                                "$ref": "#/components/schemas/ApplicationLocationAvailabilityNotification"
                              }
                            ],
                            "discriminator": {
                              "propertyName": "notificationType"
                            }
                          }
                        },
                        "example": {
                          "notification": {
                            "notificationType": "ApplicationContextDeleteNotification",
                            "contextId": "contextId123"
                          }
                        }
                      }
                    }
                  }
                },
                "responses": {
                  "204": {
                    "$ref": "#/components/responses/204"
                  }
                }
              }
            }
192
          }
193
        }
194
      }
195
    },
196
197
    "/app_contexts/{contextId}": {
      "put": {
Walter Featherstone's avatar
Walter Featherstone committed
198
        "tags": [
Michel Roy's avatar
Michel Roy committed
199
          "dev_app"
200
        ],
Michel Roy's avatar
Michel Roy committed
201
202
203
        "summary": "Updating the callbackReference and/or appLocation of an existing application context.",
        "description": "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": "devAppContextPUT",
Walter Featherstone's avatar
Walter Featherstone committed
204
        "requestBody": {
Michel Roy's avatar
Michel Roy committed
205
206
207
208
209
210
211
212
213
214
215
216
217
218
          "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"
                  }
                }
              }
            }
          }
Walter Featherstone's avatar
Walter Featherstone committed
219
        },
Michel Roy's avatar
Michel Roy committed
220
221
222
223
224
        "parameters": [
          {
            "$ref": "#/components/parameters/Path.contextId"
          }
        ],
225
226
        "responses": {
          "204": {
Michel Roy's avatar
Michel Roy committed
227
            "$ref": "#/components/responses/204"
228
229
          },
          "400": {
Michel Roy's avatar
Michel Roy committed
230
            "$ref": "#/components/responses/400"
231
232
          },
          "401": {
Michel Roy's avatar
Michel Roy committed
233
            "$ref": "#/components/responses/401"
234
235
          },
          "403": {
Michel Roy's avatar
Michel Roy committed
236
            "$ref": "#/components/responses/403"
237
238
          },
          "404": {
Michel Roy's avatar
Michel Roy committed
239
            "$ref": "#/components/responses/404"
240
          }
241
242
243
        }
      },
      "delete": {
Walter Featherstone's avatar
Walter Featherstone committed
244
        "tags": [
Michel Roy's avatar
Michel Roy committed
245
          "dev_app"
Michel Roy's avatar
Michel Roy committed
246
247
248
249
250
251
252
253
        ],
        "summary": "Deletion of an existing application context.",
        "description": "Used to delete the resource that represents the existing application context.",
        "operationId": "devAppContextDELETE",
        "parameters": [
          {
            "$ref": "#/components/parameters/Path.contextId"
          }
254
255
256
        ],
        "responses": {
          "204": {
Michel Roy's avatar
Michel Roy committed
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
            "$ref": "#/components/responses/204"
          },
          "400": {
            "$ref": "#/components/responses/400"
          },
          "401": {
            "$ref": "#/components/responses/401"
          },
          "403": {
            "$ref": "#/components/responses/403"
          },
          "404": {
            "$ref": "#/components/responses/404"
          }
        }
      }
    },
    "/obtain_app_loc_availability": {
      "post": {
        "tags": [
Michel Roy's avatar
Michel Roy committed
277
          "dev_app"
Michel Roy's avatar
Michel Roy committed
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
        ],
        "summary": "Obtain the location constraints for a new application context.",
        "description": "Used to obtain the locations available for instantiation of a specific user application in the MEC system.",
        "operationId": "appLocationAvailabilityPOST",
        "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"
                  }
                }
              }
            }
          }
        },
        "parameters": [],
        "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"
                    }
                  }
                }
              }
            }
314
315
          },
          "400": {
Michel Roy's avatar
Michel Roy committed
316
            "$ref": "#/components/responses/400"
317
318
          },
          "401": {
Michel Roy's avatar
Michel Roy committed
319
            "$ref": "#/components/responses/401"
320
321
          },
          "403": {
Michel Roy's avatar
Michel Roy committed
322
            "$ref": "#/components/responses/403"
323
324
          },
          "404": {
Michel Roy's avatar
Michel Roy committed
325
            "$ref": "#/components/responses/404"
326
327
328
329
330
          }
        }
      }
    }
  },
Walter Featherstone's avatar
Walter Featherstone committed
331
  "components": {
Michel Roy's avatar
Michel Roy committed
332
333
334
335
336
337
338
339
340
341
342
343
344
345
    "responses": {
      "204": {
        "description": "Upon success, a response 204 No Content without any response body is returned."
      },
      "400": {
        "description": "Bad Request : used to indicate that incorrect parameters were passed to the request.",
        "content": {
          "application/json": {
            "schema": {
              "type": "object",
              "properties": {
                "problemDetails": {
                  "$ref": "#/components/schemas/ProblemDetails"
                }
346
347
348
349
              }
            }
          }
        }
Michel Roy's avatar
Michel Roy 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
      },
      "401": {
        "description": "Unauthorized :  used when the client did not submit credentials.",
        "content": {
          "application/json": {
            "schema": {
              "type": "object",
              "properties": {
                "problemDetails": {
                  "$ref": "#/components/schemas/ProblemDetails"
                }
              }
            }
          }
        }
      },
      "403": {
        "description": "Forbidden :  operation is not allowed given the current status of the resource.",
        "content": {
          "application/json": {
            "schema": {
              "type": "object",
              "required": [
                "problemDetails"
              ],
              "properties": {
                "problemDetails": {
                  "$ref": "#/components/schemas/ProblemDetails"
                }
              }
            }
          }
382
383
        }
      },
Michel Roy's avatar
Michel Roy committed
384
385
386
387
388
389
390
391
392
393
394
395
396
      "404": {
        "description": "Not Found :  used when a client provided a URI that cannot be mapped to a valid resource URI.",
        "content": {
          "application/json": {
            "schema": {
              "type": "object",
              "properties": {
                "problemDetails": {
                  "$ref": "#/components/schemas/ProblemDetails"
                }
              }
            }
          }
397
398
399
        }
      }
    },
Walter Featherstone's avatar
Walter Featherstone committed
400
    "parameters": {
Michel Roy's avatar
Michel Roy committed
401
      "Query.appName": {
Walter Featherstone's avatar
Walter Featherstone committed
402
403
        "name": "appName",
        "in": "query",
Michel Roy's avatar
Michel Roy committed
404
        "description": "Name to identify the MEC application.",
Walter Featherstone's avatar
Walter Featherstone committed
405
406
407
408
        "required": false,
        "schema": {
          "type": "array",
          "items": {
Michel Roy's avatar
Michel Roy committed
409
410
            "type": "string",
            "maxLength": 32
Walter Featherstone's avatar
Walter Featherstone committed
411
412
413
          }
        }
      },
Michel Roy's avatar
Michel Roy committed
414
      "Query.appProvider": {
Walter Featherstone's avatar
Walter Featherstone committed
415
416
        "name": "appProvider",
        "in": "query",
Michel Roy's avatar
Michel Roy committed
417
        "description": "Provider of the MEC application.",
Walter Featherstone's avatar
Walter Featherstone committed
418
419
420
421
        "required": false,
        "schema": {
          "type": "array",
          "items": {
Michel Roy's avatar
Michel Roy committed
422
423
            "type": "string",
            "maxLength": 32
Walter Featherstone's avatar
Walter Featherstone committed
424
425
426
          }
        }
      },
Michel Roy's avatar
Michel Roy committed
427
      "Query.appSoftVersion": {
Walter Featherstone's avatar
Walter Featherstone committed
428
429
        "name": "appSoftVersion",
        "in": "query",
Michel Roy's avatar
Michel Roy committed
430
        "description": "Software version of the MEC application.",
Walter Featherstone's avatar
Walter Featherstone committed
431
432
433
434
        "required": false,
        "schema": {
          "type": "array",
          "items": {
Michel Roy's avatar
Michel Roy committed
435
436
            "type": "string",
            "maxLength": 32
Walter Featherstone's avatar
Walter Featherstone committed
437
438
439
          }
        }
      },
Michel Roy's avatar
Michel Roy committed
440
      "Query.vendorId": {
Walter Featherstone's avatar
Walter Featherstone committed
441
442
443
444
445
446
447
        "name": "vendorId",
        "in": "query",
        "description": "Vendor identifier",
        "required": false,
        "schema": {
          "type": "array",
          "items": {
Michel Roy's avatar
Michel Roy committed
448
449
            "type": "string",
            "maxLength": 32
Walter Featherstone's avatar
Walter Featherstone committed
450
451
452
          }
        }
      },
Michel Roy's avatar
Michel Roy committed
453
454
455
456
457
458
459
460
461
462
463
464
465
466
      "Query.serviceCont": {
        "name": "serviceCont",
        "in": "query",
        "description": "Required service continuity mode for this application. Permitted values: 0 = SERVICE_CONTINUITY_NOT_REQUIRED. 1 = SERVICE_CONTINUITY_REQUIRED.",
        "required": false,
        "schema": {
          "type": "integer",
          "enum": [
            0,
            1
          ]
        }
      },
      "Path.contextId": {
Walter Featherstone's avatar
Walter Featherstone committed
467
468
        "name": "contextId",
        "in": "path",
Michel Roy's avatar
Michel Roy committed
469
        "description": "Uniquely identifies the application context in the MEC system. It is assigned by the MEC system.",
Walter Featherstone's avatar
Walter Featherstone committed
470
471
472
        "required": true,
        "schema": {
          "type": "string"
473
474
475
        }
      }
    },
Michel Roy's avatar
Michel Roy committed
476
477
478
479
480
481
482
483
    "schemas": {
      "AddressChangeNotification": {
        "properties": {
          "appInstanceId": {
            "description": "Identifier of the user application instance.",
            "type": "string",
            "x-etsi-mec-cardinality": "1",
            "x-etsi-mec-origin-type": "String"
Walter Featherstone's avatar
Walter Featherstone committed
484
          },
Michel Roy's avatar
Michel Roy committed
485
486
487
488
489
          "contextId": {
            "description": "Uniquely identifies the application context in the MEC system.",
            "type": "string",
            "x-etsi-mec-cardinality": "1",
            "x-etsi-mec-origin-type": "String"
Walter Featherstone's avatar
Walter Featherstone committed
490
          },
Michel Roy's avatar
Michel Roy committed
491
492
493
494
495
          "notificationType": {
            "description": "Shall be set to \"AddressChangeNotification\".",
            "type": "string",
            "x-etsi-mec-cardinality": "1",
            "x-etsi-mec-origin-type": "String"
Walter Featherstone's avatar
Walter Featherstone committed
496
          },
Michel Roy's avatar
Michel Roy committed
497
498
499
500
501
502
          "referenceURI": {
            "description": "Address of the user application. Used as the reference URI for the application. Assigned by the MEC system.",
            "format": "uri",
            "type": "string",
            "x-etsi-mec-cardinality": "1",
            "x-etsi-mec-origin-type": "URI"
Walter Featherstone's avatar
Walter Featherstone committed
503
          }
Michel Roy's avatar
Michel Roy committed
504
505
506
507
508
509
510
        },
        "required": [
          "notificationType",
          "contextId",
          "appInstanceId",
          "referenceURI"
        ],
Walter Featherstone's avatar
Walter Featherstone committed
511
        "type": "object",
Michel Roy's avatar
Michel Roy committed
512
513
514
        "x-etsi-ref": "6.4.2"
      },
      "AppContext": {
Walter Featherstone's avatar
Walter Featherstone committed
515
        "properties": {
Michel Roy's avatar
Michel Roy committed
516
517
518
519
520
          "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",
            "x-etsi-mec-cardinality": "0..1",
            "x-etsi-mec-origin-type": "Boolean"
Walter Featherstone's avatar
Walter Featherstone committed
521
          },
Michel Roy's avatar
Michel Roy committed
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
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
          "appInfo": {
            "description": "",
            "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]. It shall be present if the application is one in the ApplicationList.",
                "type": "string",
                "x-etsi-mec-cardinality": "0..1",
                "x-etsi-mec-origin-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",
                "x-etsi-mec-cardinality": "1",
                "x-etsi-mec-origin-type": "String"
              },
              "appDescription": {
                "description": "Human readable description of the MEC application. The length of the value shall not exceed 128 characters.",
                "type": "string",
                "maxLength": 128,
                "x-etsi-mec-cardinality": "0..1",
                "x-etsi-mec-origin-type": "String"
              },
              "appName": {
                "description": "Name of the MEC application. The length of the value shall not exceed 32 characters.",
                "type": "string",
                "maxLength": 32,
                "x-etsi-mec-cardinality": "1",
                "x-etsi-mec-origin-type": "String"
              },
              "appProvider": {
                "description": "Provider of the MEC application.\nThe length of the value shall not exceed 32 characters.",
                "type": "string",
                "maxLength": 32,
                "x-etsi-mec-cardinality": "1",
                "x-etsi-mec-origin-type": "String"
              },
              "appSoftVersion": {
                "description": "Software version of the MEC application. The length of the value shall not exceed 32 characters.",
                "type": "string",
                "maxLength": 32,
                "x-etsi-mec-cardinality": "0..1",
                "x-etsi-mec-origin-type": "String"
              },
              "appPackageSource": {
                "description": "URI of the application package.\nIncluded 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 0102 [1].",
                "format": "uri",
                "type": "string",
                "x-etsi-mec-cardinality": "0..1",
                "x-etsi-mec-origin-type": "URI"
              },
              "userAppInstanceInfo": {
                "description": "List of user application instance information.",
                "items": {
                  "type": "object",
                  "properties": {
                    "appInstanceId": {
                      "description": "Identifier of the user application instance. It shall only be included in the response.",
                      "type": "string",
                      "x-etsi-mec-cardinality": "0..1",
                      "x-etsi-mec-origin-type": "String"
                    },
                    "appLocation": {
Michel Roy's avatar
Michel Roy committed
584
                      "$ref": "#/components/schemas/LocationConstraints"
Michel Roy's avatar
Michel Roy committed
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
                    },
                    "referenceURI": {
                      "description": "Address of the user application instance. It shall only be included in the response.",
                      "format": "uri",
                      "type": "string",
                      "x-etsi-mec-cardinality": "0..1",
                      "x-etsi-mec-origin-type": "URI"
                    }
                  }
                },
                "minItems": 1,
                "type": "array",
                "x-etsi-mec-cardinality": "1..N",
                "x-etsi-mec-origin-type": "array (Structure inlined)"
              }
            },
            "required": [
              "appName",
              "appProvider",
              "appDVersion",
              "userAppInstanceInfo"
            ],
            "type": "object",
            "x-etsi-mec-cardinality": "1",
            "x-etsi-mec-origin-type": "Structure (inlined)"
Walter Featherstone's avatar
Walter Featherstone committed
610
          },
Michel Roy's avatar
Michel Roy committed
611
612
613
614
615
          "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",
            "x-etsi-mec-cardinality": "0..1",
            "x-etsi-mec-origin-type": "Boolean"
Walter Featherstone's avatar
Walter Featherstone committed
616
          },
Michel Roy's avatar
Michel Roy committed
617
618
619
620
621
622
          "associateDevAppId": {
            "description": "Uniquely identifies the device application. The length of the value shall not exceed 32 characters.",
            "type": "string",
            "maxLength": 32,
            "x-etsi-mec-cardinality": "1",
            "x-etsi-mec-origin-type": "String"
Walter Featherstone's avatar
Walter Featherstone committed
623
          },
Michel Roy's avatar
Michel Roy committed
624
625
626
627
628
629
630
631
632
633
634
635
636
          "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.",
            "format": "uri",
            "type": "string",
            "x-etsi-mec-cardinality": "0..1",
            "x-etsi-mec-origin-type": "URI"
          },
          "contextId": {
            "description": "Uniquely identifies the application context in the MEC system. Assigned by the MEC system and shall be present other than in a create request. The length of the value shall not exceed 32 characters.",
            "type": "string",
            "maxLength": 32,
            "x-etsi-mec-cardinality": "0..1",
            "x-etsi-mec-origin-type": "String"
Walter Featherstone's avatar
Walter Featherstone committed
637
          }
Michel Roy's avatar
Michel Roy committed
638
639
640
641
642
        },
        "required": [
          "associateDevAppId",
          "appInfo"
        ],
Walter Featherstone's avatar
Walter Featherstone committed
643
        "type": "object",
Michel Roy's avatar
Michel Roy committed
644
645
646
647
        "x-etsi-notes": "NOTE 1:\tIf a value of the attribute is included in the request, the same value shall be included in the response.\nNOTE 2:\tThe design of the current operation with callback reference assumes no web proxy between the entity that originates the notification and the entity that receives it.\nNOTE 3:\tThe language support for the application description may be limited.\nNOTE 4:\tAttribute appLocationUpdates and appAutoInstantiation shall not both be set to TRUE.",
        "x-etsi-ref": "6.2.3"
      },
      "ApplicationContextDeleteNotification": {
Walter Featherstone's avatar
Walter Featherstone committed
648
        "properties": {
Michel Roy's avatar
Michel Roy committed
649
650
651
652
653
          "contextId": {
            "description": "Uniquely identifies the application context that has been deleted from the MEC system.",
            "type": "string",
            "x-etsi-mec-cardinality": "1",
            "x-etsi-mec-origin-type": "String"
Walter Featherstone's avatar
Walter Featherstone committed
654
          },
Michel Roy's avatar
Michel Roy committed
655
656
657
658
659
          "notificationType": {
            "description": "Shall be set to \"ApplicationContextDeleteNotification\".",
            "type": "string",
            "x-etsi-mec-cardinality": "1",
            "x-etsi-mec-origin-type": "String"
Walter Featherstone's avatar
Walter Featherstone committed
660
          }
Michel Roy's avatar
Michel Roy committed
661
        },
Walter Featherstone's avatar
Walter Featherstone committed
662
        "required": [
Michel Roy's avatar
Michel Roy committed
663
664
          "notificationType",
          "contextId"
Walter Featherstone's avatar
Walter Featherstone committed
665
        ],
Michel Roy's avatar
Michel Roy committed
666
667
668
669
        "type": "object",
        "x-etsi-ref": "6.4.3"
      },
      "ApplicationContextUpdateNotification": {
Walter Featherstone's avatar
Walter Featherstone committed
670
671
        "properties": {
          "contextId": {
Michel Roy's avatar
Michel Roy committed
672
673
674
675
            "description": "Uniquely identifies the application context in the MEC system.",
            "type": "string",
            "x-etsi-mec-cardinality": "1",
            "x-etsi-mec-origin-type": "String"
Walter Featherstone's avatar
Walter Featherstone committed
676
          },
Michel Roy's avatar
Michel Roy committed
677
678
679
680
681
          "notificationType": {
            "description": "Shall be set to \"ApplicationContextUpdateNotification\".",
            "type": "string",
            "x-etsi-mec-cardinality": "1",
            "x-etsi-mec-origin-type": "String"
Walter Featherstone's avatar
Walter Featherstone committed
682
          },
Michel Roy's avatar
Michel Roy committed
683
684
685
686
687
688
689
690
691
692
693
694
          "userAppInstanceInfo": {
            "description": "List of user application instance information.",
            "items": {
              "type": "object",
              "properties": {
                "appInstanceId": {
                  "description": "Identifier of the user application instance.",
                  "type": "string",
                  "x-etsi-mec-cardinality": "1",
                  "x-etsi-mec-origin-type": "String"
                },
                "appLocation": {
Michel Roy's avatar
Michel Roy committed
695
                  "$ref": "#/components/schemas/LocationConstraints"
Michel Roy's avatar
Michel Roy committed
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
                },
                "referenceURI": {
                  "description": "Address of the user application instance.",
                  "format": "uri",
                  "type": "string",
                  "x-etsi-mec-cardinality": "1",
                  "x-etsi-mec-origin-type": "URI"
                }
              }
            },
            "minItems": 1,
            "required": [
              "appInstanceId",
              "referenceURI"
            ],
            "type": "array",
            "x-etsi-mec-cardinality": "1..N",
            "x-etsi-mec-origin-type": "array (Structure inlined)"
Walter Featherstone's avatar
Walter Featherstone committed
714
          }
Michel Roy's avatar
Michel Roy committed
715
        },
Walter Featherstone's avatar
Walter Featherstone committed
716
717
        "type": "object",
        "required": [
Michel Roy's avatar
Michel Roy committed
718
719
720
          "notificationType",
          "contextId",
          "userAppInstanceInfo"
Walter Featherstone's avatar
Walter Featherstone committed
721
        ],
Michel Roy's avatar
Michel Roy committed
722
723
724
        "x-etsi-ref": "6.4.4"
      },
      "ApplicationList": {
Walter Featherstone's avatar
Walter Featherstone committed
725
        "properties": {
Michel Roy's avatar
Michel Roy committed
726
727
728
729
730
731
732
733
734
735
736
737
738
739
          "appList": {
            "description": "List of user applications available to the device application. As defined below.",
            "items": {
              "type": "object",
              "properties": {
                "appInfo": {
                  "description": "",
                  "properties": {
                    "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.",
                      "properties": {
                        "bandwidth": {
                          "description": "The required connection bandwidth in kbit/s for the use of the MEC application instance. ",
                          "type": "integer",
Michel Roy's avatar
Michel Roy committed
740
                          "format": "int32",
Michel Roy's avatar
Michel Roy committed
741
742
743
744
745
746
                          "x-etsi-mec-cardinality": "0..1",
                          "x-etsi-mec-origin-type": "uint32"
                        },
                        "latency": {
                          "description": "The target round trip time in milliseconds supported by the MEC system for the MEC application instance.",
                          "type": "integer",
Michel Roy's avatar
Michel Roy committed
747
                          "format": "int32",
Michel Roy's avatar
Michel Roy committed
748
749
750
751
752
753
                          "x-etsi-mec-cardinality": "0..1",
                          "x-etsi-mec-origin-type": "uint32"
                        },
                        "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",
Michel Roy's avatar
Michel Roy committed
754
                          "format": "int32",
Michel Roy's avatar
Michel Roy committed
755
756
757
758
759
760
761
762
763
                          "x-etsi-mec-cardinality": "0..1",
                          "x-etsi-mec-origin-type": "uint32"
                        },
                        "serviceCont": {
                          "description": "Required service continuity mode for this application. Permitted values: 0 = SERVICE_CONTINUITY_NOT_REQUIRED. 1 = SERVICE_CONTINUITY_REQUIRED.",
                          "enum": [
                            0,
                            1
                          ],
Michel Roy's avatar
Michel Roy committed
764
                          "type": "integer",
Michel Roy's avatar
Michel Roy committed
765
766
767
768
769
770
                          "x-etsi-mec-cardinality": "0..1",
                          "x-etsi-mec-origin-type": "Enum"
                        },
                        "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",
Michel Roy's avatar
Michel Roy committed
771
                          "format": "int32",
Michel Roy's avatar
Michel Roy committed
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
                          "x-etsi-mec-cardinality": "0..1",
                          "x-etsi-mec-origin-type": "uint32"
                        }
                      },
                      "type": "object",
                      "x-etsi-mec-cardinality": "0..1",
                      "x-etsi-mec-origin-type": "Structure (inlined)"
                    },
                    "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",
                      "x-etsi-mec-cardinality": "1",
                      "x-etsi-mec-origin-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",
                      "x-etsi-mec-cardinality": "1",
                      "x-etsi-mec-origin-type": "String"
                    },
                    "appDescription": {
                      "description": "Human readable description of the MEC application (see note 2).",
                      "type": "string",
                      "maxLength": 128,
                      "x-etsi-mec-cardinality": "1",
                      "x-etsi-mec-origin-type": "String"
                    },
                    "appLocation": {
                      "description": "Identifies the locations of the MEC application.",
                      "items": {
                        "$ref": "#/components/schemas/LocationConstraints"
                      },
                      "minItems": 0,
                      "type": "array",
                      "x-etsi-mec-cardinality": "0..N",
                      "x-etsi-mec-origin-type": "LocationConstraints"
                    },
                    "appName": {
                      "description": "Name of the MEC application. The length of the value shall not exceed 32 characters.",
                      "type": "string",
                      "maxLength": 32,
                      "x-etsi-mec-cardinality": "1",
                      "x-etsi-mec-origin-type": "String"
                    },
                    "appProvider": {
                      "description": "Provider of the MEC application. The length of the value shall not exceed 32 characters.",
                      "type": "string",
                      "maxLength": 32,
                      "x-etsi-mec-cardinality": "1",
                      "x-etsi-mec-origin-type": "String"
                    },
                    "appSoftVersion": {
                      "description": "Software version of the MEC application. The length of the value shall not exceed 32 characters.",
                      "type": "string",
                      "maxLength": 32,
                      "x-etsi-mec-cardinality": "1",
                      "x-etsi-mec-origin-type": "String"
                    }
                  },
                  "required": [
                    "appDId",
                    "appName",
                    "appProvider",
                    "appSoftVersion",
                    "appDVersion",
                    "appDescription"
                  ],
                  "type": "object",
                  "x-etsi-mec-cardinality": "1",
                  "x-etsi-mec-origin-type": "Structure (inlined)"
                },
                "vendorSpecificExt": {
                  "description": "Extension for vendor specific information (see note 1).",
                  "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",
                      "maxLength": 32,
                      "x-etsi-mec-cardinality": "1",
                      "x-etsi-mec-origin-type": "String"
                    }
                  },
                  "required": [
                    "vendorId"
                  ],
                  "type": "object",
                  "x-etsi-mec-cardinality": "0..1",
                  "x-etsi-mec-origin-type": "Structure (inlined)"
                }
              }
            },
            "minItems": 0,
            "required": [
              "appInfo"
            ],
            "type": "array",
            "x-etsi-mec-cardinality": "0..N",
            "x-etsi-mec-origin-type": "Array (Structure (inlined))"
Walter Featherstone's avatar
Walter Featherstone committed
870
          }
Michel Roy's avatar
Michel Roy committed
871
872
873
874
        },
        "type": "object",
        "x-etsi-notes": "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.",
        "x-etsi-ref": "6.2.2"
Walter Featherstone's avatar
Walter Featherstone committed
875
      },
Michel Roy's avatar
Michel Roy committed
876
      "ApplicationLocationAvailability": {
877
        "properties": {
Michel Roy's avatar
Michel Roy committed
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
          "appInfo": {
            "description": "",
            "properties": {
              "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",
                "x-etsi-mec-cardinality": "1",
                "x-etsi-mec-origin-type": "String"
              },
              "appDescription": {
                "description": "Human readable description of the MEC application. The length of the value shall not exceed 128 characters.",
                "type": "string",
                "maxLength": 128,
                "x-etsi-mec-cardinality": "0..1",
                "x-etsi-mec-origin-type": "String"
              },
              "appName": {
                "description": "Name of the MEC application. The length of the value shall not exceed 32 characters.",
                "type": "string",
                "maxLength": 32,
                "x-etsi-mec-cardinality": "1",
                "x-etsi-mec-origin-type": "String"
              },
              "appPackageSource": {
                "description": "URI of the application package. Shall be included in the request. The application package shall comply with the definitions in clause 6.2.1.2 of ETSI GS MEC 0102 [1].",
                "format": "uri",
                "type": "string",
                "x-etsi-mec-cardinality": "0..1",
                "x-etsi-mec-origin-type": "URI"
              },
              "appProvider": {
                "description": "Provider of the MEC application. The length of the value shall not exceed 32 characters.",
                "type": "string",
                "maxLength": 32,
                "x-etsi-mec-cardinality": "1",
                "x-etsi-mec-origin-type": "String"
              },
              "appSoftVersion": {
                "description": "Software version of the MEC application. The length of the value shall not exceed 32 characters.",
                "type": "string",
                "maxLength": 32,
                "x-etsi-mec-cardinality": "0..1",
                "x-etsi-mec-origin-type": "String"
              },
              "availableLocations": {
                "description": "MEC application location constraints. ",
                "items": {
                  "type": "object",
                  "properties": {
                    "appLocation": {
Michel Roy's avatar
Michel Roy committed
928
                      "$ref": "#/components/schemas/LocationConstraints"
Michel Roy's avatar
Michel Roy committed
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
                    }
                  }
                },
                "minItems": 0,
                "type": "array",
                "x-etsi-mec-cardinality": "0..N",
                "x-etsi-mec-origin-type": "array (Structure (inline))"
              }
            },
            "required": [
              "appName",
              "appProvider",
              "appDVersion"
            ],
            "type": "object",
            "x-etsi-mec-cardinality": "1",
            "x-etsi-mec-origin-type": "Structure (inlined)"
          },
          "associateDevAppId": {
            "description": "Uniquely identifies the device application. The length of the value shall not exceed 32 characters.",
            "type": "string",
            "maxLength": 32,
            "x-etsi-mec-cardinality": "1",
            "x-etsi-mec-origin-type": "String"
953
          }
Michel Roy's avatar
Michel Roy committed
954
        },
955
        "required": [
Michel Roy's avatar
Michel Roy committed
956
957
          "associateDevAppId",
          "appInfo"
958
        ],
Michel Roy's avatar
Michel Roy committed
959
960
961
962
        "type": "object",
        "x-etsi-ref": "6.2.4"
      },
      "ApplicationLocationAvailabilityNotification": {
963
        "properties": {
Michel Roy's avatar
Michel Roy committed
964
965
966
967
968
969
          "availableLocations": {
            "description": "Locations available to the MEC application.",
            "items": {
              "type": "object",
              "properties": {
                "appLocation": {
Michel Roy's avatar
Michel Roy committed
970
                  "$ref": "#/components/schemas/LocationConstraints"
Michel Roy's avatar
Michel Roy committed
971
972
973
974
975
976
977
978
979
980
                }
              }
            },
            "minItems": 1,
            "required": [
              "appLocation"
            ],
            "type": "array",
            "x-etsi-mec-cardinality": "1..N",
            "x-etsi-mec-origin-type": "array (Structure (inline))"
981
          },
Michel Roy's avatar
Michel Roy committed
982
983
984
985
986
          "contextId": {
            "description": "Uniquely identifies the application context in the MEC system.",
            "type": "string",
            "x-etsi-mec-cardinality": "0..1",
            "x-etsi-mec-origin-type": "String"
987
          },
Michel Roy's avatar
Michel Roy committed
988
989
990
991
992
          "notificationType": {
            "description": "Shall be set to \"ApplicationLocationAvailabilityNotification\".",
            "type": "string",
            "x-etsi-mec-cardinality": "1",
            "x-etsi-mec-origin-type": "String"
993
          }
Michel Roy's avatar
Michel Roy committed
994
        },
Walter Featherstone's avatar
Walter Featherstone committed
995
996
        "type": "object",
        "required": [
Michel Roy's avatar
Michel Roy committed
997
998
          "notificationType",
          "availableLocations"
Walter Featherstone's avatar
Walter Featherstone committed
999
        ],
Michel Roy's avatar
Michel Roy committed
1000
1001
1002
        "x-etsi-ref": "6.4.5"
      },
      "LocationConstraints": {
Walter Featherstone's avatar
Walter Featherstone committed
1003
        "properties": {
Michel Roy's avatar
Michel Roy committed
1004
          "area": {
Michel Roy's avatar
Michel Roy committed
1005
            "$ref": "#/components/schemas/Polygon"
Walter Featherstone's avatar
Walter Featherstone committed
1006
          },
Michel Roy's avatar
Michel Roy committed
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
          "civicAddressElement": {
            "description": "Zero or more elements comprising the civic address. Shall be absent if the \"area\" attribute is present.",
            "items": {
              "type": "object",
              "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",
                  "x-etsi-mec-cardinality": "1",
                  "x-etsi-mec-origin-type": "Integer"
                },
                "caValue": {
                  "description": "Content of civic address element corresponding to the caType. The format caValue shall comply with section 3.4 of IETF RFC 4776 [6].",
                  "type": "string",
                  "x-etsi-mec-cardinality": "1",
                  "x-etsi-mec-origin-type": "String"
                }
              }
            },
            "minItems": 0,
            "required": [
              "caType",
              "caValue"
            ],
            "type": "array",
            "x-etsi-mec-cardinality": "0..N",
            "x-etsi-mec-origin-type": "array (Structure inlined)"
Walter Featherstone's avatar
Walter Featherstone committed
1034
          },
Michel Roy's avatar
Michel Roy committed
1035
1036
1037
1038
1039
1040
          "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",
            "maxLength": 2,
            "x-etsi-mec-cardinality": "0..1",
            "x-etsi-mec-origin-type": "String"
Walter Featherstone's avatar
Walter Featherstone committed
1041
          }
Michel Roy's avatar
Michel Roy committed
1042
        },
Walter Featherstone's avatar
Walter Featherstone committed
1043
        "type": "object",
Michel Roy's avatar
Michel Roy committed
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
1064
1065
1066
1067
1068
        "x-etsi-notes": "NOTE:\tIf both \"countryCode\" and \"area\" are present, no conflicts should exist between the values of these two attributes. In case of conflicts, the API producer (e.g. MEO, MEAO) shall disregard parts of the geographic area signalled by \"area\" that are outside the boundaries of the country signalled by \"countryCode\". If \"countryCode\" is absent, it is solely the \"area\" attribute that defines the location constraint.",
        "x-etsi-ref": "6.5.2"
      },
      "Polygon": {
        "properties": {
          "coordinates": {
            "items": {
              "items": {
                "items": {
                  "type": "number",
                  "format": "float"
                },
                "type": "array"
              },
              "type": "array"
            },
            "minItems": 1,
            "type": "array",
            "x-etsi-mec-cardinality": 1,
            "x-etsi-mec-origin-type": "array"
          }
        },
        "type": "object"
      },
      "ProblemDetails": {
Walter Featherstone's avatar
Walter Featherstone committed
1069
        "properties": {
Michel Roy's avatar
Michel Roy committed
1070
1071
1072
1073
1074
          "detail": {
            "description": "A human-readable explanation specific to this occurrence of the problem",
            "type": "string",
            "x-etsi-mec-cardinality": "0..1",
            "x-etsi-mec-origin-type": "String"
Walter Featherstone's avatar
Walter Featherstone committed
1075
          },
Michel Roy's avatar
Michel Roy committed
1076
1077
1078
1079
1080
1081
          "instance": {
            "description": "A URI reference that identifies the specific occurrence of the problem",
            "format": "uri",
            "type": "string",
            "x-etsi-mec-cardinality": "0..1",
            "x-etsi-mec-origin-type": "URI"
Walter Featherstone's avatar
Walter Featherstone committed
1082
          },
Michel Roy's avatar
Michel Roy committed
1083
1084
          "status": {
            "description": "The HTTP status code for this occurrence of the problem",
Michel Roy's avatar
Michel Roy committed
1085
            "format": "int32",
Michel Roy's avatar
Michel Roy committed
1086
1087
1088
            "type": "integer",
            "x-etsi-mec-cardinality": "0..1",
            "x-etsi-mec-origin-type": "Uint32"
Walter Featherstone's avatar
Walter Featherstone committed
1089
          },
Michel Roy's avatar
Michel Roy committed
1090
1091
1092
1093
1094
          "title": {
            "description": "A short, human-readable summary of the problem type",
            "type": "string",
            "x-etsi-mec-cardinality": "0..1",
            "x-etsi-mec-origin-type": "String"
Walter Featherstone's avatar
Walter Featherstone committed
1095
          },
Michel Roy's avatar
Michel Roy committed
1096
1097
1098
1099
1100
1101
          "type": {
            "description": "A URI reference according to IETF RFC 3986 that identifies the problem type",
            "format": "uri",
            "type": "string",
            "x-etsi-mec-cardinality": "0..1",
            "x-etsi-mec-origin-type": "URI"
Walter Featherstone's avatar
Walter Featherstone committed
1102
          }
Michel Roy's avatar
Michel Roy committed
1103
1104
        },
        "type": "object"
1105
      }
1106
    }
1107
  }
Michel Roy's avatar
Michel Roy committed
1108
}