-
Notifications
You must be signed in to change notification settings - Fork 6
/
slice-mngr_NST.json
2700 lines (2700 loc) · 136 KB
/
slice-mngr_NST.json
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
{
"swagger": "2.0",
"info": {
"version": "1.2",
"title": "Network Slice Template (NST) Management interface",
"description": "Network Slice Template (NST) interface: This interface is aligned with the ETSI NFV IFA0013/SOL005 specification, making the required changes to adapt it to the management of NSTs.\n",
"license": {
"name": "H2020 5GTANGO copyright"
},
"contact": {
"name": "H2020 5GTANGO"
}
},
"basePath": "/api/nst/v1",
"schemes": [
"https"
],
"consumes": [
"application/json"
],
"produces": [
"application/json"
],
"paths": {
"/descriptors": {
"post": {
"description": "**Create NST Info**: Create a NetSlice Template Info object and the whole NST item information presented as JSON. After NST creation, the Upload NST completes the on-boarding operation.\n",
"parameters": [
{
"name": "userDefinedData",
"description": "Data associated to a NST.",
"in": "body",
"required": true,
"schema": {
"description": "User Info associated to the NST.",
"type": "object",
"properties": {
"name": {
"description": "Name of the NetSLice Template",
"type": "string",
"format": "string"
},
"version": {
"description": "Version of the NetSLice Template",
"type": "string",
"format": "string"
},
"author": {
"description": "Author name of the NetSLice Template",
"type": "string",
"format": "string"
},
"vendor": {
"description": "Vendor name of the NetSLice Template",
"type": "string",
"format": "string"
},
"description": {
"description": "Description of the NetSLice Template",
"type": "string",
"format": "string"
},
"sliceServices": {
"type": "array",
"items": {
"type": "object",
"properties": {
"servname": {
"type": "string",
"description": "Uuid of the Network Service to be in the Template"
},
"nsdID": {
"type": "string",
"description": "Uuid of the Network Service to be in the Template"
},
"slaID": {
"type": "string",
"description": "Uuid of the Network Service to be in the Template"
}
}
}
}
},
"example": {
"name": "Example_NST",
"version": 1.1,
"author": "5gTango",
"vendor": "5gTango",
"description": "This is a description of a NS",
"sliceServices": [
{
"servname": "service_name",
"nsdID": "66a1c857-76d7-48db-98a1-6674b531b010",
"slaID": "a365dd7e-42c7-4db1-947f-1e2de4e432cc"
},
{
"servname": "service_name",
"nsdID": "66a1c857-76d7-48db-98a1-6674b531b010",
"slaID": "a365dd7e-42c7-4db1-947f-1e2de4e432cc"
}
]
}
}
}
],
"responses": {
"201": {
"description": "Netslice Template structure.",
"headers": {
"Content-Type": {
"description": "The MIME type of the body of the response (\"application/json\").",
"type": "string",
"maximum": 1,
"minimum": 1
},
"WWW-Authenticate": {
"description": "Challenge if the corresponding HTTP request has not provided authorization, or error details if the corresponding HTTP request has provided an invalid authorization token.\n",
"type": "string",
"maximum": 1,
"minimum": 0
},
"Location": {
"description": "The resource URI of the created NSI instance.",
"type": "string",
"format": "url"
}
},
"schema": {
"description": "The generated NST object.",
"example": {
"created_at": "2018-07-19T12:40:41.419+00:00",
"md5": "42510e3a015bd1468b85987763566376",
"nstd": {
"name": "Example_NST",
"version": 1.1,
"author": "5gTango NetSlicer",
"vendor": "5gTango",
"sliceServices": [
{
"nsdRef": "6a1c857-76d7-48db-98a1-6674b531b010",
"nsdName": "service_name",
"slaID": "a365dd7e-42c7-4db1-947f-1e2de4e432cc",
"is-shared": false
}
],
"5qi_value": 1,
"notificationTypes": "",
"onboardingState": "ENABLED",
"operationalState": "ENABLED",
"NSI_list_ref": [
"6a1c857-76d7-48db-98a1-6674b531b010",
"a365dd7e-42c7-4db1-947f-1e2de4e432cc"
],
"usageState": "IN_USE"
},
"signature": null,
"status": "active",
"updated_at": "2018-07-19T12:43:06.691+00:00",
"username": null,
"uuid": "66a1c857-76d7-48db-98a1-6674b531b010"
}
}
},
"400": {
"description": "If the request is malformed or syntactically incorrect.\n",
"headers": {
"Content-Type": {
"description": "The MIME type of the body of the response (\"application/problem+json\").",
"type": "string",
"maximum": 1,
"minimum": 1
},
"WWW-Authenticate": {
"description": "Challenge if the corresponding HTTP request has not provided authorization, or error details if the corresponding HTTP request has provided an invalid authorization token.\n",
"type": "string",
"maximum": 1,
"minimum": 0
}
},
"schema": {
"description": "General \"ProblemDetails\" data structure from IETF RFC 7807 [19].\n",
"type": "object",
"required": [
"status",
"detail"
],
"properties": {
"type": {
"description": "Problem type according to IETF RFC 3986 [5]\n",
"type": "string",
"format": "URI"
},
"title": {
"description": "A short, human-readable summary of the problem type.\n",
"type": "string"
},
"status": {
"description": "The HTTP status code for this occurrence of the problem.\n",
"type": "integer"
},
"detail": {
"description": "A longer explanation of the specific occurrence of the problem.\n",
"type": "string"
},
"instance": {
"description": "A URI reference that identifies the specific occurrence of the problem.\n",
"type": "string",
"format": "URI"
}
}
}
},
"401": {
"description": "If the request contains no access token even though one is required, or if the request contains an authorization token that is invalid.\n",
"headers": {
"Content-Type": {
"description": "The MIME type of the body of the response (\"application/problem+json\").",
"type": "string",
"maximum": 1,
"minimum": 1
},
"WWW-Authenticate": {
"description": "Challenge if the corresponding HTTP request has not provided authorization, or error details if the corresponding HTTP request has provided an invalid authorization token.\n",
"type": "string",
"maximum": 1,
"minimum": 0
}
},
"schema": {
"description": "General \"ProblemDetails\" data structure from IETF RFC 7807 [19].\n",
"type": "object",
"required": [
"status",
"detail"
],
"properties": {
"type": {
"description": "Problem type according to IETF RFC 3986 [5]\n",
"type": "string",
"format": "URI"
},
"title": {
"description": "A short, human-readable summary of the problem type.\n",
"type": "string"
},
"status": {
"description": "The HTTP status code for this occurrence of the problem.\n",
"type": "integer"
},
"detail": {
"description": "A longer explanation of the specific occurrence of the problem.\n",
"type": "string"
},
"instance": {
"description": "A URI reference that identifies the specific occurrence of the problem.\n",
"type": "string",
"format": "URI"
}
}
}
},
"403": {
"description": "If the API consumer is not allowed to perform a particular request to a particular resource, the API producer shall respond with this response code.\n",
"headers": {
"Content-Type": {
"description": "The MIME type of the body of the response (\"application/problem+json\").",
"type": "string",
"maximum": 1,
"minimum": 1
},
"WWW-Authenticate": {
"description": "Challenge if the corresponding HTTP request has not provided authorization, or error details if the corresponding HTTP request has provided an invalid authorization token.\n",
"type": "string",
"maximum": 1,
"minimum": 0
}
},
"schema": {
"description": "General \"ProblemDetails\" data structure from IETF RFC 7807 [19].\n",
"type": "object",
"required": [
"status",
"detail"
],
"properties": {
"type": {
"description": "Problem type according to IETF RFC 3986 [5]\n",
"type": "string",
"format": "URI"
},
"title": {
"description": "A short, human-readable summary of the problem type.\n",
"type": "string"
},
"status": {
"description": "The HTTP status code for this occurrence of the problem.\n",
"type": "integer"
},
"detail": {
"description": "A longer explanation of the specific occurrence of the problem.\n",
"type": "string"
},
"instance": {
"description": "A URI reference that identifies the specific occurrence of the problem.\n",
"type": "string",
"format": "URI"
}
}
}
},
"404": {
"description": "If the API producer did not find a current representation for the resource addressed by the URI passed in the request, or is not willing to disclose that one exists.\n",
"headers": {
"Content-Type": {
"description": "The MIME type of the body of the response (\"application/problem+json\").",
"type": "string",
"maximum": 1,
"minimum": 1
},
"WWW-Authenticate": {
"description": "Challenge if the corresponding HTTP request has not provided authorization, or error details if the corresponding HTTP request has provided an invalid authorization token.\n",
"type": "string",
"maximum": 1,
"minimum": 0
}
},
"schema": {
"description": "General \"ProblemDetails\" data structure from IETF RFC 7807 [19].\n",
"type": "object",
"required": [
"status",
"detail"
],
"properties": {
"type": {
"description": "Problem type according to IETF RFC 3986 [5]\n",
"type": "string",
"format": "URI"
},
"title": {
"description": "A short, human-readable summary of the problem type.\n",
"type": "string"
},
"status": {
"description": "The HTTP status code for this occurrence of the problem.\n",
"type": "integer"
},
"detail": {
"description": "A longer explanation of the specific occurrence of the problem.\n",
"type": "string"
},
"instance": {
"description": "A URI reference that identifies the specific occurrence of the problem.\n",
"type": "string",
"format": "URI"
}
}
}
},
"405": {
"description": "If the API producer did not find a current representation for the resource addressed by the URI passed in the request, or is not willing to disclose that one exists.\n",
"headers": {
"Content-Type": {
"description": "The MIME type of the body of the response (\"application/problem+json\").",
"type": "string",
"maximum": 1,
"minimum": 1
},
"WWW-Authenticate": {
"description": "Challenge if the corresponding HTTP request has not provided authorization, or error details if the corresponding HTTP request has provided an invalid authorization token.\n",
"type": "string",
"maximum": 1,
"minimum": 0
}
},
"schema": {
"description": "General \"ProblemDetails\" data structure from IETF RFC 7807 [19].\n",
"type": "object",
"required": [
"status",
"detail"
],
"properties": {
"type": {
"description": "Problem type according to IETF RFC 3986 [5]\n",
"type": "string",
"format": "URI"
},
"title": {
"description": "A short, human-readable summary of the problem type.\n",
"type": "string"
},
"status": {
"description": "The HTTP status code for this occurrence of the problem.\n",
"type": "integer"
},
"detail": {
"description": "A longer explanation of the specific occurrence of the problem.\n",
"type": "string"
},
"instance": {
"description": "A URI reference that identifies the specific occurrence of the problem.\n",
"type": "string",
"format": "URI"
}
}
}
},
"406": {
"description": "If the \"Accept\" HTTP header does not contain at least one name of a content type that is acceptable to the API producer.\n",
"headers": {
"Content-Type": {
"description": "The MIME type of the body of the response (\"application/problem+json\").",
"type": "string",
"maximum": 1,
"minimum": 1
},
"WWW-Authenticate": {
"description": "Challenge if the corresponding HTTP request has not provided authorization, or error details if the corresponding HTTP request has provided an invalid authorization token.\n",
"type": "string",
"maximum": 1,
"minimum": 0
}
},
"schema": {
"description": "General \"ProblemDetails\" data structure from IETF RFC 7807 [19].\n",
"type": "object",
"required": [
"status",
"detail"
],
"properties": {
"type": {
"description": "Problem type according to IETF RFC 3986 [5]\n",
"type": "string",
"format": "URI"
},
"title": {
"description": "A short, human-readable summary of the problem type.\n",
"type": "string"
},
"status": {
"description": "The HTTP status code for this occurrence of the problem.\n",
"type": "integer"
},
"detail": {
"description": "A longer explanation of the specific occurrence of the problem.\n",
"type": "string"
},
"instance": {
"description": "A URI reference that identifies the specific occurrence of the problem.\n",
"type": "string",
"format": "URI"
}
}
}
},
"409": {
"description": "Another request is in progress that prohibits the fulfillment of the current request, or the current resource state is inconsistent with the request.\n",
"headers": {
"Content-Type": {
"description": "The MIME type of the body of the response (\"application/problem+json\").",
"type": "string",
"maximum": 1,
"minimum": 1
},
"WWW-Authenticate": {
"description": "Challenge if the corresponding HTTP request has not provided authorization, or error details if the corresponding HTTP request has provided an invalid authorization token.\n",
"type": "string",
"maximum": 1,
"minimum": 0
}
},
"schema": {
"description": "General \"ProblemDetails\" data structure from IETF RFC 7807 [19].\n",
"type": "object",
"required": [
"status",
"detail"
],
"properties": {
"type": {
"description": "Problem type according to IETF RFC 3986 [5]\n",
"type": "string",
"format": "URI"
},
"title": {
"description": "A short, human-readable summary of the problem type.\n",
"type": "string"
},
"status": {
"description": "The HTTP status code for this occurrence of the problem.\n",
"type": "integer"
},
"detail": {
"description": "A longer explanation of the specific occurrence of the problem.\n",
"type": "string"
},
"instance": {
"description": "A URI reference that identifies the specific occurrence of the problem.\n",
"type": "string",
"format": "URI"
}
}
}
},
"412": {
"description": "This code is used in conjunction with conditional requests (typically used to protect resources consistency when using PUT or PATCH in a multi-client scenario) to indicate that a precondition has failed.\n",
"headers": {
"Content-Type": {
"description": "The MIME type of the body of the response (\"application/problem+json\").",
"type": "string",
"maximum": 1,
"minimum": 1
},
"WWW-Authenticate": {
"description": "Challenge if the corresponding HTTP request has not provided authorization, or error details if the corresponding HTTP request has provided an invalid authorization token.\n",
"type": "string",
"maximum": 1,
"minimum": 0
}
},
"schema": {
"description": "General \"ProblemDetails\" data structure from IETF RFC 7807 [19].\n",
"type": "object",
"required": [
"status",
"detail"
],
"properties": {
"type": {
"description": "Problem type according to IETF RFC 3986 [5]\n",
"type": "string",
"format": "URI"
},
"title": {
"description": "A short, human-readable summary of the problem type.\n",
"type": "string"
},
"status": {
"description": "The HTTP status code for this occurrence of the problem.\n",
"type": "integer"
},
"detail": {
"description": "A longer explanation of the specific occurrence of the problem.\n",
"type": "string"
},
"instance": {
"description": "A URI reference that identifies the specific occurrence of the problem.\n",
"type": "string",
"format": "URI"
}
}
}
},
"416": {
"description": "This code is returned if the requested byte range in the Range HTTP header is not present in the requested resource.\n",
"headers": {
"Content-Type": {
"description": "The MIME type of the body of the response (\"application/problem+json\").",
"type": "string",
"maximum": 1,
"minimum": 1
},
"WWW-Authenticate": {
"description": "Challenge if the corresponding HTTP request has not provided authorization, or error details if the corresponding HTTP request has provided an invalid authorization token.\n",
"type": "string",
"maximum": 1,
"minimum": 0
}
},
"schema": {
"description": "General \"ProblemDetails\" data structure from IETF RFC 7807 [19].\n",
"type": "object",
"required": [
"status",
"detail"
],
"properties": {
"type": {
"description": "Problem type according to IETF RFC 3986 [5]\n",
"type": "string",
"format": "URI"
},
"title": {
"description": "A short, human-readable summary of the problem type.\n",
"type": "string"
},
"status": {
"description": "The HTTP status code for this occurrence of the problem.\n",
"type": "integer"
},
"detail": {
"description": "A longer explanation of the specific occurrence of the problem.\n",
"type": "string"
},
"instance": {
"description": "A URI reference that identifies the specific occurrence of the problem.\n",
"type": "string",
"format": "URI"
}
}
}
},
"422": {
"description": "If the payload body of a request contains syntactically correct data (e.g. well-formed JSON) but the data cannot be processed (e.g. because it fails validation against a schema).\n",
"headers": {
"Content-Type": {
"description": "The MIME type of the body of the response.",
"type": "string",
"maximum": 1,
"minimum": 1
},
"WWW-Authenticate": {
"description": "Challenge if the corresponding HTTP request has not provided authorization, or error details if the corresponding HTTP request has provided an invalid authorization token.\n",
"type": "string",
"maximum": 1,
"minimum": 0
}
},
"schema": {
"description": "The definition of the general \"ProblemDetails\" data structure from IETF RFC 7807 [19] is reproduced inthis structure. Compared to the general framework defined in IETF RFC 7807 [19], the \"status\" and \"detail\" attributes are mandated to be included by the present document, to ensure that the response contains additional textual information about an error. IETF RFC 7807 [19] foresees extensibility of the \"ProblemDetails\" type. It is possible that particular APIs in the present document, or particular implementations, define extensions to define additional attributes that provide more information about the error. The description column only provides some explanation of the meaning to Facilitate understanding of the design. For a full description, see IETF RFC 7807 [19].\n",
"type": "object",
"required": [
"status",
"detail"
],
"properties": {
"type": {
"description": "A URI reference according to IETF RFC 3986 [5] that identifies the problem type. It is encouraged that the URI provides human-readable documentation for the problem (e.g. using HTML) when dereferenced. When this member is not present, its value is assumed to be \"about:blank\".\n",
"type": "string",
"format": "URI"
},
"title": {
"description": "A short, human-readable summary of the problem type. It should not change from occurrence to occurrence of the problem, except for purposes of localization. If type is given and other than \"about:blank\", this attribute shall also be provided. A short, human-readable summary of the problem type. It SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization (e.g., using proactive content negotiation; see [RFC7231], Section 3.4).\n",
"type": "string"
},
"status": {
"description": "The HTTP status code for this occurrence of the problem. The HTTP status code ([RFC7231], Section 6) generated by the origin server for this occurrence of the problem.\n",
"type": "integer"
},
"detail": {
"description": "A human-readable explanation specific to this occurrence of the problem.\n",
"type": "string"
},
"instance": {
"description": "A URI reference that identifies the specific occurrence of the problem. It may yield further information if dereferenced.\n",
"type": "string",
"format": "URI"
}
}
}
},
"500": {
"description": "If there is an application error not related to the client's input that cannot be easily mapped to any other HTTP response code (\"catch all error\").\n",
"headers": {
"Content-Type": {
"description": "The MIME type of the body of the response (\"application/problem+json\").",
"type": "string",
"maximum": 1,
"minimum": 1
},
"WWW-Authenticate": {
"description": "Challenge if the corresponding HTTP request has not provided authorization, or error details if the corresponding HTTP request has provided an invalid authorization token.\n",
"type": "string",
"maximum": 1,
"minimum": 0
}
},
"schema": {
"description": "General \"ProblemDetails\" data structure from IETF RFC 7807 [19].\n",
"type": "object",
"required": [
"status",
"detail"
],
"properties": {
"type": {
"description": "Problem type according to IETF RFC 3986 [5]\n",
"type": "string",
"format": "URI"
},
"title": {
"description": "A short, human-readable summary of the problem type.\n",
"type": "string"
},
"status": {
"description": "The HTTP status code for this occurrence of the problem.\n",
"type": "integer"
},
"detail": {
"description": "A longer explanation of the specific occurrence of the problem.\n",
"type": "string"
},
"instance": {
"description": "A URI reference that identifies the specific occurrence of the problem.\n",
"type": "string",
"format": "URI"
}
}
}
},
"503": {
"description": "If the API producer encounters an internal overload situation of itself or of a system it relies on.\n",
"headers": {
"Content-Type": {
"description": "The MIME type of the body of the response (\"application/problem+json\").",
"type": "string",
"maximum": 1,
"minimum": 1
},
"WWW-Authenticate": {
"description": "Challenge if the corresponding HTTP request has not provided authorization, or error details if the corresponding HTTP request has provided an invalid authorization token.\n",
"type": "string",
"maximum": 1,
"minimum": 0
}
},
"schema": {
"description": "General \"ProblemDetails\" data structure from IETF RFC 7807 [19].\n",
"type": "object",
"required": [
"status",
"detail"
],
"properties": {
"type": {
"description": "Problem type according to IETF RFC 3986 [5]\n",
"type": "string",
"format": "URI"
},
"title": {
"description": "A short, human-readable summary of the problem type.\n",
"type": "string"
},
"status": {
"description": "The HTTP status code for this occurrence of the problem.\n",
"type": "integer"
},
"detail": {
"description": "A longer explanation of the specific occurrence of the problem.\n",
"type": "string"
},
"instance": {
"description": "A URI reference that identifies the specific occurrence of the problem.\n",
"type": "string",
"format": "URI"
}
}
}
}
}
},
"get": {
"description": "**Query NST**: Queries NST information (multiple NSTs).\n",
"responses": {
"200": {
"description": "Results of the query (NSTs).\n",
"headers": {
"Content-Type": {
"description": "The MIME type of the body of the response (\"application/json\").",
"type": "string",
"maximum": 1,
"minimum": 1
},
"WWW-Authenticate": {
"description": "Challenge if the corresponding HTTP request has not provided authorization, or error details if the corresponding HTTP request has provided an invalid authorization token.",
"type": "string",
"maximum": 1,
"minimum": 0
}
},
"schema": {
"type": "array",
"items": {
"description": "Results of the query (NST).",
"type": "object",
"properties": {
"uuid": {
"description": "A unique identifier of the NST allocated by the Slice Manager.\n",
"type": "string"
},
"created_at": {
"description": "Describe the datetime when it was created.\n",
"type": "string"
},
"updated_at": {
"description": "Describe the datetime when it was updated.\n",
"type": "string"
},
"name": {
"description": "NST Name.",
"type": "string"
},
"version": {
"description": "NST Version.",
"type": "string"
},
"author": {
"description": "NST author.",
"type": "string"
},
"vendor": {
"description": "NST vendor.",
"type": "string"
},
"nstNsdIds": {
"description": "List of underlying NSDs that comprise the NST.",
"type": "string"
},
"onboardingState": {
"description": "Operational state (ENABLE, DISABLED).",
"type": "string",
"enum": [
"ENABLED",
"DISABLED"
]
},
"operationalState": {
"description": "Operational state (ENABLE, DISABLED).",
"type": "string",
"enum": [
"ENABLED",
"DISABLED"
]
},
"usageState": {
"description": "Usage state (IN_USE, NOT_IN_USE).",
"type": "string",
"enum": [
"IN_USE",
"NOT_IN_USE"
]
},
"notificationTypes": {
"description": "Permited values: NstOnboardingNotification, NStTChangeNotification and NstDeletionNotification.\n",
"type": "string",
"enum": [
"NstOnboardingNotification",
"NstChangeNotification",
"NstDeletionNotification"
]
}
}
}
}
},
"400": {
"description": "If the request is malformed or syntactically incorrect.\n",
"headers": {
"Content-Type": {
"description": "The MIME type of the body of the response (\"application/problem+json\").",
"type": "string",
"maximum": 1,
"minimum": 1
},
"WWW-Authenticate": {
"description": "Challenge if the corresponding HTTP request has not provided authorization, or error details if the corresponding HTTP request has provided an invalid authorization token.\n",
"type": "string",
"maximum": 1,
"minimum": 0
}
},
"schema": {
"description": "General \"ProblemDetails\" data structure from IETF RFC 7807 [19].\n",
"type": "object",
"required": [
"status",
"detail"
],
"properties": {
"type": {
"description": "Problem type according to IETF RFC 3986 [5]\n",
"type": "string",
"format": "URI"
},
"title": {
"description": "A short, human-readable summary of the problem type.\n",
"type": "string"
},
"status": {
"description": "The HTTP status code for this occurrence of the problem.\n",
"type": "integer"
},
"detail": {
"description": "A longer explanation of the specific occurrence of the problem.\n",
"type": "string"
},
"instance": {
"description": "A URI reference that identifies the specific occurrence of the problem.\n",
"type": "string",
"format": "URI"
}
}
}
},
"401": {
"description": "If the request contains no access token even though one is required, or if the request contains an authorization token that is invalid.\n",
"headers": {
"Content-Type": {
"description": "The MIME type of the body of the response (\"application/problem+json\").",
"type": "string",
"maximum": 1,
"minimum": 1
},
"WWW-Authenticate": {
"description": "Challenge if the corresponding HTTP request has not provided authorization, or error details if the corresponding HTTP request has provided an invalid authorization token.\n",
"type": "string",
"maximum": 1,
"minimum": 0
}
},
"schema": {
"description": "General \"ProblemDetails\" data structure from IETF RFC 7807 [19].\n",
"type": "object",
"required": [
"status",
"detail"
],
"properties": {
"type": {
"description": "Problem type according to IETF RFC 3986 [5]\n",
"type": "string",
"format": "URI"
},
"title": {
"description": "A short, human-readable summary of the problem type.\n",
"type": "string"
},
"status": {
"description": "The HTTP status code for this occurrence of the problem.\n",
"type": "integer"
},
"detail": {
"description": "A longer explanation of the specific occurrence of the problem.\n",
"type": "string"
},
"instance": {
"description": "A URI reference that identifies the specific occurrence of the problem.\n",
"type": "string",
"format": "URI"
}
}
}
},
"403": {
"description": "If the API consumer is not allowed to perform a particular request to a particular resource, the API producer shall respond with this response code.\n",
"headers": {
"Content-Type": {
"description": "The MIME type of the body of the response (\"application/problem+json\").",
"type": "string",
"maximum": 1,
"minimum": 1
},
"WWW-Authenticate": {
"description": "Challenge if the corresponding HTTP request has not provided authorization, or error details if the corresponding HTTP request has provided an invalid authorization token.\n",
"type": "string",
"maximum": 1,
"minimum": 0
}
},
"schema": {
"description": "General \"ProblemDetails\" data structure from IETF RFC 7807 [19].\n",
"type": "object",
"required": [
"status",
"detail"
],
"properties": {
"type": {
"description": "Problem type according to IETF RFC 3986 [5]\n",
"type": "string",
"format": "URI"
},
"title": {
"description": "A short, human-readable summary of the problem type.\n",
"type": "string"
},
"status": {
"description": "The HTTP status code for this occurrence of the problem.\n",
"type": "integer"
},
"detail": {
"description": "A longer explanation of the specific occurrence of the problem.\n",
"type": "string"
},
"instance": {
"description": "A URI reference that identifies the specific occurrence of the problem.\n",
"type": "string",
"format": "URI"
}
}
}
},
"404": {
"description": "If the API producer did not find a current representation for the resource addressed by the URI passed in the request, or is not willing to disclose that one exists.\n",
"headers": {
"Content-Type": {
"description": "The MIME type of the body of the response (\"application/problem+json\").",
"type": "string",