docs/api/swagger/swagger.json

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