4 - description: OSM NB API
5 url: 'https://osm.etsi.org/nbapi/v1.0.0'
9 This is Open Source MANO Northbound API featuring ETSI NFV SOL005.
10 For more information on OSM, you can visit [http://osm.etsi.org](http://osm.etsi.org).
11 You can send us your comments and questions to OSM_TECH@list.etsi.org
12 or join the [OpenSourceMANO Slack Workplace](https://join.slack.com/t/opensourcemano/shared_invite/enQtMzQ3MzYzNTQ0NDIyLWVkNTE4ZjZjNWI0ZTQyN2VhOTI1MjViMzU1NWYwMWM3ODI4NTQyY2VlODA2ZjczMWIyYTFkZWNiZmFkM2M2ZDk)
14 title: OSM NB API featuring ETSI NFV SOL005
16 email: OSM_TECH@list.etsi.org
19 url: 'http://www.apache.org/licenses/LICENSE-2.0.html'
22 - name: 'VNF packages'
23 description: Management operations of VNF descriptors and packages
25 description: Management operations of NS descriptors and packages
26 - name: 'NS instances'
27 description: Management operations of NS instances
28 - name: 'NetSlice templates'
29 description: Management operations of NetSlice Templates
30 - name: 'NetSlice instances'
31 description: Management operations of NetSlice Instances
32 - name: 'NS Performance Management'
33 description: Management operations related to Performance Mangement of NS instances
34 - name: 'Physical Data Units (PDU)'
35 description: Management operations of PDUs
36 - name: 'Authentication'
37 description: Authentication operations
39 description: Management operations of users, projects and roles
40 - name: 'Infrastructure'
41 description: Management operations of VIM, VIM accounts, WIM and SDN controllers
42 - name: 'Repositories'
43 description: Management operations of repositories
45 description: Management operations of Administration items
53 '/nsd/v1/ns_descriptors':
57 summary: Query information about multiple NS descriptor resources
58 description: Query information about multiple NS descriptor resources
66 $ref: '#/components/schemas/ArrayOfNsdInfo'
69 $ref: '#/components/schemas/ArrayOfNsdInfo'
71 $ref: '#/components/responses/BadRequest'
73 $ref: '#/components/responses/Unauthorized'
75 $ref: '#/components/responses/Forbidden'
77 $ref: '#/components/responses/NotFound'
79 $ref: '#/components/responses/MethodNotAllowed'
81 $ref: '#/components/responses/NotAcceptable'
83 $ref: '#/components/responses/Conflict'
85 $ref: '#/components/responses/UnprocessableEntity'
87 $ref: '#/components/responses/InternalServerError'
89 $ref: '#/components/responses/ServiceUnavailable'
91 $ref: '#/components/responses/UnexpectedError'
93 $ref: '#/components/responses/UnexpectedError'
97 summary: Create a new NS descriptor resource
98 description: Create a new NS descriptor resource
101 $ref: '#/components/requestBodies/CreateNsdInfoRequest'
113 $ref: '#/components/schemas/ObjectId'
116 $ref: '#/components/schemas/ObjectId'
118 $ref: '#/components/responses/BadRequest'
120 $ref: '#/components/responses/Unauthorized'
122 $ref: '#/components/responses/Forbidden'
124 $ref: '#/components/responses/NotFound'
126 $ref: '#/components/responses/MethodNotAllowed'
128 $ref: '#/components/responses/NotAcceptable'
130 $ref: '#/components/responses/Conflict'
132 $ref: '#/components/responses/UnprocessableEntity'
134 $ref: '#/components/responses/InternalServerError'
136 $ref: '#/components/responses/ServiceUnavailable'
138 $ref: '#/components/responses/UnexpectedError'
140 $ref: '#/components/responses/UnexpectedError'
141 '/nsd/v1/ns_descriptors/{nsdInfoId}':
146 description: NSD Info ID
152 summary: Read information about an individual NS descriptor resource
153 description: Read information about an individual NS descriptor resource
161 $ref: '#/components/schemas/NsdInfo'
164 $ref: '#/components/schemas/NsdInfo'
166 $ref: '#/components/responses/BadRequest'
168 $ref: '#/components/responses/Unauthorized'
170 $ref: '#/components/responses/Forbidden'
172 $ref: '#/components/responses/NotFound'
174 $ref: '#/components/responses/MethodNotAllowed'
176 $ref: '#/components/responses/NotAcceptable'
178 $ref: '#/components/responses/Conflict'
180 $ref: '#/components/responses/UnprocessableEntity'
182 $ref: '#/components/responses/InternalServerError'
184 $ref: '#/components/responses/ServiceUnavailable'
186 $ref: '#/components/responses/UnexpectedError'
188 $ref: '#/components/responses/UnexpectedError'
192 summary: Delete an individual NS descriptor resource
193 description: Delete an individual NS descriptor resource
194 operationId: deleteNSD
197 description: No Content
199 $ref: '#/components/responses/BadRequest'
201 $ref: '#/components/responses/Unauthorized'
203 $ref: '#/components/responses/Forbidden'
205 $ref: '#/components/responses/NotFound'
207 $ref: '#/components/responses/MethodNotAllowed'
209 $ref: '#/components/responses/NotAcceptable'
211 $ref: '#/components/responses/Conflict'
213 $ref: '#/components/responses/UnprocessableEntity'
215 $ref: '#/components/responses/InternalServerError'
217 $ref: '#/components/responses/ServiceUnavailable'
219 $ref: '#/components/responses/UnexpectedError'
221 $ref: '#/components/responses/UnexpectedError'
225 summary: Modify the data of an individual NS descriptor resource
226 description: Modify the data of an individual NS descriptor resource
227 operationId: updateNSD
229 $ref: '#/components/requestBodies/NsdInfoModifications'
232 description: No Content
234 $ref: '#/components/responses/BadRequest'
236 $ref: '#/components/responses/Unauthorized'
238 $ref: '#/components/responses/Forbidden'
240 $ref: '#/components/responses/NotFound'
242 $ref: '#/components/responses/MethodNotAllowed'
244 $ref: '#/components/responses/NotAcceptable'
246 $ref: '#/components/responses/Conflict'
248 $ref: '#/components/responses/UnprocessableEntity'
250 $ref: '#/components/responses/InternalServerError'
252 $ref: '#/components/responses/ServiceUnavailable'
254 $ref: '#/components/responses/UnexpectedError'
256 $ref: '#/components/responses/UnexpectedError'
257 '/nsd/v1/ns_descriptors/{nsdInfoId}/nsd_content':
262 description: NSD Info ID
268 summary: Fetch the content of a NSD
269 description: Fetch the content of a NSD
270 operationId: getNSDcontent
277 $ref: '#/components/schemas/NsPackage'
279 description: Partial Content
287 $ref: '#/components/schemas/NsPackage'
289 $ref: '#/components/responses/BadRequest'
291 $ref: '#/components/responses/Unauthorized'
293 $ref: '#/components/responses/Forbidden'
295 $ref: '#/components/responses/NotFound'
297 $ref: '#/components/responses/MethodNotAllowed'
299 $ref: '#/components/responses/NotAcceptable'
301 $ref: '#/components/responses/Conflict'
303 $ref: '#/components/responses/UnprocessableEntity'
305 $ref: '#/components/responses/InternalServerError'
307 $ref: '#/components/responses/ServiceUnavailable'
309 $ref: '#/components/responses/UnexpectedError'
311 $ref: '#/components/responses/UnexpectedError'
315 summary: Upload the content of a NSD
316 description: Upload the content of a NSD
317 operationId: updateNSDcontent
319 $ref: '#/components/requestBodies/NsPackage'
322 description: Accepted
324 description: No Content
326 $ref: '#/components/responses/BadRequest'
328 $ref: '#/components/responses/Unauthorized'
330 $ref: '#/components/responses/Forbidden'
332 $ref: '#/components/responses/NotFound'
334 $ref: '#/components/responses/MethodNotAllowed'
336 $ref: '#/components/responses/NotAcceptable'
338 $ref: '#/components/responses/Conflict'
340 $ref: '#/components/responses/UnprocessableEntity'
342 $ref: '#/components/responses/InternalServerError'
344 $ref: '#/components/responses/ServiceUnavailable'
346 $ref: '#/components/responses/UnexpectedError'
348 $ref: '#/components/responses/UnexpectedError'
349 '/nsd/v1/ns_descriptors/{nsdInfoId}/artifacts/{artifactPath}':
354 description: NS Package ID
360 description: Artifact Path
366 summary: Fetch individual NS package artifact
367 description: Fetch individual NS package artifact
368 operationId: getNsPkgArtifact
373 application/octet-stream:
378 description: Partial Content
384 application/octet-stream:
389 $ref: '#/components/responses/BadRequest'
391 $ref: '#/components/responses/Unauthorized'
393 $ref: '#/components/responses/Forbidden'
395 $ref: '#/components/responses/NotFound'
397 $ref: '#/components/responses/MethodNotAllowed'
399 $ref: '#/components/responses/NotAcceptable'
401 $ref: '#/components/responses/Conflict'
403 $ref: '#/components/responses/UnprocessableEntity'
405 $ref: '#/components/responses/InternalServerError'
407 $ref: '#/components/responses/ServiceUnavailable'
409 $ref: '#/components/responses/UnexpectedError'
411 $ref: '#/components/responses/UnexpectedError'
412 '/nsd/v1/ns_descriptors/{nsdInfoId}/nsd':
417 description: NS Package ID
423 summary: Read NSD of an on-boarded NS package
424 description: Read NSD of an on-boarded NS package
425 operationId: getNsPkgNsd
432 $ref: '#/components/schemas/NsDescriptor'
434 $ref: '#/components/responses/BadRequest'
436 $ref: '#/components/responses/Unauthorized'
438 $ref: '#/components/responses/Forbidden'
440 $ref: '#/components/responses/NotFound'
442 $ref: '#/components/responses/MethodNotAllowed'
444 $ref: '#/components/responses/NotAcceptable'
446 $ref: '#/components/responses/Conflict'
448 $ref: '#/components/responses/UnprocessableEntity'
450 $ref: '#/components/responses/InternalServerError'
452 $ref: '#/components/responses/ServiceUnavailable'
454 $ref: '#/components/responses/UnexpectedError'
456 $ref: '#/components/responses/UnexpectedError'
457 '/nsd/v1/ns_descriptors_content':
461 summary: Upload a NS package by providing the content of the NS package
462 description: Upload a NS package by providing the content of the NS package
463 operationId: uploadNsPkgsContent
468 $ref: '#/components/schemas/NsPackage'
480 $ref: '#/components/schemas/ObjectId'
483 $ref: '#/components/schemas/ObjectId'
485 description: Accepted
487 description: No Content
489 $ref: '#/components/responses/BadRequest'
491 $ref: '#/components/responses/Unauthorized'
493 $ref: '#/components/responses/Forbidden'
495 $ref: '#/components/responses/NotFound'
497 $ref: '#/components/responses/MethodNotAllowed'
499 $ref: '#/components/responses/NotAcceptable'
501 $ref: '#/components/responses/Conflict'
503 $ref: '#/components/responses/UnprocessableEntity'
505 $ref: '#/components/responses/InternalServerError'
507 $ref: '#/components/responses/ServiceUnavailable'
509 $ref: '#/components/responses/UnexpectedError'
511 $ref: '#/components/responses/UnexpectedError'
515 summary: Query information about multiple NS package resources
516 description: Query information about multiple NS package resources
517 operationId: getNsPkgsContent
524 $ref: '#/components/schemas/ArrayOfNsdInfo'
527 $ref: '#/components/schemas/ArrayOfNsdInfo'
529 description: Partial Content
535 application/octet-stream:
540 $ref: '#/components/responses/BadRequest'
542 $ref: '#/components/responses/Unauthorized'
544 $ref: '#/components/responses/Forbidden'
546 $ref: '#/components/responses/NotFound'
548 $ref: '#/components/responses/MethodNotAllowed'
550 $ref: '#/components/responses/NotAcceptable'
552 $ref: '#/components/responses/Conflict'
554 $ref: '#/components/responses/UnprocessableEntity'
556 $ref: '#/components/responses/InternalServerError'
558 $ref: '#/components/responses/ServiceUnavailable'
560 $ref: '#/components/responses/UnexpectedError'
562 $ref: '#/components/responses/UnexpectedError'
563 '/nsd/v1/ns_descriptors_content/{nsdInfoId}':
568 description: NS Package ID
574 summary: Read information about an individual NS package resource
575 description: Read information about an individual NS package resource
576 operationId: getNsPkgsIdContent
583 $ref: '#/components/schemas/NsdInfo'
586 $ref: '#/components/schemas/NsdInfo'
588 $ref: '#/components/responses/BadRequest'
590 $ref: '#/components/responses/Unauthorized'
592 $ref: '#/components/responses/Forbidden'
594 $ref: '#/components/responses/NotFound'
596 $ref: '#/components/responses/MethodNotAllowed'
598 $ref: '#/components/responses/NotAcceptable'
600 $ref: '#/components/responses/Conflict'
602 $ref: '#/components/responses/UnprocessableEntity'
604 $ref: '#/components/responses/InternalServerError'
606 $ref: '#/components/responses/ServiceUnavailable'
608 $ref: '#/components/responses/UnexpectedError'
610 $ref: '#/components/responses/UnexpectedError'
614 summary: Modify an individual NS package resource
615 description: Modify an individual NS package resource
616 operationId: updateNsPkgsIdContent
618 $ref: '#/components/requestBodies/NsdInfoModifications'
621 description: No Content
623 $ref: '#/components/responses/BadRequest'
625 $ref: '#/components/responses/Unauthorized'
627 $ref: '#/components/responses/Forbidden'
629 $ref: '#/components/responses/NotFound'
631 $ref: '#/components/responses/MethodNotAllowed'
633 $ref: '#/components/responses/NotAcceptable'
635 $ref: '#/components/responses/Conflict'
637 $ref: '#/components/responses/UnprocessableEntity'
639 $ref: '#/components/responses/InternalServerError'
641 $ref: '#/components/responses/ServiceUnavailable'
643 $ref: '#/components/responses/UnexpectedError'
645 $ref: '#/components/responses/UnexpectedError'
649 summary: Delete an individual NS package resource
650 description: Delete an individual NS package resource
651 operationId: deleteNSPkgsIdContent
654 description: No Content
656 $ref: '#/components/responses/BadRequest'
658 $ref: '#/components/responses/Unauthorized'
660 $ref: '#/components/responses/Forbidden'
662 $ref: '#/components/responses/NotFound'
664 $ref: '#/components/responses/MethodNotAllowed'
666 $ref: '#/components/responses/NotAcceptable'
668 $ref: '#/components/responses/Conflict'
670 $ref: '#/components/responses/UnprocessableEntity'
672 $ref: '#/components/responses/InternalServerError'
674 $ref: '#/components/responses/ServiceUnavailable'
676 $ref: '#/components/responses/UnexpectedError'
678 $ref: '#/components/responses/UnexpectedError'
682 '/vnfpkgm/v1/vnf_packages':
686 summary: Query information about multiple VNF package resources
687 description: Query information about multiple VNF package resources
688 operationId: getVnfPkgs
695 $ref: '#/components/schemas/ArrayOfVnfPkgInfo'
698 $ref: '#/components/schemas/ArrayOfVnfPkgInfo'
700 $ref: '#/components/responses/BadRequest'
702 $ref: '#/components/responses/Unauthorized'
704 $ref: '#/components/responses/Forbidden'
706 $ref: '#/components/responses/NotFound'
708 $ref: '#/components/responses/MethodNotAllowed'
710 $ref: '#/components/responses/NotAcceptable'
712 $ref: '#/components/responses/Conflict'
714 $ref: '#/components/responses/UnprocessableEntity'
716 $ref: '#/components/responses/InternalServerError'
718 $ref: '#/components/responses/ServiceUnavailable'
720 $ref: '#/components/responses/UnexpectedError'
722 $ref: '#/components/responses/UnexpectedError'
726 summary: Create a new VNF package resource
727 description: Create a new VNF package resource
728 operationId: addVnfPkg
730 $ref: '#/components/requestBodies/CreateVnfPkgInfoRequest'
742 $ref: '#/components/schemas/ObjectId'
745 $ref: '#/components/schemas/ObjectId'
747 $ref: '#/components/responses/BadRequest'
749 $ref: '#/components/responses/Unauthorized'
751 $ref: '#/components/responses/Forbidden'
753 $ref: '#/components/responses/NotFound'
755 $ref: '#/components/responses/MethodNotAllowed'
757 $ref: '#/components/responses/NotAcceptable'
759 $ref: '#/components/responses/Conflict'
761 $ref: '#/components/responses/UnprocessableEntity'
763 $ref: '#/components/responses/InternalServerError'
765 $ref: '#/components/responses/ServiceUnavailable'
767 $ref: '#/components/responses/UnexpectedError'
769 $ref: '#/components/responses/UnexpectedError'
770 '/vnfpkgm/v1/vnf_packages/{vnfPkgId}':
775 description: VNF Package ID
781 summary: Read information about an individual VNF package resource
782 description: Read information about an individual VNF package resource
783 operationId: getVnfPkg
790 $ref: '#/components/schemas/VnfPkgInfo'
793 $ref: '#/components/schemas/VnfPkgInfo'
795 $ref: '#/components/responses/BadRequest'
797 $ref: '#/components/responses/Unauthorized'
799 $ref: '#/components/responses/Forbidden'
801 $ref: '#/components/responses/NotFound'
803 $ref: '#/components/responses/MethodNotAllowed'
805 $ref: '#/components/responses/NotAcceptable'
807 $ref: '#/components/responses/Conflict'
809 $ref: '#/components/responses/UnprocessableEntity'
811 $ref: '#/components/responses/InternalServerError'
813 $ref: '#/components/responses/ServiceUnavailable'
815 $ref: '#/components/responses/UnexpectedError'
817 $ref: '#/components/responses/UnexpectedError'
821 summary: Delete an individual VNF package resource
822 description: Delete an individual VNF package resource
823 operationId: deleteVnfPkg
826 description: No Content
828 $ref: '#/components/responses/BadRequest'
830 $ref: '#/components/responses/Unauthorized'
832 $ref: '#/components/responses/Forbidden'
834 $ref: '#/components/responses/NotFound'
836 $ref: '#/components/responses/MethodNotAllowed'
838 $ref: '#/components/responses/NotAcceptable'
840 $ref: '#/components/responses/Conflict'
842 $ref: '#/components/responses/UnprocessableEntity'
844 $ref: '#/components/responses/InternalServerError'
846 $ref: '#/components/responses/ServiceUnavailable'
848 $ref: '#/components/responses/UnexpectedError'
850 $ref: '#/components/responses/UnexpectedError'
854 summary: Modify an individual VNF package resource
855 description: Modify an individual VNF package resource
856 operationId: updateVnfPkg
858 $ref: '#/components/requestBodies/VnfPkgInfoModifications'
861 description: No Content
863 $ref: '#/components/responses/BadRequest'
865 $ref: '#/components/responses/Unauthorized'
867 $ref: '#/components/responses/Forbidden'
869 $ref: '#/components/responses/NotFound'
871 $ref: '#/components/responses/MethodNotAllowed'
873 $ref: '#/components/responses/NotAcceptable'
875 $ref: '#/components/responses/Conflict'
877 $ref: '#/components/responses/UnprocessableEntity'
879 $ref: '#/components/responses/InternalServerError'
881 $ref: '#/components/responses/ServiceUnavailable'
883 $ref: '#/components/responses/UnexpectedError'
885 $ref: '#/components/responses/UnexpectedError'
886 '/vnfpkgm/v1/vnf_packages/{vnfPkgId}/vnfd':
891 description: VNF Package ID
897 summary: Read VNFD of an on-boarded VNF package
898 description: Read VNFD of an on-boarded VNF package
899 operationId: getVnfPkgVnfd
906 $ref: '#/components/schemas/VnfDescriptor'
908 $ref: '#/components/responses/BadRequest'
910 $ref: '#/components/responses/Unauthorized'
912 $ref: '#/components/responses/Forbidden'
914 $ref: '#/components/responses/NotFound'
916 $ref: '#/components/responses/MethodNotAllowed'
918 $ref: '#/components/responses/NotAcceptable'
920 $ref: '#/components/responses/Conflict'
922 $ref: '#/components/responses/UnprocessableEntity'
924 $ref: '#/components/responses/InternalServerError'
926 $ref: '#/components/responses/ServiceUnavailable'
928 $ref: '#/components/responses/UnexpectedError'
930 $ref: '#/components/responses/UnexpectedError'
931 '/vnfpkgm/v1/vnf_packages/{vnfPkgId}/package_content':
936 description: VNF Package ID
942 summary: Fetch an on-boarded VNF package
943 description: Fetch an on-boarded VNF package
944 operationId: getVnfPkgContent
951 $ref: '#/components/schemas/VnfPackage'
953 description: Partial Content
961 $ref: '#/components/schemas/VnfPackage'
963 $ref: '#/components/responses/BadRequest'
965 $ref: '#/components/responses/Unauthorized'
967 $ref: '#/components/responses/Forbidden'
969 $ref: '#/components/responses/NotFound'
971 $ref: '#/components/responses/MethodNotAllowed'
973 $ref: '#/components/responses/NotAcceptable'
975 $ref: '#/components/responses/Conflict'
977 $ref: '#/components/responses/UnprocessableEntity'
979 $ref: '#/components/responses/InternalServerError'
981 $ref: '#/components/responses/ServiceUnavailable'
983 $ref: '#/components/responses/UnexpectedError'
985 $ref: '#/components/responses/UnexpectedError'
989 summary: Upload a VNF package by providing the content of the VNF package
990 description: Upload a VNF package by providing the content of the VNF package
991 operationId: uploadVnfPkgContent
996 $ref: '#/components/schemas/VnfPackage'
999 description: Accepted
1001 description: No Content
1003 $ref: '#/components/responses/BadRequest'
1005 $ref: '#/components/responses/Unauthorized'
1007 $ref: '#/components/responses/Forbidden'
1009 $ref: '#/components/responses/NotFound'
1011 $ref: '#/components/responses/MethodNotAllowed'
1013 $ref: '#/components/responses/NotAcceptable'
1015 $ref: '#/components/responses/Conflict'
1017 $ref: '#/components/responses/UnprocessableEntity'
1019 $ref: '#/components/responses/InternalServerError'
1021 $ref: '#/components/responses/ServiceUnavailable'
1023 $ref: '#/components/responses/UnexpectedError'
1025 $ref: '#/components/responses/UnexpectedError'
1026 '/vnfpkgm/v1/vnf_packages/{vnfPkgId}/artifacts/{artifactPath}':
1031 description: VNF Package ID
1034 - name: artifactPath
1037 description: Artifact Path
1043 summary: Fetch individual VNF package artifact
1044 description: Fetch individual VNF package artifact
1045 operationId: getVnfPkgArtifact
1050 application/octet-stream:
1055 description: Partial Content
1061 application/octet-stream:
1066 $ref: '#/components/responses/BadRequest'
1068 $ref: '#/components/responses/Unauthorized'
1070 $ref: '#/components/responses/Forbidden'
1072 $ref: '#/components/responses/NotFound'
1074 $ref: '#/components/responses/MethodNotAllowed'
1076 $ref: '#/components/responses/NotAcceptable'
1078 $ref: '#/components/responses/Conflict'
1080 $ref: '#/components/responses/UnprocessableEntity'
1082 $ref: '#/components/responses/InternalServerError'
1084 $ref: '#/components/responses/ServiceUnavailable'
1086 $ref: '#/components/responses/UnexpectedError'
1088 $ref: '#/components/responses/UnexpectedError'
1089 '/vnfpkgm/v1/vnf_packages_content':
1093 summary: Upload a VNF package by providing the content of the VNF package
1094 description: Upload a VNF package by providing the content of the VNF package
1095 operationId: uploadVnfPkgsContent
1100 $ref: '#/components/schemas/VnfPackage'
1103 description: Created
1112 $ref: '#/components/schemas/ObjectId'
1115 $ref: '#/components/schemas/ObjectId'
1117 description: Accepted
1119 description: No Content
1121 $ref: '#/components/responses/BadRequest'
1123 $ref: '#/components/responses/Unauthorized'
1125 $ref: '#/components/responses/Forbidden'
1127 $ref: '#/components/responses/NotFound'
1129 $ref: '#/components/responses/MethodNotAllowed'
1131 $ref: '#/components/responses/NotAcceptable'
1133 $ref: '#/components/responses/Conflict'
1135 $ref: '#/components/responses/UnprocessableEntity'
1137 $ref: '#/components/responses/InternalServerError'
1139 $ref: '#/components/responses/ServiceUnavailable'
1141 $ref: '#/components/responses/UnexpectedError'
1143 $ref: '#/components/responses/UnexpectedError'
1147 summary: Query information about multiple VNF package resources
1148 description: Query information about multiple VNF package resources
1149 operationId: getVnfPkgsContent
1156 $ref: '#/components/schemas/ArrayOfVnfPkgInfo'
1159 $ref: '#/components/schemas/ArrayOfVnfPkgInfo'
1161 description: Partial Content
1167 application/octet-stream:
1172 $ref: '#/components/responses/BadRequest'
1174 $ref: '#/components/responses/Unauthorized'
1176 $ref: '#/components/responses/Forbidden'
1178 $ref: '#/components/responses/NotFound'
1180 $ref: '#/components/responses/MethodNotAllowed'
1182 $ref: '#/components/responses/NotAcceptable'
1184 $ref: '#/components/responses/Conflict'
1186 $ref: '#/components/responses/UnprocessableEntity'
1188 $ref: '#/components/responses/InternalServerError'
1190 $ref: '#/components/responses/ServiceUnavailable'
1192 $ref: '#/components/responses/UnexpectedError'
1194 $ref: '#/components/responses/UnexpectedError'
1195 '/vnfpkgm/v1/vnf_packages_content/{packageContentId}':
1197 - name: packageContentId
1200 description: VNF Package Content ID
1206 summary: Read information about an individual VNF package resource
1207 description: Read information about an individual VNF package resource
1208 operationId: getVnfPkgsIdContent
1215 $ref: '#/components/schemas/VnfPkgInfo'
1218 $ref: '#/components/schemas/VnfPkgInfo'
1220 $ref: '#/components/responses/BadRequest'
1222 $ref: '#/components/responses/Unauthorized'
1224 $ref: '#/components/responses/Forbidden'
1226 $ref: '#/components/responses/NotFound'
1228 $ref: '#/components/responses/MethodNotAllowed'
1230 $ref: '#/components/responses/NotAcceptable'
1232 $ref: '#/components/responses/Conflict'
1234 $ref: '#/components/responses/UnprocessableEntity'
1236 $ref: '#/components/responses/InternalServerError'
1238 $ref: '#/components/responses/ServiceUnavailable'
1240 $ref: '#/components/responses/UnexpectedError'
1242 $ref: '#/components/responses/UnexpectedError'
1246 summary: Modify an individual VNF package resource
1247 description: Modify an individual VNF package resource
1248 operationId: updateVnfPkgsIdContent
1250 $ref: '#/components/requestBodies/VnfPkgInfoModifications'
1253 description: No Content
1255 $ref: '#/components/responses/BadRequest'
1257 $ref: '#/components/responses/Unauthorized'
1259 $ref: '#/components/responses/Forbidden'
1261 $ref: '#/components/responses/NotFound'
1263 $ref: '#/components/responses/MethodNotAllowed'
1265 $ref: '#/components/responses/NotAcceptable'
1267 $ref: '#/components/responses/Conflict'
1269 $ref: '#/components/responses/UnprocessableEntity'
1271 $ref: '#/components/responses/InternalServerError'
1273 $ref: '#/components/responses/ServiceUnavailable'
1275 $ref: '#/components/responses/UnexpectedError'
1277 $ref: '#/components/responses/UnexpectedError'
1281 summary: Delete an individual VNF package resource
1282 description: Delete an individual VNF package resource
1283 operationId: deleteVnfPkgsIdContent
1286 description: No Content
1288 $ref: '#/components/responses/BadRequest'
1290 $ref: '#/components/responses/Unauthorized'
1292 $ref: '#/components/responses/Forbidden'
1294 $ref: '#/components/responses/NotFound'
1296 $ref: '#/components/responses/MethodNotAllowed'
1298 $ref: '#/components/responses/NotAcceptable'
1300 $ref: '#/components/responses/Conflict'
1302 $ref: '#/components/responses/UnprocessableEntity'
1304 $ref: '#/components/responses/InternalServerError'
1306 $ref: '#/components/responses/ServiceUnavailable'
1308 $ref: '#/components/responses/UnexpectedError'
1310 $ref: '#/components/responses/UnexpectedError'
1313 # BEGIN NS Instances
1314 '/nslcm/v1/ns_instances':
1318 summary: Query information about multiple NS instances
1319 description: Query information about multiple NS isntances
1320 operationId: getNSinstances
1327 $ref: '#/components/schemas/ArrayOfNsInstance'
1330 $ref: '#/components/schemas/ArrayOfNsInstance'
1332 $ref: '#/components/responses/BadRequest'
1334 $ref: '#/components/responses/Unauthorized'
1336 $ref: '#/components/responses/Forbidden'
1338 $ref: '#/components/responses/NotFound'
1340 $ref: '#/components/responses/MethodNotAllowed'
1342 $ref: '#/components/responses/NotAcceptable'
1344 $ref: '#/components/responses/Conflict'
1346 $ref: '#/components/responses/UnprocessableEntity'
1348 $ref: '#/components/responses/InternalServerError'
1350 $ref: '#/components/responses/ServiceUnavailable'
1352 $ref: '#/components/responses/UnexpectedError'
1354 $ref: '#/components/responses/UnexpectedError'
1358 summary: Create a new NS instance resource
1359 description: Create a new NS instance resource
1360 operationId: addNSinstance
1362 $ref: '#/components/requestBodies/InstantiateNsRequest'
1365 description: Created
1374 $ref: '#/components/schemas/ObjectId'
1377 $ref: '#/components/schemas/ObjectId'
1379 $ref: '#/components/responses/BadRequest'
1381 $ref: '#/components/responses/Unauthorized'
1383 $ref: '#/components/responses/Forbidden'
1385 $ref: '#/components/responses/NotFound'
1387 $ref: '#/components/responses/MethodNotAllowed'
1389 $ref: '#/components/responses/NotAcceptable'
1391 $ref: '#/components/responses/Conflict'
1393 $ref: '#/components/responses/UnprocessableEntity'
1395 $ref: '#/components/responses/InternalServerError'
1397 $ref: '#/components/responses/ServiceUnavailable'
1399 $ref: '#/components/responses/UnexpectedError'
1401 $ref: '#/components/responses/UnexpectedError'
1402 '/nslcm/v1/ns_instances/{nsInstanceId}':
1404 - name: nsInstanceId
1407 description: NS Instance ID
1410 - name: vcaStatusRefresh
1413 description: Set to true if vca status needs to be refreshed.
1419 summary: Read an individual NS instance resource
1420 description: Read an individual NS instance resource
1421 operationId: getNSinstance
1428 $ref: '#/components/schemas/NsInstance'
1431 $ref: '#/components/schemas/NsInstance'
1433 $ref: '#/components/responses/BadRequest'
1435 $ref: '#/components/responses/Unauthorized'
1437 $ref: '#/components/responses/Forbidden'
1439 $ref: '#/components/responses/NotFound'
1441 $ref: '#/components/responses/MethodNotAllowed'
1443 $ref: '#/components/responses/NotAcceptable'
1445 $ref: '#/components/responses/Conflict'
1447 $ref: '#/components/responses/UnprocessableEntity'
1449 $ref: '#/components/responses/InternalServerError'
1451 $ref: '#/components/responses/ServiceUnavailable'
1453 $ref: '#/components/responses/UnexpectedError'
1455 $ref: '#/components/responses/UnexpectedError'
1459 summary: Delete an individual NS instance resource
1460 description: Delete an individual NS instance resource
1461 operationId: deleteNSinstance
1464 description: No Content
1466 $ref: '#/components/responses/BadRequest'
1468 $ref: '#/components/responses/Unauthorized'
1470 $ref: '#/components/responses/Forbidden'
1472 $ref: '#/components/responses/NotFound'
1474 $ref: '#/components/responses/MethodNotAllowed'
1476 $ref: '#/components/responses/NotAcceptable'
1478 $ref: '#/components/responses/Conflict'
1480 $ref: '#/components/responses/UnprocessableEntity'
1482 $ref: '#/components/responses/InternalServerError'
1484 $ref: '#/components/responses/ServiceUnavailable'
1486 $ref: '#/components/responses/UnexpectedError'
1488 $ref: '#/components/responses/UnexpectedError'
1489 '/nslcm/v1/ns_instances/{nsInstanceId}/instantiate':
1491 - name: nsInstanceId
1494 description: NS Instance ID
1500 summary: Instantiate a NS
1502 Instantiate a NS. The precondition is that the NS instance must have
1503 been created and must be in NOT_INSTANTIATED state. As a result of the
1504 success of this operation, the NFVO creates a "NS Lifecycle Operation
1505 Occurrence" resource for the request, and the NS instance state becomes
1507 operationId: instantiateNSinstance
1509 $ref: '#/components/requestBodies/InstantiateNsRequest'
1512 description: Accepted
1516 It must point to the new "NS Lifecycle Operation Occurrence"
1517 resource, i.e. an URI like ".../ns_lcm_op_occs/{nsLcmOpOccId}"
1524 $ref: '#/components/schemas/ObjectId'
1527 $ref: '#/components/schemas/ObjectId'
1529 $ref: '#/components/responses/BadRequest'
1531 $ref: '#/components/responses/Unauthorized'
1533 $ref: '#/components/responses/Forbidden'
1535 $ref: '#/components/responses/NotFound'
1537 $ref: '#/components/responses/MethodNotAllowed'
1539 $ref: '#/components/responses/NotAcceptable'
1541 $ref: '#/components/responses/Conflict'
1543 $ref: '#/components/responses/UnprocessableEntity'
1545 $ref: '#/components/responses/InternalServerError'
1547 $ref: '#/components/responses/ServiceUnavailable'
1549 $ref: '#/components/responses/UnexpectedError'
1551 $ref: '#/components/responses/UnexpectedError'
1552 '/nslcm/v1/ns_instances/{nsInstanceId}/scale':
1554 - name: nsInstanceId
1557 description: NS Instance ID
1563 summary: Scale a NS instance
1565 Scale a NS instance. The precondition is that the NS instance must have
1566 been created and must be in INSTANTIATED state. As a result of the
1567 success of this operation, the NFVO creates a "NS Lifecycle Operation
1568 Occurrence" resource for the request, and the NS instance state remains
1570 operationId: scaleNSinstance
1572 $ref: '#/components/requestBodies/ScaleNsRequest'
1575 description: Accepted
1579 It must point to the new "NS Lifecycle Operation Occurrence"
1580 resource, i.e. an URI like ".../ns_lcm_op_occs/{nsLcmOpOccId}"
1585 $ref: '#/components/responses/BadRequest'
1587 $ref: '#/components/responses/Unauthorized'
1589 $ref: '#/components/responses/Forbidden'
1591 $ref: '#/components/responses/NotFound'
1593 $ref: '#/components/responses/MethodNotAllowed'
1595 $ref: '#/components/responses/NotAcceptable'
1597 $ref: '#/components/responses/Conflict'
1599 $ref: '#/components/responses/UnprocessableEntity'
1601 $ref: '#/components/responses/InternalServerError'
1603 $ref: '#/components/responses/ServiceUnavailable'
1605 $ref: '#/components/responses/UnexpectedError'
1607 $ref: '#/components/responses/UnexpectedError'
1608 '/nslcm/v1/ns_instances/{nsInstanceId}/terminate':
1610 - name: nsInstanceId
1613 description: NS Instance ID
1619 summary: Terminate a NS instance
1621 Terminate a NS instance. The precondition is that the NS instance must have
1622 been created and must be in INSTANTIATED state. As a result of the
1623 success of this operation, the NFVO creates a "NS Lifecycle Operation
1624 Occurrence" resource for the request, and the NS instance state becomes
1626 operationId: terminateNSinstance
1628 # Request data is not required
1629 $ref: '#/components/requestBodies/TerminateNsRequest'
1632 description: Accepted
1636 It must point to the new "NS Lifecycle Operation Occurrence"
1637 resource, i.e. an URI like ".../ns_lcm_op_occs/{nsLcmOpOccId}"
1644 $ref: '#/components/schemas/ObjectId'
1647 $ref: '#/components/schemas/ObjectId'
1649 $ref: '#/components/responses/BadRequest'
1651 $ref: '#/components/responses/Unauthorized'
1653 $ref: '#/components/responses/Forbidden'
1655 $ref: '#/components/responses/NotFound'
1657 $ref: '#/components/responses/MethodNotAllowed'
1659 $ref: '#/components/responses/NotAcceptable'
1661 $ref: '#/components/responses/Conflict'
1663 $ref: '#/components/responses/UnprocessableEntity'
1665 $ref: '#/components/responses/InternalServerError'
1667 $ref: '#/components/responses/ServiceUnavailable'
1669 $ref: '#/components/responses/UnexpectedError'
1671 $ref: '#/components/responses/UnexpectedError'
1672 '/nslcm/v1/ns_instances/{nsInstanceId}/action':
1674 - name: nsInstanceId
1677 description: NS Instance ID
1683 summary: Execute an action on a NS instance
1685 Execute an action on a NS instance.
1686 The NS instance must have been created and must be in INSTANTIATED state.
1687 operationId: actionOnNSinstance
1692 $ref: '#/components/schemas/NSinstanceActionRequest'
1695 $ref: '#/components/schemas/NSinstanceActionRequest'
1698 description: Accepted
1702 It must point to the new "NS Lifecycle Operation Occurrence"
1703 resource, i.e. an URI like ".../ns_lcm_op_occs/{nsLcmOpOccId}"
1710 $ref: '#/components/schemas/ObjectId'
1713 $ref: '#/components/schemas/ObjectId'
1715 $ref: '#/components/responses/BadRequest'
1717 $ref: '#/components/responses/Unauthorized'
1719 $ref: '#/components/responses/Forbidden'
1721 $ref: '#/components/responses/NotFound'
1723 $ref: '#/components/responses/MethodNotAllowed'
1725 $ref: '#/components/responses/NotAcceptable'
1727 $ref: '#/components/responses/Conflict'
1729 $ref: '#/components/responses/UnprocessableEntity'
1731 $ref: '#/components/responses/InternalServerError'
1733 $ref: '#/components/responses/ServiceUnavailable'
1735 $ref: '#/components/responses/UnexpectedError'
1737 $ref: '#/components/responses/UnexpectedError'
1738 '/nslcm/v1/ns_instances_content':
1742 summary: Query information about multiple NS instances
1743 description: Query information about multiple NS isntances
1744 operationId: getNSinstancesContent
1751 $ref: '#/components/schemas/ArrayOfNsInstance'
1754 $ref: '#/components/schemas/ArrayOfNsInstance'
1756 $ref: '#/components/responses/BadRequest'
1758 $ref: '#/components/responses/Unauthorized'
1760 $ref: '#/components/responses/Forbidden'
1762 $ref: '#/components/responses/NotFound'
1764 $ref: '#/components/responses/MethodNotAllowed'
1766 $ref: '#/components/responses/NotAcceptable'
1768 $ref: '#/components/responses/Conflict'
1770 $ref: '#/components/responses/UnprocessableEntity'
1772 $ref: '#/components/responses/InternalServerError'
1774 $ref: '#/components/responses/ServiceUnavailable'
1776 $ref: '#/components/responses/UnexpectedError'
1778 $ref: '#/components/responses/UnexpectedError'
1782 summary: Create a new NS instance
1783 description: Create a new NS instance
1784 operationId: createNSinstanceContent
1786 $ref: '#/components/requestBodies/InstantiateNsRequest'
1789 description: Created
1798 $ref: '#/components/schemas/CreateNSinstanceContentResponse'
1801 $ref: '#/components/schemas/CreateNSinstanceContentResponse'
1803 $ref: '#/components/responses/BadRequest'
1805 $ref: '#/components/responses/Unauthorized'
1807 $ref: '#/components/responses/Forbidden'
1809 $ref: '#/components/responses/NotFound'
1811 $ref: '#/components/responses/MethodNotAllowed'
1813 $ref: '#/components/responses/NotAcceptable'
1815 $ref: '#/components/responses/Conflict'
1817 $ref: '#/components/responses/UnprocessableEntity'
1819 $ref: '#/components/responses/InternalServerError'
1821 $ref: '#/components/responses/ServiceUnavailable'
1823 $ref: '#/components/responses/UnexpectedError'
1825 $ref: '#/components/responses/UnexpectedError'
1826 '/nslcm/v1/ns_instances_content/{nsInstanceContentId}':
1828 - name: nsInstanceContentId
1831 description: NS Instance Content ID
1837 summary: Read an individual NS instance resource
1838 description: Read an individual NS instance resource
1839 operationId: getNSinstanceContent
1846 $ref: '#/components/schemas/NsInstance'
1849 $ref: '#/components/schemas/NsInstance'
1851 $ref: '#/components/responses/BadRequest'
1853 $ref: '#/components/responses/Unauthorized'
1855 $ref: '#/components/responses/Forbidden'
1857 $ref: '#/components/responses/NotFound'
1859 $ref: '#/components/responses/MethodNotAllowed'
1861 $ref: '#/components/responses/NotAcceptable'
1863 $ref: '#/components/responses/Conflict'
1865 $ref: '#/components/responses/UnprocessableEntity'
1867 $ref: '#/components/responses/InternalServerError'
1869 $ref: '#/components/responses/ServiceUnavailable'
1871 $ref: '#/components/responses/UnexpectedError'
1873 $ref: '#/components/responses/UnexpectedError'
1877 summary: Delete an individual NS instance resource
1878 description: Delete an individual NS instance resource
1879 operationId: deleteNSinstanceContent
1882 description: Accepted
1886 $ref: '#/components/schemas/ObjectId'
1889 $ref: '#/components/schemas/ObjectId'
1891 description: No Content
1893 $ref: '#/components/responses/BadRequest'
1895 $ref: '#/components/responses/Unauthorized'
1897 $ref: '#/components/responses/Forbidden'
1899 $ref: '#/components/responses/NotFound'
1901 $ref: '#/components/responses/MethodNotAllowed'
1903 $ref: '#/components/responses/NotAcceptable'
1905 $ref: '#/components/responses/Conflict'
1907 $ref: '#/components/responses/UnprocessableEntity'
1909 $ref: '#/components/responses/InternalServerError'
1911 $ref: '#/components/responses/ServiceUnavailable'
1913 $ref: '#/components/responses/UnexpectedError'
1915 $ref: '#/components/responses/UnexpectedError'
1916 '/nslcm/v1/ns_lcm_op_occs':
1920 summary: Query information about multiple NS LCM Operation Occurrences
1921 description: Query information about multiple NS LCM Operation Occurrences
1922 operationId: getNSLCMOpOccs
1929 $ref: '#/components/schemas/ArrayOfNsLcmOpOcc'
1932 $ref: '#/components/schemas/ArrayOfNsLcmOpOcc'
1934 $ref: '#/components/responses/BadRequest'
1936 $ref: '#/components/responses/Unauthorized'
1938 $ref: '#/components/responses/Forbidden'
1940 $ref: '#/components/responses/NotFound'
1942 $ref: '#/components/responses/MethodNotAllowed'
1944 $ref: '#/components/responses/NotAcceptable'
1946 $ref: '#/components/responses/Conflict'
1948 $ref: '#/components/responses/UnprocessableEntity'
1950 $ref: '#/components/responses/InternalServerError'
1952 $ref: '#/components/responses/ServiceUnavailable'
1954 $ref: '#/components/responses/UnexpectedError'
1956 $ref: '#/components/responses/UnexpectedError'
1957 '/nslcm/v1/ns_lcm_op_occs/{nsLcmOpOccId}':
1959 - name: nsLcmOpOccId
1962 description: NS LCM Operation Occurrence ID
1968 summary: Query information about an individual NS LCM Operation Occurrence
1969 description: Query information about an individual NS LCM Operation Occurrence
1970 operationId: getNSLCMOpOcc
1977 $ref: '#/components/schemas/NsLcmOpOcc'
1980 $ref: '#/components/schemas/NsLcmOpOcc'
1982 $ref: '#/components/responses/BadRequest'
1984 $ref: '#/components/responses/Unauthorized'
1986 $ref: '#/components/responses/Forbidden'
1988 $ref: '#/components/responses/NotFound'
1990 $ref: '#/components/responses/MethodNotAllowed'
1992 $ref: '#/components/responses/NotAcceptable'
1994 $ref: '#/components/responses/Conflict'
1996 $ref: '#/components/responses/UnprocessableEntity'
1998 $ref: '#/components/responses/InternalServerError'
2000 $ref: '#/components/responses/ServiceUnavailable'
2002 $ref: '#/components/responses/UnexpectedError'
2004 $ref: '#/components/responses/UnexpectedError'
2005 '/nslcm/v1/vnf_instances':
2009 summary: Query information about multiple VNF Instances
2010 description: Query information about multiple VNF Instances
2011 operationId: getVnfInstances
2018 $ref: '#/components/schemas/ArrayOfVnfInstanceInfo'
2021 $ref: '#/components/schemas/ArrayOfVnfInstanceInfo'
2023 $ref: '#/components/responses/BadRequest'
2025 $ref: '#/components/responses/Unauthorized'
2027 $ref: '#/components/responses/Forbidden'
2029 $ref: '#/components/responses/NotFound'
2031 $ref: '#/components/responses/MethodNotAllowed'
2033 $ref: '#/components/responses/NotAcceptable'
2035 $ref: '#/components/responses/Conflict'
2037 $ref: '#/components/responses/UnprocessableEntity'
2039 $ref: '#/components/responses/InternalServerError'
2041 $ref: '#/components/responses/ServiceUnavailable'
2043 $ref: '#/components/responses/UnexpectedError'
2045 $ref: '#/components/responses/UnexpectedError'
2046 '/nslcm/v1/vnf_instances/{vnfInstanceId}':
2048 - name: vnfInstanceId
2051 description: VNF Instance ID
2057 summary: Query information about an individual VNF Instance
2058 description: Query information about an individual VNF Instance
2059 operationId: getVnfInstance
2066 $ref: '#/components/schemas/VnfInstanceInfo'
2069 $ref: '#/components/schemas/VnfInstanceInfo'
2071 $ref: '#/components/responses/BadRequest'
2073 $ref: '#/components/responses/Unauthorized'
2075 $ref: '#/components/responses/Forbidden'
2077 $ref: '#/components/responses/NotFound'
2079 $ref: '#/components/responses/MethodNotAllowed'
2081 $ref: '#/components/responses/NotAcceptable'
2083 $ref: '#/components/responses/Conflict'
2085 $ref: '#/components/responses/UnprocessableEntity'
2087 $ref: '#/components/responses/InternalServerError'
2089 $ref: '#/components/responses/ServiceUnavailable'
2091 $ref: '#/components/responses/UnexpectedError'
2093 $ref: '#/components/responses/UnexpectedError'
2094 /nslcm/v1/subscriptions:
2098 summary: Query information about multiple NS instance subscription
2099 description: Query information about multiple NS instance subscription
2100 operationId: getNsSubcriptions
2107 $ref: '#/components/schemas/ArrayOfNslcmSubscriptionInfo'
2110 $ref: '#/components/schemas/ArrayOfNslcmSubscriptionInfo'
2112 $ref: '#/components/responses/BadRequest'
2114 $ref: '#/components/responses/Unauthorized'
2116 $ref: '#/components/responses/Forbidden'
2118 $ref: '#/components/responses/NotFound'
2120 $ref: '#/components/responses/MethodNotAllowed'
2122 $ref: '#/components/responses/NotAcceptable'
2124 $ref: '#/components/responses/Conflict'
2126 $ref: '#/components/responses/UnprocessableEntity'
2128 $ref: '#/components/responses/InternalServerError'
2130 $ref: '#/components/responses/ServiceUnavailable'
2132 $ref: '#/components/responses/UnexpectedError'
2134 $ref: '#/components/responses/UnexpectedError'
2138 summary: Create a new subscription for the Network service
2139 description: Create a new subscription for the Network service
2140 operationId: addNsSubcriptions
2142 $ref: '#/components/requestBodies/NslcmSubscriptionRequest'
2145 description: Created
2153 $ref: '#/components/schemas/NslcmSubscriptionResponse'
2156 $ref: '#/components/schemas/NslcmSubscriptionResponse'
2158 $ref: '#/components/responses/BadRequest'
2160 $ref: '#/components/responses/Unauthorized'
2162 $ref: '#/components/responses/Forbidden'
2164 $ref: '#/components/responses/NotFound'
2166 $ref: '#/components/responses/MethodNotAllowed'
2168 $ref: '#/components/responses/NotAcceptable'
2170 $ref: '#/components/responses/Conflict'
2172 $ref: '#/components/responses/UnprocessableEntity'
2174 $ref: '#/components/responses/InternalServerError'
2176 $ref: '#/components/responses/ServiceUnavailable'
2178 $ref: '#/components/responses/UnexpectedError'
2180 $ref: '#/components/responses/UnexpectedError'
2181 '/nslcm/v1/subscriptions/{nsSubscriptionsId}':
2183 - name: nsSubscriptionsId
2186 description: Network Service Subscription ID
2192 summary: Read information about an individual Network Service Subscription
2193 description: Read information about an individual Network Service Subscription
2194 operationId: getNsSubcriptionId
2201 $ref: '#/components/schemas/NslcmSubscriptionInfo'
2204 $ref: '#/components/schemas/NslcmSubscriptionInfo'
2206 $ref: '#/components/responses/BadRequest'
2208 $ref: '#/components/responses/Unauthorized'
2210 $ref: '#/components/responses/Forbidden'
2212 $ref: '#/components/responses/NotFound'
2214 $ref: '#/components/responses/MethodNotAllowed'
2216 $ref: '#/components/responses/NotAcceptable'
2218 $ref: '#/components/responses/Conflict'
2220 $ref: '#/components/responses/UnprocessableEntity'
2222 $ref: '#/components/responses/InternalServerError'
2224 $ref: '#/components/responses/ServiceUnavailable'
2226 $ref: '#/components/responses/UnexpectedError'
2228 $ref: '#/components/responses/UnexpectedError'
2232 summary: Delete an individual Network Service Subscription
2233 description: Delete an individual Network Service Subscription
2234 operationId: deleteNsSubcriptionId
2237 description: No Content
2239 $ref: '#/components/responses/BadRequest'
2241 $ref: '#/components/responses/Unauthorized'
2243 $ref: '#/components/responses/Forbidden'
2245 $ref: '#/components/responses/NotFound'
2247 $ref: '#/components/responses/MethodNotAllowed'
2249 $ref: '#/components/responses/NotAcceptable'
2251 $ref: '#/components/responses/Conflict'
2253 $ref: '#/components/responses/UnprocessableEntity'
2255 $ref: '#/components/responses/InternalServerError'
2257 $ref: '#/components/responses/ServiceUnavailable'
2259 $ref: '#/components/responses/UnexpectedError'
2261 $ref: '#/components/responses/UnexpectedError'
2264 # BEGIN NetSlice Templates
2265 '/nst/v1/netslice_templates':
2268 - "NetSlice templates"
2269 summary: Query information about multiple NetSlice template resources
2270 description: Query information about multiple NetSlice template resources
2271 operationId: getNSTs
2278 $ref: '#/components/schemas/ArrayOfNstInfo'
2281 $ref: '#/components/schemas/ArrayOfNstInfo'
2283 $ref: '#/components/responses/BadRequest'
2285 $ref: '#/components/responses/Unauthorized'
2287 $ref: '#/components/responses/Forbidden'
2289 $ref: '#/components/responses/NotFound'
2291 $ref: '#/components/responses/MethodNotAllowed'
2293 $ref: '#/components/responses/NotAcceptable'
2295 $ref: '#/components/responses/Conflict'
2297 $ref: '#/components/responses/UnprocessableEntity'
2299 $ref: '#/components/responses/InternalServerError'
2301 $ref: '#/components/responses/ServiceUnavailable'
2303 $ref: '#/components/responses/UnexpectedError'
2305 $ref: '#/components/responses/UnexpectedError'
2308 - "NetSlice templates"
2309 summary: Create a new NetSlice template resource
2310 description: Create a new NetSlice template resource
2313 $ref: '#/components/requestBodies/CreateNstInfoRequest'
2316 description: Created
2325 $ref: '#/components/schemas/ObjectId'
2328 $ref: '#/components/schemas/ObjectId'
2330 $ref: '#/components/responses/BadRequest'
2332 $ref: '#/components/responses/Unauthorized'
2334 $ref: '#/components/responses/Forbidden'
2336 $ref: '#/components/responses/NotFound'
2338 $ref: '#/components/responses/MethodNotAllowed'
2340 $ref: '#/components/responses/NotAcceptable'
2342 $ref: '#/components/responses/Conflict'
2344 $ref: '#/components/responses/UnprocessableEntity'
2346 $ref: '#/components/responses/InternalServerError'
2348 $ref: '#/components/responses/ServiceUnavailable'
2350 $ref: '#/components/responses/UnexpectedError'
2352 $ref: '#/components/responses/UnexpectedError'
2353 '/nst/v1/netslice_templates/{netsliceTemplateId}':
2355 - name: netsliceTemplateId
2358 description: NetSlice Template ID
2363 - "NetSlice templates"
2364 summary: Read information about an individual NetSlice template resource
2365 description: Read information about an individual NetSlice template resource
2373 $ref: '#/components/schemas/NstInfo'
2376 $ref: '#/components/schemas/NstInfo'
2378 $ref: '#/components/responses/BadRequest'
2380 $ref: '#/components/responses/Unauthorized'
2382 $ref: '#/components/responses/Forbidden'
2384 $ref: '#/components/responses/NotFound'
2386 $ref: '#/components/responses/MethodNotAllowed'
2388 $ref: '#/components/responses/NotAcceptable'
2390 $ref: '#/components/responses/Conflict'
2392 $ref: '#/components/responses/UnprocessableEntity'
2394 $ref: '#/components/responses/InternalServerError'
2396 $ref: '#/components/responses/ServiceUnavailable'
2398 $ref: '#/components/responses/UnexpectedError'
2400 $ref: '#/components/responses/UnexpectedError'
2403 - "NetSlice templates"
2404 summary: Delete an individual NetSlice template resource
2405 description: Delete an individual NetSlice template resource
2406 operationId: deleteNST
2409 description: No Content
2411 $ref: '#/components/responses/BadRequest'
2413 $ref: '#/components/responses/Unauthorized'
2415 $ref: '#/components/responses/Forbidden'
2417 $ref: '#/components/responses/NotFound'
2419 $ref: '#/components/responses/MethodNotAllowed'
2421 $ref: '#/components/responses/NotAcceptable'
2423 $ref: '#/components/responses/Conflict'
2425 $ref: '#/components/responses/UnprocessableEntity'
2427 $ref: '#/components/responses/InternalServerError'
2429 $ref: '#/components/responses/ServiceUnavailable'
2431 $ref: '#/components/responses/UnexpectedError'
2433 $ref: '#/components/responses/UnexpectedError'
2434 '/nst/v1/netslice_templates/{netsliceTemplateId}/artifacts/{artifactPath}':
2436 - name: netsliceTemplateId
2439 description: NetSlice Template ID
2442 - name: artifactPath
2445 description: Artifact Path
2450 - "NetSlice templates"
2451 summary: Fetch individual NetSlice Template artifact
2452 description: Fetch individual NetSlice Template artifact
2453 operationId: getNstArtifact
2458 application/octet-stream:
2463 description: Partial Content
2469 application/octet-stream:
2474 $ref: '#/components/responses/BadRequest'
2476 $ref: '#/components/responses/Unauthorized'
2478 $ref: '#/components/responses/Forbidden'
2480 $ref: '#/components/responses/NotFound'
2482 $ref: '#/components/responses/MethodNotAllowed'
2484 $ref: '#/components/responses/NotAcceptable'
2486 $ref: '#/components/responses/Conflict'
2488 $ref: '#/components/responses/UnprocessableEntity'
2490 $ref: '#/components/responses/InternalServerError'
2492 $ref: '#/components/responses/ServiceUnavailable'
2494 $ref: '#/components/responses/UnexpectedError'
2496 $ref: '#/components/responses/UnexpectedError'
2497 '/nst/v1/netslice_templates/{netsliceTemplateId}/nst':
2499 - name: netsliceTemplateId
2502 description: NetSlice Template ID
2507 - "NetSlice templates"
2508 summary: Read NST of an on-boarded NetSlice Template
2509 description: Read NST of an on-boarded NetSlice Template
2510 operationId: getNstNst
2517 $ref: '#/components/schemas/NetSliceTemplate'
2519 $ref: '#/components/responses/BadRequest'
2521 $ref: '#/components/responses/Unauthorized'
2523 $ref: '#/components/responses/Forbidden'
2525 $ref: '#/components/responses/NotFound'
2527 $ref: '#/components/responses/MethodNotAllowed'
2529 $ref: '#/components/responses/NotAcceptable'
2531 $ref: '#/components/responses/Conflict'
2533 $ref: '#/components/responses/UnprocessableEntity'
2535 $ref: '#/components/responses/InternalServerError'
2537 $ref: '#/components/responses/ServiceUnavailable'
2539 $ref: '#/components/responses/UnexpectedError'
2541 $ref: '#/components/responses/UnexpectedError'
2542 '/nst/v1/netslice_templates/{netsliceTemplateId}/nst_content':
2544 - name: netsliceTemplateId
2547 description: NetSlice Template ID
2552 - "NetSlice templates"
2553 summary: Fetch the content of a NST
2554 description: Fetch the content of a NST
2555 operationId: getNSTcontent
2562 $ref: '#/components/schemas/NetSlicePackage'
2564 description: Partial Content
2572 $ref: '#/components/schemas/NetSlicePackage'
2574 $ref: '#/components/responses/BadRequest'
2576 $ref: '#/components/responses/Unauthorized'
2578 $ref: '#/components/responses/Forbidden'
2580 $ref: '#/components/responses/NotFound'
2582 $ref: '#/components/responses/MethodNotAllowed'
2584 $ref: '#/components/responses/NotAcceptable'
2586 $ref: '#/components/responses/Conflict'
2588 $ref: '#/components/responses/UnprocessableEntity'
2590 $ref: '#/components/responses/InternalServerError'
2592 $ref: '#/components/responses/ServiceUnavailable'
2594 $ref: '#/components/responses/UnexpectedError'
2596 $ref: '#/components/responses/UnexpectedError'
2599 - "NetSlice templates"
2600 summary: Upload the content of a NST
2601 description: Upload the content of a NST
2602 operationId: updateNSTcontent
2604 $ref: '#/components/requestBodies/NetSlicePackage'
2607 description: Accepted
2609 description: No Content
2611 $ref: '#/components/responses/BadRequest'
2613 $ref: '#/components/responses/Unauthorized'
2615 $ref: '#/components/responses/Forbidden'
2617 $ref: '#/components/responses/NotFound'
2619 $ref: '#/components/responses/MethodNotAllowed'
2621 $ref: '#/components/responses/NotAcceptable'
2623 $ref: '#/components/responses/Conflict'
2625 $ref: '#/components/responses/UnprocessableEntity'
2627 $ref: '#/components/responses/InternalServerError'
2629 $ref: '#/components/responses/ServiceUnavailable'
2631 $ref: '#/components/responses/UnexpectedError'
2633 $ref: '#/components/responses/UnexpectedError'
2634 '/nst/v1/netslice_templates_content':
2637 - "NetSlice templates"
2638 summary: Upload a NetSlice package by providing the content of the NetSlice package
2639 description: Upload a NetSlice package by providing the content of the NetSlice package
2640 operationId: uploadNstContent
2645 $ref: '#/components/schemas/NetSlicePackage'
2648 description: Created
2657 $ref: '#/components/schemas/ObjectId'
2660 $ref: '#/components/schemas/ObjectId'
2662 description: Accepted
2664 description: No Content
2666 $ref: '#/components/responses/BadRequest'
2668 $ref: '#/components/responses/Unauthorized'
2670 $ref: '#/components/responses/Forbidden'
2672 $ref: '#/components/responses/NotFound'
2674 $ref: '#/components/responses/MethodNotAllowed'
2676 $ref: '#/components/responses/NotAcceptable'
2678 $ref: '#/components/responses/Conflict'
2680 $ref: '#/components/responses/UnprocessableEntity'
2682 $ref: '#/components/responses/InternalServerError'
2684 $ref: '#/components/responses/ServiceUnavailable'
2686 $ref: '#/components/responses/UnexpectedError'
2688 $ref: '#/components/responses/UnexpectedError'
2691 - "NetSlice templates"
2692 summary: Query information about multiple NetSlice Template resources
2693 description: Query information about multiple NetSlice Template resources
2694 operationId: getNstContent
2701 $ref: '#/components/schemas/ArrayOfNstInfo'
2704 $ref: '#/components/schemas/ArrayOfNstInfo'
2706 description: Partial Content
2712 application/octet-stream:
2717 $ref: '#/components/responses/BadRequest'
2719 $ref: '#/components/responses/Unauthorized'
2721 $ref: '#/components/responses/Forbidden'
2723 $ref: '#/components/responses/NotFound'
2725 $ref: '#/components/responses/MethodNotAllowed'
2727 $ref: '#/components/responses/NotAcceptable'
2729 $ref: '#/components/responses/Conflict'
2731 $ref: '#/components/responses/UnprocessableEntity'
2733 $ref: '#/components/responses/InternalServerError'
2735 $ref: '#/components/responses/ServiceUnavailable'
2737 $ref: '#/components/responses/UnexpectedError'
2739 $ref: '#/components/responses/UnexpectedError'
2740 '/nst/v1/netslice_templates_content/{netsliceTemplateContentId}':
2742 - name: netsliceTemplateContentId
2745 description: NetSlice Template ID
2750 - "NetSlice templates"
2751 summary: Read information about an individual NetSlice Template resource
2752 description: Read information about an individual NetSlice Template resource
2753 operationId: getNstIdContent
2760 $ref: '#/components/schemas/NstInfo'
2763 $ref: '#/components/schemas/NstInfo'
2765 $ref: '#/components/responses/BadRequest'
2767 $ref: '#/components/responses/Unauthorized'
2769 $ref: '#/components/responses/Forbidden'
2771 $ref: '#/components/responses/NotFound'
2773 $ref: '#/components/responses/MethodNotAllowed'
2775 $ref: '#/components/responses/NotAcceptable'
2777 $ref: '#/components/responses/Conflict'
2779 $ref: '#/components/responses/UnprocessableEntity'
2781 $ref: '#/components/responses/InternalServerError'
2783 $ref: '#/components/responses/ServiceUnavailable'
2785 $ref: '#/components/responses/UnexpectedError'
2787 $ref: '#/components/responses/UnexpectedError'
2790 - "NetSlice templates"
2791 summary: Modify an individual NetSlice Template resource
2792 description: Modify an individual NetSlice Template resource
2793 operationId: updateNstIdContent
2795 $ref: '#/components/requestBodies/NstInfoModifications'
2798 description: No Content
2800 $ref: '#/components/responses/BadRequest'
2802 $ref: '#/components/responses/Unauthorized'
2804 $ref: '#/components/responses/Forbidden'
2806 $ref: '#/components/responses/NotFound'
2808 $ref: '#/components/responses/MethodNotAllowed'
2810 $ref: '#/components/responses/NotAcceptable'
2812 $ref: '#/components/responses/Conflict'
2814 $ref: '#/components/responses/UnprocessableEntity'
2816 $ref: '#/components/responses/InternalServerError'
2818 $ref: '#/components/responses/ServiceUnavailable'
2820 $ref: '#/components/responses/UnexpectedError'
2822 $ref: '#/components/responses/UnexpectedError'
2825 - "NetSlice templates"
2826 summary: Delete an individual NetSlice Template resource
2827 description: Delete an individual NetSlice Template resource
2828 operationId: deleteNstIdContent
2831 description: No Content
2833 $ref: '#/components/responses/BadRequest'
2835 $ref: '#/components/responses/Unauthorized'
2837 $ref: '#/components/responses/Forbidden'
2839 $ref: '#/components/responses/NotFound'
2841 $ref: '#/components/responses/MethodNotAllowed'
2843 $ref: '#/components/responses/NotAcceptable'
2845 $ref: '#/components/responses/Conflict'
2847 $ref: '#/components/responses/UnprocessableEntity'
2849 $ref: '#/components/responses/InternalServerError'
2851 $ref: '#/components/responses/ServiceUnavailable'
2853 $ref: '#/components/responses/UnexpectedError'
2855 $ref: '#/components/responses/UnexpectedError'
2856 # END NetSlice Templates
2858 # BEGIN NetSlice Instances
2859 '/nsilcm/v1/netslice_instances':
2862 - "NetSlice instances"
2863 summary: Query information about multiple NetSlice instances
2864 description: Query information about multiple NetSlice isntances
2865 operationId: getNSIs
2872 $ref: '#/components/schemas/ArrayOfNetSliceInstance'
2875 $ref: '#/components/schemas/ArrayOfNetSliceInstance'
2877 $ref: '#/components/responses/BadRequest'
2879 $ref: '#/components/responses/Unauthorized'
2881 $ref: '#/components/responses/Forbidden'
2883 $ref: '#/components/responses/NotFound'
2885 $ref: '#/components/responses/MethodNotAllowed'
2887 $ref: '#/components/responses/NotAcceptable'
2889 $ref: '#/components/responses/Conflict'
2891 $ref: '#/components/responses/UnprocessableEntity'
2893 $ref: '#/components/responses/InternalServerError'
2895 $ref: '#/components/responses/ServiceUnavailable'
2897 $ref: '#/components/responses/UnexpectedError'
2899 $ref: '#/components/responses/UnexpectedError'
2902 - "NetSlice instances"
2903 summary: Create a new NetSlice instance resource
2904 description: Create a new NetSlice instance resource
2907 $ref: '#/components/requestBodies/InstantiateNsiRequest'
2910 description: Created
2919 $ref: '#/components/schemas/ObjectId'
2922 $ref: '#/components/schemas/ObjectId'
2924 $ref: '#/components/responses/BadRequest'
2926 $ref: '#/components/responses/Unauthorized'
2928 $ref: '#/components/responses/Forbidden'
2930 $ref: '#/components/responses/NotFound'
2932 $ref: '#/components/responses/MethodNotAllowed'
2934 $ref: '#/components/responses/NotAcceptable'
2936 $ref: '#/components/responses/Conflict'
2938 $ref: '#/components/responses/UnprocessableEntity'
2940 $ref: '#/components/responses/InternalServerError'
2942 $ref: '#/components/responses/ServiceUnavailable'
2944 $ref: '#/components/responses/UnexpectedError'
2946 $ref: '#/components/responses/UnexpectedError'
2947 '/nsilcm/v1/netslice_instances/{netsliceInstanceId}':
2949 - name: netsliceInstanceId
2952 description: NetSlice Instance ID
2957 - "NetSlice instances"
2958 summary: Read an individual NetSlice instance resource
2959 description: Read an individual NetSlice instance resource
2967 $ref: '#/components/schemas/NetSliceInstance'
2970 $ref: '#/components/schemas/NetSliceInstance'
2972 $ref: '#/components/responses/BadRequest'
2974 $ref: '#/components/responses/Unauthorized'
2976 $ref: '#/components/responses/Forbidden'
2978 $ref: '#/components/responses/NotFound'
2980 $ref: '#/components/responses/MethodNotAllowed'
2982 $ref: '#/components/responses/NotAcceptable'
2984 $ref: '#/components/responses/Conflict'
2986 $ref: '#/components/responses/UnprocessableEntity'
2988 $ref: '#/components/responses/InternalServerError'
2990 $ref: '#/components/responses/ServiceUnavailable'
2992 $ref: '#/components/responses/UnexpectedError'
2994 $ref: '#/components/responses/UnexpectedError'
2997 - "NetSlice instances"
2998 summary: Delete an individual NetSlice instance resource
2999 description: Delete an individual NetSlice instance resource
3000 operationId: deleteNSI
3003 description: No Content
3005 $ref: '#/components/responses/BadRequest'
3007 $ref: '#/components/responses/Unauthorized'
3009 $ref: '#/components/responses/Forbidden'
3011 $ref: '#/components/responses/NotFound'
3013 $ref: '#/components/responses/MethodNotAllowed'
3015 $ref: '#/components/responses/NotAcceptable'
3017 $ref: '#/components/responses/Conflict'
3019 $ref: '#/components/responses/UnprocessableEntity'
3021 $ref: '#/components/responses/InternalServerError'
3023 $ref: '#/components/responses/ServiceUnavailable'
3025 $ref: '#/components/responses/UnexpectedError'
3027 $ref: '#/components/responses/UnexpectedError'
3028 '/nsilcm/v1/netslice_instances/{netsliceInstanceId}/instantiate':
3030 - name: netsliceInstanceId
3033 description: NetSlice Instance ID
3038 - "NetSlice instances"
3039 summary: Instantiate a NetSlice
3041 Instantiate a NetSlice. The precondition is that the NetSlice instance
3042 must have been created and must be in NOT_INSTANTIATED state. As a result
3043 of the success of this operation, the NFVO creates a "NetSlice Lifecycle
3044 Operation Occurrence" resource for the request, and the NS instance state
3045 becomes INSTANTIATED.
3046 operationId: instantiateNSI
3048 $ref: '#/components/requestBodies/InstantiateNsiRequest'
3051 description: Accepted
3055 It must point to the new "NetSlice Lifecycle Operation Occurrence"
3056 resource, i.e. an URI like ".../nsi_lcm_op_occs/{nsiLcmOpOccId}"
3063 $ref: '#/components/schemas/ObjectId'
3066 $ref: '#/components/schemas/ObjectId'
3068 $ref: '#/components/responses/BadRequest'
3070 $ref: '#/components/responses/Unauthorized'
3072 $ref: '#/components/responses/Forbidden'
3074 $ref: '#/components/responses/NotFound'
3076 $ref: '#/components/responses/MethodNotAllowed'
3078 $ref: '#/components/responses/NotAcceptable'
3080 $ref: '#/components/responses/Conflict'
3082 $ref: '#/components/responses/UnprocessableEntity'
3084 $ref: '#/components/responses/InternalServerError'
3086 $ref: '#/components/responses/ServiceUnavailable'
3088 $ref: '#/components/responses/UnexpectedError'
3090 $ref: '#/components/responses/UnexpectedError'
3091 '/nsilcm/v1/netslice_instances/{netsliceInstanceId}/terminate':
3093 - name: netsliceInstanceId
3096 description: NetSlice Instance ID
3101 - "NetSlice instances"
3102 summary: Terminate a NetSlice instance
3104 Terminate a NetSlice instance. The precondition is that the NetSlice instance
3105 must have been created and must be in INSTANTIATED state. As a result of the
3106 success of this operation, the NFVO creates a "NetSlice Lifecycle Operation
3107 Occurrence" resource for the request, and the NetSlice instance state becomes
3109 operationId: terminateNSI
3111 # Request data is not required
3112 $ref: '#/components/requestBodies/TerminateNsiRequest'
3115 description: Accepted
3119 It must point to the new "NetSlice Lifecycle Operation Occurrence"
3120 resource, i.e. an URI like ".../nsi_lcm_op_occs/{nsiLcmOpOccId}"
3127 $ref: '#/components/schemas/ObjectId'
3130 $ref: '#/components/schemas/ObjectId'
3132 $ref: '#/components/responses/BadRequest'
3134 $ref: '#/components/responses/Unauthorized'
3136 $ref: '#/components/responses/Forbidden'
3138 $ref: '#/components/responses/NotFound'
3140 $ref: '#/components/responses/MethodNotAllowed'
3142 $ref: '#/components/responses/NotAcceptable'
3144 $ref: '#/components/responses/Conflict'
3146 $ref: '#/components/responses/UnprocessableEntity'
3148 $ref: '#/components/responses/InternalServerError'
3150 $ref: '#/components/responses/ServiceUnavailable'
3152 $ref: '#/components/responses/UnexpectedError'
3154 $ref: '#/components/responses/UnexpectedError'
3155 '/nsilcm/v1/netslice_instances/{netsliceInstanceId}/action':
3157 - name: netsliceInstanceId
3160 description: NetSlice Instance ID
3165 - "NetSlice instances"
3166 summary: Execute an action on a NetSlice instance
3168 Execute an action on a NetSlice instance.
3169 The NetSlice instance must have been created and must be in INSTANTIATED state.
3170 operationId: actionOnNSI
3175 $ref: '#/components/schemas/NsiActionRequest'
3178 $ref: '#/components/schemas/NsiActionRequest'
3181 description: Accepted
3185 It must point to the new "NS Lifecycle Operation Occurrence"
3186 resource, i.e. an URI like ".../ns_lcm_op_occs/{nsLcmOpOccId}"
3193 $ref: '#/components/schemas/ObjectId'
3196 $ref: '#/components/schemas/ObjectId'
3198 $ref: '#/components/responses/BadRequest'
3200 $ref: '#/components/responses/Unauthorized'
3202 $ref: '#/components/responses/Forbidden'
3204 $ref: '#/components/responses/NotFound'
3206 $ref: '#/components/responses/MethodNotAllowed'
3208 $ref: '#/components/responses/NotAcceptable'
3210 $ref: '#/components/responses/Conflict'
3212 $ref: '#/components/responses/UnprocessableEntity'
3214 $ref: '#/components/responses/InternalServerError'
3216 $ref: '#/components/responses/ServiceUnavailable'
3218 $ref: '#/components/responses/UnexpectedError'
3220 $ref: '#/components/responses/UnexpectedError'
3221 '/nsilcm/v1/netslice_instances_content':
3224 - "NetSlice instances"
3225 summary: Query information about multiple NetSlice instances
3226 description: Query information about multiple NetSlice isntances
3227 operationId: getNSIsContent
3234 $ref: '#/components/schemas/ArrayOfNetSliceInstance'
3237 $ref: '#/components/schemas/ArrayOfNetSliceInstance'
3239 $ref: '#/components/responses/BadRequest'
3241 $ref: '#/components/responses/Unauthorized'
3243 $ref: '#/components/responses/Forbidden'
3245 $ref: '#/components/responses/NotFound'
3247 $ref: '#/components/responses/MethodNotAllowed'
3249 $ref: '#/components/responses/NotAcceptable'
3251 $ref: '#/components/responses/Conflict'
3253 $ref: '#/components/responses/UnprocessableEntity'
3255 $ref: '#/components/responses/InternalServerError'
3257 $ref: '#/components/responses/ServiceUnavailable'
3259 $ref: '#/components/responses/UnexpectedError'
3261 $ref: '#/components/responses/UnexpectedError'
3264 - "NetSlice instances"
3265 summary: Create a new NetSlice instance
3266 description: Create a new NetSlice instance
3267 operationId: createNSIContent
3269 $ref: '#/components/requestBodies/InstantiateNsiRequest'
3272 description: Created
3281 $ref: '#/components/schemas/CreateNsiContentResponse'
3284 $ref: '#/components/schemas/CreateNsiContentResponse'
3286 $ref: '#/components/responses/BadRequest'
3288 $ref: '#/components/responses/Unauthorized'
3290 $ref: '#/components/responses/Forbidden'
3292 $ref: '#/components/responses/NotFound'
3294 $ref: '#/components/responses/MethodNotAllowed'
3296 $ref: '#/components/responses/NotAcceptable'
3298 $ref: '#/components/responses/Conflict'
3300 $ref: '#/components/responses/UnprocessableEntity'
3302 $ref: '#/components/responses/InternalServerError'
3304 $ref: '#/components/responses/ServiceUnavailable'
3306 $ref: '#/components/responses/UnexpectedError'
3308 $ref: '#/components/responses/UnexpectedError'
3309 '/nsilcm/v1/netslice_instances_content/{netsliceInstanceContentId}':
3311 - name: netsliceInstanceContentId
3314 description: NetSlice Instance Content ID
3319 - "NetSlice instances"
3320 summary: Read an individual NetSlice instance resource
3321 description: Read an individual NetSlice instance resource
3322 operationId: getNSIContent
3329 $ref: '#/components/schemas/NetSliceInstance'
3332 $ref: '#/components/schemas/NetSliceInstance'
3334 $ref: '#/components/responses/BadRequest'
3336 $ref: '#/components/responses/Unauthorized'
3338 $ref: '#/components/responses/Forbidden'
3340 $ref: '#/components/responses/NotFound'
3342 $ref: '#/components/responses/MethodNotAllowed'
3344 $ref: '#/components/responses/NotAcceptable'
3346 $ref: '#/components/responses/Conflict'
3348 $ref: '#/components/responses/UnprocessableEntity'
3350 $ref: '#/components/responses/InternalServerError'
3352 $ref: '#/components/responses/ServiceUnavailable'
3354 $ref: '#/components/responses/UnexpectedError'
3356 $ref: '#/components/responses/UnexpectedError'
3359 - "NetSlice instances"
3360 summary: Delete an individual NS instance resource
3361 description: Delete an individual NS instance resource
3362 operationId: deleteNSIContent
3365 description: Accepted
3369 $ref: '#/components/schemas/ObjectId'
3372 $ref: '#/components/schemas/ObjectId'
3374 description: No Content
3376 $ref: '#/components/responses/BadRequest'
3378 $ref: '#/components/responses/Unauthorized'
3380 $ref: '#/components/responses/Forbidden'
3382 $ref: '#/components/responses/NotFound'
3384 $ref: '#/components/responses/MethodNotAllowed'
3386 $ref: '#/components/responses/NotAcceptable'
3388 $ref: '#/components/responses/Conflict'
3390 $ref: '#/components/responses/UnprocessableEntity'
3392 $ref: '#/components/responses/InternalServerError'
3394 $ref: '#/components/responses/ServiceUnavailable'
3396 $ref: '#/components/responses/UnexpectedError'
3398 $ref: '#/components/responses/UnexpectedError'
3399 '/nsilcm/v1/nsi_lcm_op_occs':
3402 - "NetSlice instances"
3403 summary: Query information about multiple NetSlice LCM Operation Occurrences
3404 description: Query information about multiple NetSlice LCM Operation Occurrences
3405 operationId: getNsiLcmOpOccs
3412 $ref: '#/components/schemas/ArrayOfNsiLcmOpOcc'
3415 $ref: '#/components/schemas/ArrayOfNsiLcmOpOcc'
3417 $ref: '#/components/responses/BadRequest'
3419 $ref: '#/components/responses/Unauthorized'
3421 $ref: '#/components/responses/Forbidden'
3423 $ref: '#/components/responses/NotFound'
3425 $ref: '#/components/responses/MethodNotAllowed'
3427 $ref: '#/components/responses/NotAcceptable'
3429 $ref: '#/components/responses/Conflict'
3431 $ref: '#/components/responses/UnprocessableEntity'
3433 $ref: '#/components/responses/InternalServerError'
3435 $ref: '#/components/responses/ServiceUnavailable'
3437 $ref: '#/components/responses/UnexpectedError'
3439 $ref: '#/components/responses/UnexpectedError'
3440 '/nsilcm/v1/nsi_lcm_op_occs/{nsiLcmOpOccId}':
3442 - name: nsiLcmOpOccId
3445 description: NetSlice LCM Operation Occurrence ID
3450 - "NetSlice instances"
3451 summary: Query information about an individual NetSlice LCM Operation Occurrence
3452 description: Query information about an individual NetSlice LCM Operation Occurrence
3453 operationId: getNsiLcmOpOcc
3460 $ref: '#/components/schemas/NsiLcmOpOcc'
3463 $ref: '#/components/schemas/NsiLcmOpOcc'
3465 $ref: '#/components/responses/BadRequest'
3467 $ref: '#/components/responses/Unauthorized'
3469 $ref: '#/components/responses/Forbidden'
3471 $ref: '#/components/responses/NotFound'
3473 $ref: '#/components/responses/MethodNotAllowed'
3475 $ref: '#/components/responses/NotAcceptable'
3477 $ref: '#/components/responses/Conflict'
3479 $ref: '#/components/responses/UnprocessableEntity'
3481 $ref: '#/components/responses/InternalServerError'
3483 $ref: '#/components/responses/ServiceUnavailable'
3485 $ref: '#/components/responses/UnexpectedError'
3487 $ref: '#/components/responses/UnexpectedError'
3488 # END NetSlice Instances
3491 '/nspm/v1/pm_jobs/{pmJobId}/reports/{nsId}':
3496 description: NS PM Job ID
3507 - "NS Performance Management"
3508 summary: Query information about an individual NS PM Job Report
3509 description: Query information about an individual NS PM Job Report
3510 operationId: getNsPmJobReport
3517 $ref: '#/components/schemas/NsPmJobReportInfo'
3520 $ref: '#/components/schemas/NsPmJobReportInfo'
3522 $ref: '#/components/responses/BadRequest'
3524 $ref: '#/components/responses/Unauthorized'
3526 $ref: '#/components/responses/Forbidden'
3528 $ref: '#/components/responses/NotFound'
3530 $ref: '#/components/responses/MethodNotAllowed'
3532 $ref: '#/components/responses/NotAcceptable'
3534 $ref: '#/components/responses/Conflict'
3536 $ref: '#/components/responses/UnprocessableEntity'
3538 $ref: '#/components/responses/InternalServerError'
3540 $ref: '#/components/responses/ServiceUnavailable'
3542 $ref: '#/components/responses/UnexpectedError'
3544 $ref: '#/components/responses/UnexpectedError'
3548 '/pdu/v1/pdu_descriptors':
3551 - "Physical Data Units (PDU)"
3552 summary: Query information about multiple PDU Descriptors
3553 description: Query information about multiple PDU Descriptors
3554 operationId: getPDUs
3561 $ref: '#/components/schemas/ArrayOfPduInfo'
3564 $ref: '#/components/schemas/ArrayOfPduInfo'
3566 $ref: '#/components/responses/BadRequest'
3568 $ref: '#/components/responses/Unauthorized'
3570 $ref: '#/components/responses/Forbidden'
3572 $ref: '#/components/responses/NotFound'
3574 $ref: '#/components/responses/MethodNotAllowed'
3576 $ref: '#/components/responses/NotAcceptable'
3578 $ref: '#/components/responses/Conflict'
3580 $ref: '#/components/responses/UnprocessableEntity'
3582 $ref: '#/components/responses/InternalServerError'
3584 $ref: '#/components/responses/ServiceUnavailable'
3586 $ref: '#/components/responses/UnexpectedError'
3588 $ref: '#/components/responses/UnexpectedError'
3591 - "Physical Data Units (PDU)"
3592 summary: Create a new PDU
3593 description: Create a new PDU Descriptor
3594 operationId: createPDU
3596 $ref: '#/components/requestBodies/CreatePduRequest'
3608 $ref: '#/components/schemas/ObjectId'
3611 $ref: '#/components/schemas/ObjectId'
3613 $ref: '#/components/responses/BadRequest'
3615 $ref: '#/components/responses/Unauthorized'
3617 $ref: '#/components/responses/Forbidden'
3619 $ref: '#/components/responses/NotFound'
3621 $ref: '#/components/responses/MethodNotAllowed'
3623 $ref: '#/components/responses/NotAcceptable'
3625 $ref: '#/components/responses/Conflict'
3627 $ref: '#/components/responses/UnprocessableEntity'
3629 $ref: '#/components/responses/InternalServerError'
3631 $ref: '#/components/responses/ServiceUnavailable'
3633 $ref: '#/components/responses/UnexpectedError'
3635 $ref: '#/components/responses/UnexpectedError'
3636 '/pdu/v1/pdu_descriptors/{pduDescriptorId}':
3638 - name: pduDescriptorId
3641 description: PDU Descriptor ID
3646 - "Physical Data Units (PDU)"
3647 summary: Query information about an individual PDU Descriptor
3648 description: Query information about an individual PDU Descriptor
3656 $ref: '#/components/schemas/PduInfo'
3659 $ref: '#/components/schemas/PduInfo'
3661 $ref: '#/components/responses/BadRequest'
3663 $ref: '#/components/responses/Unauthorized'
3665 $ref: '#/components/responses/Forbidden'
3667 $ref: '#/components/responses/NotFound'
3669 $ref: '#/components/responses/MethodNotAllowed'
3671 $ref: '#/components/responses/NotAcceptable'
3673 $ref: '#/components/responses/Conflict'
3675 $ref: '#/components/responses/UnprocessableEntity'
3677 $ref: '#/components/responses/InternalServerError'
3679 $ref: '#/components/responses/ServiceUnavailable'
3681 $ref: '#/components/responses/UnexpectedError'
3683 $ref: '#/components/responses/UnexpectedError'
3686 - "Physical Data Units (PDU)"
3687 summary: Modify an individual PDU Descriptor
3688 description: Modify an individual PDU Descriptor
3689 operationId: editPDU
3691 $ref: '#/components/requestBodies/EditPduRequest'
3694 description: No Content
3696 $ref: '#/components/responses/BadRequest'
3698 $ref: '#/components/responses/Unauthorized'
3700 $ref: '#/components/responses/Forbidden'
3702 $ref: '#/components/responses/NotFound'
3704 $ref: '#/components/responses/MethodNotAllowed'
3706 $ref: '#/components/responses/NotAcceptable'
3708 $ref: '#/components/responses/Conflict'
3710 $ref: '#/components/responses/UnprocessableEntity'
3712 $ref: '#/components/responses/InternalServerError'
3714 $ref: '#/components/responses/ServiceUnavailable'
3716 $ref: '#/components/responses/UnexpectedError'
3718 $ref: '#/components/responses/UnexpectedError'
3721 - "Physical Data Units (PDU)"
3722 summary: Delete an individual PDU Descriptor
3723 description: Delete an individual PDU Descriptor
3724 operationId: deletePDU
3727 description: No Content
3729 $ref: '#/components/responses/BadRequest'
3731 $ref: '#/components/responses/Unauthorized'
3733 $ref: '#/components/responses/Forbidden'
3735 $ref: '#/components/responses/NotFound'
3737 $ref: '#/components/responses/MethodNotAllowed'
3739 $ref: '#/components/responses/NotAcceptable'
3741 $ref: '#/components/responses/Conflict'
3743 $ref: '#/components/responses/UnprocessableEntity'
3745 $ref: '#/components/responses/InternalServerError'
3747 $ref: '#/components/responses/ServiceUnavailable'
3749 $ref: '#/components/responses/UnexpectedError'
3751 $ref: '#/components/responses/UnexpectedError'
3760 summary: Query information about multiple Tokens
3761 description: Query information about multiple Tokens
3762 operationId: getTokens
3769 $ref: '#/components/schemas/ArrayOfTokenInfo'
3772 $ref: '#/components/schemas/ArrayOfTokenInfo'
3774 $ref: '#/components/responses/BadRequest'
3776 $ref: '#/components/responses/Unauthorized'
3778 $ref: '#/components/responses/Forbidden'
3780 $ref: '#/components/responses/NotFound'
3782 $ref: '#/components/responses/MethodNotAllowed'
3784 $ref: '#/components/responses/NotAcceptable'
3786 $ref: '#/components/responses/Conflict'
3788 $ref: '#/components/responses/UnprocessableEntity'
3790 $ref: '#/components/responses/InternalServerError'
3792 $ref: '#/components/responses/ServiceUnavailable'
3794 $ref: '#/components/responses/UnexpectedError'
3796 $ref: '#/components/responses/UnexpectedError'
3801 summary: Request a new Token
3802 description: Request a new Token
3803 operationId: createToken
3805 $ref: '#/components/requestBodies/CreateTokenRequest'
3817 $ref: '#/components/schemas/TokenInfo'
3820 $ref: '#/components/schemas/TokenInfo'
3822 $ref: '#/components/responses/BadRequest'
3824 $ref: '#/components/responses/Unauthorized'
3826 $ref: '#/components/responses/Forbidden'
3828 $ref: '#/components/responses/NotFound'
3830 $ref: '#/components/responses/MethodNotAllowed'
3832 $ref: '#/components/responses/NotAcceptable'
3834 $ref: '#/components/responses/Conflict'
3836 $ref: '#/components/responses/UnprocessableEntity'
3838 $ref: '#/components/responses/InternalServerError'
3840 $ref: '#/components/responses/ServiceUnavailable'
3842 $ref: '#/components/responses/UnexpectedError'
3844 $ref: '#/components/responses/UnexpectedError'
3849 summary: Delete the Token indicated in the Authorization Header
3850 description: Delete the Token indicated in the Authorization Header
3851 operationId: deleteAuthToken
3863 $ref: '#/components/responses/BadRequest'
3865 $ref: '#/components/responses/Unauthorized'
3867 $ref: '#/components/responses/Forbidden'
3869 $ref: '#/components/responses/NotFound'
3871 $ref: '#/components/responses/MethodNotAllowed'
3873 $ref: '#/components/responses/NotAcceptable'
3875 $ref: '#/components/responses/Conflict'
3877 $ref: '#/components/responses/UnprocessableEntity'
3879 $ref: '#/components/responses/InternalServerError'
3881 $ref: '#/components/responses/ServiceUnavailable'
3883 $ref: '#/components/responses/UnexpectedError'
3885 $ref: '#/components/responses/UnexpectedError'
3886 '/admin/v1/tokens/{tokenId}':
3891 description: Token ID
3898 summary: Query information about an individual Token
3899 description: Query information about an individual Token
3900 operationId: getToken
3907 $ref: '#/components/schemas/TokenInfo'
3910 $ref: '#/components/schemas/TokenInfo'
3912 $ref: '#/components/responses/BadRequest'
3914 $ref: '#/components/responses/Unauthorized'
3916 $ref: '#/components/responses/Forbidden'
3918 $ref: '#/components/responses/NotFound'
3920 $ref: '#/components/responses/MethodNotAllowed'
3922 $ref: '#/components/responses/NotAcceptable'
3924 $ref: '#/components/responses/Conflict'
3926 $ref: '#/components/responses/UnprocessableEntity'
3928 $ref: '#/components/responses/InternalServerError'
3930 $ref: '#/components/responses/ServiceUnavailable'
3932 $ref: '#/components/responses/UnexpectedError'
3934 $ref: '#/components/responses/UnexpectedError'
3939 summary: Delete the Token indicated as parameter
3940 description: Delete the Token indicated as parameter
3941 operationId: deleteToken
3953 $ref: '#/components/responses/BadRequest'
3955 $ref: '#/components/responses/Unauthorized'
3957 $ref: '#/components/responses/Forbidden'
3959 $ref: '#/components/responses/NotFound'
3961 $ref: '#/components/responses/MethodNotAllowed'
3963 $ref: '#/components/responses/NotAcceptable'
3965 $ref: '#/components/responses/Conflict'
3967 $ref: '#/components/responses/UnprocessableEntity'
3969 $ref: '#/components/responses/InternalServerError'
3971 $ref: '#/components/responses/ServiceUnavailable'
3973 $ref: '#/components/responses/UnexpectedError'
3975 $ref: '#/components/responses/UnexpectedError'
3981 summary: Query information about multiple Users
3982 description: Query information about multiple Users
3983 operationId: getUsers
3990 $ref: '#/components/schemas/ArrayOfUserInfo'
3993 $ref: '#/components/schemas/ArrayOfUserInfo'
3995 $ref: '#/components/responses/BadRequest'
3997 $ref: '#/components/responses/Unauthorized'
3999 $ref: '#/components/responses/Forbidden'
4001 $ref: '#/components/responses/NotFound'
4003 $ref: '#/components/responses/MethodNotAllowed'
4005 $ref: '#/components/responses/NotAcceptable'
4007 $ref: '#/components/responses/Conflict'
4009 $ref: '#/components/responses/UnprocessableEntity'
4011 $ref: '#/components/responses/InternalServerError'
4013 $ref: '#/components/responses/ServiceUnavailable'
4015 $ref: '#/components/responses/UnexpectedError'
4017 $ref: '#/components/responses/UnexpectedError'
4022 summary: Create a new User
4023 description: Create a new User
4024 operationId: createUser
4026 $ref: '#/components/requestBodies/CreateUserRequest'
4029 description: Created
4038 $ref: '#/components/schemas/ObjectId'
4041 $ref: '#/components/schemas/ObjectId'
4043 $ref: '#/components/responses/BadRequest'
4045 $ref: '#/components/responses/Unauthorized'
4047 $ref: '#/components/responses/Forbidden'
4049 $ref: '#/components/responses/NotFound'
4051 $ref: '#/components/responses/MethodNotAllowed'
4053 $ref: '#/components/responses/NotAcceptable'
4055 $ref: '#/components/responses/Conflict'
4057 $ref: '#/components/responses/UnprocessableEntity'
4059 $ref: '#/components/responses/InternalServerError'
4061 $ref: '#/components/responses/ServiceUnavailable'
4063 $ref: '#/components/responses/UnexpectedError'
4065 $ref: '#/components/responses/UnexpectedError'
4066 '/admin/v1/users/{userId}':
4071 description: User ID/Name
4078 summary: Query information about an individual User
4079 description: Query information about an individual User
4080 operationId: getUser
4087 $ref: '#/components/schemas/UserInfo'
4090 $ref: '#/components/schemas/UserInfo'
4092 $ref: '#/components/responses/BadRequest'
4094 $ref: '#/components/responses/Unauthorized'
4096 $ref: '#/components/responses/Forbidden'
4098 $ref: '#/components/responses/NotFound'
4100 $ref: '#/components/responses/MethodNotAllowed'
4102 $ref: '#/components/responses/NotAcceptable'
4104 $ref: '#/components/responses/Conflict'
4106 $ref: '#/components/responses/UnprocessableEntity'
4108 $ref: '#/components/responses/InternalServerError'
4110 $ref: '#/components/responses/ServiceUnavailable'
4112 $ref: '#/components/responses/UnexpectedError'
4114 $ref: '#/components/responses/UnexpectedError'
4119 summary: Modify a User
4120 description: Modify a User
4121 operationId: editUser
4123 $ref: '#/components/requestBodies/EditUserRequest'
4126 description: No Content
4128 $ref: '#/components/responses/BadRequest'
4130 $ref: '#/components/responses/Unauthorized'
4132 $ref: '#/components/responses/Forbidden'
4134 $ref: '#/components/responses/NotFound'
4136 $ref: '#/components/responses/MethodNotAllowed'
4138 $ref: '#/components/responses/NotAcceptable'
4140 $ref: '#/components/responses/Conflict'
4142 $ref: '#/components/responses/UnprocessableEntity'
4144 $ref: '#/components/responses/InternalServerError'
4146 $ref: '#/components/responses/ServiceUnavailable'
4148 $ref: '#/components/responses/UnexpectedError'
4150 $ref: '#/components/responses/UnexpectedError'
4155 summary: Delete a User
4156 description: Delete a User
4157 operationId: deleteUser
4160 description: No Content
4162 $ref: '#/components/responses/BadRequest'
4164 $ref: '#/components/responses/Unauthorized'
4166 $ref: '#/components/responses/Forbidden'
4168 $ref: '#/components/responses/NotFound'
4170 $ref: '#/components/responses/MethodNotAllowed'
4172 $ref: '#/components/responses/NotAcceptable'
4174 $ref: '#/components/responses/Conflict'
4176 $ref: '#/components/responses/UnprocessableEntity'
4178 $ref: '#/components/responses/InternalServerError'
4180 $ref: '#/components/responses/ServiceUnavailable'
4182 $ref: '#/components/responses/UnexpectedError'
4184 $ref: '#/components/responses/UnexpectedError'
4185 '/admin/v1/projects':
4190 summary: Query information about multiple Projects
4191 description: Query information about multiple Projects
4192 operationId: getProjects
4199 $ref: '#/components/schemas/ArrayOfProjectInfo'
4202 $ref: '#/components/schemas/ArrayOfProjectInfo'
4204 $ref: '#/components/responses/BadRequest'
4206 $ref: '#/components/responses/Unauthorized'
4208 $ref: '#/components/responses/Forbidden'
4210 $ref: '#/components/responses/NotFound'
4212 $ref: '#/components/responses/MethodNotAllowed'
4214 $ref: '#/components/responses/NotAcceptable'
4216 $ref: '#/components/responses/Conflict'
4218 $ref: '#/components/responses/UnprocessableEntity'
4220 $ref: '#/components/responses/InternalServerError'
4222 $ref: '#/components/responses/ServiceUnavailable'
4224 $ref: '#/components/responses/UnexpectedError'
4226 $ref: '#/components/responses/UnexpectedError'
4231 summary: Create a new Project
4232 description: Create a new Project
4233 operationId: createProject
4235 $ref: '#/components/requestBodies/CreateProjectRequest'
4238 description: Created
4247 $ref: '#/components/schemas/ObjectId'
4250 $ref: '#/components/schemas/ObjectId'
4252 $ref: '#/components/responses/BadRequest'
4254 $ref: '#/components/responses/Unauthorized'
4256 $ref: '#/components/responses/Forbidden'
4258 $ref: '#/components/responses/NotFound'
4260 $ref: '#/components/responses/MethodNotAllowed'
4262 $ref: '#/components/responses/NotAcceptable'
4264 $ref: '#/components/responses/Conflict'
4266 $ref: '#/components/responses/UnprocessableEntity'
4268 $ref: '#/components/responses/InternalServerError'
4270 $ref: '#/components/responses/ServiceUnavailable'
4272 $ref: '#/components/responses/UnexpectedError'
4274 $ref: '#/components/responses/UnexpectedError'
4275 '/admin/v1/projects/{projectId}':
4280 description: Project ID/Name
4287 summary: Query information about an individual Project
4288 description: Query information about an individual Project
4289 operationId: getProject
4296 $ref: '#/components/schemas/ProjectInfo'
4299 $ref: '#/components/schemas/ProjectInfo'
4301 $ref: '#/components/responses/BadRequest'
4303 $ref: '#/components/responses/Unauthorized'
4305 $ref: '#/components/responses/Forbidden'
4307 $ref: '#/components/responses/NotFound'
4309 $ref: '#/components/responses/MethodNotAllowed'
4311 $ref: '#/components/responses/NotAcceptable'
4313 $ref: '#/components/responses/Conflict'
4315 $ref: '#/components/responses/UnprocessableEntity'
4317 $ref: '#/components/responses/InternalServerError'
4319 $ref: '#/components/responses/ServiceUnavailable'
4321 $ref: '#/components/responses/UnexpectedError'
4323 $ref: '#/components/responses/UnexpectedError'
4328 summary: Modify a Project
4329 description: Modify a Project
4330 operationId: editProject
4332 $ref: '#/components/requestBodies/EditProjectRequest'
4335 description: No Content
4337 $ref: '#/components/responses/BadRequest'
4339 $ref: '#/components/responses/Unauthorized'
4341 $ref: '#/components/responses/Forbidden'
4343 $ref: '#/components/responses/NotFound'
4345 $ref: '#/components/responses/MethodNotAllowed'
4347 $ref: '#/components/responses/NotAcceptable'
4349 $ref: '#/components/responses/Conflict'
4351 $ref: '#/components/responses/UnprocessableEntity'
4353 $ref: '#/components/responses/InternalServerError'
4355 $ref: '#/components/responses/ServiceUnavailable'
4357 $ref: '#/components/responses/UnexpectedError'
4359 $ref: '#/components/responses/UnexpectedError'
4364 summary: Delete a Project
4365 description: Delete a Project
4366 operationId: deleteProject
4369 description: No Content
4371 $ref: '#/components/responses/BadRequest'
4373 $ref: '#/components/responses/Unauthorized'
4375 $ref: '#/components/responses/Forbidden'
4377 $ref: '#/components/responses/NotFound'
4379 $ref: '#/components/responses/MethodNotAllowed'
4381 $ref: '#/components/responses/NotAcceptable'
4383 $ref: '#/components/responses/Conflict'
4385 $ref: '#/components/responses/UnprocessableEntity'
4387 $ref: '#/components/responses/InternalServerError'
4389 $ref: '#/components/responses/ServiceUnavailable'
4391 $ref: '#/components/responses/UnexpectedError'
4393 $ref: '#/components/responses/UnexpectedError'
4399 summary: Query information about multiple Roles
4400 description: Query information about multiple Roles
4401 operationId: getRoles
4408 $ref: '#/components/schemas/ArrayOfRoleInfo'
4411 $ref: '#/components/schemas/ArrayOfRoleInfo'
4413 $ref: '#/components/responses/BadRequest'
4415 $ref: '#/components/responses/Unauthorized'
4417 $ref: '#/components/responses/Forbidden'
4419 $ref: '#/components/responses/NotFound'
4421 $ref: '#/components/responses/MethodNotAllowed'
4423 $ref: '#/components/responses/NotAcceptable'
4425 $ref: '#/components/responses/Conflict'
4427 $ref: '#/components/responses/UnprocessableEntity'
4429 $ref: '#/components/responses/InternalServerError'
4431 $ref: '#/components/responses/ServiceUnavailable'
4433 $ref: '#/components/responses/UnexpectedError'
4435 $ref: '#/components/responses/UnexpectedError'
4440 summary: Create a new Role
4441 description: Create a new Role
4442 operationId: createRole
4444 $ref: '#/components/requestBodies/CreateRoleRequest'
4447 description: Created
4456 $ref: '#/components/schemas/ObjectId'
4459 $ref: '#/components/schemas/ObjectId'
4461 $ref: '#/components/responses/BadRequest'
4463 $ref: '#/components/responses/Unauthorized'
4465 $ref: '#/components/responses/Forbidden'
4467 $ref: '#/components/responses/NotFound'
4469 $ref: '#/components/responses/MethodNotAllowed'
4471 $ref: '#/components/responses/NotAcceptable'
4473 $ref: '#/components/responses/Conflict'
4475 $ref: '#/components/responses/UnprocessableEntity'
4477 $ref: '#/components/responses/InternalServerError'
4479 $ref: '#/components/responses/ServiceUnavailable'
4481 $ref: '#/components/responses/UnexpectedError'
4483 $ref: '#/components/responses/UnexpectedError'
4484 '/admin/v1/roles/{roleId}':
4489 description: Role ID/Name
4496 summary: Query information about an individual Role
4497 description: Query information about an individual Role
4498 operationId: getRole
4505 $ref: '#/components/schemas/RoleInfo'
4508 $ref: '#/components/schemas/RoleInfo'
4510 $ref: '#/components/responses/BadRequest'
4512 $ref: '#/components/responses/Unauthorized'
4514 $ref: '#/components/responses/Forbidden'
4516 $ref: '#/components/responses/NotFound'
4518 $ref: '#/components/responses/MethodNotAllowed'
4520 $ref: '#/components/responses/NotAcceptable'
4522 $ref: '#/components/responses/Conflict'
4524 $ref: '#/components/responses/UnprocessableEntity'
4526 $ref: '#/components/responses/InternalServerError'
4528 $ref: '#/components/responses/ServiceUnavailable'
4530 $ref: '#/components/responses/UnexpectedError'
4532 $ref: '#/components/responses/UnexpectedError'
4537 summary: Modify a Role
4538 description: Modify a Role
4539 operationId: editRole
4541 $ref: '#/components/requestBodies/EditRoleRequest'
4544 description: No Content
4546 $ref: '#/components/responses/BadRequest'
4548 $ref: '#/components/responses/Unauthorized'
4550 $ref: '#/components/responses/Forbidden'
4552 $ref: '#/components/responses/NotFound'
4554 $ref: '#/components/responses/MethodNotAllowed'
4556 $ref: '#/components/responses/NotAcceptable'
4558 $ref: '#/components/responses/Conflict'
4560 $ref: '#/components/responses/UnprocessableEntity'
4562 $ref: '#/components/responses/InternalServerError'
4564 $ref: '#/components/responses/ServiceUnavailable'
4566 $ref: '#/components/responses/UnexpectedError'
4568 $ref: '#/components/responses/UnexpectedError'
4573 summary: Delete a Role
4574 description: Delete a Role
4575 operationId: deleteRole
4578 description: No Content
4580 $ref: '#/components/responses/BadRequest'
4582 $ref: '#/components/responses/Unauthorized'
4584 $ref: '#/components/responses/Forbidden'
4586 $ref: '#/components/responses/NotFound'
4588 $ref: '#/components/responses/MethodNotAllowed'
4590 $ref: '#/components/responses/NotAcceptable'
4592 $ref: '#/components/responses/Conflict'
4594 $ref: '#/components/responses/UnprocessableEntity'
4596 $ref: '#/components/responses/InternalServerError'
4598 $ref: '#/components/responses/ServiceUnavailable'
4600 $ref: '#/components/responses/UnexpectedError'
4602 $ref: '#/components/responses/UnexpectedError'
4608 summary: Query information about multiple VIMs
4609 description: Query information about multiple VIMs
4610 operationId: getVIMs
4617 $ref: '#/components/schemas/ArrayOfVimInfo'
4620 $ref: '#/components/schemas/ArrayOfVimInfo'
4622 $ref: '#/components/responses/BadRequest'
4624 $ref: '#/components/responses/Unauthorized'
4626 $ref: '#/components/responses/Forbidden'
4628 $ref: '#/components/responses/NotFound'
4630 $ref: '#/components/responses/MethodNotAllowed'
4632 $ref: '#/components/responses/NotAcceptable'
4634 $ref: '#/components/responses/Conflict'
4636 $ref: '#/components/responses/UnprocessableEntity'
4638 $ref: '#/components/responses/InternalServerError'
4640 $ref: '#/components/responses/ServiceUnavailable'
4642 $ref: '#/components/responses/UnexpectedError'
4644 $ref: '#/components/responses/UnexpectedError'
4649 summary: Create a new VIM
4650 description: Create a new VIM
4651 operationId: createVIM
4653 $ref: '#/components/requestBodies/CreateVimRequest'
4656 description: Accepted
4660 $ref: '#/components/schemas/ObjectId_plus_OpId'
4663 $ref: '#/components/schemas/ObjectId_plus_OpId'
4665 $ref: '#/components/responses/BadRequest'
4667 $ref: '#/components/responses/Unauthorized'
4669 $ref: '#/components/responses/Forbidden'
4671 $ref: '#/components/responses/NotFound'
4673 $ref: '#/components/responses/MethodNotAllowed'
4675 $ref: '#/components/responses/NotAcceptable'
4677 $ref: '#/components/responses/Conflict'
4679 $ref: '#/components/responses/UnprocessableEntity'
4681 $ref: '#/components/responses/InternalServerError'
4683 $ref: '#/components/responses/ServiceUnavailable'
4685 $ref: '#/components/responses/UnexpectedError'
4687 $ref: '#/components/responses/UnexpectedError'
4688 '/admin/v1/vims/{vimId}':
4701 summary: Query information about an individual VIM
4702 description: Query information about an individual VIM
4710 $ref: '#/components/schemas/VimInfo'
4713 $ref: '#/components/schemas/VimInfo'
4715 $ref: '#/components/responses/BadRequest'
4717 $ref: '#/components/responses/Unauthorized'
4719 $ref: '#/components/responses/Forbidden'
4721 $ref: '#/components/responses/NotFound'
4723 $ref: '#/components/responses/MethodNotAllowed'
4725 $ref: '#/components/responses/NotAcceptable'
4727 $ref: '#/components/responses/Conflict'
4729 $ref: '#/components/responses/UnprocessableEntity'
4731 $ref: '#/components/responses/InternalServerError'
4733 $ref: '#/components/responses/ServiceUnavailable'
4735 $ref: '#/components/responses/UnexpectedError'
4737 $ref: '#/components/responses/UnexpectedError'
4742 summary: Modify a VIM
4743 description: Modify a VIM
4744 operationId: editVIM
4746 $ref: '#/components/requestBodies/EditVimRequest'
4749 description: Accepted
4753 $ref: '#/components/schemas/OpId'
4756 $ref: '#/components/schemas/OpId'
4758 $ref: '#/components/responses/BadRequest'
4760 $ref: '#/components/responses/Unauthorized'
4762 $ref: '#/components/responses/Forbidden'
4764 $ref: '#/components/responses/NotFound'
4766 $ref: '#/components/responses/MethodNotAllowed'
4768 $ref: '#/components/responses/NotAcceptable'
4770 $ref: '#/components/responses/Conflict'
4772 $ref: '#/components/responses/UnprocessableEntity'
4774 $ref: '#/components/responses/InternalServerError'
4776 $ref: '#/components/responses/ServiceUnavailable'
4778 $ref: '#/components/responses/UnexpectedError'
4780 $ref: '#/components/responses/UnexpectedError'
4785 summary: Delete a VIM
4786 description: Delete a VIM
4787 operationId: deleteVIM
4790 description: Accepted
4792 $ref: '#/components/responses/BadRequest'
4794 $ref: '#/components/responses/Unauthorized'
4796 $ref: '#/components/responses/Forbidden'
4798 $ref: '#/components/responses/NotFound'
4800 $ref: '#/components/responses/MethodNotAllowed'
4802 $ref: '#/components/responses/NotAcceptable'
4804 $ref: '#/components/responses/Conflict'
4806 $ref: '#/components/responses/UnprocessableEntity'
4808 $ref: '#/components/responses/InternalServerError'
4810 $ref: '#/components/responses/ServiceUnavailable'
4812 $ref: '#/components/responses/UnexpectedError'
4814 $ref: '#/components/responses/UnexpectedError'
4815 '/admin/v1/vim_accounts':
4820 summary: Query information about multiple VIM Accounts
4821 description: Query information about multiple VIM Accounts
4822 operationId: getVimAccounts
4829 $ref: '#/components/schemas/ArrayOfVimInfo'
4832 $ref: '#/components/schemas/ArrayOfVimInfo'
4834 $ref: '#/components/responses/BadRequest'
4836 $ref: '#/components/responses/Unauthorized'
4838 $ref: '#/components/responses/Forbidden'
4840 $ref: '#/components/responses/NotFound'
4842 $ref: '#/components/responses/MethodNotAllowed'
4844 $ref: '#/components/responses/NotAcceptable'
4846 $ref: '#/components/responses/Conflict'
4848 $ref: '#/components/responses/UnprocessableEntity'
4850 $ref: '#/components/responses/InternalServerError'
4852 $ref: '#/components/responses/ServiceUnavailable'
4854 $ref: '#/components/responses/UnexpectedError'
4856 $ref: '#/components/responses/UnexpectedError'
4861 summary: Create a new VIM Account
4862 description: Create a new VIM Account
4863 operationId: createVimAccount
4865 $ref: '#/components/requestBodies/CreateVimRequest'
4868 description: Accepted
4872 $ref: '#/components/schemas/ObjectId_plus_OpId'
4875 $ref: '#/components/schemas/ObjectId_plus_OpId'
4877 $ref: '#/components/responses/BadRequest'
4879 $ref: '#/components/responses/Unauthorized'
4881 $ref: '#/components/responses/Forbidden'
4883 $ref: '#/components/responses/NotFound'
4885 $ref: '#/components/responses/MethodNotAllowed'
4887 $ref: '#/components/responses/NotAcceptable'
4889 $ref: '#/components/responses/Conflict'
4891 $ref: '#/components/responses/UnprocessableEntity'
4893 $ref: '#/components/responses/InternalServerError'
4895 $ref: '#/components/responses/ServiceUnavailable'
4897 $ref: '#/components/responses/UnexpectedError'
4899 $ref: '#/components/responses/UnexpectedError'
4900 '/admin/v1/vim_accounts/{vimAccountId}':
4902 - name: vimAccountId
4905 description: VIM Account ID
4913 summary: Query information about an individual VIM Account
4914 description: Query information about an individual VIM Account
4915 operationId: getVimAccount
4922 $ref: '#/components/schemas/VimInfo'
4925 $ref: '#/components/schemas/VimInfo'
4927 $ref: '#/components/responses/BadRequest'
4929 $ref: '#/components/responses/Unauthorized'
4931 $ref: '#/components/responses/Forbidden'
4933 $ref: '#/components/responses/NotFound'
4935 $ref: '#/components/responses/MethodNotAllowed'
4937 $ref: '#/components/responses/NotAcceptable'
4939 $ref: '#/components/responses/Conflict'
4941 $ref: '#/components/responses/UnprocessableEntity'
4943 $ref: '#/components/responses/InternalServerError'
4945 $ref: '#/components/responses/ServiceUnavailable'
4947 $ref: '#/components/responses/UnexpectedError'
4949 $ref: '#/components/responses/UnexpectedError'
4954 summary: Modify a VIM Account
4955 description: Modify a VIM Account
4956 operationId: editVimAccount
4958 $ref: '#/components/requestBodies/EditVimRequest'
4961 description: Accepted
4965 $ref: '#/components/schemas/OpId'
4968 $ref: '#/components/schemas/OpId'
4970 $ref: '#/components/responses/BadRequest'
4972 $ref: '#/components/responses/Unauthorized'
4974 $ref: '#/components/responses/Forbidden'
4976 $ref: '#/components/responses/NotFound'
4978 $ref: '#/components/responses/MethodNotAllowed'
4980 $ref: '#/components/responses/NotAcceptable'
4982 $ref: '#/components/responses/Conflict'
4984 $ref: '#/components/responses/UnprocessableEntity'
4986 $ref: '#/components/responses/InternalServerError'
4988 $ref: '#/components/responses/ServiceUnavailable'
4990 $ref: '#/components/responses/UnexpectedError'
4992 $ref: '#/components/responses/UnexpectedError'
4997 summary: Delete a VIM Account
4998 description: Delete a VIM Account
4999 operationId: deleteVimAccount
5002 description: Accepted
5004 $ref: '#/components/responses/BadRequest'
5006 $ref: '#/components/responses/Unauthorized'
5008 $ref: '#/components/responses/Forbidden'
5010 $ref: '#/components/responses/NotFound'
5012 $ref: '#/components/responses/MethodNotAllowed'
5014 $ref: '#/components/responses/NotAcceptable'
5016 $ref: '#/components/responses/Conflict'
5018 $ref: '#/components/responses/UnprocessableEntity'
5020 $ref: '#/components/responses/InternalServerError'
5022 $ref: '#/components/responses/ServiceUnavailable'
5024 $ref: '#/components/responses/UnexpectedError'
5026 $ref: '#/components/responses/UnexpectedError'
5027 '/admin/v1/wim_accounts':
5032 summary: Query information about multiple WIM Accounts
5033 description: Query information about multiple WIM Accounts
5034 operationId: getWimAccounts
5041 $ref: '#/components/schemas/ArrayOfWimInfo'
5044 $ref: '#/components/schemas/ArrayOfWimInfo'
5046 $ref: '#/components/responses/BadRequest'
5048 $ref: '#/components/responses/Unauthorized'
5050 $ref: '#/components/responses/Forbidden'
5052 $ref: '#/components/responses/NotFound'
5054 $ref: '#/components/responses/MethodNotAllowed'
5056 $ref: '#/components/responses/NotAcceptable'
5058 $ref: '#/components/responses/Conflict'
5060 $ref: '#/components/responses/UnprocessableEntity'
5062 $ref: '#/components/responses/InternalServerError'
5064 $ref: '#/components/responses/ServiceUnavailable'
5066 $ref: '#/components/responses/UnexpectedError'
5068 $ref: '#/components/responses/UnexpectedError'
5073 summary: Create a new WIM Account
5074 description: Create a new WIM Account
5075 operationId: createWimAccount
5077 $ref: '#/components/requestBodies/CreateWimRequest'
5080 description: Accepted
5084 $ref: '#/components/schemas/ObjectId_plus_OpId'
5087 $ref: '#/components/schemas/ObjectId_plus_OpId'
5089 $ref: '#/components/responses/BadRequest'
5091 $ref: '#/components/responses/Unauthorized'
5093 $ref: '#/components/responses/Forbidden'
5095 $ref: '#/components/responses/NotFound'
5097 $ref: '#/components/responses/MethodNotAllowed'
5099 $ref: '#/components/responses/NotAcceptable'
5101 $ref: '#/components/responses/Conflict'
5103 $ref: '#/components/responses/UnprocessableEntity'
5105 $ref: '#/components/responses/InternalServerError'
5107 $ref: '#/components/responses/ServiceUnavailable'
5109 $ref: '#/components/responses/UnexpectedError'
5111 $ref: '#/components/responses/UnexpectedError'
5112 '/admin/v1/wim_accounts/{wimAccountId}':
5114 - name: wimAccountId
5117 description: WIM Account ID
5125 summary: Query information about an individual WIM Account
5126 description: Query information about an individual WIM Account
5127 operationId: getWimAccount
5134 $ref: '#/components/schemas/WimInfo'
5137 $ref: '#/components/schemas/WimInfo'
5139 $ref: '#/components/responses/BadRequest'
5141 $ref: '#/components/responses/Unauthorized'
5143 $ref: '#/components/responses/Forbidden'
5145 $ref: '#/components/responses/NotFound'
5147 $ref: '#/components/responses/MethodNotAllowed'
5149 $ref: '#/components/responses/NotAcceptable'
5151 $ref: '#/components/responses/Conflict'
5153 $ref: '#/components/responses/UnprocessableEntity'
5155 $ref: '#/components/responses/InternalServerError'
5157 $ref: '#/components/responses/ServiceUnavailable'
5159 $ref: '#/components/responses/UnexpectedError'
5161 $ref: '#/components/responses/UnexpectedError'
5166 summary: Modify a WIM Account
5167 description: Modify a WIM Account
5168 operationId: editWimAccount
5170 $ref: '#/components/requestBodies/EditWimRequest'
5173 description: Accepted
5177 $ref: '#/components/schemas/OpId'
5180 $ref: '#/components/schemas/OpId'
5182 $ref: '#/components/responses/BadRequest'
5184 $ref: '#/components/responses/Unauthorized'
5186 $ref: '#/components/responses/Forbidden'
5188 $ref: '#/components/responses/NotFound'
5190 $ref: '#/components/responses/MethodNotAllowed'
5192 $ref: '#/components/responses/NotAcceptable'
5194 $ref: '#/components/responses/Conflict'
5196 $ref: '#/components/responses/UnprocessableEntity'
5198 $ref: '#/components/responses/InternalServerError'
5200 $ref: '#/components/responses/ServiceUnavailable'
5202 $ref: '#/components/responses/UnexpectedError'
5204 $ref: '#/components/responses/UnexpectedError'
5209 summary: Delete a WIM Account
5210 description: Delete a WIM Account
5211 operationId: deleteWimAccount
5214 description: Accepted
5216 $ref: '#/components/responses/BadRequest'
5218 $ref: '#/components/responses/Unauthorized'
5220 $ref: '#/components/responses/Forbidden'
5222 $ref: '#/components/responses/NotFound'
5224 $ref: '#/components/responses/MethodNotAllowed'
5226 $ref: '#/components/responses/NotAcceptable'
5228 $ref: '#/components/responses/Conflict'
5230 $ref: '#/components/responses/UnprocessableEntity'
5232 $ref: '#/components/responses/InternalServerError'
5234 $ref: '#/components/responses/ServiceUnavailable'
5236 $ref: '#/components/responses/UnexpectedError'
5238 $ref: '#/components/responses/UnexpectedError'
5244 summary: Query information about multiple SDNs
5245 description: Query information about multiple SDNs
5246 operationId: getSDNs
5253 $ref: '#/components/schemas/ArrayOfSdnInfo'
5256 $ref: '#/components/schemas/ArrayOfSdnInfo'
5258 $ref: '#/components/responses/BadRequest'
5260 $ref: '#/components/responses/Unauthorized'
5262 $ref: '#/components/responses/Forbidden'
5264 $ref: '#/components/responses/NotFound'
5266 $ref: '#/components/responses/MethodNotAllowed'
5268 $ref: '#/components/responses/NotAcceptable'
5270 $ref: '#/components/responses/Conflict'
5272 $ref: '#/components/responses/UnprocessableEntity'
5274 $ref: '#/components/responses/InternalServerError'
5276 $ref: '#/components/responses/ServiceUnavailable'
5278 $ref: '#/components/responses/UnexpectedError'
5280 $ref: '#/components/responses/UnexpectedError'
5285 summary: Create a new SDN
5286 description: Create a new SDN
5287 operationId: createSDN
5289 $ref: '#/components/requestBodies/CreateSdnRequest'
5292 description: Accepted
5296 $ref: '#/components/schemas/ObjectId_plus_OpId'
5299 $ref: '#/components/schemas/ObjectId_plus_OpId'
5301 $ref: '#/components/responses/BadRequest'
5303 $ref: '#/components/responses/Unauthorized'
5305 $ref: '#/components/responses/Forbidden'
5307 $ref: '#/components/responses/NotFound'
5309 $ref: '#/components/responses/MethodNotAllowed'
5311 $ref: '#/components/responses/NotAcceptable'
5313 $ref: '#/components/responses/Conflict'
5315 $ref: '#/components/responses/UnprocessableEntity'
5317 $ref: '#/components/responses/InternalServerError'
5319 $ref: '#/components/responses/ServiceUnavailable'
5321 $ref: '#/components/responses/UnexpectedError'
5323 $ref: '#/components/responses/UnexpectedError'
5324 '/admin/v1/sdns/{sdnId}':
5337 summary: Query information about an individual SDN
5338 description: Query information about an individual SDN
5346 $ref: '#/components/schemas/SdnInfo'
5349 $ref: '#/components/schemas/SdnInfo'
5351 $ref: '#/components/responses/BadRequest'
5353 $ref: '#/components/responses/Unauthorized'
5355 $ref: '#/components/responses/Forbidden'
5357 $ref: '#/components/responses/NotFound'
5359 $ref: '#/components/responses/MethodNotAllowed'
5361 $ref: '#/components/responses/NotAcceptable'
5363 $ref: '#/components/responses/Conflict'
5365 $ref: '#/components/responses/UnprocessableEntity'
5367 $ref: '#/components/responses/InternalServerError'
5369 $ref: '#/components/responses/ServiceUnavailable'
5371 $ref: '#/components/responses/UnexpectedError'
5373 $ref: '#/components/responses/UnexpectedError'
5378 summary: Modify a SDN
5379 description: Modify a SDN
5380 operationId: editSDN
5382 $ref: '#/components/requestBodies/EditSdnRequest'
5385 description: Accepted
5389 $ref: '#/components/schemas/OpId'
5392 $ref: '#/components/schemas/OpId'
5394 $ref: '#/components/responses/BadRequest'
5396 $ref: '#/components/responses/Unauthorized'
5398 $ref: '#/components/responses/Forbidden'
5400 $ref: '#/components/responses/NotFound'
5402 $ref: '#/components/responses/MethodNotAllowed'
5404 $ref: '#/components/responses/NotAcceptable'
5406 $ref: '#/components/responses/Conflict'
5408 $ref: '#/components/responses/UnprocessableEntity'
5410 $ref: '#/components/responses/InternalServerError'
5412 $ref: '#/components/responses/ServiceUnavailable'
5414 $ref: '#/components/responses/UnexpectedError'
5416 $ref: '#/components/responses/UnexpectedError'
5421 summary: Delete a SDN
5422 description: Delete a SDN
5423 operationId: deleteSDN
5426 description: Accepted
5428 $ref: '#/components/responses/BadRequest'
5430 $ref: '#/components/responses/Unauthorized'
5432 $ref: '#/components/responses/Forbidden'
5434 $ref: '#/components/responses/NotFound'
5436 $ref: '#/components/responses/MethodNotAllowed'
5438 $ref: '#/components/responses/NotAcceptable'
5440 $ref: '#/components/responses/Conflict'
5442 $ref: '#/components/responses/UnprocessableEntity'
5444 $ref: '#/components/responses/InternalServerError'
5446 $ref: '#/components/responses/ServiceUnavailable'
5448 $ref: '#/components/responses/UnexpectedError'
5450 $ref: '#/components/responses/UnexpectedError'
5451 '/admin/v1/k8sclusters':
5456 summary: Query information about multiple K8s Clusters
5457 description: Query information about multiple K8s Clusters
5458 operationId: getK8sClusters
5465 $ref: '#/components/schemas/ArrayOfK8sClusterInfo'
5468 $ref: '#/components/schemas/ArrayOfK8sClusterInfo'
5470 $ref: '#/components/responses/BadRequest'
5472 $ref: '#/components/responses/Unauthorized'
5474 $ref: '#/components/responses/Forbidden'
5476 $ref: '#/components/responses/NotFound'
5478 $ref: '#/components/responses/MethodNotAllowed'
5480 $ref: '#/components/responses/NotAcceptable'
5482 $ref: '#/components/responses/Conflict'
5484 $ref: '#/components/responses/UnprocessableEntity'
5486 $ref: '#/components/responses/InternalServerError'
5488 $ref: '#/components/responses/ServiceUnavailable'
5490 $ref: '#/components/responses/UnexpectedError'
5492 $ref: '#/components/responses/UnexpectedError'
5497 summary: Create a new K8s Cluster
5498 description: Create a new K8s Cluster
5499 operationId: createK8sCluster
5501 $ref: '#/components/requestBodies/CreateK8sClusterRequest'
5504 description: Accepted
5508 $ref: '#/components/schemas/ObjectId_plus_OpId'
5511 $ref: '#/components/schemas/ObjectId_plus_OpId'
5513 $ref: '#/components/responses/BadRequest'
5515 $ref: '#/components/responses/Unauthorized'
5517 $ref: '#/components/responses/Forbidden'
5519 $ref: '#/components/responses/NotFound'
5521 $ref: '#/components/responses/MethodNotAllowed'
5523 $ref: '#/components/responses/NotAcceptable'
5525 $ref: '#/components/responses/Conflict'
5527 $ref: '#/components/responses/UnprocessableEntity'
5529 $ref: '#/components/responses/InternalServerError'
5531 $ref: '#/components/responses/ServiceUnavailable'
5533 $ref: '#/components/responses/UnexpectedError'
5535 $ref: '#/components/responses/UnexpectedError'
5536 '/admin/v1/k8sclusters/{k8sClusterId}':
5538 - name: k8sClusterId
5541 description: K8s Cluster ID
5549 summary: Query information about an individual K8s Cluster
5550 description: Query information about an individual K8s Cluster
5551 operationId: getK8sCluster
5558 $ref: '#/components/schemas/K8sClusterInfo'
5561 $ref: '#/components/schemas/K8sClusterInfo'
5563 $ref: '#/components/responses/BadRequest'
5565 $ref: '#/components/responses/Unauthorized'
5567 $ref: '#/components/responses/Forbidden'
5569 $ref: '#/components/responses/NotFound'
5571 $ref: '#/components/responses/MethodNotAllowed'
5573 $ref: '#/components/responses/NotAcceptable'
5575 $ref: '#/components/responses/Conflict'
5577 $ref: '#/components/responses/UnprocessableEntity'
5579 $ref: '#/components/responses/InternalServerError'
5581 $ref: '#/components/responses/ServiceUnavailable'
5583 $ref: '#/components/responses/UnexpectedError'
5585 $ref: '#/components/responses/UnexpectedError'
5590 summary: Modify a K8s Cluster
5591 description: Modify a K8s Cluster
5592 operationId: editK8sCluster
5594 $ref: '#/components/requestBodies/EditK8sClusterRequest'
5597 description: Accepted
5601 $ref: '#/components/schemas/OpId'
5604 $ref: '#/components/schemas/OpId'
5606 $ref: '#/components/responses/BadRequest'
5608 $ref: '#/components/responses/Unauthorized'
5610 $ref: '#/components/responses/Forbidden'
5612 $ref: '#/components/responses/NotFound'
5614 $ref: '#/components/responses/MethodNotAllowed'
5616 $ref: '#/components/responses/NotAcceptable'
5618 $ref: '#/components/responses/Conflict'
5620 $ref: '#/components/responses/UnprocessableEntity'
5622 $ref: '#/components/responses/InternalServerError'
5624 $ref: '#/components/responses/ServiceUnavailable'
5626 $ref: '#/components/responses/UnexpectedError'
5628 $ref: '#/components/responses/UnexpectedError'
5633 summary: Delete a K8s Cluster
5634 description: Delete a K8s Cluster
5635 operationId: deleteK8sCluster
5638 description: Accepted
5640 $ref: '#/components/responses/BadRequest'
5642 $ref: '#/components/responses/Unauthorized'
5644 $ref: '#/components/responses/Forbidden'
5646 $ref: '#/components/responses/NotFound'
5648 $ref: '#/components/responses/MethodNotAllowed'
5650 $ref: '#/components/responses/NotAcceptable'
5652 $ref: '#/components/responses/Conflict'
5654 $ref: '#/components/responses/UnprocessableEntity'
5656 $ref: '#/components/responses/InternalServerError'
5658 $ref: '#/components/responses/ServiceUnavailable'
5660 $ref: '#/components/responses/UnexpectedError'
5662 $ref: '#/components/responses/UnexpectedError'
5668 summary: Query information about multiple VCAs
5669 description: Query information about multiple VCAs
5670 operationId: getVcas
5677 $ref: '#/components/schemas/ArrayOfVcaInfo'
5680 $ref: '#/components/schemas/ArrayOfVcaInfo'
5682 $ref: '#/components/responses/BadRequest'
5684 $ref: '#/components/responses/Unauthorized'
5686 $ref: '#/components/responses/Forbidden'
5688 $ref: '#/components/responses/NotFound'
5690 $ref: '#/components/responses/MethodNotAllowed'
5692 $ref: '#/components/responses/NotAcceptable'
5694 $ref: '#/components/responses/Conflict'
5696 $ref: '#/components/responses/UnprocessableEntity'
5698 $ref: '#/components/responses/InternalServerError'
5700 $ref: '#/components/responses/ServiceUnavailable'
5702 $ref: '#/components/responses/UnexpectedError'
5704 $ref: '#/components/responses/UnexpectedError'
5709 summary: Create a new VCA
5710 description: Create a new VCA
5711 operationId: createVca
5713 $ref: '#/components/requestBodies/CreateVcaRequest'
5716 description: Accepted
5720 $ref: '#/components/schemas/ObjectId_plus_OpId'
5723 $ref: '#/components/schemas/ObjectId_plus_OpId'
5725 $ref: '#/components/responses/BadRequest'
5727 $ref: '#/components/responses/Unauthorized'
5729 $ref: '#/components/responses/Forbidden'
5731 $ref: '#/components/responses/NotFound'
5733 $ref: '#/components/responses/MethodNotAllowed'
5735 $ref: '#/components/responses/NotAcceptable'
5737 $ref: '#/components/responses/Conflict'
5739 $ref: '#/components/responses/UnprocessableEntity'
5741 $ref: '#/components/responses/InternalServerError'
5743 $ref: '#/components/responses/ServiceUnavailable'
5745 $ref: '#/components/responses/UnexpectedError'
5747 $ref: '#/components/responses/UnexpectedError'
5748 '/admin/v1/vca/{vcaId}':
5761 summary: Query information about an individual VCA
5762 description: Query information about an individual VCA
5770 $ref: '#/components/schemas/VcaInfo'
5773 $ref: '#/components/schemas/VcaInfo'
5775 $ref: '#/components/responses/BadRequest'
5777 $ref: '#/components/responses/Unauthorized'
5779 $ref: '#/components/responses/Forbidden'
5781 $ref: '#/components/responses/NotFound'
5783 $ref: '#/components/responses/MethodNotAllowed'
5785 $ref: '#/components/responses/NotAcceptable'
5787 $ref: '#/components/responses/Conflict'
5789 $ref: '#/components/responses/UnprocessableEntity'
5791 $ref: '#/components/responses/InternalServerError'
5793 $ref: '#/components/responses/ServiceUnavailable'
5795 $ref: '#/components/responses/UnexpectedError'
5797 $ref: '#/components/responses/UnexpectedError'
5802 summary: Modify a VCA
5803 description: Modify a VCA
5804 operationId: editVca
5806 $ref: '#/components/requestBodies/EditVcaRequest'
5809 description: Accepted
5813 $ref: '#/components/schemas/OpId'
5816 $ref: '#/components/schemas/OpId'
5818 $ref: '#/components/responses/BadRequest'
5820 $ref: '#/components/responses/Unauthorized'
5822 $ref: '#/components/responses/Forbidden'
5824 $ref: '#/components/responses/NotFound'
5826 $ref: '#/components/responses/MethodNotAllowed'
5828 $ref: '#/components/responses/NotAcceptable'
5830 $ref: '#/components/responses/Conflict'
5832 $ref: '#/components/responses/UnprocessableEntity'
5834 $ref: '#/components/responses/InternalServerError'
5836 $ref: '#/components/responses/ServiceUnavailable'
5838 $ref: '#/components/responses/UnexpectedError'
5840 $ref: '#/components/responses/UnexpectedError'
5845 summary: Delete a VCA
5846 description: Delete a VCA
5847 operationId: deleteVca
5850 description: Accepted
5852 $ref: '#/components/responses/BadRequest'
5854 $ref: '#/components/responses/Unauthorized'
5856 $ref: '#/components/responses/Forbidden'
5858 $ref: '#/components/responses/NotFound'
5860 $ref: '#/components/responses/MethodNotAllowed'
5862 $ref: '#/components/responses/NotAcceptable'
5864 $ref: '#/components/responses/Conflict'
5866 $ref: '#/components/responses/UnprocessableEntity'
5868 $ref: '#/components/responses/InternalServerError'
5870 $ref: '#/components/responses/ServiceUnavailable'
5872 $ref: '#/components/responses/UnexpectedError'
5874 $ref: '#/components/responses/UnexpectedError'
5875 '/admin/v1/k8srepos':
5880 summary: Query information about multiple K8s Repos
5881 description: Query information about multiple K8s Repos
5882 operationId: getK8sRepos
5889 $ref: '#/components/schemas/ArrayOfK8sRepoInfo'
5892 $ref: '#/components/schemas/ArrayOfK8sRepoInfo'
5894 $ref: '#/components/responses/BadRequest'
5896 $ref: '#/components/responses/Unauthorized'
5898 $ref: '#/components/responses/Forbidden'
5900 $ref: '#/components/responses/NotFound'
5902 $ref: '#/components/responses/MethodNotAllowed'
5904 $ref: '#/components/responses/NotAcceptable'
5906 $ref: '#/components/responses/Conflict'
5908 $ref: '#/components/responses/UnprocessableEntity'
5910 $ref: '#/components/responses/InternalServerError'
5912 $ref: '#/components/responses/ServiceUnavailable'
5914 $ref: '#/components/responses/UnexpectedError'
5916 $ref: '#/components/responses/UnexpectedError'
5921 summary: Create a new K8s Repo
5922 description: Create a new K8s Repo
5923 operationId: createK8sRepo
5925 $ref: '#/components/requestBodies/CreateK8sRepoRequest'
5928 description: Accepted
5932 $ref: '#/components/schemas/ObjectId_plus_OpId'
5935 $ref: '#/components/schemas/ObjectId_plus_OpId'
5937 $ref: '#/components/responses/BadRequest'
5939 $ref: '#/components/responses/Unauthorized'
5941 $ref: '#/components/responses/Forbidden'
5943 $ref: '#/components/responses/NotFound'
5945 $ref: '#/components/responses/MethodNotAllowed'
5947 $ref: '#/components/responses/NotAcceptable'
5949 $ref: '#/components/responses/Conflict'
5951 $ref: '#/components/responses/UnprocessableEntity'
5953 $ref: '#/components/responses/InternalServerError'
5955 $ref: '#/components/responses/ServiceUnavailable'
5957 $ref: '#/components/responses/UnexpectedError'
5959 $ref: '#/components/responses/UnexpectedError'
5960 '/admin/v1/k8srepos/{k8sRepoId}':
5965 description: K8s Repo ID
5973 summary: Query information about an individual K8s Repo
5974 description: Query information about an individual K8s Repo
5975 operationId: getK8sRepo
5982 $ref: '#/components/schemas/K8sRepoInfo'
5985 $ref: '#/components/schemas/K8sRepoInfo'
5987 $ref: '#/components/responses/BadRequest'
5989 $ref: '#/components/responses/Unauthorized'
5991 $ref: '#/components/responses/Forbidden'
5993 $ref: '#/components/responses/NotFound'
5995 $ref: '#/components/responses/MethodNotAllowed'
5997 $ref: '#/components/responses/NotAcceptable'
5999 $ref: '#/components/responses/Conflict'
6001 $ref: '#/components/responses/UnprocessableEntity'
6003 $ref: '#/components/responses/InternalServerError'
6005 $ref: '#/components/responses/ServiceUnavailable'
6007 $ref: '#/components/responses/UnexpectedError'
6009 $ref: '#/components/responses/UnexpectedError'
6014 summary: Delete a K8s Repo
6015 description: Delete a K8s Repo
6016 operationId: deleteK8sRepo
6019 description: Accepted
6021 $ref: '#/components/responses/BadRequest'
6023 $ref: '#/components/responses/Unauthorized'
6025 $ref: '#/components/responses/Forbidden'
6027 $ref: '#/components/responses/NotFound'
6029 $ref: '#/components/responses/MethodNotAllowed'
6031 $ref: '#/components/responses/NotAcceptable'
6033 $ref: '#/components/responses/Conflict'
6035 $ref: '#/components/responses/UnprocessableEntity'
6037 $ref: '#/components/responses/InternalServerError'
6039 $ref: '#/components/responses/ServiceUnavailable'
6041 $ref: '#/components/responses/UnexpectedError'
6043 $ref: '#/components/responses/UnexpectedError'
6047 description: Find out more about OSM
6048 url: 'https://osm.etsi.org/docs/user-guide/'
6053 description: Bad request. The server cannot process the request due to a client error.
6057 $ref: '#/components/schemas/ProblemDetails'
6059 description: Authorization information is missing or invalid.
6063 $ref: '#/components/schemas/ProblemDetails'
6065 description: Not enough permissions to do this operation.
6069 $ref: '#/components/schemas/ProblemDetails'
6071 description: The specified resource was not found.
6075 $ref: '#/components/schemas/ProblemDetails'
6077 description: This method is not supported for the requested resource.
6081 $ref: '#/components/schemas/ProblemDetails'
6083 description: The requested resource content cannot match the Accept headers sent in the request.
6087 $ref: '#/components/schemas/ProblemDetails'
6089 description: The operation cannot be executed currently, due to a conflict with the state of the resource.
6093 $ref: '#/components/schemas/ProblemDetails'
6094 UnprocessableEntity:
6095 description: The request was well-formed but was unable to be followed due to semantic errors.
6099 $ref: '#/components/schemas/ProblemDetails'
6100 InternalServerError:
6101 description: Internal server error.
6105 $ref: '#/components/schemas/ProblemDetails'
6107 description: Service temporarily unavailable.
6111 $ref: '#/components/schemas/ProblemDetails'
6113 description: Unexpected error.
6117 $ref: '#/components/schemas/ProblemDetails'
6119 description: VNF Descriptor (plaintext)
6123 $ref: '#/components/schemas/VnfDescriptor'
6125 description: VNF Package (compressed)
6129 $ref: '#/components/schemas/VnfPackage'
6131 description: NS Descriptor (plaintext)
6135 $ref: '#/components/schemas/NsDescriptor'
6137 description: NS Package (compressed)
6141 $ref: '#/components/schemas/NsPackage'
6143 description: NetSlice Template (plaintext)
6147 $ref: '#/components/schemas/NetSliceTemplate'
6149 description: NetSlice Package (compressed)
6153 $ref: '#/components/schemas/NetSlicePackage'
6154 NslcmSubscriptionResponse:
6155 description: NslcmSubscriptionResponse
6159 $ref: '#/components/schemas/NslcmSubscriptionResponse'
6162 $ref: '#/components/schemas/NslcmSubscriptionResponse'
6173 # A free list of key:value pairs
6175 additionalProperties: true
6182 CreateNsdInfoRequest:
6183 # A free list of key:value pairs
6185 additionalProperties: true
6186 NsdInfoModifications:
6188 NS Descriptor Information
6189 Only generic fields (id, name, description) are described
6190 For a full specification of the NS Descriptor see:
6191 http://osm-download.etsi.org/ftp/osm-doc/nsd.html
6195 description: NSD Identifier
6198 description: NSD Name
6201 description: NSD Description
6205 NS Descriptor Information
6206 Only generic fields (_id, id, name, description) are described
6207 For a full specification of the NS Descriptor see:
6208 http://osm-download.etsi.org/ftp/osm-doc/nsd.html
6213 Identifier of the onboarded individual NS descriptor
6214 resource. This identifier is allocated by the NFVO.
6219 This identifier, which is allocated by the NSD
6220 designer, identifies the NSD in a globally unique
6221 way. It is copied from the NSD content and shall be
6222 present after the NSD content is on-boarded.
6226 Name of the onboarded NSD. This information is
6227 copied from the NSD content and shall be present
6228 after the NSD content is on-boarded.
6232 Description of the onboarded NSD.
6233 This information is copied from the NSD content.
6241 $ref: '#/components/schemas/NsdInfo'
6257 additionalProperties: true
6267 CreateVnfPkgInfoRequest:
6268 # A free list of key:value pairs
6270 additionalProperties: true
6271 VnfPkgInfoModifications:
6273 VNF Package Information
6274 Only generic fields (id, name, description) are described
6275 For a full specification of the VNF Descriptor see:
6276 http://osm-download.etsi.org/ftp/osm-doc/vnfd.html
6280 description: VNF Package Identifier
6283 description: VNF Package Name
6286 description: VNF Package description
6290 VNF Package Information
6291 Only generic fields (_id, id, name, description) are described
6292 For a full specification of the VNF Descriptor see:
6293 http://osm-download.etsi.org/ftp/osm-doc/vnfd.html
6298 Identifier of the VNF package. This identifier is allocated by the NFVO.
6302 description: VNF Package Identifier
6305 description: VNF Package Name
6308 description: VNF Package description
6316 $ref: '#/components/schemas/VnfPkgInfo'
6318 # Substituted by InstantiateNsRequest
6321 NS Instance Information
6322 Only generic fields (_id, id, name, description) are described
6323 For a full specification of the NS Instance see:
6324 http://osm-download.etsi.org/ftp/osm-doc/nsr.html
6328 description: Identifier of the NS instance.
6332 description: Identifier of the NS instance.
6336 description: Human readable name of the NS instance.
6339 description: Human readable description of the NS instance.
6345 InstantiateNsRequest:
6350 Human-readable name of the NS instance to be created.
6354 Identifier of the NSD that defines the NS instance to be created.
6359 Identifier of the VIM Account where the NS instance shall be created.
6378 additionalParamsForNs:
6380 additionalProperties: true
6381 additionalParamsForVnf: &additionalparamsforvnf
6390 additionalProperties: true
6394 use this namespace for all the KDU deployed in this VNF
6395 (if any). By default it is used the id of the project
6396 additionalParamsForVdu:
6405 additionalProperties: true
6409 additionalProperties: false
6410 additionalParamsForKdu:
6419 description: use this namespace for this KDU
6424 additionalProperties: true
6428 additionalProperties: false
6432 additionalProperties: false
6445 To compute automatically the target VIM for each VNF based on
6446 constrains, e.g. latency. Currently only 'PLA' is supported
6447 placement-constraints:
6449 additionalProperties: true
6483 additionalProperties: false
6498 floating-ip-required:
6502 additionalProperties: false
6506 additionalProperties: false
6545 additionalProperties: false
6559 additionalProperties: false
6561 additionalProperties: false
6573 connect additional ports to the created underlay SDN connectivity.
6574 Normally for external connectivy.
6588 additionalProperties: true
6593 additionalProperties: false
6594 internal-connection-point:
6607 additionalProperties: False
6612 additionalProperties: false
6617 additionalProperties: false
6636 additionalProperties: true
6644 additionalProperties: true
6652 additionalProperties: false
6653 vnfd-connection-point-ref:
6658 member-vnf-index-ref:
6660 vnfd-connection-point-ref:
6666 - member-vnf-index-ref
6667 - vnfd-connection-point-ref
6669 additionalProperties: false
6673 additionalProperties: false
6679 additionalProperties: false
6688 description: timeout for the scale operation
6701 scaling-group-descriptor:
6708 - scaling-group-descriptor
6710 additionalProperties: false
6714 additionalProperties: false
6718 additionalProperties: false
6722 timeout_ns_terminate:
6723 description: timeout for terminate operation
6726 description: remove network service if termination end without error
6728 skip_terminate_primitives:
6729 description: Do not execute network service termination primitives
6731 additionalProperties: false
6735 $ref: '#/components/schemas/NsInstance'
6736 NSinstanceActionRequest:
6742 name of the primitive in the 'config-descriptor'. If the target is
6743 a kdu it can be also 'status', 'rollback' or 'upgrade'
6745 description: parameters of this primitive
6746 $ref: '#/components/schemas/KeyValuePairs'
6749 description: provide if the target action is for a vnf, vdu or kdu
6752 description: provide if the target action is for a vdu
6755 description: provide if the target action is for a kdu
6759 description: timeout for the day 1/2 operation
6764 additionalProperties: false
6765 # CreateNSinstanceContentRequest:
6766 # Substituted by InstantiateNsRequest
6767 CreateNSinstanceContentResponse:
6790 isAutomaticInvocation:
6832 $ref: '#/components/schemas/NsLcmOpOcc'
6835 VNF Instance Information
6836 Only generic fields (_id, id) are described
6837 For a full specification of the VNF Instance see:
6838 http://osm-download.etsi.org/ftp/osm-doc/vnfr.html
6847 ArrayOfVnfInstanceInfo:
6850 $ref: '#/components/schemas/VnfInstanceInfo'
6853 NetSlice Template Information
6854 Only generic fields (_id, id, name) are described
6855 For a full specification of the NetSlice Template see:
6856 http://osm-download.etsi.org/ftp/osm-doc/nst.html
6860 description: NetSlice Template Identifier
6864 description: Human readable NetSlice Template Identifier
6867 description: Human readable name of the NetSlice Template
6872 $ref: '#/components/schemas/NstInfo'
6873 CreateNstInfoRequest:
6874 # A free list of key:value pairs
6876 additionalProperties: true
6883 NstInfoModifications:
6885 NetSlice Template Information
6886 Only generic fields (id, name) are described
6887 For a full specification of the NetSlice Template see:
6888 http://osm-download.etsi.org/ftp/osm-doc/nst.html
6892 description: NST Identifier
6895 description: NST Name
6899 NetSlice Instance Information
6900 Only generic fields (_id, id, name, description) are described
6901 For a full specification of the NetSlice Instance see:
6902 http://osm-download.etsi.org/ftp/osm-doc/nsi.html
6906 description: Identifier of the NetSlice instance.
6910 description: Identifier of the NetSlice instance.
6914 description: Human readable name of the NetSlice instance.
6917 description: Human readable description of the NetSlice instance.
6923 ArrayOfNetSliceInstance:
6926 $ref: '#/components/schemas/NetSliceInstance'
6928 # Substituted by InstantiateNsiRequest
6929 InstantiateNsiRequest:
6934 Human-readable name of the NetSlice instance to be created.
6938 Identifier of the NST that defines the NetSlice instance to be created.
6943 Identifier of the VIM Account where the NetSlice instance shall be created.
6959 additionalParamsForNsi:
6961 additionalProperties: true
6993 additionalParamsForNs:
6995 additionalProperties: true
6996 additionalParamsForVnf: *additionalparamsforvnf
7035 additionalProperties: false
7050 floating-ip-required:
7054 additionalProperties: false
7058 additionalProperties: false
7097 additionalProperties: false
7111 additionalProperties: false
7113 additionalProperties: false
7121 additionalProperties: false
7122 internal-connection-point:
7135 additionalProperties: False
7140 additionalProperties: false
7145 additionalProperties: false
7164 additionalProperties: true
7172 additionalProperties: true
7180 additionalProperties: false
7181 vnfd-connection-point-ref:
7186 member-vnf-index-ref:
7188 vnfd-connection-point-ref:
7194 - member-vnf-index-ref
7195 - vnfd-connection-point-ref
7197 additionalProperties: false
7201 additionalProperties: false
7203 additionalProperties: false
7222 additionalProperties: true
7225 additionalProperties: false
7231 additionalProperties: false
7232 TerminateNsiRequest:
7237 Timestamp indicating the end time of the NSI, i.e. the NSI will be terminated
7238 automatically at this timestamp. Cardinality "0" indicates the NSI termination
7239 takes place immediately.
7248 $ref: '#/components/schemas/KeyValuePairs'
7257 # CreateNsiContentRequest:
7258 # Substituted by InstantiateNsiRequest
7259 CreateNsiContentResponse:
7282 isAutomaticInvocation:
7329 $ref: '#/components/schemas/NsiLcmOpOcc'
7373 $ref: '#/components/schemas/TokenInfo'
7396 project_role_mappings:
7418 $ref: '#/components/schemas/UserInfo'
7419 ProjectRoleMappings:
7431 additionalProperties: false
7432 ProjectRoleMappingsOpt:
7443 additionalProperties: false
7455 project_role_mappings:
7456 $ref: '#/components/schemas/ProjectRoleMappings'
7460 additionalProperties: false
7467 additionalProperties: true
7470 Array edition keys must start with '$'
7471 and follow the syntax defined in: https://osm.etsi.org/wikipub/index.php/NBI_API_Description
7481 - $ref: '#/components/schemas/ShortNameList'
7482 - $ref: '#/components/schemas/ArrayEditionSchema'
7483 project_role_mappings:
7484 $ref: '#/components/schemas/ProjectRoleMappings'
7485 add_project_role_mappings:
7486 $ref: '#/components/schemas/ProjectRoleMappings'
7487 remove_project_role_mappings:
7488 $ref: '#/components/schemas/ProjectRoleMappingsOpt'
7544 additionalProperties: false
7600 additionalProperties: false
7610 $ref: '#/components/schemas/QuotasInfo'
7614 $ref: '#/components/schemas/ProjectInfo'
7615 CreateProjectRequest:
7623 $ref: '#/components/schemas/QuotasInfo'
7626 additionalProperties: false
7635 $ref: '#/components/schemas/EditQuotasInfo'
7636 additionalProperties: false
7639 additionalProperties:
7643 Permissions keys must follow the syntax 'main_topic[:subtopic[:id[:component|action|etc]]]'
7644 Permission values are either true or false
7645 EditPermissionsInfo:
7647 additionalProperties:
7651 Permissions keys must follow the syntax 'main_topic[:subtopic[:id[:component|action|etc]]]'
7652 Permission values are either true, false, or null
7662 $ref: '#/components/schemas/PermissionsInfo'
7666 $ref: '#/components/schemas/RoleInfo'
7673 $ref: '#/components/schemas/PermissionsInfo'
7676 additionalProperties: false
7683 $ref: '#/components/schemas/EditPermissionsInfo'
7684 additionalProperties: false
7715 $ref: '#/components/schemas/VimType'
7730 additionalProperties: true
7736 $ref: '#/components/schemas/VimInfo'
7754 $ref: '#/components/schemas/VimType'
7769 additionalProperties: true
7779 additionalProperties: false
7792 $ref: '#/components/schemas/VimType'
7807 additionalProperties: true
7808 additionalProperties: false
7850 $ref: '#/components/schemas/WimType'
7860 additionalProperties: true
7864 $ref: '#/components/schemas/WimInfo'
7880 $ref: '#/components/schemas/WimType'
7890 additionalProperties: true
7895 additionalProperties: false
7916 additionalProperties: true
7917 additionalProperties: false
7956 - $ref: '#/components/schemas/SdnExtraProperties'
7957 - $ref: '#/components/schemas/SdnBasicProperties'
7961 $ref: '#/components/schemas/SdnInfo'
7964 - $ref: '#/components/schemas/SdnBasicProperties'
7971 additionalProperties: false
7974 - $ref: '#/components/schemas/SdnBasicProperties'
7975 additionalProperties: false
8031 additionalProperties: false
8055 $ref: '#/components/schemas/PduInterfaces'
8059 $ref: '#/components/schemas/PduInfo'
8080 $ref: '#/components/schemas/PduInterfaces'
8085 additionalProperties: false
8106 $ref: '#/components/schemas/PduInterfaces'
8107 additionalProperties: false
8112 additionalProperties: true
8130 additionalProperties: true
8137 $ref: '#/components/schemas/K8sClusterNetList'
8144 ArrayOfK8sClusterInfo:
8147 $ref: '#/components/schemas/K8sClusterInfo'
8148 CreateK8sClusterRequest:
8162 additionalProperties: true
8169 $ref: '#/components/schemas/K8sClusterNetList'
8182 additionalProperties: false
8183 EditK8sClusterRequest:
8192 additionalProperties: true
8199 $ref: '#/components/schemas/K8sClusterNetList'
8206 additionalProperties: false
8240 additionalProperties: true
8244 $ref: '#/components/schemas/VcaInfo'
8275 additionalProperties: true
8286 additionalProperties: false
8312 additionalProperties: true
8313 additionalProperties: false
8330 $ref: '#/components/schemas/K8sRepoType'
8337 $ref: '#/components/schemas/K8sRepoInfo'
8338 CreateK8sRepoRequest:
8346 $ref: '#/components/schemas/K8sRepoType'
8354 additionalProperties: false
8355 NslcmSubscriptionResponse:
8368 NslcmSubscriptionInfo:
8385 $ref: '#/components/schemas/Authenticationschema'
8386 ArrayOfNslcmSubscriptionInfo:
8389 $ref: '#/components/schemas/NslcmSubscriptionInfo'
8390 NsInstanceSubscriptionFilter:
8392 used to identify the network service
8395 - $ref: '#/components/schemas/nsdIds'
8396 - $ref: '#/components/schemas/vnfdIds'
8397 - $ref: '#/components/schemas/pnfdIds'
8398 - $ref: '#/components/schemas/nsInstanceIds'
8399 - $ref: '#/components/schemas/nsInstanceNames'
8423 nsInstanceSubscriptionFilter:
8424 $ref: '#/components/schemas/NsInstanceSubscriptionFilter'
8427 If NsLcmOperationOccurrenceNotification is selected then at least operationTypes or states is required. If NsLcmOperationOccurrenceNotification is selected then at least nsComponentTypes, lcmOpName and lcmOpOccStatus is required
8432 - NsIdentifierCreationNotification
8433 - NsIdentifierDeletionNotification
8434 - NsLcmOperationOccurrenceNotification
8435 - NsChangeNotification
8453 - PARTIALLY_COMPLETED
8466 lcmOpNameImpactingNsComponent:
8473 - VNF_SCALE_TO_LEVEL
8474 - VNF_CHANGE_FLAVOUR
8478 - VNF_CHANGE_EXT_CONN
8485 lcmOpOccStatusImpactingNsComponent:
8492 - PARTIALLY_COMPLETED
8495 Authenticationschema:
8509 NslcmSubscriptionRequest:
8513 $ref: '#/components/schemas/Nslcmsubschema'
8518 $ref: '#/components/schemas/Authenticationschema'
8524 CreateNsdInfoRequest:
8528 $ref: '#/components/schemas/CreateNsdInfoRequest'
8531 $ref: '#/components/schemas/CreateNsdInfoRequest'
8532 NsdInfoModifications:
8536 $ref: '#/components/schemas/NsdInfoModifications'
8539 $ref: '#/components/schemas/NsdInfoModifications'
8544 $ref: '#/components/schemas/NsDescriptor'
8549 $ref: '#/components/schemas/NsPackage'
8550 CreateVnfPkgInfoRequest:
8554 $ref: '#/components/schemas/CreateVnfPkgInfoRequest'
8557 $ref: '#/components/schemas/CreateVnfPkgInfoRequest'
8558 VnfPkgInfoModifications:
8562 $ref: '#/components/schemas/VnfPkgInfoModifications'
8565 $ref: '#/components/schemas/VnfPkgInfoModifications'
8570 $ref: '#/components/schemas/VnfPackage'
8575 $ref: '#/components/schemas/VnfDescriptor'
8577 # Substituted by InstantiateNsRequest
8578 InstantiateNsRequest:
8582 $ref: '#/components/schemas/InstantiateNsRequest'
8585 $ref: '#/components/schemas/InstantiateNsRequest'
8590 $ref: '#/components/schemas/ScaleNsRequest'
8593 $ref: '#/components/schemas/ScaleNsRequest'
8598 $ref: '#/components/schemas/TerminateNsRequest'
8601 $ref: '#/components/schemas/TerminateNsRequest'
8602 # CreateNSinstanceContentRequest:
8603 # Substituted by InstantiateNsRequest
8604 CreateNstInfoRequest:
8608 $ref: '#/components/schemas/CreateNstInfoRequest'
8611 $ref: '#/components/schemas/CreateNstInfoRequest'
8616 $ref: '#/components/schemas/NetSliceTemplate'
8621 $ref: '#/components/schemas/NetSlicePackage'
8622 NstInfoModifications:
8626 $ref: '#/components/schemas/NstInfoModifications'
8629 $ref: '#/components/schemas/NstInfoModifications'
8631 # Substituted by InstantiateNsiRequest
8632 InstantiateNsiRequest:
8636 $ref: '#/components/schemas/InstantiateNsiRequest'
8639 $ref: '#/components/schemas/InstantiateNsiRequest'
8640 TerminateNsiRequest:
8644 $ref: '#/components/schemas/TerminateNsiRequest'
8647 $ref: '#/components/schemas/TerminateNsiRequest'
8652 $ref: '#/components/schemas/NsiActionRequest'
8655 $ref: '#/components/schemas/NsiActionRequest'
8656 # CreateNsiContentRequest:
8657 # Substituted by InstantiateNsiRequest
8662 $ref: '#/components/schemas/CreateTokenRequest'
8665 $ref: '#/components/schemas/CreateTokenRequest'
8670 $ref: '#/components/schemas/CreateUserRequest'
8673 $ref: '#/components/schemas/CreateUserRequest'
8678 $ref: '#/components/schemas/EditUserRequest'
8681 $ref: '#/components/schemas/EditUserRequest'
8682 CreateProjectRequest:
8686 $ref: '#/components/schemas/CreateProjectRequest'
8689 $ref: '#/components/schemas/CreateProjectRequest'
8694 $ref: '#/components/schemas/EditProjectRequest'
8697 $ref: '#/components/schemas/EditProjectRequest'
8702 $ref: '#/components/schemas/CreateRoleRequest'
8705 $ref: '#/components/schemas/CreateRoleRequest'
8710 $ref: '#/components/schemas/EditRoleRequest'
8713 $ref: '#/components/schemas/EditRoleRequest'
8718 $ref: '#/components/schemas/CreateVimRequest'
8721 $ref: '#/components/schemas/CreateVimRequest'
8726 $ref: '#/components/schemas/EditVimRequest'
8729 $ref: '#/components/schemas/EditVimRequest'
8734 $ref: '#/components/schemas/CreateWimRequest'
8737 $ref: '#/components/schemas/CreateWimRequest'
8742 $ref: '#/components/schemas/EditWimRequest'
8745 $ref: '#/components/schemas/EditWimRequest'
8750 $ref: '#/components/schemas/CreateSdnRequest'
8753 $ref: '#/components/schemas/CreateSdnRequest'
8758 $ref: '#/components/schemas/EditSdnRequest'
8761 $ref: '#/components/schemas/EditSdnRequest'
8766 $ref: '#/components/schemas/CreatePduRequest'
8769 $ref: '#/components/schemas/CreatePduRequest'
8774 $ref: '#/components/schemas/EditPduRequest'
8777 $ref: '#/components/schemas/EditPduRequest'
8778 CreateK8sClusterRequest:
8782 $ref: '#/components/schemas/CreateK8sClusterRequest'
8785 $ref: '#/components/schemas/CreateK8sClusterRequest'
8786 EditK8sClusterRequest:
8790 $ref: '#/components/schemas/EditK8sClusterRequest'
8793 $ref: '#/components/schemas/EditK8sClusterRequest'
8798 $ref: '#/components/schemas/CreateVcaRequest'
8801 $ref: '#/components/schemas/CreateVcaRequest'
8806 $ref: '#/components/schemas/EditVcaRequest'
8809 $ref: '#/components/schemas/EditVcaRequest'
8810 CreateK8sRepoRequest:
8814 $ref: '#/components/schemas/CreateK8sRepoRequest'
8817 $ref: '#/components/schemas/CreateK8sRepoRequest'
8818 NslcmSubscriptionRequest:
8822 $ref: '#/components/schemas/NslcmSubscriptionRequest'
8825 $ref: '#/components/schemas/NslcmSubscriptionRequest'
8826 # END REQUEST BODIES