Newer
Older
1
2
3
4
5
6
7
8
9
10
11
12
13
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
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
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
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
335
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
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
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
500
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
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
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
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'
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://{apiRoot}/app_lcm/v1/'
openapi: 3.0.0
tags:
- name: app-lcm
description: App lifecycle management
- name: app-lcm-notifications
description: App lifecycle management notifications
paths:
/app_instances:
post:
tags:
- ''
summary: 'Create an application instance resource'
description: 'Create an application instance resource'
operationId: appInstancePOST
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/CreateAppInstanceRequest'
responses:
'201':
description: 'An application instance identifier and the related resource has been created successfully.'
content:
application/zip:
schema:
$ref: '#/components/schemas/AppInstanceInfo'
'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:
- ''
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: appInstanceGET
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: 'Array the representations of zero or more application instances'
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/AppInstanceInfo'
'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_instances/{appInstanceId}:
parameters:
- in: path
name: appInstanceId
schema:
type: string
required: true
get:
tags:
- ''
summary: 'Retrieves the information of an individual application instance via reading an individual application instance.'
description: 'Retrieves the information of an individual application instance via reading an individual application instance.'
operationId: appInstanceIdGET
responses:
'200':
description: 'Contains a representation of the read resource.'
content:
application/json:
schema:
$ref: '#/components/schemas/AppInstanceInfo'
'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:
- ''
summary: 'Deletes an individual application instance resource.'
description: 'Deletes an individual application instance resource.'
operationId: appInstanceIdDELETE
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'
'409':
$ref: '#/components/responses/409'
'429':
$ref: '#/components/responses/429'
/subscriptions:
post:
tags:
- ''
summary: 'subscribe to the notification of application instance operational state change'
description: 'subscribe to the notification of application instance operational state change'
operationId: appLcmSubscriptionsPOST
parameters:
- in: query
name: subscriptionType
schema:
oneOf:
- $ref: '#/components/schemas/AppInst.SubscriptionType'
- $ref: '#/components/schemas/AppLcmOpOcc.SubscriptionType'
required: true
requestBody:
required: true
content:
application/json:
schema:
oneOf:
- $ref: '#/components/schemas/AppInstSubscriptionRequest'
- $ref: '#/components/schemas/AppLcmOpOccSubscriptionRequest'
responses:
'201':
description: 'a representation of the created SubscriptionInfo.'
content:
application/json:
schema:
oneOf:
- $ref: '#/components/schemas/AppInstSubscriptionInfo'
- $ref: '#/components/schemas/AppLcmOpOccSubscriptionInfo'
'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:
- ''
summary: 'Retrieves the information of multiple subscriptions to notifications related to an application instance.'
description: 'Retrieves the information of multiple subscriptions to notifications related to an application instance.'
operationId: appLcmSubscriptionsGET
parameters:
- in: query
name: subscriptionType
description: 'Permitted values: AppInstanceStateChange or AppLcmOpOccStateChange'
schema:
type: string
required: false
responses:
'200':
description: ' List of all subscriptions is returned.'
content:
application/json:
schema:
$ref: '#/components/schemas/SubscriptionLinkList'
'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
required: true
get:
tags:
- ''
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
parameters:
- in: query
name: subscriptionType
description: 'Permitted values: AppInstanceStateChange or AppLcmOpOccStateChange'
schema:
type: string
required: true
responses:
'200':
description: Representation of the resource.
content:
application/json:
schema:
oneOf:
- $ref: '#/components/schemas/AppInstSubscriptionInfo'
- $ref: '#/components/schemas/AppLcmOpOccSubscriptionInfo'
'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:
- ''
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 oneOf: AppInstNotification, AppLcmOpOccNotification #
###############################################################################
/URI_is_provided_by_the_client_when_creating_the_subscription_AppInstNotification_AppLcmOpOccNotification:
post:
tags:
- ''
summary: 'Delivers a notification from the application lifecycle management resource to the subscriber.'
description: 'Delivers a notification from the application lifecycle management resource to the subscriber.'
operationId: appInstNotificationPOST
requestBody:
required: true
content:
application/json:
schema:
oneOf:
- $ref: '#/components/schemas/AppInstNotification'
- $ref: '#/components/schemas/AppLcmOpOccNotification'
responses:
'204':
$ref: '#/components/responses/204'
'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_instances/{appInstanceId}/instantiate:
parameters:
- in: path
name: appInstanceId
schema:
type: string
required: true
post:
tags:
- ''
summary: 'task of instantiating an application instance.'
description: 'task of instantiating an application instance.'
operationId: appLcmInstanciatePOST
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/InstantiateAppRequest'
responses:
'202':
description: 'accepted for processing, but the processing has not yet 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'
/app_instances/{appInstanceId}/terminate:
parameters:
- in: path
name: appInstanceId
schema:
type: string
required: true
post:
tags:
- ''
summary: 'terminate an application instance.'
description: 'terminate an application instance.'
operationId: appLcmTerminatePOST
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/TerminateAppRequest'
responses:
'202':
description: 'accepted for processing, but the processing has not yet 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'
/app_instances/{appInstanceId}/operate:
parameters:
- in: path
name: appInstanceId
schema:
type: string
required: true
post:
tags:
- ''
summary: 'change the operational state, i.e. start or stop, of the application instance'
description: 'change the operational state, i.e. start or stop, of the application instance'
operationId: appLcmOperatePOST
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/OperateAppRequest'
responses:
'202':
description: 'accepted for processing, but the processing has not yet 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'
/app_lcm_op_occs:
get:
tags:
- ''
summary: 'retrieves information of operation status about multiple application instance lifecycle management operation occurrences'
description: 'retrieves information of operation status about multiple application instance lifecycle management operation occurrences'
operationId: appLcmOpOccsGET
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: 'Status information for zero or more application instance lifecycle management operation occurrences was queried successfully'
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/AppInstanceLcmOpOcc'
'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_lcm_op_occs/{appLcmOpOccId}:
parameters:
- in: path
name: appLcmOpOccId
schema:
type: string
required: true
get:
tags:
- ''
summary: 'reads the status information of an individual application LCM operation occurrence'
description: 'reads the status information of an individual application LCM operation occurrence'
operationId: appLcmOpOccsbyIdGET
responses:
'200':
description: 'Information about an application LCM operation occurrence was read successfully'
content:
application/json:
schema:
$ref: '#/components/schemas/AppInstanceLcmOpOcc'
'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'
components:
schemas:
AppInstanceLcmOpOcc:
description: >-
'This data type represents an application lifecycle management operation occurrence'
type: object
required:
- id
- operationState
- stateEnteredTime
- startTime
- lcmOperation
- _links
properties:
id:
$ref: '#/components/schemas/AppInstanceLcmOpOcc.Id'
operationState:
$ref: '#/components/schemas/OperationState'
stateEnteredTime:
$ref: '#/components/schemas/TimeStamp'
startTime:
$ref: '#/components/schemas/TimeStamp'
lcmOperation:
$ref: '#/components/schemas/LcmOperation'
operationParams:
$ref: '#/components/schemas/OperationParams'
_links:
$ref: '#/components/schemas/AppInstanceLcmOpOcc.links'
AppInstanceLcmOpOcc.Id:
description: >-
'Identifier of the subscription to application LCM operation occurrence notification'
type: string
OperationParams:
description: >-
'Input parameters of the LCM operation. This attribute shall be formatted according to the request data type of the related LCM operation.'
type: string
enum:
- INSTANTIATE
- OPERATE
- TERMINATE
AppInstanceLcmOpOcc.links:
description: >-
Links to resources related to this resource.
type: object
required:
- self
- appInstance
properties:
self:
$ref: '#/components/schemas/LinkType'
appInstance:
$ref: '#/components/schemas/LinkType'
SubscriptionLinkList:
description: >-
'The data type represents a subscription link list of notification on application lifecycle management. '
type: object
required:
- _links
properties:
_links:
$ref: '#/components/schemas/SubscriptionLinkList.links'
SubscriptionLinkList.links:
description: >-
Links to resources related to this resource.
type: object
required:
- self
properties:
self:
$ref: '#/components/schemas/LinkType'
subscriptions:
type: array
items:
$ref: '#/components/schemas/SubscriptionLinkList.links.subscriptions'
SubscriptionLinkList.links.subscriptions:
description: >-
A link list to the subscriptions
type: object
required:
- href
- subscriptionType
properties:
href:
type: string
format: uri
subscriptionType:
type: string
format: enum
enum:
- AppInstanceStateChange
- AppLcmOpOccStateChange
AppLcmOpOccSubscriptionInfo:
description: >-
'This data type represents a subscription to notifications of application life cycle management operation occurrence'
type: object
required:
- id
- subscriptionType
- callbackUri
- _links
properties:
id:
$ref: '#/components/schemas/AppLcmOpOccSubscriptionInfo.Id'
subscriptionType:
$ref: '#/components/schemas/AppLcmOpOcc.SubscriptionType'
callbackUri:
$ref: '#/components/schemas/CallbackUri'
_links:
$ref: '#/components/schemas/AppLcmOpOccSubscriptionInfo.links'
AppLcmOpOccSubscriptionInfo.Id:
description: >-
''
type: string
AppLcmOpOcc.SubscriptionType:
description: >-
Shall be set to AppLcmOpOccStateChange.
type: string
enum:
- AppLcmOpOccStateChange
AppLcmOpOccSubscriptionInfo.links:
description: >-
Links to resources related to this resource.
type: object
required:
- self
properties:
self:
$ref: '#/components/schemas/LinkType'
AppInstSubscriptionInfo:
description: >-
'The data type represents a subscription to notification of application instance operational state change.'
type: object
required:
- id
- subscriptionType
- notificationType
- callbackUri
- _links
properties:
id:
$ref: '#/components/schemas/AppInstSubscriptionInfo.Id'
subscriptionType:
$ref: '#/components/schemas/AppInst.SubscriptionType'
notificationType:
$ref: '#/components/schemas/AppInst.NotificationType'
callbackUri:
$ref: '#/components/schemas/CallbackUri'
_links:
$ref: '#/components/schemas/AppInstSubscriptionInfo.links'
AppInstSubscriptionInfo.Id:
description: >-
'Identifier of the subscription to application instance operational state change notification.'
type: string
AppInst.SubscriptionType:
description: >-
Shall be set to AppInstanceStateChange.
type: string
enum:
- AppInstanceStateChange
AppInst.NotificationType:
description: >-
Subscribed notification
type: string
enum:
- NOT_INSTANTIATED
- STARTED
- STOPPED
CallbackUri:
description: >-
The URI of the endpoint for the notification to be sent to.
type: string
format: uri
AppInstSubscriptionInfo.links:
description: Links to resources related to this resource.
properties:
self:
$ref: '#/components/schemas/LinkType'
required:
- self
type: object
AppLcmOpOccSubscriptionRequest:
properties:
appLcmOpOccSubscriptionFilter:
# description': Subscription filter criteria to match specific application LCM operation occurrences.
# x-etsi-mec-cardinality': 0..1
# x-etsi-mec-origin-type': AppLcmOpOccSubscriptionFilter
$ref: '#/components/schemas/AppLcmOpOccSubscriptionFilter'
callbackUri:
# description': The URI of the endpoint for the notification to be sent to.
# x-etsi-mec-cardinality': '1'
# x-etsi-mec-origin-type': Uri
$ref: '#/components/schemas/URI'
subscriptionType:
description: Shall be set to "AppLcmOpOccStateChange".
type: string
x-etsi-mec-cardinality: '1'
x-etsi-mec-origin-type: String
required:
- subscriptionType
- callbackUri
type: object
x-etsi-ref: 6.2.2.14
URI:
type: string
AppLcmOpOccSubscriptionFilter:
properties:
appInstanceSubscriptionFilter:
# description': If present, this attribute contains filter criteria that selects one or more application instances on which to receive "LCM operation occurrence" notifications.
# x-etsi-mec-cardinality': 0..1
# x-etsi-mec-origin-type': AppInstanceSubscriptionFilter
$ref: '#/components/schemas/AppInstanceSubscriptionFilter'
notificationTypes:
$ref: '#/components/schemas/NotificationTypes'
operationStates:
$ref: '#/components/schemas/OperationStates'
operationTypes:
$ref: '#/components/schemas/OperationTypes'
NotificationTypes:
description: Match particular notification types.
type: string
enum:
- AppLcmOperationOccurrenceNotification
OperationStates:
description: >-
'Type of the LCM operation state represented by this application instance LCM operation occurrence.'
type: string
enum:
- STARTING
- PROCESSING
- COMPLETED
- FAILED
OperationTypes:
description: >-
'Type of the LCM operation represented by this application instance LCM operation occurrence.'
type: string
enum:
- INSTANTIATE
- OPERATE
- TERMINATE
CreateAppInstanceRequest:
properties:
appDId:
description: The application descriptor identifier. It is managed by the application provider to identify the application descriptor in a globally unique way.
type: string
x-etsi-mec-cardinality: '1'
x-etsi-mec-origin-type: String
appInstanceDescription:
description: Human-readable description of the application instance to be created.
type: string
x-etsi-mec-cardinality: 0..1
x-etsi-mec-origin-type: String
appInstanceName:
description: Human-readable name of the application instance to be created.
type: string
x-etsi-mec-cardinality: 0..1
x-etsi-mec-origin-type: String
required:
- appDId
type: object
x-etsi-ref: 6.2.2.3
AppInstSubscriptionRequest:
type: object
required:
- subscriptionType
- callbackUri
properties:
subscriptionType:
$ref: '#/components/schemas/AppInst.SubscriptionType'
callbackUri:
$ref: '#/components/schemas/CallbackUri'
appInstanceState:
$ref: '#/components/schemas/AppInstanceState'
appInstanceSubscriptionFilter:
$ref: '#/components/schemas/AppInstanceSubscriptionFilter'
AppInstanceSubscriptionFilter:
description: >-
'This data type represents subscription filter criteria to match application instances. '
type: object
required:
- appInstSelectorType
properties:
appInstSelectorType:
$ref: '#/components/schemas/AppInstSelectorType'
appInstances:
type: array
items:
$ref: '#/components/schemas/AppInstances'
appsFromProviders:
type: array
items:
$ref: '#/components/schemas/AppsFromProviders'
AppsFromProviders:
description: >-
'Present only if appInstIdSelector = APP_FROM_PROVIDER. Match existing application instances, or those created in the future whilst the subscription is active, that belong to applications from certain providers.'
type: object
required:
- appProvider
properties:
appProvider:
$ref: '#/components/schemas/AppProvider'
appProducts:
$ref: '#/components/schemas/AppProducts'
AppProducts:
description: >-
'If present, match application instances that belong to application products with certain product names, from one particular provider.'
type: object
required:
- appName
properties:
appName:
$ref: '#/components/schemas/AppName'
versions:
$ref: '#/components/schemas/AppProducts.Versions'
AppProducts.Versions:
description: >-
'If present, match application instances that belong to application products with certain versions and a certain product name, from one particular provider.'
type: object
required:
- appSoftVersion
properties:
appSoftVersion:
$ref: '#/components/schemas/AppSoftVersion'
appDVersion:
type: array
items:
$ref: '#/components/schemas/AppDVersion'
AppInstances:
description: >-
If appInstIdSelector = APP_IDENTITY match existing application instances with an application instance identifier listed in this attribute.
type: string
AppInstSelectorType:
description: '0 = void'
type: string
enum:
- VOID
- APP_IDENTITY
- APP_NAME
- APP_D_ID
- APP_FROM_PROVIDER
AppInstanceState:
description: >-
Only send notifications for application instances that are in one of the states listed in this attribute. If this attribute is absent, match all states.
type: string
format: enum
enum:
- NOT_INSTANTIATED
- STARTED
- STOPPED
AppInstNotification:
properties:
_links:
description: Links to resources related to this notification.
properties:
subscription:
# description': A link to the related subscription.
# x-etsi-mec-cardinality': '1'
# x-etsi-mec-origin-type': LinkType
$ref: '#/components/schemas/LinkType'
required:
- subscription
type: object
x-etsi-mec-cardinality: '1'
appDId:
description: The application descriptor identifier identifies the application package and the application descriptor in a globally unique way.
type: string
x-etsi-mec-cardinality: '1'
x-etsi-mec-origin-type: String
appInstanceId:
description: Identifier of application instance.
type: string
x-etsi-mec-cardinality: '1'
x-etsi-mec-origin-type: String
appPkgId:
description: 'Identifier of the onboarded application package. '
type: string
x-etsi-mec-cardinality: '1'
x-etsi-mec-origin-type: String
id:
description: Identifier of this notification. If a notification is sent multiple times due to multiple subscriptions, the "notificationId" attribute of all these notifications shall have the same value.
type: string
x-etsi-mec-cardinality: '1'
x-etsi-mec-origin-type: String
notificationType:
# description: "Discriminator for the different notification types:\nNOT_INSTANTIATED: the application instance is not instantiated. \nSTARTED: the application instance is up and running. \nSTOPPED: the application instance stops operation."
# type: string
# x-etsi-mec-cardinality: '1'
$ref: '#/components/schemas/AppInst.NotificationType'
subscriptionId:
description: Identifier of the subscription related to this notification.
type: string
x-etsi-mec-cardinality: '1'
x-etsi-mec-origin-type: String
timeStamp:
# description': Date and time of the notification generation.
# x-etsi-mec-cardinality': '1'
# x-etsi-mec-origin-type': TimeStamp
$ref: '#/components/schemas/TimeStamp'
required:
- id
- notificationType
- subscriptionId
- timeStamp
- appInstanceId
- appPkgId
- appDId
- _links
type: object
x-etsi-ref: 6.2.2.11
AppInstanceInfo:
description: >-
'The data type of AppInstanceInfo represents the parameters of instantiated application instance resources.'
type: object
required:
- id
- appDId
- appProvider
- appName
- appSoftVersion
- appDVersion
- appPkgId
- instantiationState
- _links
properties:
id:
$ref: '#/components/schemas/AppInstanceId'
appInstanceName:
$ref: '#/components/schemas/AppInstanceName'
appInstanceDescription:
$ref: '#/components/schemas/AppInstanceDescription'
appDId:
$ref: '#/components/schemas/AppDId'
appProvider:
$ref: '#/components/schemas/AppProvider'
appName:
$ref: '#/components/schemas/AppName'
appSoftVersion:
$ref: '#/components/schemas/AppSoftVersion'
appDVersion:
$ref: '#/components/schemas/AppDVersion'
appPkgId:
$ref: '#/components/schemas/AppPkgId'
vimConnectionInfo:
type: array
items:
$ref: '#/components/schemas/VimConnectionInfo'
instantiationState:
$ref: '#/components/schemas/InstantiationState'
instantiatedAppState:
$ref: '#/components/schemas/InstantiatedAppState'
_links:
$ref: '#/components/schemas/AppInstanceInfo.links'
AppInstanceId:
description: >-
Identifier of application instance.
type: string
OperationState:
description: >-
Operation state
type: string
format: enum
enum:
- STARTING
- PROCESSING
- COMPLETED
- FAILED
AppInstanceName:
description: Name of the application instance.
type: string