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