MEC010-2_AppPkgMgmt.json 79.3 KB
Newer Older
1
{
Elian Kraja's avatar
Elian Kraja committed
2
3
4
5
6
7
8
9
10
11
12
    "info": {
      "title": "ETSI GS MEC 010-2 - Part 2: Application lifecycle, rules and requirements management",
      "version": "2.1.1",
      "description": "ETSI GS MEC 010-2 - Part 2: Application lifecycle, rules and requirements management described using OpenAPI.",
      "license": {
        "name": "BSD-3-Clause",
        "url": "https://forge.etsi.org/legal-matters"
      },
      "contact": {
        "url": "https://forge.etsi.org/rep/mec/gs010-2-app-pkg-lcm-api"
      }
13
    },
Elian Kraja's avatar
Elian Kraja committed
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
    "externalDocs": {
      "description": "ETSI GS MEC 010-2 - Part 2: Application lifecycle, rules and requirements management, v2.1.1",
      "url": "https://www.etsi.org/deliver/etsi_gs/MEC/001_099/01002/02.01.01_60/gs_MEC01002v020101p.pdf"
    },
    "servers": [
      {
        "url": "https://localhost/app_pkgm/v1"
      }
    ],
    "openapi": "3.0.0",
    "tags": [
      {
        "name": "app-pkgm",
        "description": "App Package management"
      },
      {
        "name": "app-pkgm-notifications",
        "description": "App Package management notifications"
      }
    ],
    "paths": {
      "/app_packages": {
        "post": {
          "tags": [
            "app-pkgm"
          ],
          "summary": "Create a resource for on-boarding an application package to a MEO",
          "description": "Create a resource for on-boarding an application package to a MEO",
          "operationId": "app_packagesPOST",
          "requestBody": {
            "description": "Resource to be created",
            "required": true,
46
47
48
            "content": {
              "application/json": {
                "schema": {
Elian Kraja's avatar
Elian Kraja committed
49
                  "$ref": "#/components/schemas/CreateAppPkg"
50
51
52
53
                }
              }
            }
          },
Elian Kraja's avatar
Elian Kraja committed
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
          "responses": {
            "201": {
              "description": "Successful response for resource creation",
              "content": {
                "application/json": {
                  "schema": {
                    "type": "array",
                    "items": {
                      "$ref": "#/components/schemas/AppPkgInfo"
                    }
                  }
                }
              }
            },
            "400": {
              "$ref": "#/components/responses/400"
            },
            "401": {
              "$ref": "#/components/responses/401"
            },
            "403": {
              "$ref": "#/components/responses/403"
            },
            "404": {
              "$ref": "#/components/responses/404"
            },
            "406": {
              "$ref": "#/components/responses/406"
            },
            "429": {
              "$ref": "#/components/responses/429"
            }
86
          }
Elian Kraja's avatar
Elian Kraja committed
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
        },
        "get": {
          "tags": [
            "app-pkgm"
          ],
          "summary": "Queries information relating to on-boarded application packages in the MEO",
          "description": "queries information relating to on-boarded application packages in the MEO",
          "operationId": "app_packagesGET",
          "parameters": [
            {
              "in": "query",
              "name": "filter",
              "schema": {
                "type": "string"
              },
              "required": false,
              "description": "Attribute-based filtering parameters according to ETSI GS MEC 009"
104
            },
Elian Kraja's avatar
Elian Kraja committed
105
106
107
108
109
110
111
112
            {
              "in": "query",
              "name": "all_fields",
              "schema": {
                "type": "string"
              },
              "required": false,
              "description": "Include all complex attributes in the response."
113
            },
Elian Kraja's avatar
Elian Kraja committed
114
115
116
117
118
119
120
121
            {
              "in": "query",
              "name": "fields",
              "schema": {
                "type": "string"
              },
              "required": false,
              "description": "Complex attributes of AppPkgInfo to be included into the response"
122
            },
Elian Kraja's avatar
Elian Kraja committed
123
124
125
126
127
128
129
130
            {
              "in": "query",
              "name": "exclude_fields",
              "schema": {
                "type": "string"
              },
              "required": false,
              "description": "Complex attributes of AppPkgInfo to be excluded from the response."
131
            },
Elian Kraja's avatar
Elian Kraja committed
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
            {
              "in": "query",
              "name": "exclude_default",
              "schema": {
                "type": "string"
              },
              "required": false,
              "description": "Indicates to exclude the following complex attributes of AppPkgInfo from the response."
            }
          ],
          "responses": {
            "200": {
              "description": "Contains a representation of the application package resource",
              "content": {
                "application/json": {
                  "schema": {
                    "type": "array",
                    "items": {
                      "$ref": "#/components/schemas/AppPkgInfo"
                    }
                  }
                }
              }
            },
            "400": {
              "$ref": "#/components/responses/400"
            },
            "401": {
              "$ref": "#/components/responses/401"
            },
            "403": {
              "$ref": "#/components/responses/403"
            },
            "404": {
              "$ref": "#/components/responses/404"
            },
            "406": {
              "$ref": "#/components/responses/406"
            },
            "429": {
              "$ref": "#/components/responses/429"
            }
          }
        }
      },
      "/app_packages/{appPkgId}": {
        "parameters": [
179
          {
Elian Kraja's avatar
Elian Kraja committed
180
181
            "in": "path",
            "name": "appPkgId",
182
183
184
            "schema": {
              "type": "string"
            },
Elian Kraja's avatar
Elian Kraja committed
185
186
            "required": true,
            "description": "Identifier of an individual application package resource"
187
188
          }
        ],
Elian Kraja's avatar
Elian Kraja committed
189
190
191
192
193
194
195
196
197
198
199
200
201
        "get": {
          "tags": [
            "app-pkgm"
          ],
          "summary": "Queries the information related to individual application package resources",
          "description": "Queries the information related to individual application package resources",
          "operationId": "app_packageGET",
          "responses": {
            "200": {
              "description": "Contains a representation of the application package resource",
              "content": {
                "application/json": {
                  "schema": {
202
203
204
205
                    "$ref": "#/components/schemas/AppPkgInfo"
                  }
                }
              }
Elian Kraja's avatar
Elian Kraja committed
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
            },
            "400": {
              "$ref": "#/components/responses/400"
            },
            "401": {
              "$ref": "#/components/responses/401"
            },
            "403": {
              "$ref": "#/components/responses/403"
            },
            "404": {
              "$ref": "#/components/responses/404"
            },
            "406": {
              "$ref": "#/components/responses/406"
            },
            "429": {
              "$ref": "#/components/responses/429"
224
225
            }
          }
Elian Kraja's avatar
Elian Kraja committed
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
        },
        "delete": {
          "tags": [
            "app-pkgm"
          ],
          "summary": "Deletes an individual application package resources",
          "description": "Deletes an individual application package resources",
          "operationId": "app_packageDELETE",
          "responses": {
            "204": {
              "$ref": "#/components/responses/204"
            },
            "400": {
              "$ref": "#/components/responses/400"
            },
            "401": {
              "$ref": "#/components/responses/401"
            },
            "403": {
              "$ref": "#/components/responses/403"
            },
            "404": {
              "$ref": "#/components/responses/404"
            },
            "406": {
              "$ref": "#/components/responses/406"
            },
            "429": {
              "$ref": "#/components/responses/429"
            }
          }
        },
        "patch": {
          "tags": [
            "app-pkgm"
          ],
          "summary": "Updates the operational state of an individual application package resource",
          "description": "Updates the operational state of an individual application package resources",
          "operationId": "app_packagePATCH",
          "requestBody": {
            "description": "Operational state to be set",
            "required": true,
268
269
270
            "content": {
              "application/json": {
                "schema": {
Elian Kraja's avatar
Elian Kraja committed
271
                  "$ref": "#/components/schemas/AppPkgInfoModifications"
272
273
274
275
                }
              }
            }
          },
Elian Kraja's avatar
Elian Kraja committed
276
277
278
279
280
281
282
283
284
          "responses": {
            "200": {
              "description": "Shows that the operation has been completed successfully",
              "content": {
                "application/json": {
                  "schema": {
                    "$ref": "#/components/schemas/AppPkgInfoModifications"
                  }
                }
285
              }
Elian Kraja's avatar
Elian Kraja committed
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
            },
            "400": {
              "$ref": "#/components/responses/400"
            },
            "401": {
              "$ref": "#/components/responses/401"
            },
            "403": {
              "$ref": "#/components/responses/403"
            },
            "404": {
              "$ref": "#/components/responses/404"
            },
            "406": {
              "$ref": "#/components/responses/406"
            },
            "409": {
              "$ref": "#/components/responses/409"
            },
            "429": {
              "$ref": "#/components/responses/429"
307
308
            }
          }
Elian Kraja's avatar
Elian Kraja committed
309
310
311
312
313
314
315
316
317
318
319
320
321
        }
      },
      "/subscriptions": {
        "post": {
          "tags": [
            "app-pkgm"
          ],
          "summary": "Subscribe to notifications about on-boarding an application package",
          "description": "Subscribe to notifications about on-boarding an application package",
          "operationId": "subscriptionsPOST",
          "requestBody": {
            "description": "The input parameters of subscribe operation to notifications",
            "required": true,
322
323
324
            "content": {
              "application/json": {
                "schema": {
Elian Kraja's avatar
Elian Kraja committed
325
                  "$ref": "#/components/schemas/AppPkgSubscription"
326
327
328
329
                }
              }
            }
          },
Elian Kraja's avatar
Elian Kraja committed
330
331
332
333
334
335
336
337
338
          "responses": {
            "201": {
              "description": "Successful response for created subscription",
              "content": {
                "application/json": {
                  "schema": {
                    "$ref": "#/components/schemas/AppPkgSubscriptionInfo"
                  }
                }
339
              }
Elian Kraja's avatar
Elian Kraja committed
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
            },
            "400": {
              "$ref": "#/components/responses/400"
            },
            "401": {
              "$ref": "#/components/responses/401"
            },
            "403": {
              "$ref": "#/components/responses/403"
            },
            "404": {
              "$ref": "#/components/responses/404"
            },
            "406": {
              "$ref": "#/components/responses/406"
            },
            "429": {
              "$ref": "#/components/responses/429"
358
359
360
            }
          }
        },
Elian Kraja's avatar
Elian Kraja committed
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
        "get": {
          "tags": [
            "app-pkgm"
          ],
          "summary": "used to retrieve the information of subscriptions to individual application package resource in MEO",
          "description": "used to retrieve the information of subscriptions to individual application package resource in MEO package",
          "operationId": "subscriptionsGET",
          "responses": {
            "200": {
              "description": "List of zero or more subscriptions",
              "content": {
                "application/json": {
                  "schema": {
                    "$ref": "#/components/schemas/AppPkgSubscriptionLinkList"
                  }
376
377
                }
              }
Elian Kraja's avatar
Elian Kraja committed
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
            },
            "400": {
              "$ref": "#/components/responses/400"
            },
            "401": {
              "$ref": "#/components/responses/401"
            },
            "403": {
              "$ref": "#/components/responses/403"
            },
            "404": {
              "$ref": "#/components/responses/404"
            },
            "406": {
              "$ref": "#/components/responses/406"
            },
            "429": {
              "$ref": "#/components/responses/429"
396
397
398
399
            }
          }
        }
      },
Elian Kraja's avatar
Elian Kraja committed
400
401
402
403
404
405
406
407
408
409
410
      "/subscriptions/{subscriptionId}": {
        "parameters": [
          {
            "in": "path",
            "name": "subscriptionId",
            "schema": {
              "type": "string"
            },
            "description": "Identifier of an individual subscription to notifications about application package changes",
            "required": true
          }
411
        ],
Elian Kraja's avatar
Elian Kraja committed
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
        "get": {
          "tags": [
            "app-pkgm"
          ],
          "summary": "Used to represent an individual subscription to notifications about application package changes.",
          "description": "Used to represent an individual subscription to notifications about application package changes.",
          "operationId": "individualSubscriptionGET",
          "responses": {
            "200": {
              "description": "Representation of the resource.",
              "content": {
                "application/json": {
                  "schema": {
                    "$ref": "#/components/schemas/AppPkgSubscriptionInfo"
                  }
427
428
                }
              }
Elian Kraja's avatar
Elian Kraja committed
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
            },
            "400": {
              "$ref": "#/components/responses/400"
            },
            "401": {
              "$ref": "#/components/responses/401"
            },
            "403": {
              "$ref": "#/components/responses/403"
            },
            "404": {
              "$ref": "#/components/responses/404"
            },
            "406": {
              "$ref": "#/components/responses/406"
            },
            "429": {
              "$ref": "#/components/responses/429"
            }
          }
        },
        "delete": {
          "tags": [
            "app-pkgm"
          ],
          "summary": "Deletes the individual subscription to notifications about application package changes in MEO.",
          "description": "Deletes the individual subscription to notifications about application package changes in MEO.",
          "operationId": "individualSubscriptionDELETE",
          "responses": {
            "204": {
              "$ref": "#/components/responses/204"
            },
            "401": {
              "$ref": "#/components/responses/401"
            },
            "403": {
              "$ref": "#/components/responses/403"
            },
            "404": {
              "$ref": "#/components/responses/404"
            },
            "429": {
              "$ref": "#/components/responses/429"
472
473
474
            }
          }
        }
Elian Kraja's avatar
Elian Kraja committed
475
476
477
478
479
480
481
482
483
484
485
486
      },
      "/URI_is_provided_by_the_client_when_creating_the_subscription_AppPkgNotification": {
        "post": {
          "tags": [
            "app-pkgm-notifications"
          ],
          "summary": "Registers a notification endpoint to notify application package operations",
          "description": "Registers a notification endpoint to notify application package operations",
          "operationId": "app_pkg_notificationPOST",
          "requestBody": {
            "description": "Notification endpoint to be created",
            "required": true,
487
488
489
            "content": {
              "application/json": {
                "schema": {
Elian Kraja's avatar
Elian Kraja committed
490
                  "$ref": "#/components/schemas/AppPkgNotification"
491
492
493
494
                }
              }
            }
          },
Elian Kraja's avatar
Elian Kraja committed
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
          "responses": {
            "204": {
              "$ref": "#/components/responses/204"
            },
            "401": {
              "$ref": "#/components/responses/401"
            },
            "403": {
              "$ref": "#/components/responses/403"
            },
            "404": {
              "$ref": "#/components/responses/404"
            },
            "429": {
              "$ref": "#/components/responses/429"
510
511
512
            }
          }
        }
Elian Kraja's avatar
Elian Kraja committed
513
514
      },
      "/app_packages/{appPkgId}/appd": {
515
516
        "parameters": [
          {
Elian Kraja's avatar
Elian Kraja committed
517
518
            "in": "path",
            "name": "appPkgId",
519
520
521
            "schema": {
              "type": "string"
            },
Elian Kraja's avatar
Elian Kraja committed
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
            "description": "Identifier of an on-boarded individual application package",
            "required": true
          }
        ],
        "get": {
          "tags": [
            "app-pkgm"
          ],
          "summary": "Reads the content of the AppD of on-boarded individual application package resources.",
          "description": "Reads the content of the AppD of on-boarded individual application package resources.",
          "operationId": "appPkgIdGET",
          "parameters": [
            {
              "in": "query",
              "name": "filter",
              "schema": {
                "type": "string"
              },
              "required": false,
              "description": "Attribute-based filtering parameters according to ETSI GS MEC 009"
542
            },
Elian Kraja's avatar
Elian Kraja committed
543
544
545
546
547
548
549
550
            {
              "in": "query",
              "name": "all_fields",
              "schema": {
                "type": "string"
              },
              "required": false,
              "description": "Include all complex attributes in the response."
551
            },
Elian Kraja's avatar
Elian Kraja committed
552
553
554
555
556
557
558
559
            {
              "in": "query",
              "name": "fields",
              "schema": {
                "type": "string"
              },
              "required": false,
              "description": "Complex attributes of AppPkgInfo to be included into the response"
560
            },
Elian Kraja's avatar
Elian Kraja committed
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
615
616
617
618
            {
              "in": "query",
              "name": "exclude_fields",
              "schema": {
                "type": "string"
              },
              "required": false,
              "description": "Complex attributes of AppPkgInfo to be excluded from the response."
            },
            {
              "in": "query",
              "name": "exclude_default",
              "schema": {
                "type": "string"
              },
              "required": false,
              "description": "Indicates to exclude the following complex attributes of AppPkgInfo from the response."
            }
          ],
          "responses": {
            "200": {
              "description": "Content of the AppD is returned.",
              "content": {
                "text/plain": {
                  "schema": {
                    "$ref": "#/components/schemas/AppD"
                  }
                },
                "application/zip": {
                  "schema": {
                    "$ref": "#/components/schemas/AppD"
                  }
                }
              }
            },
            "400": {
              "$ref": "#/components/responses/400"
            },
            "401": {
              "$ref": "#/components/responses/401"
            },
            "403": {
              "$ref": "#/components/responses/403"
            },
            "404": {
              "$ref": "#/components/responses/404"
            },
            "406": {
              "$ref": "#/components/responses/406"
            },
            "429": {
              "$ref": "#/components/responses/429"
            }
          }
        }
      },
      "/onboarded_app_packages/{appDId}/appd": {
        "parameters": [
619
          {
Elian Kraja's avatar
Elian Kraja committed
620
621
            "in": "path",
            "name": "appDId",
622
623
624
            "schema": {
              "type": "string"
            },
Elian Kraja's avatar
Elian Kraja committed
625
626
            "description": "Identifier of an application descriptor",
            "required": true
627
628
          }
        ],
Elian Kraja's avatar
Elian Kraja committed
629
630
631
632
633
634
635
636
637
638
639
640
641
        "get": {
          "tags": [
            "app-pkgm"
          ],
          "summary": "Reads the content of the AppD of on-boarded individual application package resources.",
          "description": "Reads the content of the AppD of on-boarded individual application package resources.",
          "operationId": "appDGET",
          "parameters": [
            {
              "in": "query",
              "name": "filter",
              "schema": {
                "type": "string"
642
              },
Elian Kraja's avatar
Elian Kraja committed
643
644
645
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
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
              "required": false,
              "description": "Attribute-based filtering parameters according to ETSI GS MEC 009"
            },
            {
              "in": "query",
              "name": "all_fields",
              "schema": {
                "type": "string"
              },
              "required": false,
              "description": "Include all complex attributes in the response."
            },
            {
              "in": "query",
              "name": "fields",
              "schema": {
                "type": "string"
              },
              "required": false,
              "description": "Complex attributes of AppPkgInfo to be included into the response"
            },
            {
              "in": "query",
              "name": "exclude_fields",
              "schema": {
                "type": "string"
              },
              "required": false,
              "description": "Complex attributes of AppPkgInfo to be excluded from the response."
            },
            {
              "in": "query",
              "name": "exclude_default",
              "schema": {
                "type": "string"
              },
              "required": false,
              "description": "Indicates to exclude the following complex attributes of AppPkgInfo from the response."
            }
          ],
          "responses": {
            "200": {
              "description": "Content of the AppD is returned.",
              "content": {
                "text/plain": {
                  "schema": {
                    "$ref": "#/components/schemas/AppD"
                  }
                },
                "application/zip": {
                  "schema": {
                    "$ref": "#/components/schemas/AppD"
                  }
696
697
                }
              }
Elian Kraja's avatar
Elian Kraja committed
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
            },
            "400": {
              "$ref": "#/components/responses/400"
            },
            "401": {
              "$ref": "#/components/responses/401"
            },
            "403": {
              "$ref": "#/components/responses/403"
            },
            "404": {
              "$ref": "#/components/responses/404"
            },
            "406": {
              "$ref": "#/components/responses/406"
            },
            "429": {
              "$ref": "#/components/responses/429"
716
717
718
            }
          }
        }
Elian Kraja's avatar
Elian Kraja committed
719
720
      },
      "/app_packages/{appPkgId}/package_content": {
721
722
        "parameters": [
          {
Elian Kraja's avatar
Elian Kraja committed
723
724
            "in": "path",
            "name": "appPkgId",
725
726
727
            "schema": {
              "type": "string"
            },
Elian Kraja's avatar
Elian Kraja committed
728
729
730
731
732
733
734
735
736
737
738
739
740
741
            "description": "Identifier of an on-boarded individual application package",
            "required": true
          }
        ],
        "get": {
          "tags": [
            "app-pkgm"
          ],
          "summary": "Fetch the onboarded application package content identified by appPkgId or appDId.",
          "description": "Fetch the onboarded application package content identified by appPkgId or appDId.",
          "operationId": "appPkgGET",
          "responses": {
            "200": {
              "$ref": "#/components/responses/AppPkgContent.200"
742
            },
Elian Kraja's avatar
Elian Kraja committed
743
744
            "206": {
              "$ref": "#/components/responses/206"
745
            },
Elian Kraja's avatar
Elian Kraja committed
746
747
            "400": {
              "$ref": "#/components/responses/400"
748
            },
Elian Kraja's avatar
Elian Kraja committed
749
750
            "401": {
              "$ref": "#/components/responses/401"
751
            },
Elian Kraja's avatar
Elian Kraja committed
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
            "403": {
              "$ref": "#/components/responses/403"
            },
            "404": {
              "$ref": "#/components/responses/404"
            },
            "416": {
              "$ref": "#/components/responses/416"
            },
            "406": {
              "$ref": "#/components/responses/406"
            },
            "429": {
              "$ref": "#/components/responses/429"
            }
767
          }
Elian Kraja's avatar
Elian Kraja committed
768
769
770
771
772
773
774
775
776
        },
        "put": {
          "tags": [
            "app-pkgm"
          ],
          "summary": "Uploads the content of application package.",
          "description": "Uploads the content of application package.",
          "operationId": "appPkgPUT",
          "requestBody": {
777
778
779
            "content": {
              "application/zip": {
                "schema": {
Elian Kraja's avatar
Elian Kraja committed
780
781
                  "type": "string",
                  "format": "binary"
782
783
784
785
                }
              }
            }
          },
Elian Kraja's avatar
Elian Kraja committed
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
          "responses": {
            "202": {
              "description": "The application package has been accepted for uploading, but the processing has not been completed."
            },
            "400": {
              "$ref": "#/components/responses/400"
            },
            "401": {
              "$ref": "#/components/responses/401"
            },
            "403": {
              "$ref": "#/components/responses/403"
            },
            "404": {
              "$ref": "#/components/responses/404"
            },
            "406": {
              "$ref": "#/components/responses/406"
            },
            "409": {
              "$ref": "#/components/responses/409"
            },
            "429": {
              "$ref": "#/components/responses/429"
            }
811
812
813
          }
        }
      },
Elian Kraja's avatar
Elian Kraja committed
814
815
816
817
818
819
820
821
822
823
824
      "/onboarded_app_packages/{appDId}/package_content": {
        "parameters": [
          {
            "in": "path",
            "name": "appDId",
            "description": "Identifier of an application descriptor",
            "schema": {
              "type": "string"
            },
            "required": true
          }
825
        ],
Elian Kraja's avatar
Elian Kraja committed
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
        "get": {
          "tags": [
            "app-pkgm"
          ],
          "summary": "Fetch the onboarded application package content identified by appPkgId or appDId.",
          "description": "Fetch the onboarded application package content identified by appPkgId or appDId.",
          "operationId": "appDIdGET",
          "responses": {
            "200": {
              "$ref": "#/components/responses/AppPkgContent.200"
            },
            "206": {
              "$ref": "#/components/responses/206"
            },
            "400": {
              "$ref": "#/components/responses/400"
            },
            "401": {
              "$ref": "#/components/responses/401"
            },
            "403": {
              "$ref": "#/components/responses/403"
            },
            "404": {
              "$ref": "#/components/responses/404"
            },
            "416": {
              "$ref": "#/components/responses/416"
            },
            "406": {
              "$ref": "#/components/responses/406"
            },
            "429": {
              "$ref": "#/components/responses/429"
860
861
862
            }
          }
        },
Elian Kraja's avatar
Elian Kraja committed
863
864
865
866
867
868
869
870
871
872
873
874
875
876
        "put": {
          "tags": [
            "app-pkgm"
          ],
          "summary": "Uploads the content of application package.",
          "description": "Uploads the content of application package.",
          "operationId": "appDIdPUT",
          "requestBody": {
            "content": {
              "application/zip": {
                "schema": {
                  "type": "string",
                  "format": "binary"
                }
877
878
879
              }
            }
          },
Elian Kraja's avatar
Elian Kraja committed
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
          "responses": {
            "202": {
              "description": "The application package has been accepted for uploading, but the processing has not been completed."
            },
            "400": {
              "$ref": "#/components/responses/400"
            },
            "401": {
              "$ref": "#/components/responses/401"
            },
            "403": {
              "$ref": "#/components/responses/403"
            },
            "404": {
              "$ref": "#/components/responses/404"
            },
            "406": {
              "$ref": "#/components/responses/406"
            },
            "409": {
              "$ref": "#/components/responses/409"
            },
            "429": {
              "$ref": "#/components/responses/429"
            }
905
906
907
          }
        }
      }
Elian Kraja's avatar
Elian Kraja committed
908
909
910
911
912
913
914
915
916
917
918
919
920
921
    },
    "components": {
      "schemas": {
        "Algorithm": {
          "description": " Name of the algorithm used to generate the checksum,  as defined in ETSI GS NFV-SOL 004. For example, SHA-256, SHA-512.",
          "type": "string"
        },
        "AppD": {
          "properties": {
            "appDId": {
              "description": "Identifier of this MEC application descriptor. This attribute shall be globally unique. See note 1.",
              "type": "string",
              "x-etsi-mec-cardinality": "1",
              "x-etsi-mec-origin-type": "String"
922
            },
Elian Kraja's avatar
Elian Kraja committed
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
1001
1002
1003
1004
1005
1006
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
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
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
1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
1082
1083
            "appDNSRule": {
              "description": "Describes DNS rules the MEC application requires.",
              "items": {
                "$ref": "#/components/schemas/DNSRuleDescriptor"
              },
              "minItems": 0,
              "type": "array",
              "x-etsi-mec-cardinality": "0..N",
              "x-etsi-mec-origin-type": "DNSRuleDescriptor"
            },
            "appDVersion": {
              "description": "Identifies the version of the application descriptor.",
              "type": "string",
              "x-etsi-mec-cardinality": "1",
              "x-etsi-mec-origin-type": "String"
            },
            "appDescription": {
              "description": "Human readable description of the MEC application.",
              "type": "string",
              "x-etsi-mec-cardinality": "1",
              "x-etsi-mec-origin-type": "String"
            },
            "appExtCpd": {
              "description": "Describes external interface(s) exposed by this MEC application.",
              "items": {
                "$ref": "#/components/schemas/AppExternalCpd"
              },
              "minItems": 0,
              "type": "array",
              "x-etsi-mec-cardinality": "0..N",
              "x-etsi-mec-origin-type": "AppExternalCpd"
            },
            "appFeatureOptional": {
              "description": "Describes features a MEC application may use if available.",
              "items": {
                "$ref": "#/components/schemas/FeatureDependency"
              },
              "minItems": 0,
              "type": "array",
              "x-etsi-mec-cardinality": "0..N",
              "x-etsi-mec-origin-type": "FeatureDependency"
            },
            "appFeatureRequired": {
              "description": "Describes features a MEC application requires to run.",
              "items": {
                "$ref": "#/components/schemas/FeatureDependency"
              },
              "minItems": 0,
              "type": "array",
              "x-etsi-mec-cardinality": "0..N",
              "x-etsi-mec-origin-type": "FeatureDependency"
            },
            "appInfoName": {
              "description": "Human readable name for the MEC application.",
              "type": "string",
              "x-etsi-mec-cardinality": "0..1",
              "x-etsi-mec-origin-type": "String"
            },
            "appLatency": {
              "$ref": "#/components/schemas/LatencyDescriptor"
            },
            "appName": {
              "description": "Name to identify the MEC application.",
              "type": "string",
              "x-etsi-mec-cardinality": "1",
              "x-etsi-mec-origin-type": "String"
            },
            "appProvider": {
              "description": "Provider of the application and of the AppD.",
              "type": "string",
              "x-etsi-mec-cardinality": "1",
              "x-etsi-mec-origin-type": "String"
            },
            "appServiceOptional": {
              "description": "Describes services a MEC application may use if available.",
              "items": {
                "$ref": "#/components/schemas/ServiceDependency"
              },
              "minItems": 0,
              "type": "array",
              "x-etsi-mec-cardinality": "0..N",
              "x-etsi-mec-origin-type": "ServiceDependency"
            },
            "appServiceProduced": {
              "description": "Describes services a MEC application is able to produce to the platform or other MEC applications. Only relevant for service-producing apps.",
              "items": {
                "$ref": "#/components/schemas/ServiceDescriptor"
              },
              "minItems": 0,
              "type": "array",
              "x-etsi-mec-cardinality": "0..N",
              "x-etsi-mec-origin-type": "ServiceDescriptor"
            },
            "appServiceRequired": {
              "description": "Describes services a MEC application requires to run.",
              "items": {
                "$ref": "#/components/schemas/ServiceDependency"
              },
              "minItems": 0,
              "type": "array",
              "x-etsi-mec-cardinality": "0..N",
              "x-etsi-mec-origin-type": "ServiceDependency"
            },
            "appSoftVersion": {
              "description": "Identifies the version of software of the MEC application.",
              "type": "string",
              "x-etsi-mec-cardinality": "1",
              "x-etsi-mec-origin-type": "String"
            },
            "appTrafficRule": {
              "description": "Describes traffic rules the MEC application requires.",
              "items": {
                "$ref": "#/components/schemas/TrafficRuleDescriptor"
              },
              "minItems": 0,
              "type": "array",
              "x-etsi-mec-cardinality": "0..N",
              "x-etsi-mec-origin-type": "TrafficRuleDescriptor"
            },
            "changeAppInstanceStateOpConfig": {
              "$ref": "#/components/schemas/ChangeAppInstanceStateOpConfig"
            },
            "mecVersion": {
              "description": "Identifies version(s) of MEC system compatible with the MEC application described in this version of the AppD.",
              "items": {
                "type": "string"
              },
              "minItems": 1,
              "type": "array",
              "x-etsi-mec-cardinality": "1..N",
              "x-etsi-mec-origin-type": "String"
            },
            "swImageDescriptor": {
              "$ref": "#/components/schemas/SwImageDescriptor"
            },
            "terminateAppInstanceOpConfig": {
              "$ref": "#/components/schemas/TerminateAppInstanceOpConfig"
            },
            "transportDependencies": {
              "description": "Transports, if any, that this application requires to be provided by the platform. These transports will be used by the application to deliver services provided by this application. Only relevant for service-producing apps. See note 2.",
              "items": {
                "$ref": "#/components/schemas/TransportDependency"
              },
              "minItems": 0,
              "type": "array",
              "x-etsi-mec-cardinality": "0..N",
              "x-etsi-mec-origin-type": "TransportDependency"
            },
            "virtualComputeDescriptor": {
              "$ref": "#/components/schemas/VirtualComputeDescription"
            },
            "virtualStorageDescriptor": {
              "description": "Defines descriptors of virtual storage resources to be used by the MEC application.",
              "items": {
                "$ref": "#/components/schemas/VirtualStorageDescriptor"
              },
              "minItems": 0,
              "type": "array",
              "x-etsi-mec-cardinality": "0..N",
              "x-etsi-mec-origin-type": "VirtualStorageDescriptor"
            }
1084
          },
Elian Kraja's avatar
Elian Kraja committed
1085
1086
1087
1088
1089
1090
1091
1092
1093
1094
1095
1096
1097
1098
          "required": [
            "appDId",
            "appName",
            "appProvider",
            "appSoftVersion",
            "appDVersion",
            "mecVersion",
            "appDescription",
            "virtualComputeDescriptor",
            "swImageDescriptor"
          ],
          "type": "object",
          "x-etsi-notes": "NOTE 1:\tThe appDId shall be used as the unique identifier of the application package that contains this AppD.\nNOTE 2:\tThis attribute indicates groups of transport bindings which a service-producing MEC application requires to be supported by the platform in order to be able to produce its services. At least one of the indicated groups needs to be supported to fulfil the requirements.",
          "x-etsi-ref": "6.2.1.2"
1099
        },
Elian Kraja's avatar
Elian Kraja committed
1100
1101
1102
1103
1104
1105
1106
1107
1108
1109
1110
1111
1112
1113
1114
1115
1116
        "AppExternalCpd": {
          "properties": {
            "inherited_attributes": {
              "description": "All attributes inherited from Cpd.",
              "type": "object",
              "x-etsi-mec-cardinality": "1",
              "x-etsi-mec-origin-type": "inherited_attributes"
            },
            "virtualNetworkInterfaceRequirements": {
              "description": "Specifies requirements on a virtual network interface realizing the CPs instantiated from this CPD.",
              "items": {
                "$ref": "#/components/schemas/VirtualNetworkInterfaceRequirements"
              },
              "minItems": 0,
              "type": "array",
              "x-etsi-mec-cardinality": "0..N"
            }
1117
          },
Elian Kraja's avatar
Elian Kraja committed
1118
1119
1120
1121
1122
          "required": [
            "inherited_attributes"
          ],
          "type": "object",
          "x-etsi-ref": "6.2.1.6"
1123
        },
Elian Kraja's avatar
Elian Kraja committed
1124
1125
1126
1127
1128
1129
1130
1131
1132
1133
1134
1135
1136
1137
1138
1139
1140
1141
1142
1143
1144
1145
1146
1147
1148
1149
1150
1151
1152
1153
1154
1155
1156
1157
1158
1159
1160
1161
1162
1163
1164
1165
1166
1167
1168
1169
1170
1171
1172
1173
1174
1175
1176
1177
1178
1179
1180
1181
1182
1183
1184
1185
1186
1187
1188
1189
1190
1191
1192
1193
1194
1195
1196
1197
1198
1199
1200
1201
1202
1203
1204
1205
1206
1207
1208
1209
1210
1211
1212
1213
        "CallbackUri": {
          "description": "The URI of the endpoint for the notification to be sent to.",
          "type": "string",
          "format": "uri"
        },
        "AppDId": {
          "description": "Identifier of this MEC application descriptor. This attribute shall be globally unique.",
          "type": "string"
        },
        "AppProvider": {
          "description": "Provider of the application and of the AppD.",
          "type": "string"
        },
        "AppName": {
          "description": "Name to identify the MEC application.",
          "type": "string"
        },
        "AppDVersion": {
          "description": "Identifies the version of the application descriptor.",
          "type": "string"
        },
        "AppPkgId": {
          "description": "Identifier of the onboarded application package.",
          "type": "string"
        },
        "SubscriptionId": {
          "description": "Identifier of the subscription related to this notification.",
          "type": "string"
        },
        "AppPkgArtifactInfo": {
          "description": "Additional information of application package artifacts that are not application software images. Type is TBD"
        },
        "AppPkgInfo": {
          "description": "'The data type AppPkgInfo represents the parameters for an application package resource'",
          "type": "object",
          "required": [
            "id",
            "appDId",
            "appName",
            "appSoftwareVersion",
            "appDVersion",
            "checksum",
            "softwareImages",
            "onboardingState",
            "operationalState",
            "usageState",
            "_links"
          ],
          "properties": {
            "id": {
              "$ref": "#/components/schemas/AppPkgId"
            },
            "appDId": {
              "$ref": "#/components/schemas/AppDId"
            },
            "appProvider": {
              "$ref": "#/components/schemas/AppProvider"
            },
            "appName": {
              "$ref": "#/components/schemas/AppName"
            },
            "appSoftwareVersion": {
              "$ref": "#/components/schemas/AppSoftwareVersion"
            },
            "appDVersion": {
              "$ref": "#/components/schemas/AppDVersion"
            },
            "checksum": {
              "$ref": "#/components/schemas/Checksum"
            },
            "softwareImages": {
              "$ref": "#/components/schemas/AppPkgSWImageInfo"
            },
            "additionalArtifacts": {
              "$ref": "#/components/schemas/AppPkgArtifactInfo"
            },
            "onboardingState": {
              "$ref": "#/components/schemas/OnboardingState"
            },
            "operationalState": {
              "$ref": "#/components/schemas/AppPkg.OperationalState"
            },
            "usageState": {
              "$ref": "#/components/schemas/UsageState"
            },
            "userDefinedData": {
              "$ref": "#/components/schemas/KeyValuePairs"
            },
            "_links": {
              "$ref": "#/components/schemas/AppPkgInfo.links"
1214
1215
            }
          }
Elian Kraja's avatar
Elian Kraja committed
1216
1217
1218
1219
1220
1221
1222
1223
1224
1225
1226
1227
1228
1229
        },
        "AppPkgInfoModifications": {
          "description": "'The data type represents the operational state for an application package resource'",
          "type": "object",
          "required": [
            "operationState"
          ],
          "properties": {
            "operationState": {
              "type": "string",
              "enum": [
                "DISABLED",
                "ENABLED"
              ]
1230
1231
1232
            }
          }
        },
Elian Kraja's avatar
Elian Kraja committed
1233
1234
1235
        "AppSoftwareVersion": {
          "description": "Software version of the application. This is updated when there is any change to the software in the onboarded application package.",
          "type": "string"
1236
        },
Elian Kraja's avatar
Elian Kraja committed
1237
1238
1239
1240
1241
1242
1243
1244
1245
1246
1247
1248
1249
1250
1251
1252
1253
1254
1255
1256
1257
1258
1259
1260
1261
1262
1263
1264
1265
1266
1267
1268
1269
1270
1271
1272
1273
1274
1275
1276
1277
1278
1279
1280
1281
1282
1283
1284
1285
1286
1287
        "AppPkg.OperationalState": {
          "description": "Operational state of the onboarded application package: •ENABLED: the application package can be used for instantiation of new application instances. •DISABLED: the application package cannot be used for further application instantiation requests.",
          "type": "string",
          "enum": [
            "ENABLED",
            "DISABLED"
          ]
        },
        "OnboardingState": {
          "description": "Onboarding state of application package",
          "type": "string",
          "format": "enum",
          "enum": [
            "CREATED",
            "UPLOADING",
            "PROCESSING",
            "ONBOARDED"
          ]
        },
        "UsageState": {
          "description": "Usage state of the onboarded instance of the application package",
          "type": "string",
          "format": "enum",
          "enum": [
            "IN_USE",
            "NOT_IN_USE"
          ]
        },
        "KeyValuePairs": {
          "description": "'This data type represents a list of key-value pairs. The order of the pairs in the list is not significant. In JSON, a set of key-value pairs is represented as an object. It shall comply with the provisions defined in clause 4 of IETF RFC 8259'",
          "type": "object",
          "additionalProperties": true
        },
        "AppPkgInfo.links": {
          "description": "Links to resources related to this resource.",
          "type": "object",
          "required": [
            "self",
            "appD",
            "appPkgContent"
          ],
          "properties": {
            "self": {
              "$ref": "#/components/schemas/LinkType"
            },
            "appD": {
              "$ref": "#/components/schemas/LinkType"
            },
            "appPkgContent": {
              "$ref": "#/components/schemas/LinkType"
            }
1288
1289
          }
        },
Elian Kraja's avatar
Elian Kraja committed
1290
1291
1292
1293
1294
1295
1296
1297
1298
1299
1300
1301
1302
1303
1304
1305
1306
1307
1308
1309
1310
1311
1312
1313
1314
1315
1316
1317
1318
1319
1320
1321
1322
1323
1324
1325
1326
1327
1328
1329
1330
1331
        "AppPkgNotification": {
          "description": "'This data type represents an application package management notification for informing the subscribers about onboarding application package resources. The notification is triggered when a new application package is onboarded'",
          "type": "object",
          "required": [
            "id",
            "notificationType",
            "subscriptionId",
            "timeStamp",
            "appPkgId",
            "appDId",
            "operationalState",
            "_links"
          ],
          "properties": {
            "id": {
              "$ref": "#/components/schemas/AppPkgNotification.Id"
            },
            "notificationType": {
              "$ref": "#/components/schemas/AppPkg.NotificationType"
            },
            "subscriptionId": {
              "$ref": "#/components/schemas/SubscriptionId"
            },
            "timeStamp": {
              "$ref": "#/components/schemas/TimeStamp"
            },
            "appPkgId": {
              "$ref": "#/components/schemas/AppPkgId"
            },
            "appDId": {
              "$ref": "#/components/schemas/AppDId"
            },
            "operationalState": {
              "type": "string",
              "enum": [
                "DISABLED",
                "ENABLED"
              ]
            },
            "_links": {
              "$ref": "#/components/schemas/AppPkgNotification.links"
            }
1332
1333
          }
        },
Elian Kraja's avatar
Elian Kraja committed
1334
1335
1336
1337
1338
1339
1340
1341
1342
1343
1344
1345
1346
1347
1348
1349
1350
1351
1352
1353
1354
1355
1356
1357
        "AppPkgNotification.Id": {
          "description": "''",
          "type": "string"
        },
        "AppPkg.NotificationType": {
          "description": "Discriminator for the different notification types",
          "type": "string",
          "enum": [
            "AppPackageOnBoarded",
            "AppPacakgeEnabled",
            "AppPacakgeDisabled",
            "AppPackageDeleted"
          ]
        },
        "AppPkgNotification.links": {
          "description": "Links to resources related to this resource.",
          "type": "object",
          "required": [
            "subscription"
          ],
          "properties": {
            "subscription": {
              "$ref": "#/components/schemas/LinkType"
            }
1358
1359
          }
        },
Elian Kraja's avatar
Elian Kraja committed
1360
1361
1362
1363
1364
1365
1366
1367
1368
1369
1370
1371
1372
1373
1374
1375
1376
1377
1378
1379
1380
1381
1382
1383
1384
        "AppPkgSWImageInfo": {
          "description": "Information of application software image in application package. Type is TBD"
        },
        "AppPkgSubscriptionInfo": {
          "description": "'The data type represents a subscription to notification of application package management for the onboarding, or operational state change of application package'",
          "type": "object",
          "required": [
            "id",
            "subscriptionType",
            "callbackUri",
            "_links"
          ],
          "properties": {
            "id": {
              "$ref": "#/components/schemas/AppPkgSubscriptionInfo.Id"
            },
            "subscriptionType": {
              "$ref": "#/components/schemas/AppPkg.SubscriptionType"
            },
            "callbackUri": {
              "$ref": "#/components/schemas/CallbackUri"
            },
            "_links": {
              "$ref": "#/components/schemas/AppPkgSubscriptionInfo.links"
            }
1385
1386
          }
        },
Elian Kraja's avatar
Elian Kraja committed
1387
1388
1389
1390
1391
1392
1393
1394
1395
1396
1397
1398
1399
1400
1401
1402
1403
1404
1405
1406
1407
1408
1409
        "AppPkgSubscriptionInfo.Id": {
          "description": "''",
          "type": "string"
        },
        "AppPkg.SubscriptionType": {
          "description": "Subscribed notification type.",
          "type": "string",
          "enum": [
            "AppPackageOnBoarding",
            "AppPacakgeOperationChange",
            "AppPackageDeletion"
          ]
        },
        "AppPkgSubscriptionInfo.links": {
          "description": "Links to resources related to this resource.",
          "type": "object",
          "required": [
            "self"
          ],
          "properties": {
            "self": {
              "$ref": "#/components/schemas/LinkType"
            }
1410
1411
          }
        },
Elian Kraja's avatar
Elian Kraja committed
1412
1413
1414
1415
1416
1417
1418
1419
1420
1421
        "AppPkgSubscriptionLinkList": {
          "description": "'The data type represents a subscription link list of notification on application package management'",
          "type": "object",
          "required": [
            "_links"
          ],
          "properties": {
            "_links": {
              "$ref": "#/components/schemas/AppPkgSubscriptionLinkList.links"
            }
1422
1423
          }
        },
Elian Kraja's avatar
Elian Kraja committed
1424
1425
1426
1427
1428
1429
1430
1431
1432
        "AppPkgSubscriptionLinkList.links": {
          "description": "Links to resources related to this resource.",
          "type": "object",
          "required": [
            "self"
          ],
          "properties": {
            "self": {
              "$ref": "#/components/schemas/LinkType"
1433
            },
Elian Kraja's avatar
Elian Kraja committed
1434
1435
1436
1437
1438
1439
            "subscriptions": {
              "type": "array",
              "items": {
                "$ref": "#/components/schemas/Subscriptions.AppPkgSubscription"
              }
            }
1440
1441
          }
        },
Elian Kraja's avatar
Elian Kraja committed
1442
1443
1444
1445
1446
1447
1448
1449
1450
1451
1452
1453
1454
1455
        "Subscriptions.AppPkgSubscription": {
          "description": "'The data type represents the input parameters of \"subscription operation\" to notification of application package management for the onboarding, or operational state change of application package.'",
          "type": "object",
          "required": [
            "href",
            "subsctiptionType"
          ],
          "properties": {
            "href": {
              "$ref": "#/components/schemas/Href"
            },
            "subsctiptionType": {
              "$ref": "#/components/schemas/SubsctiptionType.AppPkg"
            }
1456
          }
Elian Kraja's avatar
Elian Kraja committed
1457
1458
1459
1460
1461
1462
1463
1464
1465
1466
1467
1468
1469
1470
1471
1472
1473
1474
1475
1476
1477
1478
1479
1480
1481
1482
        },
        "Href": {
          "description": "The URI referring to the subscription.",
          "type": "string",
          "format": "uri"
        },
        "AppPkgSubscription": {
          "description": "'The data type represents the input parameters of \"subscription operation\" to notification of application package management for the onboarding, or operational state change of application package.'",
          "type": "object",
          "required": [
            "callbackUri",
            "subsctiptionType"
          ],
          "properties": {
            "callbackUri": {
              "$ref": "#/components/schemas/CallbackUri"
            },
            "subsctiptionType": {
              "$ref": "#/components/schemas/SubsctiptionType.AppPkg"
            },
            "appPkgFilter": {
              "type": "array",
              "items": {
                "$ref": "#/components/schemas/AppPkgFilter"
              }
            }
1483
1484
          }
        },
Elian Kraja's avatar
Elian Kraja committed
1485
1486
1487
1488
1489
1490
1491
1492
1493
1494
1495
1496
1497
1498
1499
1500
1501
1502
1503
1504
1505
1506
        "SubsctiptionType.AppPkg": {
          "description": "'Subscribed notification type'",
          "type": "string",
          "enum": [
            "AppPackageOnBoarding",
            "AppPacakgeOperationChange",
            "AppPackageDeletion"
          ]
        },
        "AppPkgFilter": {
          "type": "string",
          "description": "The attribute-based filter is to filter application packages on which the query applies."
        },
        "ChangeAppInstanceStateOpConfig": {
          "description": "NFV",
          "type": "string"
        },
        "Checksum": {
          "description": "",
          "properties": {
            "algorithm": {
              "$ref": "#/components/schemas/Algorithm"
1507
            },
Elian Kraja's avatar
Elian Kraja committed
1508
1509
1510
            "hash": {
              "$ref": "#/components/schemas/Hash"
            }
1511
          },
Elian Kraja's avatar
Elian Kraja committed
1512
1513
1514
1515
1516
1517
1518
1519
1520
1521
1522
1523
1524
          "required": [
            "algorithm",
            "hash"
          ],
          "type": "object"
        },
        "CreateAppPkg": {
          "properties": {
            "appPkgName": {
              "description": "Name of the application package to be onboarded.",
              "type": "string",
              "x-etsi-mec-cardinality": "1",
              "x-etsi-mec-origin-type": "String"
1525
            },
Elian Kraja's avatar
Elian Kraja committed
1526
1527
            "appPkgPath": {
              "$ref": "#/components/schemas/URI"
1528
            },
Elian Kraja's avatar
Elian Kraja committed
1529
1530
1531
1532
1533
            "appPkgVersion": {
              "description": "Version of the application package to be onboarded.\nThe appPkgName with appPkgVersion can be used to uniquely identify the application package.",
              "type": "string",
              "x-etsi-mec-cardinality": "1",
              "x-etsi-mec-origin-type": "String"
1534
            },
Elian Kraja's avatar
Elian Kraja committed
1535
1536
1537
1538
1539
            "appProvider": {
              "description": "The provider's name of the application package to be onboarded.",
              "type": "string",
              "x-etsi-mec-cardinality": "0..1",
              "x-etsi-mec-origin-type": "String"
1540
            },
Elian Kraja's avatar
Elian Kraja committed
1541
1542
            "checksum": {
              "$ref": "#/components/schemas/Checksum"
1543
            },
Elian Kraja's avatar
Elian Kraja committed
1544
1545
1546
            "userDefinedData": {
              "$ref": "#/components/schemas/KeyValuePairs"
            }
1547
          },
Elian Kraja's avatar
Elian Kraja committed
1548
1549
1550
1551
1552
1553
1554
1555
1556
1557
1558
1559
1560
1561
1562
1563
1564
          "required": [
            "appPkgName",
            "appPkgVersion",
            "checksum",
            "appPkgPath"
          ],
          "type": "object",
          "x-etsi-notes": "NOTE:\tIt is for further study how to convey appPkgPath, and align with ETSI GS NFV-SOL 005 [i.7].",
          "x-etsi-ref": "6.2.3.2"
        },
        "DNSRuleDescriptor": {
          "properties": {
            "dnsRuleId": {
              "description": "Identifies the DNS Rule",
              "type": "string",
              "x-etsi-mec-cardinality": "1",
              "x-etsi-mec-origin-type": "String"
1565
            },
Elian Kraja's avatar
Elian Kraja committed
1566
1567
1568
1569
1570
            "domainName": {
              "description": "FQDN of the DNS rule",
              "type": "string",
              "x-etsi-mec-cardinality": "1",
              "x-etsi-mec-origin-type": "String"
1571
            },
Elian Kraja's avatar
Elian Kraja committed
1572
1573
1574
1575
1576
            "ipAddress": {
              "description": "IP address given by the DNS rule",
              "type": "string",
              "x-etsi-mec-cardinality": "1",
              "x-etsi-mec-origin-type": "String"
1577
            },
Elian Kraja's avatar
Elian Kraja committed
1578
1579
1580
1581
1582
1583
1584
1585
1586
            "ipAddressType": {
              "$ref": "#/components/schemas/IpAddressType"
            },
            "ttl": {
              "description": "Time-to-live value",
              "type": "integer",
              "x-etsi-mec-cardinality": "0..1",
              "x-etsi-mec-origin-type": "Int"
            }
1587
          },
Elian Kraja's avatar
Elian Kraja committed
1588
1589
1590
1591
1592
1593
1594
1595
1596
1597
1598
1599
1600
1601
1602
1603
1604
1605
1606
1607
1608
1609
1610
1611
          "required": [
            "dnsRuleId",
            "domainName",
            "ipAddressType",
            "ipAddress"
          ],
          "type": "object",
          "x-etsi-ref": "6.2.1.13"
        },
        "IpAddressType": {
          "description": "Specifies the IP address type",
          "type": "string",
          "enum": [
            "IP_V6",
            "IP_V4"
          ]
        },
        "FeatureDependency": {
          "properties": {
            "featureName": {
              "description": "The name of the feature, for example, UserApps, UEIdentity, etc.",
              "type": "string",
              "x-etsi-mec-cardinality": "1",
              "x-etsi-mec-origin-type": "String"
1612
            },
Elian Kraja's avatar
Elian Kraja committed
1613
1614
1615
1616
1617
1618
1619
1620
1621
1622
1623
1624
1625
            "version": {
              "description": "The version of the feature.",
              "type": "string",
              "x-etsi-mec-cardinality": "1",
              "x-etsi-mec-origin-type": "String"
            }
          },
          "required": [
            "featureName",
            "version"
          ],
          "type": "object",
          "x-etsi-ref": "6.2.1.8"
1626
        },
Elian Kraja's avatar
Elian Kraja committed
1627
1628
1629
1630
1631
1632
1633
1634
1635
1636
1637
1638
1639
1640
1641
1642
1643
1644
1645
1646
1647
1648
1649
1650
1651
1652
1653
1654
1655
1656
        "Hash": {
          "description": "'String 1 The hexadecimal value of the checksum'",
          "type": "string"
        },
        "InterfaceDescriptor": {
          "properties": {
            "dstIPAddress": {
              "description": "If the interface type is IP, the destination address identifies the IP address of the destination. Only used for dstInterface.",
              "type": "string",
              "x-etsi-mec-cardinality": "0..1",
              "x-etsi-mec-origin-type": "String"
            },
            "dstMACAddress": {
              "description": "If the interface type is MAC, the destination address identifies the MAC address of the destination. Only used for dstInterface.",
              "type": "string",
              "x-etsi-mec-cardinality": "0..1",
              "x-etsi-mec-origin-type": "String"
            },
            "interfaceType": {
              "$ref": "#/components/schemas/InterfaceType"
            },
            "srcMACAddress": {
              "description": "If the interface type is MAC, the source address identifies the MAC address of the interface.",
              "type": "string",
              "x-etsi-mec-cardinality": "0..1",
              "x-etsi-mec-origin-type": "String"
            },
            "tunnelInfo": {
              "$ref": "#/components/schemas/TunnelInfo"
            }
1657
          },
Elian Kraja's avatar
Elian Kraja committed
1658
1659
1660
1661
1662
1663
1664
1665
1666
1667
1668
1669
1670
1671
1672
1673
1674
1675
1676
1677
1678
1679
1680
          "required": [
            "interfaceType"
          ],
          "type": "object",
          "x-etsi-ref": "6.2.1.11"
        },
        "InterfaceType": {
          "description": "Type of interface.",
          "type": "string",
          "enum": [
            "TUNNEL",
            "MAC",
            "IP"
          ]
        },
        "LatencyDescriptor": {
          "properties": {
            "maxLatency": {
              "description": "The value of the maximum latency in nano seconds tolerated by the MEC application. See note.",
              "format": "Uint32",
              "type": "integer",
              "x-etsi-mec-cardinality": "1",
              "x-etsi-mec-origin-type": "Uint32"
1681
1682
            }
          },
Elian Kraja's avatar
Elian Kraja committed
1683
1684
1685
1686
1687
1688
1689
1690
1691
1692
1693
1694
1695
1696
1697
1698
          "required": [
            "maxLatency"
          ],
          "type": "object",
          "x-etsi-notes": "NOTE:\tThe latency is considered to be the one way end-to-end latency between the client application (e.g. in a device) and the service (i.e. the MEC Application instance).",
          "x-etsi-ref": "6.2.1.14"
        },
        "LinkType": {
          "properties": {
            "href": {
              "description": "URI referring to a resource",
              "format": "uri",
              "type": "string",
              "x-etsi-mec-cardinality": "1",
              "x-etsi-mec-origin-type": "URI"
            }
1699
          },
Elian Kraja's avatar
Elian Kraja committed
1700
1701
1702
1703
1704
1705
1706
1707
1708
1709
1710
1711
1712
1713
1714
1715
1716
1717
1718
1719
1720
1721
1722
1723
1724
1725
1726
1727
1728
1729
1730
1731
1732
1733
1734
1735
1736
1737
1738
1739
1740
          "required": [
            "href"
          ],
          "type": "object",
          "x-etsi-ref": "6.5.2"
        },
        "ProblemDetails": {
          "properties": {
            "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"
            },
            "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"
            },
            "status": {
              "description": "The HTTP status code for this occurrence of the problem",
              "format": "uint32",
              "type": "integer",
              "x-etsi-mec-cardinality": "0..1",
              "x-etsi-mec-origin-type": "Uint32"
            },
            "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"
            },
            "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"
            }
1741
          },
Elian Kraja's avatar
Elian Kraja committed
1742
1743
1744
1745
1746
1747
1748
1749
1750
1751
1752
1753
1754
1755
1756
1757
1758
1759
1760
1761
1762
1763
1764
1765
1766
1767
1768
1769
1770
1771
1772
1773
1774
1775
1776
1777
1778
1779
1780
1781
1782
1783
          "type": "object"
        },
        "SerializerTypes": {
          "type": "string"
        },
        "ServiceDependency": {
          "properties": {
            "requestedPermissions": {
              "description": "Requested permissions regarding the access of the application to the service. See clause 8.2 of ETSI GS MEC 009 [4].\nThe format of this attribute is left for the data model design stage.",
              "items": {
                "$ref": "#/components/schemas/Not_specified"
              },
              "minItems": 0,
              "type": "array",
              "x-etsi-mec-cardinality": "0..N",
              "x-etsi-mec-origin-type": "Not_specified"
            },
            "serCategory": {
              "$ref": "#/components/schemas/CategoryRef"
            },
            "serName": {
              "description": "The name of the service, for example, RNIS, LocationService, etc.",
              "type": "string",
              "x-etsi-mec-cardinality": "1",
              "x-etsi-mec-origin-type": "String"
            },
            "serTransportDependencies": {
              "description": "Indicates transport and serialization format dependencies of consuming the service. Defaults to REST + JSON if absent. See note.",
              "items": {
                "$ref": "#/components/schemas/TransportDependency"
              },
              "minItems": 0,
              "type": "array",
              "x-etsi-mec-cardinality": "0..N",
              "x-etsi-mec-origin-type": "TransportDependency"
            },
            "version": {
              "description": "The version of the service.",
              "type": "string",
              "x-etsi-mec-cardinality": "1",
              "x-etsi-mec-origin-type": "String"
            }
1784
          },
Elian Kraja's avatar
Elian Kraja committed
1785
1786
1787
1788
1789
1790
1791
1792
1793
1794
1795
1796
1797
1798
1799
1800
1801
1802
1803
1804
1805
1806
1807
1808
1809
1810
1811
1812
          "required": [
            "serName",
            "version"
          ],
          "type": "object",
          "x-etsi-notes": "NOTE:\tThis attribute indicates groups of transport bindings that a service-consuming MEC application supports for the consumption of the MEC service defined by this ServiceDependency structure. If at least one of the indicated groups is supported by the service it may be consumed by the application.",
          "x-etsi-ref": "6.2.1.17"
        },
        "ServiceDescriptor": {
          "description": "'The ServiceDescriptor data type describes a MEC service produced by a service-providing MEC application.'",
          "type": "object",
          "required": [
            "serName",
            "version"
          ],
          "properties": {
            "serName": {
              "$ref": "#/components/schemas/SerName"
            },
            "serCategory": {
              "$ref": "#/components/schemas/CategoryRef"
            },
            "version": {
              "$ref": "#/components/schemas/SerVersion"
            },
            "transportsSupported": {
              "$ref": "#/components/schemas/TransportsSupported"
            }
1813
1814
          }
        },
Elian Kraja's avatar
Elian Kraja committed
1815
1816
1817
1818
1819
1820
1821
1822
1823
1824
1825
1826
1827
1828
1829
1830
1831
1832
        "SerName": {
          "description": "The name of the service, for example, RNIS, LocationService, etc.",
          "type": "string"
        },
        "SerVersion": {
          "description": "The version of the service.",
          "type": "string"
        },
        "TransportsSupported": {
          "description": "'Indicates transports and serialization formats supported made available to the service-consuming application. Defaults to REST + JSON if absent.'",
          "type": "object",
          "required": [
            "featureName",
            "version"
          ],
          "properties": {
            "transport": {
              "$ref": "#/components/schemas/TransportDescriptor"
1833
            },
Elian Kraja's avatar
Elian Kraja committed
1834
1835
1836
            "serializers": {
              "$ref": "#/components/schemas/Serializers"
            }
1837
1838
          }
        },
Elian Kraja's avatar
Elian Kraja committed
1839
1840
1841
1842
1843
1844
1845
1846
1847
1848
1849
1850
1851
1852
1853
1854
1855
1856
1857
1858
1859
1860
1861
1862
1863
1864
1865
1866
1867
1868
1869
1870
1871
        "Serializers": {
          "description": "'Information about the serializers in this binding, as defined in the SerializerTypes type in ETSI GS MEC 011 '",
          "type": "array",
          "minItems": 1,
          "items": {
            "$ref": "#/components/schemas/SerializerTypes"
          }
        },
        "SwImageDescriptor": {
          "description": "Ref NFV",
          "type": "string"
        },
        "TerminateAppInstanceOpConfig": {
          "description": "NFV",
          "type": "string",
          "x-etsi-ref": "6.2.2.9"
        },
        "TimeStamp": {
          "properties": {
            "nanoSeconds": {
              "description": "The nanoseconds part of the Time. Time is defined as Unix-time since January 1, 1970, 00:00:00 UTC.",
              "format": "Uint32",
              "type": "integer",
              "x-etsi-mec-cardinality": "1",
              "x-etsi-mec-origin-type": "Uint32"
            },
            "seconds": {
              "description": "The seconds part of the Time. Time is defined as Unix-time since January 1, 1970, 00:00:00 UTC.",
              "format": "Uint32",
              "type": "integer",
              "x-etsi-mec-cardinality": "1",
              "x-etsi-mec-origin-type": "Uint32"
            }
1872
          },
Elian Kraja's avatar
Elian Kraja committed
1873
1874
1875
1876
1877
1878
1879
1880
1881
1882
1883
1884
1885
1886
1887
1888
1889
1890
1891
1892
1893
1894
1895
1896
1897
1898
1899
1900
1901
1902
1903
1904
1905
1906
1907
1908
1909
1910
1911
1912
1913
1914
1915
1916
1917
1918
1919
1920
1921
1922
1923
1924
1925
1926
1927
1928
1929
1930
1931
1932
1933
1934
1935
1936
1937
1938
1939
1940
1941
1942
1943
1944
1945
1946
1947
1948
1949
1950
1951
1952
1953
1954
1955
1956
1957
1958
1959
1960
1961
1962
1963
1964
1965
1966
1967
1968
1969
1970
1971
1972
1973
1974
1975
1976
1977
1978
1979
1980
1981
1982
1983
1984
1985
1986
1987
1988
1989
1990
1991
1992
1993
1994
1995
1996
1997
1998
1999
          "required": [
            "seconds",
            "nanoSeconds"
          ],
          "type": "object",
          "x-etsi-ref": "6.2.5.4"
        },
        "TrafficFilter": {
          "properties": {
            "dSCP": {
              "description": "Used to match all IPv4 packets that have the same DSCP.",
              "type": "integer",
              "x-etsi-mec-cardinality": "0..1",
              "x-etsi-mec-origin-type": "Int"
            },
            "dstAddress": {
              "description": "A IP address or a range of IP addresses.For IPv4, the IP address could be an IP address plus mask, or an individual IP address, or a range of IP addresses.For IPv6, the IP address could be an IP prefix, or a range of IP prefixes.",
              "items": {
                "type": "string"
              },
              "minItems": 0,
              "type": "array",
              "x-etsi-mec-cardinality": "0..N",
              "x-etsi-mec-origin-type": "String"
            },
            "dstPort": {
              "description": "A port or a range of ports.",
              "items": {
                "type": "string"
              },
              "minItems": 0,
              "type": "array",
              "x-etsi-mec-cardinality": "0..N",
              "x-etsi-mec-origin-type": "String"
            },
            "dstTunnelPort": {
              "description": "Used for GTP tunnel based traffic rule.",
              "items": {
                "type": "string"
              },
              "minItems": 0,
              "type": "array",
              "x-etsi-mec-cardinality": "0..N",
              "x-etsi-mec-origin-type": "String"
            },
            "protocol": {
              "description": "Specify the protocol of the traffic filter.",
              "items": {
                "type": "string"
              },
              "minItems": 0,
              "type": "array",
              "x-etsi-mec-cardinality": "0..N",
              "x-etsi-mec-origin-type": "String"
            },
            "qCI": {
              "description": "Used to match all packets that have the same QCI.",
              "type": "integer",
              "x-etsi-mec-cardinality": "0..1",
              "x-etsi-mec-origin-type": "Int"
            },
            "srcAddress": {
              "description": "An IP address or a range of IP addresses.For IPv4, the IP address could be an IP address plus mask, or an individual IP address, or a range of IP addresses.For IPv6, the IP address could be an IP prefix, or a range of IP prefixes.",
              "items": {
                "type": "string"
              },
              "minItems": 0,
              "type": "array",
              "x-etsi-mec-cardinality": "0..N",
              "x-etsi-mec-origin-type": "String"
            },
            "srcPort": {
              "description": "A port or a range of ports.",
              "items": {
                "type": "string"
              },
              "minItems": 0,
              "type": "array",
              "x-etsi-mec-cardinality": "0..N",
              "x-etsi-mec-origin-type": "String"
            },
            "srcTunnelAddress": {
              "description": "Used for GTP tunnel based traffic rule.",
              "items":