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