blob: 6df1c21e06fd0cb499c87c4745b3330738423123 [file] [log] [blame]
seshukmef45a052018-09-25 19:13:07 +08001{
2 "swagger": "2.0",
3 "info": {
4 "version": "3.1.2",
5 "title": "SO Casablanca APIs"
6 },
7 "tags": [
8 {
9 "name": "e2eServiceInstances"
10 },
11 {
12 "name": "globalhealthcheck"
13 },
14 {
15 "name": "nodehealthcheck"
16 },
17 {
18 "name": "onapsoinfraorchestrationRequests"
19 },
20 {
Harry Huangd79a1a22020-01-08 16:19:35 +080021 "name": "onapsoinfraorchestrationTasks"
22 },
23 {
seshukmef45a052018-09-25 19:13:07 +080024 "name": "onapsoinfraserviceInstantiation"
25 },
26 {
27 "name": "onapsoinfratasks"
28 },
29 {
30 "name": "onapsoinfracloudResources"
31 },
32 {
33 "name": "onapsoinfracloudResourcesRequests"
34 },
35 {
36 "name": "onapsoinframodelDistributions"
37 }
38 ],
39 "schemes": [
40 "https"
41 ],
42 "paths": {
43 "/e2eServiceInstances/{version}": {
44 "post": {
45 "tags": [
46 "e2eServiceInstances"
47 ],
48 "summary": "Create an E2E Service Instance on a version provided",
49 "description": "",
50 "operationId": "createE2EServiceInstance",
51 "consumes": [
52 "application/json"
53 ],
54 "produces": [
55 "application/json"
56 ],
57 "parameters": [
58 {
59 "in": "body",
60 "name": "body",
61 "required": false,
62 "schema": {
63 "type": "string"
64 }
65 },
66 {
67 "name": "version",
68 "in": "path",
69 "required": true,
70 "type": "string",
71 "pattern": "[vV][3-5]"
72 }
73 ],
74 "responses": {
75 "default": {
76 "description": "successful operation"
77 }
78 }
79 }
80 },
81 "/e2eServiceInstances/{version}/{serviceId}": {
82 "put": {
83 "tags": [
84 "e2eServiceInstances"
85 ],
86 "summary": "Update an E2E Service Instance on a version provided and serviceId",
87 "description": "",
88 "operationId": "updateE2EServiceInstance",
89 "consumes": [
90 "application/json"
91 ],
92 "produces": [
93 "application/json"
94 ],
95 "parameters": [
96 {
97 "in": "body",
98 "name": "body",
99 "required": false,
100 "schema": {
101 "type": "string"
102 }
103 },
104 {
105 "name": "version",
106 "in": "path",
107 "required": true,
108 "type": "string",
109 "pattern": "[vV][3-5]"
110 },
111 {
112 "name": "serviceId",
113 "in": "path",
114 "required": true,
115 "type": "string"
116 }
117 ],
118 "responses": {
119 "default": {
120 "description": "successful operation"
121 }
122 }
123 },
124 "delete": {
125 "tags": [
126 "e2eServiceInstances"
127 ],
128 "summary": "Delete E2E Service Instance on a specified version and serviceId",
129 "description": "",
130 "operationId": "deleteE2EServiceInstance",
131 "consumes": [
132 "application/json"
133 ],
134 "produces": [
135 "application/json"
136 ],
137 "parameters": [
138 {
139 "in": "body",
140 "name": "body",
141 "required": false,
142 "schema": {
143 "type": "string"
144 }
145 },
146 {
147 "name": "version",
148 "in": "path",
149 "required": true,
150 "type": "string",
151 "pattern": "[vV][3-5]"
152 },
153 {
154 "name": "serviceId",
155 "in": "path",
156 "required": true,
157 "type": "string"
158 }
159 ],
160 "responses": {
161 "default": {
162 "description": "successful operation"
163 }
164 }
165 }
166 },
Harry Huangd79a1a22020-01-08 16:19:35 +0800167 "/e2eServiceInstances/{version}/{serviceId}/operations/{operationType}": {
168 "get": {
169 "tags": [
170 "e2eServiceInstances"
171 ],
172 "summary": "Activate/Deactivate e2eServiceInstances Requests for a given serviceId",
173 "description": "",
174 "operationId": "activateE2EServiceInstances",
175 "produces": [
176 "application/json"
177 ],
178 "parameters": [
179 {
180 "name": "serviceId",
181 "in": "path",
182 "required": true,
183 "type": "string"
184 },
185 {
186 "name": "version",
187 "in": "path",
188 "required": true,
189 "type": "string",
190 "pattern": "[vV][3-5]"
191 },
192 {
193 "name": "operationType",
194 "in": "path",
195 "required": true,
196 "type": "string",
197 "pattern": "activate/deactivate"
198 }
199 ],
200 "responses": {
201 "default": {
202 "description": "successful operation"
203 }
204 }
205 }
206 },
seshukmef45a052018-09-25 19:13:07 +0800207 "/e2eServiceInstances/{version}/{serviceId}/operations/{operationId}": {
208 "get": {
209 "tags": [
210 "e2eServiceInstances"
211 ],
212 "summary": "Find e2eServiceInstances Requests for a given serviceId and operationId",
213 "description": "",
214 "operationId": "getE2EServiceInstances",
215 "produces": [
216 "application/json"
217 ],
218 "parameters": [
219 {
220 "name": "serviceId",
221 "in": "path",
222 "required": true,
223 "type": "string"
224 },
225 {
226 "name": "version",
227 "in": "path",
228 "required": true,
229 "type": "string",
230 "pattern": "[vV][3-5]"
231 },
232 {
233 "name": "operationId",
234 "in": "path",
235 "required": true,
236 "type": "string"
237 }
238 ],
239 "responses": {
240 "default": {
241 "description": "successful operation"
242 }
243 }
244 }
245 },
246 "/e2eServiceInstances/{version}/{serviceId}/scale": {
247 "post": {
248 "tags": [
249 "e2eServiceInstances"
250 ],
251 "summary": "Scale E2E Service Instance on a specified version",
252 "description": "",
253 "operationId": "scaleE2EServiceInstance",
254 "consumes": [
255 "application/json"
256 ],
257 "produces": [
258 "application/json"
259 ],
260 "parameters": [
261 {
262 "in": "body",
263 "name": "body",
264 "required": false,
265 "schema": {
266 "type": "string"
267 }
268 },
269 {
270 "name": "version",
271 "in": "path",
272 "required": true,
273 "type": "string",
274 "pattern": "[vV][3-5]"
275 },
276 {
277 "name": "serviceId",
278 "in": "path",
279 "required": true,
280 "type": "string"
281 }
282 ],
283 "responses": {
284 "default": {
285 "description": "successful operation"
286 }
287 }
288 }
289 },
290 "/e2eServiceInstances/{version}/{serviceId}/modeldifferences": {
291 "post": {
292 "tags": [
293 "e2eServiceInstances"
294 ],
295 "summary": "Find added and deleted resources of target model for the e2eserviceInstance on a given serviceId ",
296 "description": "",
297 "operationId": "compareModelwithTargetVersion",
298 "consumes": [
299 "application/json"
300 ],
301 "produces": [
302 "application/json"
303 ],
304 "parameters": [
305 {
306 "in": "body",
307 "name": "body",
308 "required": false,
309 "schema": {
310 "type": "string"
311 }
312 },
313 {
314 "name": "serviceId",
315 "in": "path",
316 "required": true,
317 "type": "string"
318 },
319 {
320 "name": "version",
321 "in": "path",
322 "required": true,
323 "type": "string",
324 "pattern": "[vV][3-5]"
325 }
326 ],
327 "responses": {
328 "default": {
329 "description": "successful operation"
330 }
331 }
332 }
333 },
334 "/globalhealthcheck": {
335 "get": {
336 "tags": [
337 "globalhealthcheck"
338 ],
339 "summary": "Performing global health check",
340 "description": "",
341 "operationId": "globalHealthcheck",
342 "produces": [
343 "text/html"
344 ],
345 "parameters": [
346 {
347 "name": "enableBpmn",
348 "in": "query",
349 "required": false,
350 "type": "boolean",
351 "default": true
352 }
353 ],
354 "responses": {
355 "default": {
356 "description": "successful operation"
357 }
358 }
359 }
360 },
361 "/nodehealthcheck": {
362 "get": {
363 "tags": [
364 "nodehealthcheck"
365 ],
366 "summary": "Performing node health check",
367 "description": "",
368 "operationId": "nodeHealthcheck",
369 "produces": [
370 "text/html"
371 ],
372 "parameters": [],
373 "responses": {
374 "default": {
375 "description": "successful operation"
376 }
377 }
378 }
379 },
380 "/onap/so/infra/orchestrationRequests/{version}": {
381 "get": {
382 "tags": [
383 "onapsoinfraorchestrationRequests"
384 ],
385 "summary": "Find Orchestrated Requests for a URI Information",
386 "description": "",
387 "operationId": "getOrchestrationRequest",
388 "produces": [
389 "application/json"
390 ],
391 "parameters": [
392 {
393 "name": "version",
394 "in": "path",
395 "required": true,
396 "type": "string",
397 "pattern": "[vV][4-7]"
398 }
399 ],
400 "responses": {
401 "default": {
402 "description": "successful operation"
403 }
404 }
405 }
406 },
407 "/onap/so/infra/orchestrationRequests/{version}/{requestId}": {
408 "get": {
409 "tags": [
410 "onapsoinfraorchestrationRequests"
411 ],
412 "summary": "Find Orchestrated Requests for a given requestId",
413 "description": "",
414 "operationId": "getOrchestrationRequestForReqId",
415 "produces": [
416 "application/json"
417 ],
418 "parameters": [
419 {
420 "name": "requestId",
421 "in": "path",
422 "required": true,
423 "type": "string"
424 },
425 {
426 "name": "version",
427 "in": "path",
428 "required": true,
429 "type": "string",
430 "pattern": "[vV][4-7]"
431 }
432 ],
433 "responses": {
434 "default": {
435 "description": "successful operation"
436 }
437 }
438 }
439 },
440 "/onap/so/infra/orchestrationRequests/{version}/{requestId}/unlock": {
441 "post": {
442 "tags": [
443 "onapsoinfraorchestrationRequests"
444 ],
445 "summary": "Unlock Orchestrated Requests for a given requestId",
446 "description": "",
447 "operationId": "unlockOrchestrationRequest",
448 "consumes": [
449 "application/json"
450 ],
451 "produces": [
452 "application/json"
453 ],
454 "parameters": [
455 {
456 "in": "body",
457 "name": "body",
458 "required": false,
459 "schema": {
460 "type": "string"
461 }
462 },
463 {
464 "name": "requestId",
465 "in": "path",
466 "required": true,
467 "type": "string"
468 },
469 {
470 "name": "version",
471 "in": "path",
472 "required": true,
473 "type": "string",
474 "pattern": "[vV][4-7]"
475 }
476 ],
477 "responses": {
478 "default": {
479 "description": "successful operation"
480 }
481 }
482 }
483 },
Harry Huangd79a1a22020-01-08 16:19:35 +0800484 "/onap/so/infra/orchestrationTasks/{version}": {
485 "get": {
486 "tags": [
487 "onapsoinfraorchestrationTasks"
488 ],
489 "summary": "Get all orchestrationTasks",
490 "description": "",
491 "operationId": "getAllOrchestrationTasks",
492 "produces": [
493 "application/json"
494 ],
495 "parameters": [
496 {
497 "name": "version",
498 "in": "path",
499 "required": true,
500 "type": "string",
501 "pattern": "[vV][4-7]"
502 }
503 ],
504 "responses": {
505 "default": {
506 "description": "successful operation"
507 }
508 }
509 }
510 },
511 "/onap/so/infra/orchestrationTasks/{version}/{taskId}": {
512 "get": {
513 "tags": [
514 "onapsoinfraorchestrationTasks"
515 ],
516 "summary": "Get orchestrationTask for a given taskId",
517 "description": "",
518 "operationId": "getOrchestrationTask",
519 "produces": [
520 "application/json"
521 ],
522 "parameters": [
523 {
524 "name": "taskId",
525 "in": "path",
526 "required": true,
527 "type": "string",
528 },
529 {
530 "name": "version",
531 "in": "path",
532 "required": true,
533 "type": "string",
534 "pattern": "[vV][4-7]"
535 }
536 ],
537 "responses": {
538 "default": {
539 "description": "successful operation"
540 }
541 }
542 }
543 },
544 "/onap/so/infra/orchestrationTasks/{version}": {
545 "post": {
546 "tags": [
547 "onapsoinfraorchestrationTasks"
548 ],
549 "summary": "Create an orchestrationTask",
550 "description": "",
551 "operationId": "createOrchestrationTask",
552 "produces": [
553 "application/json"
554 ],
555 "parameters": [
556 {
557 "name": "version",
558 "in": "path",
559 "required": true,
560 "type": "string",
561 "pattern": "[vV][4-7]"
562 }
563 ],
564 "responses": {
565 "default": {
566 "description": "successful operation"
567 }
568 }
569 }
570 },
571 "/onap/so/infra/orchestrationTasks/{version}/{taskId}": {
572 "put": {
573 "tags": [
574 "onapsoinfraorchestrationTasks"
575 ],
576 "summary": "update orchestrationTask for a given taskId",
577 "description": "",
578 "operationId": "updateOrchestrationTask",
579 "produces": [
580 "application/json"
581 ],
582 "parameters": [
583 {
584 "name": "taskId",
585 "in": "path",
586 "required": true,
587 "type": "string",
588 },
589 {
590 "name": "version",
591 "in": "path",
592 "required": true,
593 "type": "string",
594 "pattern": "[vV][4-7]"
595 }
596 ],
597 "responses": {
598 "default": {
599 "description": "successful operation"
600 }
601 }
602 }
603 },
604 "/onap/so/infra/orchestrationTasks/{version}/{taskId}": {
605 "delete": {
606 "tags": [
607 "onapsoinfraorchestrationTasks"
608 ],
609 "summary": "delete orchestrationTask for a given taskId",
610 "description": "",
611 "operationId": "deleteOrchestrationTask",
612 "produces": [
613 "application/json"
614 ],
615 "parameters": [
616 {
617 "name": "taskId",
618 "in": "path",
619 "required": true,
620 "type": "string",
621 },
622 {
623 "name": "version",
624 "in": "path",
625 "required": true,
626 "type": "string",
627 "pattern": "[vV][4-7]"
628 }
629 ],
630 "responses": {
631 "default": {
632 "description": "successful operation"
633 }
634 }
635 }
636 },
637 "/onap/so/infra/orchestrationTasks/{version}/{taskId}": {
638 "delete": {
639 "tags": [
640 "onapsoinfraorchestrationTasks"
641 ],
642 "summary": "delete orchestrationTask for a given taskId",
643 "description": "",
644 "operationId": "deleteOrchestrationTask",
645 "produces": [
646 "application/json"
647 ],
648 "parameters": [
649 {
650 "name": "taskId",
651 "in": "path",
652 "required": true,
653 "type": "string",
654 },
655 {
656 "name": "version",
657 "in": "path",
658 "required": true,
659 "type": "string",
660 "pattern": "[vV][4-7]"
661 }
662 ],
663 "responses": {
664 "default": {
665 "description": "successful operation"
666 }
667 }
668 }
669 },
670 "/onap/so/infra/orchestrationTasks/{version}/{taskId}/commit": {
671 "post": {
672 "tags": [
673 "onapsoinfraorchestrationTasks"
674 ],
675 "summary": "commit orchestrationTask for a given taskId",
676 "description": "",
677 "operationId": "commitOrchestrationTask",
678 "produces": [
679 "application/json"
680 ],
681 "parameters": [
682 {
683 "name": "taskId",
684 "in": "path",
685 "required": true,
686 "type": "string",
687 },
688 {
689 "name": "version",
690 "in": "path",
691 "required": true,
692 "type": "string",
693 "pattern": "[vV][4-7]"
694 }
695 ],
696 "responses": {
697 "default": {
698 "description": "successful operation"
699 }
700 }
701 }
702 },
703 "/onap/so/infra/orchestrationTasks/{version}/{taskId}/abort": {
704 "post": {
705 "tags": [
706 "onapsoinfraorchestrationTasks"
707 ],
708 "summary": "abort orchestrationTask for a given taskId",
709 "description": "",
710 "operationId": "abortOrchestrationTask",
711 "produces": [
712 "application/json"
713 ],
714 "parameters": [
715 {
716 "name": "taskId",
717 "in": "path",
718 "required": true,
719 "type": "string",
720 },
721 {
722 "name": "version",
723 "in": "path",
724 "required": true,
725 "type": "string",
726 "pattern": "[vV][4-7]"
727 }
728 ],
729 "responses": {
730 "default": {
731 "description": "successful operation"
732 }
733 }
734 }
735 },
seshukmef45a052018-09-25 19:13:07 +0800736 "/onap/so/infra/serviceInstantiation/{version}/serviceInstances/{serviceInstanceId}/vnfs/{vnfInstanceId}/vfModules/{vfmoduleInstanceId}/deactivateAndCloudDelete": {
737 "post": {
738 "tags": [
739 "onapsoinfraserviceInstantiation"
740 ],
741 "summary": "Deactivate and Cloud Delete VfModule instance",
742 "description": "",
743 "operationId": "deactivateAndCloudDeleteVfModuleInstance",
744 "consumes": [
745 "application/json"
746 ],
747 "produces": [
748 "application/json"
749 ],
750 "parameters": [
751 {
752 "in": "body",
753 "name": "body",
754 "required": false,
755 "schema": {
756 "type": "string"
757 }
758 },
759 {
760 "name": "version",
761 "in": "path",
762 "required": true,
763 "type": "string",
764 "pattern": "[vV][7]"
765 },
766 {
767 "name": "serviceInstanceId",
768 "in": "path",
769 "required": true,
770 "type": "string"
771 },
772 {
773 "name": "vnfInstanceId",
774 "in": "path",
775 "required": true,
776 "type": "string"
777 },
778 {
779 "name": "vfmoduleInstanceId",
780 "in": "path",
781 "required": true,
782 "type": "string"
783 }
784 ],
785 "responses": {
786 "default": {
787 "description": "successful operation"
788 }
789 }
790 }
791 },
792 "/onap/so/infra/serviceInstantiation/{version}/serviceInstances/{serviceInstanceId}/configurations/{configurationInstanceId}/enablePort": {
793 "post": {
794 "tags": [
795 "onapsoinfraserviceInstantiation"
796 ],
797 "summary": "Enable Port Mirroring",
798 "description": "",
799 "operationId": "enablePort",
800 "consumes": [
801 "application/json"
802 ],
803 "produces": [
804 "application/json"
805 ],
806 "parameters": [
807 {
808 "in": "body",
809 "name": "body",
810 "required": false,
811 "schema": {
812 "type": "string"
813 }
814 },
815 {
816 "name": "version",
817 "in": "path",
818 "required": true,
819 "type": "string",
820 "pattern": "[vV][5-7]"
821 },
822 {
823 "name": "serviceInstanceId",
824 "in": "path",
825 "required": true,
826 "type": "string"
827 },
828 {
829 "name": "configurationInstanceId",
830 "in": "path",
831 "required": true,
832 "type": "string"
833 }
834 ],
835 "responses": {
836 "default": {
837 "description": "successful operation"
838 }
839 }
840 }
841 },
842 "/onap/so/infra/serviceInstantiation/{version}/serviceInstances/{serviceInstanceId}/configurations/{configurationInstanceId}/disablePort": {
843 "post": {
844 "tags": [
845 "onapsoinfraserviceInstantiation"
846 ],
847 "summary": "Disable Port Mirroring",
848 "description": "",
849 "operationId": "disablePort",
850 "consumes": [
851 "application/json"
852 ],
853 "produces": [
854 "application/json"
855 ],
856 "parameters": [
857 {
858 "in": "body",
859 "name": "body",
860 "required": false,
861 "schema": {
862 "type": "string"
863 }
864 },
865 {
866 "name": "version",
867 "in": "path",
868 "required": true,
869 "type": "string",
870 "pattern": "[vV][5-7]"
871 },
872 {
873 "name": "serviceInstanceId",
874 "in": "path",
875 "required": true,
876 "type": "string"
877 },
878 {
879 "name": "configurationInstanceId",
880 "in": "path",
881 "required": true,
882 "type": "string"
883 }
884 ],
885 "responses": {
886 "default": {
887 "description": "successful operation"
888 }
889 }
890 }
891 },
892 "/onap/so/infra/serviceInstantiation/{version}/serviceInstances/{serviceInstanceId}/configurations/{configurationInstanceId}/activate": {
893 "post": {
894 "tags": [
895 "onapsoinfraserviceInstantiation"
896 ],
897 "summary": "Activate Port Mirroring",
898 "description": "",
899 "operationId": "activatePort",
900 "consumes": [
901 "application/json"
902 ],
903 "produces": [
904 "application/json"
905 ],
906 "parameters": [
907 {
908 "in": "body",
909 "name": "body",
910 "required": false,
911 "schema": {
912 "type": "string"
913 }
914 },
915 {
916 "name": "version",
917 "in": "path",
918 "required": true,
919 "type": "string",
920 "pattern": "[vV][5-7]"
921 },
922 {
923 "name": "serviceInstanceId",
924 "in": "path",
925 "required": true,
926 "type": "string"
927 },
928 {
929 "name": "configurationInstanceId",
930 "in": "path",
931 "required": true,
932 "type": "string"
933 }
934 ],
935 "responses": {
936 "default": {
937 "description": "successful operation"
938 }
939 }
940 }
941 },
942 "/onap/so/infra/serviceInstantiation/{version}/serviceInstances/{serviceInstanceId}/configurations/{configurationInstanceId}/deactivate": {
943 "post": {
944 "tags": [
945 "onapsoinfraserviceInstantiation"
946 ],
947 "summary": "Deactivate Port Mirroring",
948 "description": "",
949 "operationId": "deactivatePort",
950 "consumes": [
951 "application/json"
952 ],
953 "produces": [
954 "application/json"
955 ],
956 "parameters": [
957 {
958 "in": "body",
959 "name": "body",
960 "required": false,
961 "schema": {
962 "type": "string"
963 }
964 },
965 {
966 "name": "version",
967 "in": "path",
968 "required": true,
969 "type": "string",
970 "pattern": "[vV][5-7]"
971 },
972 {
973 "name": "serviceInstanceId",
974 "in": "path",
975 "required": true,
976 "type": "string"
977 },
978 {
979 "name": "configurationInstanceId",
980 "in": "path",
981 "required": true,
982 "type": "string"
983 }
984 ],
985 "responses": {
986 "default": {
987 "description": "successful operation"
988 }
989 }
990 }
991 },
992 "/onap/so/infra/serviceInstantiation/{version}/serviceInstances/{serviceInstanceId}/addRelationships": {
993 "post": {
994 "tags": [
995 "onapsoinfraserviceInstantiation"
996 ],
997 "summary": "Add Relationships to a Service Instance",
998 "description": "",
999 "operationId": "addRelationships",
1000 "consumes": [
1001 "application/json"
1002 ],
1003 "produces": [
1004 "application/json"
1005 ],
1006 "parameters": [
1007 {
1008 "in": "body",
1009 "name": "body",
1010 "required": false,
1011 "schema": {
1012 "type": "string"
1013 }
1014 },
1015 {
1016 "name": "version",
1017 "in": "path",
1018 "required": true,
1019 "type": "string",
1020 "pattern": "[vV][6-7]"
1021 },
1022 {
1023 "name": "serviceInstanceId",
1024 "in": "path",
1025 "required": true,
1026 "type": "string"
1027 }
1028 ],
1029 "responses": {
1030 "default": {
1031 "description": "successful operation"
1032 }
1033 }
1034 }
1035 },
1036 "/onap/so/infra/serviceInstantiation/{version}/serviceInstances/{serviceInstanceId}/vnfs/{vnfInstanceId}/vfModules/scaleOut": {
1037 "post": {
1038 "tags": [
1039 "onapsoinfraserviceInstantiation"
1040 ],
1041 "summary": "VF Auto Scale Out",
1042 "description": "",
1043 "operationId": "scaleOutVfModule",
1044 "consumes": [
1045 "application/json"
1046 ],
1047 "produces": [
1048 "application/json"
1049 ],
1050 "parameters": [
1051 {
1052 "in": "body",
1053 "name": "body",
1054 "required": false,
1055 "schema": {
1056 "type": "string"
1057 }
1058 },
1059 {
1060 "name": "version",
1061 "in": "path",
1062 "required": true,
1063 "type": "string",
1064 "pattern": "[vV][7]"
1065 },
1066 {
1067 "name": "serviceInstanceId",
1068 "in": "path",
1069 "required": true,
1070 "type": "string"
1071 },
1072 {
1073 "name": "vnfInstanceId",
1074 "in": "path",
1075 "required": true,
1076 "type": "string"
1077 }
1078 ],
1079 "responses": {
1080 "default": {
1081 "description": "successful operation"
1082 }
1083 }
1084 }
1085 },
1086 "/onap/so/infra/serviceInstantiation/{version}/serviceInstances/{serviceInstanceId}/vnfs/{vnfInstanceId}/inPlaceSoftwareUpdate": {
1087 "post": {
1088 "tags": [
1089 "onapsoinfraserviceInstantiation"
1090 ],
1091 "summary": "Perform VNF software update",
1092 "description": "",
1093 "operationId": "inPlaceSoftwareUpdate",
1094 "consumes": [
1095 "application/json"
1096 ],
1097 "produces": [
1098 "application/json"
1099 ],
1100 "parameters": [
1101 {
1102 "in": "body",
1103 "name": "body",
1104 "required": false,
1105 "schema": {
1106 "type": "string"
1107 }
1108 },
1109 {
1110 "name": "version",
1111 "in": "path",
1112 "required": true,
1113 "type": "string",
1114 "pattern": "[vV][6-7]"
1115 },
1116 {
1117 "name": "serviceInstanceId",
1118 "in": "path",
1119 "required": true,
1120 "type": "string"
1121 },
1122 {
1123 "name": "vnfInstanceId",
1124 "in": "path",
1125 "required": true,
1126 "type": "string"
1127 }
1128 ],
1129 "responses": {
1130 "default": {
1131 "description": "successful operation"
1132 }
1133 }
1134 }
1135 },
1136 "/onap/so/infra/serviceInstantiation/{version}/serviceInstances/{serviceInstanceId}/vnfs/{vnfInstanceId}/applyUpdatedConfig": {
1137 "post": {
1138 "tags": [
1139 "onapsoinfraserviceInstantiation"
1140 ],
1141 "summary": "Apply updated configuration",
1142 "description": "",
1143 "operationId": "applyUpdatedConfig",
1144 "consumes": [
1145 "application/json"
1146 ],
1147 "produces": [
1148 "application/json"
1149 ],
1150 "parameters": [
1151 {
1152 "in": "body",
1153 "name": "body",
1154 "required": false,
1155 "schema": {
1156 "type": "string"
1157 }
1158 },
1159 {
1160 "name": "version",
1161 "in": "path",
1162 "required": true,
1163 "type": "string",
1164 "pattern": "[vV][6-7]"
1165 },
1166 {
1167 "name": "serviceInstanceId",
1168 "in": "path",
1169 "required": true,
1170 "type": "string"
1171 },
1172 {
1173 "name": "vnfInstanceId",
1174 "in": "path",
1175 "required": true,
1176 "type": "string"
1177 }
1178 ],
1179 "responses": {
1180 "default": {
1181 "description": "successful operation"
1182 }
1183 }
1184 }
1185 },
1186 "/onap/so/infra/serviceInstantiation/{version}/serviceInstances": {
1187 "post": {
1188 "tags": [
1189 "onapsoinfraserviceInstantiation"
1190 ],
1191 "summary": "Create a Service Instance on a version provided",
1192 "description": "",
1193 "operationId": "createServiceInstance",
1194 "consumes": [
1195 "application/json"
1196 ],
1197 "produces": [
1198 "application/json"
1199 ],
1200 "parameters": [
1201 {
1202 "in": "body",
1203 "name": "body",
1204 "required": false,
1205 "schema": {
1206 "type": "string"
1207 }
1208 },
1209 {
1210 "name": "version",
1211 "in": "path",
1212 "required": true,
1213 "type": "string",
1214 "pattern": "[vV][5-7]"
1215 }
1216 ],
1217 "responses": {
1218 "default": {
1219 "description": "successful operation"
1220 }
1221 }
1222 }
1223 },
1224 "/onap/so/infra/serviceInstantiation/{version}/serviceInstances/{serviceInstanceId}/activate": {
1225 "post": {
1226 "tags": [
1227 "onapsoinfraserviceInstantiation"
1228 ],
1229 "summary": "Activate provided Service Instance",
1230 "description": "",
1231 "operationId": "activateServiceInstance",
1232 "consumes": [
1233 "application/json"
1234 ],
1235 "produces": [
1236 "application/json"
1237 ],
1238 "parameters": [
1239 {
1240 "in": "body",
1241 "name": "body",
1242 "required": false,
1243 "schema": {
1244 "type": "string"
1245 }
1246 },
1247 {
1248 "name": "version",
1249 "in": "path",
1250 "required": true,
1251 "type": "string",
1252 "pattern": "[vV][5-7]"
1253 },
1254 {
1255 "name": "serviceInstanceId",
1256 "in": "path",
1257 "required": true,
1258 "type": "string"
1259 }
1260 ],
1261 "responses": {
1262 "default": {
1263 "description": "successful operation"
1264 }
1265 }
1266 }
1267 },
1268 "/onap/so/infra/serviceInstantiation/{version}/serviceInstances/{serviceInstanceId}/deactivate": {
1269 "post": {
1270 "tags": [
1271 "onapsoinfraserviceInstantiation"
1272 ],
1273 "summary": "Deactivate provided Service Instance",
1274 "description": "",
1275 "operationId": "deactivateServiceInstance",
1276 "consumes": [
1277 "application/json"
1278 ],
1279 "produces": [
1280 "application/json"
1281 ],
1282 "parameters": [
1283 {
1284 "in": "body",
1285 "name": "body",
1286 "required": false,
1287 "schema": {
1288 "type": "string"
1289 }
1290 },
1291 {
1292 "name": "version",
1293 "in": "path",
1294 "required": true,
1295 "type": "string",
1296 "pattern": "[vV][5-7]"
1297 },
1298 {
1299 "name": "serviceInstanceId",
1300 "in": "path",
1301 "required": true,
1302 "type": "string"
1303 }
1304 ],
1305 "responses": {
1306 "default": {
1307 "description": "successful operation"
1308 }
1309 }
1310 }
1311 },
1312 "/onap/so/infra/serviceInstantiation/{version}/serviceInstances/{serviceInstanceId}": {
1313 "delete": {
1314 "tags": [
1315 "onapsoinfraserviceInstantiation"
1316 ],
1317 "summary": "Delete provided Service Instance",
1318 "description": "",
1319 "operationId": "deleteServiceInstance",
1320 "consumes": [
1321 "application/json"
1322 ],
1323 "produces": [
1324 "application/json"
1325 ],
1326 "parameters": [
1327 {
1328 "in": "body",
1329 "name": "body",
1330 "required": false,
1331 "schema": {
1332 "type": "string"
1333 }
1334 },
1335 {
1336 "name": "version",
1337 "in": "path",
1338 "required": true,
1339 "type": "string",
1340 "pattern": "[vV][5-7]"
1341 },
1342 {
1343 "name": "serviceInstanceId",
1344 "in": "path",
1345 "required": true,
1346 "type": "string"
1347 }
1348 ],
1349 "responses": {
1350 "default": {
1351 "description": "successful operation"
1352 }
1353 }
1354 }
1355 },
1356 "/onap/so/infra/serviceInstantiation/{version}/serviceInstances/assign": {
1357 "post": {
1358 "tags": [
1359 "onapsoinfraserviceInstantiation"
1360 ],
1361 "summary": "Assign Service Instance",
1362 "description": "",
1363 "operationId": "assignServiceInstance",
1364 "consumes": [
1365 "application/json"
1366 ],
1367 "produces": [
1368 "application/json"
1369 ],
1370 "parameters": [
1371 {
1372 "in": "body",
1373 "name": "body",
1374 "required": false,
1375 "schema": {
1376 "type": "string"
1377 }
1378 },
1379 {
1380 "name": "version",
1381 "in": "path",
1382 "required": true,
1383 "type": "string",
1384 "pattern": "[vV][7]"
1385 }
1386 ],
1387 "responses": {
1388 "default": {
1389 "description": "successful operation"
1390 }
1391 }
1392 }
1393 },
1394 "/onap/so/infra/serviceInstantiation/{version}/serviceInstances/{serviceInstanceId}/unassign": {
1395 "post": {
1396 "tags": [
1397 "onapsoinfraserviceInstantiation"
1398 ],
1399 "summary": "Unassign Service Instance",
1400 "description": "",
1401 "operationId": "unassignServiceInstance",
1402 "consumes": [
1403 "application/json"
1404 ],
1405 "produces": [
1406 "application/json"
1407 ],
1408 "parameters": [
1409 {
1410 "in": "body",
1411 "name": "body",
1412 "required": false,
1413 "schema": {
1414 "type": "string"
1415 }
1416 },
1417 {
1418 "name": "version",
1419 "in": "path",
1420 "required": true,
1421 "type": "string",
1422 "pattern": "[vV][7]"
1423 },
1424 {
1425 "name": "serviceInstanceId",
1426 "in": "path",
1427 "required": true,
1428 "type": "string"
1429 }
1430 ],
1431 "responses": {
1432 "default": {
1433 "description": "successful operation"
1434 }
1435 }
1436 }
1437 },
1438 "/onap/so/infra/serviceInstantiation/{version}/serviceInstances/{serviceInstanceId}/configurations": {
1439 "post": {
1440 "tags": [
1441 "onapsoinfraserviceInstantiation"
1442 ],
1443 "summary": "Create Port Mirroring Configuration",
1444 "description": "",
1445 "operationId": "createPortConfiguration",
1446 "consumes": [
1447 "application/json"
1448 ],
1449 "produces": [
1450 "application/json"
1451 ],
1452 "parameters": [
1453 {
1454 "in": "body",
1455 "name": "body",
1456 "required": false,
1457 "schema": {
1458 "type": "string"
1459 }
1460 },
1461 {
1462 "name": "version",
1463 "in": "path",
1464 "required": true,
1465 "type": "string",
1466 "pattern": "[vV][5-7]"
1467 },
1468 {
1469 "name": "serviceInstanceId",
1470 "in": "path",
1471 "required": true,
1472 "type": "string"
1473 }
1474 ],
1475 "responses": {
1476 "default": {
1477 "description": "successful operation"
1478 }
1479 }
1480 }
1481 },
1482 "/onap/so/infra/serviceInstantiation/{version}/serviceInstances/{serviceInstanceId}/configurations/{configurationInstanceId}": {
1483 "delete": {
1484 "tags": [
1485 "onapsoinfraserviceInstantiation"
1486 ],
1487 "summary": "Delete provided Port",
1488 "description": "",
1489 "operationId": "deletePortConfiguration",
1490 "consumes": [
1491 "application/json"
1492 ],
1493 "produces": [
1494 "application/json"
1495 ],
1496 "parameters": [
1497 {
1498 "in": "body",
1499 "name": "body",
1500 "required": false,
1501 "schema": {
1502 "type": "string"
1503 }
1504 },
1505 {
1506 "name": "version",
1507 "in": "path",
1508 "required": true,
1509 "type": "string",
1510 "pattern": "[vV][5-7]"
1511 },
1512 {
1513 "name": "serviceInstanceId",
1514 "in": "path",
1515 "required": true,
1516 "type": "string"
1517 },
1518 {
1519 "name": "configurationInstanceId",
1520 "in": "path",
1521 "required": true,
1522 "type": "string"
1523 }
1524 ],
1525 "responses": {
1526 "default": {
1527 "description": "successful operation"
1528 }
1529 }
1530 }
1531 },
1532 "/onap/so/infra/serviceInstantiation/{version}/serviceInstances/{serviceInstanceId}/removeRelationships": {
1533 "post": {
1534 "tags": [
1535 "onapsoinfraserviceInstantiation"
1536 ],
1537 "summary": "Remove Relationships from Service Instance",
1538 "description": "",
1539 "operationId": "removeRelationships",
1540 "consumes": [
1541 "application/json"
1542 ],
1543 "produces": [
1544 "application/json"
1545 ],
1546 "parameters": [
1547 {
1548 "in": "body",
1549 "name": "body",
1550 "required": false,
1551 "schema": {
1552 "type": "string"
1553 }
1554 },
1555 {
1556 "name": "version",
1557 "in": "path",
1558 "required": true,
1559 "type": "string",
1560 "pattern": "[vV][6-7]"
1561 },
1562 {
1563 "name": "serviceInstanceId",
1564 "in": "path",
1565 "required": true,
1566 "type": "string"
1567 }
1568 ],
1569 "responses": {
1570 "default": {
1571 "description": "successful operation"
1572 }
1573 }
1574 }
1575 },
1576 "/onap/so/infra/serviceInstantiation/{version}/serviceInstances/{serviceInstanceId}/vnfs": {
1577 "post": {
1578 "tags": [
1579 "onapsoinfraserviceInstantiation"
1580 ],
1581 "summary": "Create VNF on a specified version and serviceInstance",
1582 "description": "",
1583 "operationId": "createVnfInstance",
1584 "consumes": [
1585 "application/json"
1586 ],
1587 "produces": [
1588 "application/json"
1589 ],
1590 "parameters": [
1591 {
1592 "in": "body",
1593 "name": "body",
1594 "required": false,
1595 "schema": {
1596 "type": "string"
1597 }
1598 },
1599 {
1600 "name": "version",
1601 "in": "path",
1602 "required": true,
1603 "type": "string",
1604 "pattern": "[vV][5-7]"
1605 },
1606 {
1607 "name": "serviceInstanceId",
1608 "in": "path",
1609 "required": true,
1610 "type": "string"
1611 }
1612 ],
1613 "responses": {
1614 "default": {
1615 "description": "successful operation"
1616 }
1617 }
1618 }
1619 },
1620 "/onap/so/infra/serviceInstantiation/{version}/serviceInstances/{serviceInstanceId}/vnfs/{vnfInstanceId}/replace": {
1621 "post": {
1622 "tags": [
1623 "onapsoinfraserviceInstantiation"
1624 ],
1625 "summary": "Replace provided VNF instance",
1626 "description": "",
1627 "operationId": "replaceVnfInstance",
1628 "consumes": [
1629 "application/json"
1630 ],
1631 "produces": [
1632 "application/json"
1633 ],
1634 "parameters": [
1635 {
1636 "in": "body",
1637 "name": "body",
1638 "required": false,
1639 "schema": {
1640 "type": "string"
1641 }
1642 },
1643 {
1644 "name": "version",
1645 "in": "path",
1646 "required": true,
1647 "type": "string",
1648 "pattern": "[vV][5-7]"
1649 },
1650 {
1651 "name": "serviceInstanceId",
1652 "in": "path",
1653 "required": true,
1654 "type": "string"
1655 },
1656 {
1657 "name": "vnfInstanceId",
1658 "in": "path",
1659 "required": true,
1660 "type": "string"
1661 }
1662 ],
1663 "responses": {
1664 "default": {
1665 "description": "successful operation"
1666 }
1667 }
1668 }
1669 },
1670 "/onap/so/infra/serviceInstantiation/{version}/serviceInstances/{serviceInstanceId}/vnfs/{vnfInstanceId}": {
1671 "put": {
1672 "tags": [
1673 "onapsoinfraserviceInstantiation"
1674 ],
1675 "summary": "Update VNF on a specified version, serviceInstance and vnfInstance",
1676 "description": "",
1677 "operationId": "updateVnfInstance",
1678 "consumes": [
1679 "application/json"
1680 ],
1681 "produces": [
1682 "application/json"
1683 ],
1684 "parameters": [
1685 {
1686 "in": "body",
1687 "name": "body",
1688 "required": false,
1689 "schema": {
1690 "type": "string"
1691 }
1692 },
1693 {
1694 "name": "version",
1695 "in": "path",
1696 "required": true,
1697 "type": "string",
1698 "pattern": "[vV][5-7]"
1699 },
1700 {
1701 "name": "serviceInstanceId",
1702 "in": "path",
1703 "required": true,
1704 "type": "string"
1705 },
1706 {
1707 "name": "vnfInstanceId",
1708 "in": "path",
1709 "required": true,
1710 "type": "string"
1711 }
1712 ],
1713 "responses": {
1714 "default": {
1715 "description": "successful operation"
1716 }
1717 }
1718 },
1719 "delete": {
1720 "tags": [
1721 "onapsoinfraserviceInstantiation"
1722 ],
1723 "summary": "Delete provided VNF instance",
1724 "description": "",
1725 "operationId": "deleteVnfInstance",
1726 "consumes": [
1727 "application/json"
1728 ],
1729 "produces": [
1730 "application/json"
1731 ],
1732 "parameters": [
1733 {
1734 "in": "body",
1735 "name": "body",
1736 "required": false,
1737 "schema": {
1738 "type": "string"
1739 }
1740 },
1741 {
1742 "name": "version",
1743 "in": "path",
1744 "required": true,
1745 "type": "string",
1746 "pattern": "[vV][5-7]"
1747 },
1748 {
1749 "name": "serviceInstanceId",
1750 "in": "path",
1751 "required": true,
1752 "type": "string"
1753 },
1754 {
1755 "name": "vnfInstanceId",
1756 "in": "path",
1757 "required": true,
1758 "type": "string"
1759 }
1760 ],
1761 "responses": {
1762 "default": {
1763 "description": "successful operation"
1764 }
1765 }
1766 }
1767 },
1768 "/onap/so/infra/serviceInstantiation/{version}/serviceInstances/{serviceInstanceId}/vnfs/{vnfInstanceId}/vfModules": {
1769 "post": {
1770 "tags": [
1771 "onapsoinfraserviceInstantiation"
1772 ],
1773 "summary": "Create VfModule on a specified version, serviceInstance and vnfInstance",
1774 "description": "",
1775 "operationId": "createVfModuleInstance",
1776 "consumes": [
1777 "application/json"
1778 ],
1779 "produces": [
1780 "application/json"
1781 ],
1782 "parameters": [
1783 {
1784 "in": "body",
1785 "name": "body",
1786 "required": false,
1787 "schema": {
1788 "type": "string"
1789 }
1790 },
1791 {
1792 "name": "version",
1793 "in": "path",
1794 "required": true,
1795 "type": "string",
1796 "pattern": "[vV][5-7]"
1797 },
1798 {
1799 "name": "serviceInstanceId",
1800 "in": "path",
1801 "required": true,
1802 "type": "string"
1803 },
1804 {
1805 "name": "vnfInstanceId",
1806 "in": "path",
1807 "required": true,
1808 "type": "string"
1809 }
1810 ],
1811 "responses": {
1812 "default": {
1813 "description": "successful operation"
1814 }
1815 }
1816 }
1817 },
1818 "/onap/so/infra/serviceInstantiation/{version}/serviceInstances/{serviceInstanceId}/vnfs/{vnfInstanceId}/vfModules/{vfmoduleInstanceId}/replace": {
1819 "post": {
1820 "tags": [
1821 "onapsoinfraserviceInstantiation"
1822 ],
1823 "summary": "Create VfModule on a specified version, serviceInstance and vnfInstance",
1824 "description": "",
1825 "operationId": "replaceVfModuleInstance",
1826 "consumes": [
1827 "application/json"
1828 ],
1829 "produces": [
1830 "application/json"
1831 ],
1832 "parameters": [
1833 {
1834 "in": "body",
1835 "name": "body",
1836 "required": false,
1837 "schema": {
1838 "type": "string"
1839 }
1840 },
1841 {
1842 "name": "version",
1843 "in": "path",
1844 "required": true,
1845 "type": "string",
1846 "pattern": "[vV][5-7]"
1847 },
1848 {
1849 "name": "serviceInstanceId",
1850 "in": "path",
1851 "required": true,
1852 "type": "string"
1853 },
1854 {
1855 "name": "vnfInstanceId",
1856 "in": "path",
1857 "required": true,
1858 "type": "string"
1859 },
1860 {
1861 "name": "vfmoduleInstanceId",
1862 "in": "path",
1863 "required": true,
1864 "type": "string"
1865 }
1866 ],
1867 "responses": {
1868 "default": {
1869 "description": "successful operation"
1870 }
1871 }
1872 }
1873 },
1874 "/onap/so/infra/serviceInstantiation/{version}/serviceInstances/{serviceInstanceId}/vnfs/{vnfInstanceId}/vfModules/{vfmoduleInstanceId}": {
1875 "put": {
1876 "tags": [
1877 "onapsoinfraserviceInstantiation"
1878 ],
1879 "summary": "Update VfModule on a specified version, serviceInstance, vnfInstance and vfModule",
1880 "description": "",
1881 "operationId": "updateVfModuleInstance",
1882 "consumes": [
1883 "application/json"
1884 ],
1885 "produces": [
1886 "application/json"
1887 ],
1888 "parameters": [
1889 {
1890 "in": "body",
1891 "name": "body",
1892 "required": false,
1893 "schema": {
1894 "type": "string"
1895 }
1896 },
1897 {
1898 "name": "version",
1899 "in": "path",
1900 "required": true,
1901 "type": "string",
1902 "pattern": "[vV][5-7]"
1903 },
1904 {
1905 "name": "serviceInstanceId",
1906 "in": "path",
1907 "required": true,
1908 "type": "string"
1909 },
1910 {
1911 "name": "vnfInstanceId",
1912 "in": "path",
1913 "required": true,
1914 "type": "string"
1915 },
1916 {
1917 "name": "vfmoduleInstanceId",
1918 "in": "path",
1919 "required": true,
1920 "type": "string"
1921 }
1922 ],
1923 "responses": {
1924 "default": {
1925 "description": "successful operation"
1926 }
1927 }
1928 },
1929 "delete": {
1930 "tags": [
1931 "onapsoinfraserviceInstantiation"
1932 ],
1933 "summary": "Delete provided VfModule instance",
1934 "description": "",
1935 "operationId": "deleteVfModuleInstance",
1936 "consumes": [
1937 "application/json"
1938 ],
1939 "produces": [
1940 "application/json"
1941 ],
1942 "parameters": [
1943 {
1944 "in": "body",
1945 "name": "body",
1946 "required": false,
1947 "schema": {
1948 "type": "string"
1949 }
1950 },
1951 {
1952 "name": "version",
1953 "in": "path",
1954 "required": true,
1955 "type": "string",
1956 "pattern": "[vV][5-7]"
1957 },
1958 {
1959 "name": "serviceInstanceId",
1960 "in": "path",
1961 "required": true,
1962 "type": "string"
1963 },
1964 {
1965 "name": "vnfInstanceId",
1966 "in": "path",
1967 "required": true,
1968 "type": "string"
1969 },
1970 {
1971 "name": "vfmoduleInstanceId",
1972 "in": "path",
1973 "required": true,
1974 "type": "string"
1975 }
1976 ],
1977 "responses": {
1978 "default": {
1979 "description": "successful operation"
1980 }
1981 }
1982 }
1983 },
1984 "/onap/so/infra/serviceInstantiation/{version}/serviceInstances/{serviceInstanceId}/vnfs/{vnfInstanceId}/volumeGroups": {
1985 "post": {
1986 "tags": [
1987 "onapsoinfraserviceInstantiation"
1988 ],
1989 "summary": "Create VolumeGroup on a specified version, serviceInstance, vnfInstance",
1990 "description": "",
1991 "operationId": "createVolumeGroupInstance",
1992 "consumes": [
1993 "application/json"
1994 ],
1995 "produces": [
1996 "application/json"
1997 ],
1998 "parameters": [
1999 {
2000 "in": "body",
2001 "name": "body",
2002 "required": false,
2003 "schema": {
2004 "type": "string"
2005 }
2006 },
2007 {
2008 "name": "version",
2009 "in": "path",
2010 "required": true,
2011 "type": "string",
2012 "pattern": "[vV][5-7]"
2013 },
2014 {
2015 "name": "serviceInstanceId",
2016 "in": "path",
2017 "required": true,
2018 "type": "string"
2019 },
2020 {
2021 "name": "vnfInstanceId",
2022 "in": "path",
2023 "required": true,
2024 "type": "string"
2025 }
2026 ],
2027 "responses": {
2028 "default": {
2029 "description": "successful operation"
2030 }
2031 }
2032 }
2033 },
2034 "/onap/so/infra/serviceInstantiation/{version}/serviceInstances/{serviceInstanceId}/vnfs/{vnfInstanceId}/volumeGroups/{volumeGroupInstanceId}": {
2035 "put": {
2036 "tags": [
2037 "onapsoinfraserviceInstantiation"
2038 ],
2039 "summary": "Update VolumeGroup on a specified version, serviceInstance, vnfInstance and volumeGroup",
2040 "description": "",
2041 "operationId": "updateVolumeGroupInstance",
2042 "consumes": [
2043 "application/json"
2044 ],
2045 "produces": [
2046 "application/json"
2047 ],
2048 "parameters": [
2049 {
2050 "in": "body",
2051 "name": "body",
2052 "required": false,
2053 "schema": {
2054 "type": "string"
2055 }
2056 },
2057 {
2058 "name": "version",
2059 "in": "path",
2060 "required": true,
2061 "type": "string",
2062 "pattern": "[vV][5-7]"
2063 },
2064 {
2065 "name": "serviceInstanceId",
2066 "in": "path",
2067 "required": true,
2068 "type": "string"
2069 },
2070 {
2071 "name": "vnfInstanceId",
2072 "in": "path",
2073 "required": true,
2074 "type": "string"
2075 },
2076 {
2077 "name": "volumeGroupInstanceId",
2078 "in": "path",
2079 "required": true,
2080 "type": "string"
2081 }
2082 ],
2083 "responses": {
2084 "default": {
2085 "description": "successful operation"
2086 }
2087 }
2088 },
2089 "delete": {
2090 "tags": [
2091 "onapsoinfraserviceInstantiation"
2092 ],
2093 "summary": "Delete provided VolumeGroup instance",
2094 "description": "",
2095 "operationId": "deleteVolumeGroupInstance",
2096 "consumes": [
2097 "application/json"
2098 ],
2099 "produces": [
2100 "application/json"
2101 ],
2102 "parameters": [
2103 {
2104 "in": "body",
2105 "name": "body",
2106 "required": false,
2107 "schema": {
2108 "type": "string"
2109 }
2110 },
2111 {
2112 "name": "version",
2113 "in": "path",
2114 "required": true,
2115 "type": "string",
2116 "pattern": "[vV][5-7]"
2117 },
2118 {
2119 "name": "serviceInstanceId",
2120 "in": "path",
2121 "required": true,
2122 "type": "string"
2123 },
2124 {
2125 "name": "vnfInstanceId",
2126 "in": "path",
2127 "required": true,
2128 "type": "string"
2129 },
2130 {
2131 "name": "volumeGroupInstanceId",
2132 "in": "path",
2133 "required": true,
2134 "type": "string"
2135 }
2136 ],
2137 "responses": {
2138 "default": {
2139 "description": "successful operation"
2140 }
2141 }
2142 }
2143 },
2144 "/onap/so/infra/serviceInstantiation/{version}/serviceInstances/{serviceInstanceId}/networks": {
2145 "post": {
2146 "tags": [
2147 "onapsoinfraserviceInstantiation"
2148 ],
2149 "summary": "Create NetworkInstance on a specified version and serviceInstance ",
2150 "description": "",
2151 "operationId": "createNetworkInstance",
2152 "consumes": [
2153 "application/json"
2154 ],
2155 "produces": [
2156 "application/json"
2157 ],
2158 "parameters": [
2159 {
2160 "in": "body",
2161 "name": "body",
2162 "required": false,
2163 "schema": {
2164 "type": "string"
2165 }
2166 },
2167 {
2168 "name": "version",
2169 "in": "path",
2170 "required": true,
2171 "type": "string",
2172 "pattern": "[vV][5-7]"
2173 },
2174 {
2175 "name": "serviceInstanceId",
2176 "in": "path",
2177 "required": true,
2178 "type": "string"
2179 }
2180 ],
2181 "responses": {
2182 "default": {
2183 "description": "successful operation"
2184 }
2185 }
2186 }
2187 },
2188 "/onap/so/infra/serviceInstantiation/{version}/serviceInstances/{serviceInstanceId}/networks/{networkInstanceId}": {
2189 "put": {
2190 "tags": [
2191 "onapsoinfraserviceInstantiation"
2192 ],
2193 "summary": "Update VolumeGroup on a specified version, serviceInstance, networkInstance",
2194 "description": "",
2195 "operationId": "updateNetworkInstance",
2196 "consumes": [
2197 "application/json"
2198 ],
2199 "produces": [
2200 "application/json"
2201 ],
2202 "parameters": [
2203 {
2204 "in": "body",
2205 "name": "body",
2206 "required": false,
2207 "schema": {
2208 "type": "string"
2209 }
2210 },
2211 {
2212 "name": "version",
2213 "in": "path",
2214 "required": true,
2215 "type": "string",
2216 "pattern": "[vV][5-7]"
2217 },
2218 {
2219 "name": "serviceInstanceId",
2220 "in": "path",
2221 "required": true,
2222 "type": "string"
2223 },
2224 {
2225 "name": "networkInstanceId",
2226 "in": "path",
2227 "required": true,
2228 "type": "string"
2229 }
2230 ],
2231 "responses": {
2232 "default": {
2233 "description": "successful operation"
2234 }
2235 }
2236 },
2237 "delete": {
2238 "tags": [
2239 "onapsoinfraserviceInstantiation"
2240 ],
2241 "summary": "Delete provided Network instance",
2242 "description": "",
2243 "operationId": "deleteNetworkInstance",
2244 "consumes": [
2245 "application/json"
2246 ],
2247 "produces": [
2248 "application/json"
2249 ],
2250 "parameters": [
2251 {
2252 "in": "body",
2253 "name": "body",
2254 "required": false,
2255 "schema": {
2256 "type": "string"
2257 }
2258 },
2259 {
2260 "name": "version",
2261 "in": "path",
2262 "required": true,
2263 "type": "string",
2264 "pattern": "[vV][5-7]"
2265 },
2266 {
2267 "name": "serviceInstanceId",
2268 "in": "path",
2269 "required": true,
2270 "type": "string"
2271 },
2272 {
2273 "name": "networkInstanceId",
2274 "in": "path",
2275 "required": true,
2276 "type": "string"
2277 }
2278 ],
2279 "responses": {
2280 "default": {
2281 "description": "successful operation"
2282 }
2283 }
2284 }
2285 },
2286 "/onap/so/infra/tasks/{version}": {
2287 "get": {
2288 "tags": [
2289 "onapsoinfratasks"
2290 ],
2291 "summary": "Finds Manual Tasks",
2292 "description": "",
2293 "operationId": "queryFilters",
2294 "parameters": [
2295 {
2296 "name": "taskId",
2297 "in": "query",
2298 "required": false,
2299 "type": "string"
2300 },
2301 {
2302 "name": "originalRequestId",
2303 "in": "query",
2304 "required": false,
2305 "type": "string"
2306 },
2307 {
2308 "name": "subscriptionServiceType",
2309 "in": "query",
2310 "required": false,
2311 "type": "string"
2312 },
2313 {
2314 "name": "nfRole",
2315 "in": "query",
2316 "required": false,
2317 "type": "string"
2318 },
2319 {
2320 "name": "buildingBlockName",
2321 "in": "query",
2322 "required": false,
2323 "type": "string"
2324 },
2325 {
2326 "name": "originalRequestDate",
2327 "in": "query",
2328 "required": false,
2329 "type": "string"
2330 },
2331 {
2332 "name": "originalRequestorId",
2333 "in": "query",
2334 "required": false,
2335 "type": "string"
2336 },
2337 {
2338 "name": "version",
2339 "in": "path",
2340 "required": true,
2341 "type": "string",
2342 "pattern": "[vV]1"
2343 }
2344 ],
2345 "responses": {
2346 "default": {
2347 "description": "successful operation"
2348 }
2349 }
2350 }
2351 },
2352 "/onap/so/infra/cloudResources/{version}/operationalEnvironments": {
2353 "post": {
2354 "tags": [
2355 "onapsoinfracloudResources"
2356 ],
2357 "summary": "Create an Operational Environment",
2358 "description": "",
2359 "operationId": "createOperationEnvironment",
2360 "consumes": [
2361 "application/json"
2362 ],
2363 "produces": [
2364 "application/json"
2365 ],
2366 "parameters": [
2367 {
2368 "in": "body",
2369 "name": "body",
2370 "required": false,
2371 "schema": {
2372 "type": "string"
2373 }
2374 },
2375 {
2376 "name": "version",
2377 "in": "path",
2378 "required": true,
2379 "type": "string",
2380 "pattern": "[vV][1]"
2381 }
2382 ],
2383 "responses": {
2384 "default": {
2385 "description": "successful operation"
2386 }
2387 }
2388 }
2389 },
2390 "/onap/so/infra/cloudResources/{version}/operationalEnvironments/{operationalEnvironmentId}/activate": {
2391 "post": {
2392 "tags": [
2393 "onapsoinfracloudResources"
2394 ],
2395 "summary": "Activate an Operational Environment",
2396 "description": "",
2397 "operationId": "activateOperationEnvironment",
2398 "consumes": [
2399 "application/json"
2400 ],
2401 "produces": [
2402 "application/json"
2403 ],
2404 "parameters": [
2405 {
2406 "in": "body",
2407 "name": "body",
2408 "required": false,
2409 "schema": {
2410 "type": "string"
2411 }
2412 },
2413 {
2414 "name": "version",
2415 "in": "path",
2416 "required": true,
2417 "type": "string",
2418 "pattern": "[vV][1]"
2419 },
2420 {
2421 "name": "operationalEnvironmentId",
2422 "in": "path",
2423 "required": true,
2424 "type": "string"
2425 }
2426 ],
2427 "responses": {
2428 "default": {
2429 "description": "successful operation"
2430 }
2431 }
2432 }
2433 },
2434 "/onap/so/infra/cloudResources/{version}/operationalEnvironments/{operationalEnvironmentId}/deactivate": {
2435 "post": {
2436 "tags": [
2437 "onapsoinfracloudResources"
2438 ],
2439 "summary": "Deactivate an Operational Environment",
2440 "description": "",
2441 "operationId": "deactivateOperationEnvironment",
2442 "consumes": [
2443 "application/json"
2444 ],
2445 "produces": [
2446 "application/json"
2447 ],
2448 "parameters": [
2449 {
2450 "in": "body",
2451 "name": "body",
2452 "required": false,
2453 "schema": {
2454 "type": "string"
2455 }
2456 },
2457 {
2458 "name": "version",
2459 "in": "path",
2460 "required": true,
2461 "type": "string",
2462 "pattern": "[vV][1]"
2463 },
2464 {
2465 "name": "operationalEnvironmentId",
2466 "in": "path",
2467 "required": true,
2468 "type": "string"
2469 }
2470 ],
2471 "responses": {
2472 "default": {
2473 "description": "successful operation"
2474 }
2475 }
2476 }
2477 },
2478 "/onap/so/infra/cloudResourcesRequests/{version}/{requestId}/unlock": {
2479 "post": {
2480 "tags": [
2481 "onapsoinfracloudResourcesRequests"
2482 ],
2483 "summary": "Unlock CloudOrchestration requests for a specified requestId",
2484 "description": "",
2485 "operationId": "unlockOrchestrationRequestForReqId",
2486 "consumes": [
2487 "application/json"
2488 ],
2489 "produces": [
2490 "application/json"
2491 ],
2492 "parameters": [
2493 {
2494 "in": "body",
2495 "name": "body",
2496 "required": false,
2497 "schema": {
2498 "type": "string"
2499 }
2500 },
2501 {
2502 "name": "requestId",
2503 "in": "path",
2504 "required": true,
2505 "type": "string"
2506 },
2507 {
2508 "name": "version",
2509 "in": "path",
2510 "required": true,
2511 "type": "string",
2512 "pattern": "[vV][1]"
2513 }
2514 ],
2515 "responses": {
2516 "default": {
2517 "description": "successful operation"
2518 }
2519 }
2520 }
2521 },
2522 "/onap/so/infra/cloudResourcesRequests/{version}": {
2523 "get": {
2524 "tags": [
2525 "onapsoinfracloudResourcesRequests"
2526 ],
2527 "summary": "Get status of an Operational Environment based on filter criteria",
2528 "description": "",
2529 "operationId": "getOperationEnvironmentStatusFilter",
2530 "consumes": [
2531 "application/json"
2532 ],
2533 "produces": [
2534 "application/json"
2535 ],
2536 "parameters": [
2537 {
2538 "name": "version",
2539 "in": "path",
2540 "required": true,
2541 "type": "string",
2542 "pattern": "[vV][1]"
2543 }
2544 ],
2545 "responses": {
2546 "default": {
2547 "description": "successful operation"
2548 }
2549 }
2550 }
2551 },
2552 "/onap/so/infra/modelDistributions/{version}/distributions/{distributionId}": {
2553 "post": {
2554 "tags": [
2555 "onapsoinframodelDistributions"
2556 ],
2557 "summary": "Update model distribution status",
2558 "description": "",
2559 "operationId": "updateModelDistributionStatus",
2560 "consumes": [
2561 "application/json"
2562 ],
2563 "produces": [
2564 "application/json"
2565 ],
2566 "parameters": [
2567 {
2568 "in": "body",
2569 "name": "body",
2570 "required": false,
2571 "schema": {
2572 "type": "string"
2573 }
2574 },
2575 {
2576 "name": "version",
2577 "in": "path",
2578 "required": true,
2579 "type": "string",
2580 "pattern": "[vV][1]"
2581 },
2582 {
2583 "name": "distributionId",
2584 "in": "path",
2585 "required": true,
2586 "type": "string"
2587 }
2588 ],
2589 "responses": {
2590 "default": {
2591 "description": "successful operation"
2592 }
2593 }
2594 }
2595 }
2596 }
Harry Huangd79a1a22020-01-08 16:19:35 +08002597}