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_lcm/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
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
description: 'Identifier of an individual application instance'
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
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
description: >-
"Query parameter to filter on a specific subscription type.
Permitted values:
• "AppInstanceStateChange"
• "AppLcmOpOccStateChange"
"
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
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
description: 'Represents an individual subscription to notification related to an application instance'
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
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 #
###############################################################################
/user_defined_notification:
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
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
description: 'Identifier of an individual application instance'
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
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
description: 'Identifier of an individual application instance'
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
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
description: 'Identifier of an individual application instance'
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
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
description: 'Identifies an individual application LCM operation occurrence'
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
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
1084
1085
1086
1087
1088
1089
1090
1091
1092
1093
1094
1095
1096
1097
1098
1099
1100
1101
1102
1103
1104
1105
1106
1107
1108
1109
1110
1111
1112
1113
1114
1115
1116
1117
1118
1119
1120
1121
1122
1123
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
1214
1215
1216
1217
1218
1219
1220
1221
1222
1223
1224
1225
1226
1227
1228
1229
1230
1231
1232
1233
1234
1235
1236
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
1288
1289
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
1332
1333
1334
1335
1336
1337
1338
1339
1340
1341
1342
1343
1344
1345
1346
1347
1348
1349
1350
1351
1352
1353
1354
1355
1356
1357
1358
1359
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
1385
1386
1387
1388
1389
1390
1391
1392
1393
1394
1395
1396
1397
1398
1399
1400
1401
1402
1403
1404
1405
1406
1407
1408
1409
1410
1411
1412
1413
1414
1415
1416
1417
1418
1419
1420
1421
1422
1423
1424
1425
1426
1427
1428
1429
1430
1431
1432
1433
1434
1435
1436
1437
1438
1439
1440
1441
1442
1443
1444
1445
1446
1447
1448
1449
1450
1451
1452
1453
1454
1455
1456
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
1483
1484
1485
1486
1487
1488
1489
1490
1491
1492
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
AppInstanceDescription:
description: Human-readable description of the application instance to be created.
type: string
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
AppSoftVersion:
description: 'Identifies the version of software of 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
InstantiationState:
description: Instantiation state of the application instance
type: string
enum:
- NOT_INSTANTIATED
- INSTANTIATED
InstantiatedAppState:
description: >-
'Information specific to an instantiated application. This attribute shall be present if the instantiationState attribute value is INSTANTIATED.'
type: object
required:
- operationalState
properties:
operationalState:
$ref: '#/components/schemas/OperationalState'
OperationalState:
description: Operational state is applicable in the instantiation state INSTANTIATED
type: string
enum:
- STARTED
- STOPPED
AppInstanceInfo.links:
description: >-
Links to resources related to this resource.
type: object
required:
- self
properties:
self:
$ref: '#/components/schemas/LinkType'
instantiate:
$ref: '#/components/schemas/LinkType'
terminate:
$ref: '#/components/schemas/LinkType'
operate:
$ref: '#/components/schemas/LinkType'
LcmOperation:
description: >-
Type of the actual LCM operation represented by this application instance LCM operation occurrence
type: string
format: enum
enum:
- INSTATIATE
- OPERATE
- TERMINATE
AppLcmOpOccNotification:
description: >-
'This data type represents a notification related to state changes of an application LCM operation occurrence which informs the subscribers'
type: object
required:
- id
- notificationType
- subscriptionId
- timeStamp
- appLcmOpOccId
- appInstanceId
- _links
properties:
id:
$ref: '#/components/schemas/AppLcmOpOccNotification.Id'
notificationType:
$ref: '#/components/schemas/AppLcmOpOcc.NotificationType'
subscriptionId:
$ref: '#/components/schemas/SubscriptionId'
timeStamp:
$ref: '#/components/schemas/TimeStamp'
appLcmOpOccId:
$ref: '#/components/schemas/AppLcmOpOccId'
appInstanceId:
$ref: '#/components/schemas/AppInstanceId'
_links:
$ref: '#/components/schemas/AppLcmOpOccNotification.links'
AppLcmOpOccNotification.Id:
description: >-
''
type: string
AppLcmOpOcc.NotificationType:
description: >-
Discriminator for the different notification types
type: string
enum:
- STARTING
- PROCESSING
- COMPLETED
- FAILED
SubscriptionId:
description: >-
Identifier of the subscription related to this notification.
type: string
AppLcmOpOccId:
description: >-
Identifier of application lifecycle management operation occurrence.
type: string
AppLcmOpOccNotification.links:
description: >-
Links to resources related to this resource.
type: object
required:
- appInstance
- subscription
- appLcmOpOcc
properties:
appInstance:
$ref: '#/components/schemas/LinkType'
subscription:
$ref: '#/components/schemas/LinkType'
appLcmOpOcc:
$ref: '#/components/schemas/LinkType'
InstantiateAppRequest:
properties:
locationConstraints:
# description': Defines the location constraints for the application instance to be created. See note 3.
# x-etsi-mec-cardinality': 0..1
# x-etsi-mec-origin-type': LocationConstraints
$ref: '#/components/schemas/LocationConstraints'
selectedMECHostInfo:
description: Describes the information of selected host for the application instance. See note 2.
items:
$ref: '#/components/schemas/MECHostInformation'
minItems: 1
type: array
x-etsi-mec-cardinality: 1..N
x-etsi-mec-origin-type: MECHostInformation
vimConnectionInfo:
description: 'Information about VIM connections to be used for managing the resources for the application instance, or refer to external / externally-managed virtual links.
This attribute shall only be supported and may be present if application-related resource management in direct mode is applicable. See note 2.'
items:
$ref: '#/components/schemas/VimConnectionInfo'
minItems: 0
type: array
x-etsi-mec-cardinality: 0..N
x-etsi-mec-origin-type: VimConnectionInfo
virtualComputeDescriptor:
# description': Describes CPU, Memory and acceleration requirements of the virtual machine for the application instance to be created. See note 1.
# x-etsi-mec-cardinality': 0..1
# x-etsi-mec-origin-type': VirtualComputeDescription
$ref: '#/components/schemas/VirtualComputeDescription'
virtualStorageDescriptor:
description: Defines descriptors of virtual storage resources to be used by the application instance to be created. See note 1.
items:
$ref: '#/components/schemas/VirtualStorageDescriptor'
minItems: 0
type: array
x-etsi-mec-cardinality: 0..N
x-etsi-mec-origin-type: VirtualStorageDescriptor
required:
- selectedMECHostInfo
type: object
x-etsi-notes: "NOTE 1:\tThis attribute may be provided in the InstantiateAppRequest structure to override the same attribute in the AppD. \nNOTE 2:\tThis field applies to Mm3 reference point only.\nNOTE 3:\tThis field applies to Mm1 reference point only."
x-etsi-ref: 6.2.2.7
LinkType:
properties:
href:
description: URI referring to a resource
format: uri
type: string
x-etsi-mec-cardinality: '1'
x-etsi-mec-origin-type: URI
required:
- href
type: object
x-etsi-ref: 6.5.2
LocationConstraints:
description: >-
'The LocationConstraints data type supports the specification of MEC application requirements related to MEC application deployment location constraints. The location constraints shall be presented as a country code, optionally followed by a civic address based on the format defined by IETF RFC 4776'
type: object
required:
- countryCode
properties:
countryCode:
$ref: '#/components/schemas/CountryCode'
civicAddressElement:
type: array
items:
$ref: '#/components/schemas/CivicAddressElement'
CountryCode:
description: 'The two-letter ISO 3166 country code in capital letters.'
type: string
CivicAddressElement:
description: >-
'The civic address.'
type: object
required:
- caType
- caValue
properties:
caType:
$ref: '#/components/schemas/CaType'
caValue:
$ref: '#/components/schemas/CaValue'
CaType:
description: >-
'Describe the content type of caValue. The value of caType shall comply with section 3.4 of IETF RFC 4776.'
type: integer
CaValue:
description: >-
'Content of civic address element corresponding to the caType. The format caValue shall comply with section 3.4 of IETF RFC 4776.'
type: string
MECHostInformation:
properties:
hostId:
#description: 'User defined MEC host ID. '
$ref: '#/components/schemas/KeyValuePairs'
#x-etsi-mec-cardinality: '1'
#x-etsi-mec-origin-type: KeyValuePairs
hostName:
description: Human-readable name of MEC host.
type: string
x-etsi-mec-cardinality: 0..1
x-etsi-mec-origin-type: String
required:
- hostId
type: object
x-etsi-ref: 6.2.2.17
OperateAppRequest:
properties:
changeStateTo:
#description: "The desired operational state: \nSTARTED: the application instance is up and running.\nSTOPPED: the application instance stops operation."
# x-etsi-mec-cardinality: '1'
$ref: '#/components/schemas/ChangeStateTo'
gracefulStopTimeout:
description: The time interval (in seconds) to wait for the application instance to be taken out of service during graceful stop, before stopping the application. See note 1 and note 2.
type: integer
x-etsi-mec-cardinality: 0..1
x-etsi-mec-origin-type: Integer
stopType:
#description: 'The stop type'
#x-etsi-mec-cardinality: 0..1
$ref: '#/components/schemas/StopType'
required:
- changeStateTo
type: object
x-etsi-notes: "NOTE 1:\tThe \"stopType\" and \"gracefulStopTimeout\" attributes shall be absent, when the \"changeStateTo\" attribute is equal to \"STARTED\". \nNOTE 2:\tThe \"gracefulStopTimeout\" attribute shall be present, when the \"changeStateTo\" is equal to \"STOPPED\" and the \"stopType\" attribute is equal to \"GRACEFUL\". The \"gracefulStopTimeout\" attribute shall be absent, when the \"changeStateTo\" attribute is equal to \"STOPPED\" and the \"stopType\" attribute is equal to \"FORCEFUL\". \nNOTE 3:\tThe request shall be treated as if the \"stopType\" attribute was set to \"FORCEFUL\", when the \"changeStateTo\" attribute is equal to \"STOPPED\" and the \"stopType\" attribute is absent."
x-etsi-ref: 6.2.2.8
StopType:
description: >-
Signals forceful or graceful stop
type: string
enum:
- FORCEFUL
- GRACEFUL
ChangeStateTo:
description: 'The desired operational state'
type: string
format: enum
enum:
- STARTED
- STOPPED
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
type: object
TerminateAppRequest:
properties:
gracefulTerminationTimeout:
description: "This attribute is only applicable in case of graceful termination. It defines the time to wait for the application instance to be taken out of service before shutting down the application and releasing the resources. \nThe unit is seconds.\nIf not given and the \"terminationType\" attribute is set to \"GRACEFUL\", it is expected to wait for the successful taking out of service of the application, no matter how long it takes, before shutting down the application and releasing the resources."
type: integer
x-etsi-mec-cardinality: 0..1
x-etsi-mec-origin-type: Integer
terminationType:
# description: 'Indicates whether forceful or graceful termination is requested.'
# x-etsi-mec-cardinality: '1'
$ref: '#/components/schemas/TerminationType'
required:
- terminationType
type: object
x-etsi-notes: "NOTE:\tIf the application instance is still in service, requesting forceful termination can adversely impact service."
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
required:
- seconds
- nanoSeconds
type: object
x-etsi-ref: 6.2.5.4
TerminationType:
description: >-
'Indicates whether forceful or graceful termination is requested.'
type: string
format: enum
enum:
- FORCEFUL
- GRACEFUL
VimConnectionInfo:
properties:
accessInfo:
#description: 'Authentication credentials for accessing the VIM, and other access-related information such as tenants or infrastructure resource groups (see note). The applicable keys are dependent on the content of vimType.If the VimConnectionInfo structure is part of an HTTP response payload body, sensitive attributes that are children of this attributes (such as passwords) shall not be included.If the VimConnectionInfo structure is part of an HTTP request payload body, sensitive attributes that are children of this attribute (such as passwords) shall be present if they have not been provisioned out of band.'
$ref: '#/components/schemas/KeyValuePairs'
#x-etsi-mec-cardinality: 0..1
#x-etsi-mec-origin-type: KeyValuePairs
extra:
#description: VIM type specific additional information. The applicable structure, and whether or not this attribute is available, is dependent on the content of vimType.
$ref: '#/components/schemas/KeyValuePairs'
#x-etsi-mec-cardinality: 0..1
#x-etsi-mec-origin-type: KeyValuePairs
id:
description: The identifier of the VIM Connection. This identifier is managed by the MEO.
type: string
x-etsi-mec-cardinality: '1'
x-etsi-mec-origin-type: String
interfaceInfo:
#description: 'Information about the interface or interfaces to the VIM, if applicable, such as the URI of an interface endpoint to communicate with the VIM. The applicable keys are dependent on the content of vimType.Alternatively, such information may have been configured into the VNFM and bound to the vimId.'
$ref: '#/components/schemas/KeyValuePairs'
#x-etsi-mec-cardinality: 0..1
#x-etsi-mec-origin-type: KeyValuePairs
vimId:
description: 'The identifier of the VIM instance. This identifier is managed by the MEO.Shall be present to address additional information about the VIM if such information has been configured into the MEPM by means outside the scope of the present document, and should be absent otherwise.'
type: string
x-etsi-mec-cardinality: 0..1
x-etsi-mec-origin-type: String
vimType:
description: 'Discriminator for the different types of the VIM information.The value of this attribute determines the structure of the "interfaceInfo" and "accessInfo" attributes, based on the type of the VIM.The set of permitted values is expected to change over time as new types or versions of VIMs become available. '
type: string
x-etsi-mec-cardinality: '1'
x-etsi-mec-origin-type: String
required:
- id
- vimType
type: object
x-etsi-ref: 6.2.2.18
VirtualComputeDescription:
description: Ref NFV
type: string
VirtualStorageDescriptor:
description: Ref NFV
type: string
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
responses:
204:
description: No Content
206:
description: Partial content
400:
description: 'Bad Request : used to indicate that incorrect parameters were passed to the request.'
content:
application/json:
schema:
$ref: '#/components/schemas/ProblemDetails'
401:
description: 'Unauthorized : used when the client did not submit credentials.'
content:
application/json:
schema:
$ref: '#/components/schemas/ProblemDetails'
403:
description: 'Forbidden : operation is not allowed given the current status of the resource.'
content:
application/json:
schema:
$ref: '#/components/schemas/ProblemDetails'
404:
description: 'Not Found : used when a client provided a URI that cannot be mapped to a valid resource URI.'
content:
application/json:
schema:
$ref: '#/components/schemas/ProblemDetails'
406:
description: 'Not Acceptable : used to indicate that the server cannot provide the any of the content formats supported by the client.'
content:
application/json:
schema:
$ref: '#/components/schemas/ProblemDetails'
409:
description: 'Conflict : The operation cannot be executed currently, due to a conflict with the state of the resource'
content:
application/json:
schema:
$ref: '#/components/schemas/ProblemDetails'
412:
description: 'Precondition failed : used when a condition has failed during conditional requests, e.g. when
using ETags to avoid write conflicts when using PUT'
content:
application/json:
schema:
$ref: '#/components/schemas/ProblemDetails'
414:
description: 'URI Too Long : used to indicate that the server is refusing to process the request because the request URI is longer than the server is willing or able to process.'
content:
application/json:
schema:
$ref: '#/components/schemas/ProblemDetails'
415:
description: 'Unsupported Media Type : used to indicate that the server or the client does not support the content type of the entity body.'
content:
application/json:
schema:
$ref: '#/components/schemas/ProblemDetails'
416:
description: 'Range Not Satisfiable .'
422:
description: 'Unprocessable Entity : used to indicate that the server understands the content type of the request entity and that the syntax of the request entity is correct but that the server is unable to process the contained instructions. This error condition can occur if an JSON request body is syntactically correct but semantically incorrect, for example if the target area for the request is considered too large. This error condition can also occur if the capabilities required by the request are not supported.'
content:
application/json:
schema:
$ref: '#/components/schemas/ProblemDetails'
example:
application/problem+json:
problemDetails:
type: 'https://meAppServer.example.com/rni/v2/probs/too-many targets'
title: Too many targets
status: '422'
detail: The target area for the request is considered too large
instance: /meAppClient.example.com/77777/msgs/abc
429:
description: 'Too Many Requests : used when a rate limiter has triggered.'
content:
application/json:
schema:
$ref: '#/components/schemas/ProblemDetails'