Newer
Older
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'
name: ETSI Forge
email: cti_support@etsi.org
url: https://forge.etsi.org/rep/mec/gs010-2-app-pkg-lcm-api
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'
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
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
content:
application/json:
schema:
$ref: '#/components/schemas/CreateAppPkg'
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'
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'
- 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: '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:
- in: path
name: appPkgId
schema:
type: string
required: true
description: 'Identifier of an individual application package resource'
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:
$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'
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
content:
application/json:
schema:
$ref: '#/components/schemas/AppPkgInfoModifications'
responses:
'200':
description: 'Shows that the operation has been completed successfully'
content:
application/json:
schema:
$ref: '#/components/schemas/AppPkgInfoModifications'
'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'
/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
content:
application/json:
schema:
$ref: '#/components/schemas/AppPkgSubscription'
responses:
'201':
description: Successful response for created subscription
content:
application/json:
schema:
$ref: '#/components/schemas/AppPkgSubscriptionInfo'
'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'
callbacks:
notification:
'{$request.body#/subscription.href}':
post:
summary: 'Callback POST used to send a notification'
description: ' The notification is triggered when a new application package is onboarded'
operationId: notificationPOST
requestBody:
description: Subscription notification
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/AppPkgNotification'
responses:
'204':
$ref: '#/components/responses/204'
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
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'
'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'
/subscriptions/{subscriptionId}:
parameters:
- in: path
name: subscriptionId
schema:
type: string
description: 'Identifier of an individual subscription to notifications about application package changes'
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
required: true
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'
'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'
###############################################################################
# Notification endpoint AppPkgNotification #
###############################################################################
/user_defined_notification:
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
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
content:
application/json:
schema:
$ref: '#/components/schemas/AppPkgNotification'
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'
/app_packages/{appPkgId}/appd:
parameters:
- in: path
name: appPkgId
schema:
type: string
description: 'Identifier of an on-boarded individual application package'
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
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'
- 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'
'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:
- in: path
name: appDId
schema:
type: string
description: 'Identifier of an application descriptor'
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
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: appDGET
parameters:
- in: query
name: filter
schema:
type: string
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'
'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}/package_content:
parameters:
- in: path
name: appPkgId
schema:
type: string
description: 'Identifier of an on-boarded individual application package'
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
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
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'
'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'
put:
tags:
- 'app-pkgm'
summary: 'Uploads the content of application package.'
description: 'Uploads the content of application package.'
operationId: appPkgPUT
requestBody:
content:
application/zip:
schema:
type: string
format: binary
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'
/onboarded_app_packages/{appDId}/package_content:
parameters:
- in: path
name: appDId
description: 'Identifier of an application descriptor'
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
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
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
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
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
870
871
872
873
874
875
876
877
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
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
schema:
type: string
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: 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'
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
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'
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
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:
# description': Describes the maximum latency tolerated by the MEC application.
# x-etsi-mec-cardinality': 0..1
# x-etsi-mec-origin-type': LatencyDescriptor
$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:
# description': Configuration parameters for the change application instance state operation.
# x-etsi-mec-cardinality': 0..1
# x-etsi-mec-origin-type': 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:
# description': Describes the software image which is directly loaded on the virtualisation machine instantiating this Application.
# x-etsi-mec-cardinality': '1'
# x-etsi-mec-origin-type': SwImageDescriptor
$ref: '#/components/schemas/SwImageDescriptor'
terminateAppInstanceOpConfig:
# description': Configuration parameters for the Terminate application instance operation.
# x-etsi-mec-cardinality': 0..1
# x-etsi-mec-origin-type': 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:
# description': Describes CPU, Memory and acceleration requirements of the virtual machine.
# x-etsi-mec-cardinality': '1'
# x-etsi-mec-origin-type': VirtualComputeDescription
$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
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
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
#x-etsi-mec-origin-type: VirtualNetworkInterfaceRequirements
required:
- inherited_attributes
type: object
x-etsi-ref: 6.2.1.6
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'
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
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
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'
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'
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'
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