docs/api/swagger/swagger.yaml

   1 swagger: '2.0'
   2 info:
   3   version: 3.1.2
   4   title: SO Casablanca APIs
   5 tags:
   6   - name: e2eServiceInstances
   7   - name: globalhealthcheck
   8   - name: nodehealthcheck
   9   - name: onapsoinfraorchestrationRequests
  10   - name: onapsoinfraserviceInstantiation
  11   - name: onapsoinfratasks
  12   - name: onapsoinfracloudResources
  13   - name: onapsoinfracloudResourcesRequests
  14   - name: onapsoinframodelDistributions
  15 schemes:
  16   - http
  17 paths:
  18   '/onap/so/infra/e2eServiceInstances/{version}':
  19     post:
  20       tags:
  21         - e2eServiceInstances
  22       summary: Create an E2E Service Instance on a version provided
  23       description: ''
  24       operationId: createE2EServiceInstance
  25       consumes:
  26         - application/json
  27       produces:
  28         - application/json
  29       parameters:
  30         - in: body
  31           name: body
  32           required: false
  33           schema:
  34             type: string
  35         - name: version
  36           in: path
  37           required: true
  38           type: string
  39           pattern: '[vV][3-5]'
  40       responses:
  41         default:
  42           description: successful operation
  43   '/onap/so/infra/e2eServiceInstances/{version}/{serviceId}':
  44     put:
  45       tags:
  46         - e2eServiceInstances
  47       summary: Update an E2E Service Instance on a version provided and serviceId
  48       description: ''
  49       operationId: updateE2EServiceInstance
  50       consumes:
  51         - application/json
  52       produces:
  53         - application/json
  54       parameters:
  55         - in: body
  56           name: body
  57           required: false
  58           schema:
  59             type: string
  60         - name: version
  61           in: path
  62           required: true
  63           type: string
  64           pattern: '[vV][3-5]'
  65         - name: serviceId
  66           in: path
  67           required: true
  68           type: string
  69       responses:
  70         default:
  71           description: successful operation
  72     delete:
  73       tags:
  74         - e2eServiceInstances
  75       summary: Delete E2E Service Instance on a specified version and serviceId
  76       description: ''
  77       operationId: deleteE2EServiceInstance
  78       consumes:
  79         - application/json
  80       produces:
  81         - application/json
  82       parameters:
  83         - in: body
  84           name: body
  85           required: false
  86           schema:
  87             type: string
  88         - name: version
  89           in: path
  90           required: true
  91           type: string
  92           pattern: '[vV][3-5]'
  93         - name: serviceId
  94           in: path
  95           required: true
  96           type: string
  97       responses:
  98         default:
  99           description: successful operation
 100   '/onap/so/infra/e2eServiceInstances/{version}/{serviceId}/operations/{operationId}':
 101     get:
 102       tags:
 103         - e2eServiceInstances
 104       summary: Find e2eServiceInstances Requests for a given serviceId and operationId
 105       description: ''
 106       operationId: getE2EServiceInstances
 107       produces:
 108         - application/json
 109       parameters:
 110         - name: serviceId
 111           in: path
 112           required: true
 113           type: string
 114         - name: version
 115           in: path
 116           required: true
 117           type: string
 118           pattern: '[vV][3-5]'
 119         - name: operationId
 120           in: path
 121           required: true
 122           type: string
 123       responses:
 124         default:
 125           description: successful operation
 126   '/onap/so/infra/e2eServiceInstances/{version}/{serviceId}/scale':
 127     post:
 128       tags:
 129         - e2eServiceInstances
 130       summary: Scale E2E Service Instance on a specified version
 131       description: ''
 132       operationId: scaleE2EServiceInstance
 133       consumes:
 134         - application/json
 135       produces:
 136         - application/json
 137       parameters:
 138         - in: body
 139           name: body
 140           required: false
 141           schema:
 142             type: string
 143         - name: version
 144           in: path
 145           required: true
 146           type: string
 147           pattern: '[vV][3-5]'
 148         - name: serviceId
 149           in: path
 150           required: true
 151           type: string
 152       responses:
 153         default:
 154           description: successful operation
 155   '/onap/so/infra/e2eServiceInstances/{version}/{serviceId}/modeldifferences':
 156     post:
 157       tags:
 158         - e2eServiceInstances
 159       summary: >-
 160         Find added and deleted resources of target model for the
 161         e2eserviceInstance on a given serviceId
 162       description: ''
 163       operationId: compareModelwithTargetVersion
 164       consumes:
 165         - application/json
 166       produces:
 167         - application/json
 168       parameters:
 169         - in: body
 170           name: body
 171           required: false
 172           schema:
 173             type: string
 174         - name: serviceId
 175           in: path
 176           required: true
 177           type: string
 178         - name: version
 179           in: path
 180           required: true
 181           type: string
 182           pattern: '[vV][3-5]'
 183       responses:
 184         default:
 185           description: successful operation
 186   /globalhealthcheck:
 187     get:
 188       tags:
 189         - globalhealthcheck
 190       summary: Performing global health check
 191       description: ''
 192       operationId: globalHealthcheck
 193       produces:
 194         - text/html
 195       parameters:
 196         - name: enableBpmn
 197           in: query
 198           required: false
 199           type: boolean
 200           default: true
 201       responses:
 202         default:
 203           description: successful operation
 204   /nodehealthcheck:
 205     get:
 206       tags:
 207         - nodehealthcheck
 208       summary: Performing node health check
 209       description: ''
 210       operationId: nodeHealthcheck
 211       produces:
 212         - text/html
 213       parameters: []
 214       responses:
 215         default:
 216           description: successful operation
 217   '/onap/so/infra/orchestrationRequests/{version}':
 218     get:
 219       tags:
 220         - onapsoinfraorchestrationRequests
 221       summary: Find Orchestrated Requests for a URI Information
 222       description: ''
 223       operationId: getOrchestrationRequest
 224       produces:
 225         - application/json
 226       parameters:
 227         - name: version
 228           in: path
 229           required: true
 230           type: string
 231           pattern: '[vV][4-7]'
 232       responses:
 233         default:
 234           description: successful operation
 235   '/onap/so/infra/orchestrationRequests/{version}/{requestId}':
 236     get:
 237       tags:
 238         - onapsoinfraorchestrationRequests
 239       summary: Find Orchestrated Requests for a given requestId
 240       description: ''
 241       operationId: getOrchestrationRequestForReqId
 242       produces:
 243         - application/json
 244       parameters:
 245         - name: requestId
 246           in: path
 247           required: true
 248           type: string
 249         - name: version
 250           in: path
 251           required: true
 252           type: string
 253           pattern: '[vV][4-7]'
 254       responses:
 255         default:
 256           description: successful operation
 257   '/onap/so/infra/orchestrationRequests/{version}/{requestId}/unlock':
 258     post:
 259       tags:
 260         - onapsoinfraorchestrationRequests
 261       summary: Unlock Orchestrated Requests for a given requestId
 262       description: ''
 263       operationId: unlockOrchestrationRequest
 264       consumes:
 265         - application/json
 266       produces:
 267         - application/json
 268       parameters:
 269         - in: body
 270           name: body
 271           required: false
 272           schema:
 273             type: string
 274         - name: requestId
 275           in: path
 276           required: true
 277           type: string
 278         - name: version
 279           in: path
 280           required: true
 281           type: string
 282           pattern: '[vV][4-7]'
 283       responses:
 284         default:
 285           description: successful operation
 286   '/onap/so/infra/serviceInstantiation/{version}/serviceInstances/{serviceInstanceId}/vnfs/{vnfInstanceId}/vfModules/{vfmoduleInstanceId}/deactivateAndCloudDelete':
 287     post:
 288       tags:
 289         - onapsoinfraserviceInstantiation
 290       summary: Deactivate and Cloud Delete VfModule instance
 291       description: ''
 292       operationId: deactivateAndCloudDeleteVfModuleInstance
 293       consumes:
 294         - application/json
 295       produces:
 296         - application/json
 297       parameters:
 298         - in: body
 299           name: body
 300           required: false
 301           schema:
 302             type: string
 303         - name: version
 304           in: path
 305           required: true
 306           type: string
 307           pattern: '[vV][7]'
 308         - name: serviceInstanceId
 309           in: path
 310           required: true
 311           type: string
 312         - name: vnfInstanceId
 313           in: path
 314           required: true
 315           type: string
 316         - name: vfmoduleInstanceId
 317           in: path
 318           required: true
 319           type: string
 320       responses:
 321         default:
 322           description: successful operation
 323   '/onap/so/infra/serviceInstantiation/{version}/serviceInstances/{serviceInstanceId}/configurations/{configurationInstanceId}/enablePort':
 324     post:
 325       tags:
 326         - onapsoinfraserviceInstantiation
 327       summary: Enable Port Mirroring
 328       description: ''
 329       operationId: enablePort
 330       consumes:
 331         - application/json
 332       produces:
 333         - application/json
 334       parameters:
 335         - in: body
 336           name: body
 337           required: false
 338           schema:
 339             type: string
 340         - name: version
 341           in: path
 342           required: true
 343           type: string
 344           pattern: '[vV][5-7]'
 345         - name: serviceInstanceId
 346           in: path
 347           required: true
 348           type: string
 349         - name: configurationInstanceId
 350           in: path
 351           required: true
 352           type: string
 353       responses:
 354         default:
 355           description: successful operation
 356   '/onap/so/infra/serviceInstantiation/{version}/serviceInstances/{serviceInstanceId}/configurations/{configurationInstanceId}/disablePort':
 357     post:
 358       tags:
 359         - onapsoinfraserviceInstantiation
 360       summary: Disable Port Mirroring
 361       description: ''
 362       operationId: disablePort
 363       consumes:
 364         - application/json
 365       produces:
 366         - application/json
 367       parameters:
 368         - in: body
 369           name: body
 370           required: false
 371           schema:
 372             type: string
 373         - name: version
 374           in: path
 375           required: true
 376           type: string
 377           pattern: '[vV][5-7]'
 378         - name: serviceInstanceId
 379           in: path
 380           required: true
 381           type: string
 382         - name: configurationInstanceId
 383           in: path
 384           required: true
 385           type: string
 386       responses:
 387         default:
 388           description: successful operation
 389   '/onap/so/infra/serviceInstantiation/{version}/serviceInstances/{serviceInstanceId}/configurations/{configurationInstanceId}/activate':
 390     post:
 391       tags:
 392         - onapsoinfraserviceInstantiation
 393       summary: Activate Port Mirroring
 394       description: ''
 395       operationId: activatePort
 396       consumes:
 397         - application/json
 398       produces:
 399         - application/json
 400       parameters:
 401         - in: body
 402           name: body
 403           required: false
 404           schema:
 405             type: string
 406         - name: version
 407           in: path
 408           required: true
 409           type: string
 410           pattern: '[vV][5-7]'
 411         - name: serviceInstanceId
 412           in: path
 413           required: true
 414           type: string
 415         - name: configurationInstanceId
 416           in: path
 417           required: true
 418           type: string
 419       responses:
 420         default:
 421           description: successful operation
 422   '/onap/so/infra/serviceInstantiation/{version}/serviceInstances/{serviceInstanceId}/configurations/{configurationInstanceId}/deactivate':
 423     post:
 424       tags:
 425         - onapsoinfraserviceInstantiation
 426       summary: Deactivate Port Mirroring
 427       description: ''
 428       operationId: deactivatePort
 429       consumes:
 430         - application/json
 431       produces:
 432         - application/json
 433       parameters:
 434         - in: body
 435           name: body
 436           required: false
 437           schema:
 438             type: string
 439         - name: version
 440           in: path
 441           required: true
 442           type: string
 443           pattern: '[vV][5-7]'
 444         - name: serviceInstanceId
 445           in: path
 446           required: true
 447           type: string
 448         - name: configurationInstanceId
 449           in: path
 450           required: true
 451           type: string
 452       responses:
 453         default:
 454           description: successful operation
 455   '/onap/so/infra/serviceInstantiation/{version}/serviceInstances/{serviceInstanceId}/addRelationships':
 456     post:
 457       tags:
 458         - onapsoinfraserviceInstantiation
 459       summary: Add Relationships to a Service Instance
 460       description: ''
 461       operationId: addRelationships
 462       consumes:
 463         - application/json
 464       produces:
 465         - application/json
 466       parameters:
 467         - in: body
 468           name: body
 469           required: false
 470           schema:
 471             type: string
 472         - name: version
 473           in: path
 474           required: true
 475           type: string
 476           pattern: '[vV][6-7]'
 477         - name: serviceInstanceId
 478           in: path
 479           required: true
 480           type: string
 481       responses:
 482         default:
 483           description: successful operation
 484   '/onap/so/infra/serviceInstantiation/{version}/serviceInstances/{serviceInstanceId}/vnfs/{vnfInstanceId}/vfModules/scaleOut':
 485     post:
 486       tags:
 487         - onapsoinfraserviceInstantiation
 488       summary: VF Auto Scale Out
 489       description: ''
 490       operationId: scaleOutVfModule
 491       consumes:
 492         - application/json
 493       produces:
 494         - application/json
 495       parameters:
 496         - in: body
 497           name: body
 498           required: false
 499           schema:
 500             type: string
 501         - name: version
 502           in: path
 503           required: true
 504           type: string
 505           pattern: '[vV][7]'
 506         - name: serviceInstanceId
 507           in: path
 508           required: true
 509           type: string
 510         - name: vnfInstanceId
 511           in: path
 512           required: true
 513           type: string
 514       responses:
 515         default:
 516           description: successful operation
 517   '/onap/so/infra/serviceInstantiation/{version}/serviceInstances/{serviceInstanceId}/vnfs/{vnfInstanceId}/inPlaceSoftwareUpdate':
 518     post:
 519       tags:
 520         - onapsoinfraserviceInstantiation
 521       summary: Perform VNF software update
 522       description: ''
 523       operationId: inPlaceSoftwareUpdate
 524       consumes:
 525         - application/json
 526       produces:
 527         - application/json
 528       parameters:
 529         - in: body
 530           name: body
 531           required: false
 532           schema:
 533             type: string
 534         - name: version
 535           in: path
 536           required: true
 537           type: string
 538           pattern: '[vV][6-7]'
 539         - name: serviceInstanceId
 540           in: path
 541           required: true
 542           type: string
 543         - name: vnfInstanceId
 544           in: path
 545           required: true
 546           type: string
 547       responses:
 548         default:
 549           description: successful operation
 550   '/onap/so/infra/serviceInstantiation/{version}/serviceInstances/{serviceInstanceId}/vnfs/{vnfInstanceId}/applyUpdatedConfig':
 551     post:
 552       tags:
 553         - onapsoinfraserviceInstantiation
 554       summary: Apply updated configuration
 555       description: ''
 556       operationId: applyUpdatedConfig
 557       consumes:
 558         - application/json
 559       produces:
 560         - application/json
 561       parameters:
 562         - in: body
 563           name: body
 564           required: false
 565           schema:
 566             type: string
 567         - name: version
 568           in: path
 569           required: true
 570           type: string
 571           pattern: '[vV][6-7]'
 572         - name: serviceInstanceId
 573           in: path
 574           required: true
 575           type: string
 576         - name: vnfInstanceId
 577           in: path
 578           required: true
 579           type: string
 580       responses:
 581         default:
 582           description: successful operation
 583   '/onap/so/infra/serviceInstantiation/{version}/serviceInstances':
 584     post:
 585       tags:
 586         - onapsoinfraserviceInstantiation
 587       summary: Create a Service Instance on a version provided
 588       description: ''
 589       operationId: createServiceInstance
 590       consumes:
 591         - application/json
 592       produces:
 593         - application/json
 594       parameters:
 595         - in: body
 596           name: body
 597           required: false
 598           schema:
 599             type: string
 600         - name: version
 601           in: path
 602           required: true
 603           type: string
 604           pattern: '[vV][5-7]'
 605       responses:
 606         default:
 607           description: successful operation
 608   '/onap/so/infra/serviceInstantiation/{version}/serviceInstances/{serviceInstanceId}/activate':
 609     post:
 610       tags:
 611         - onapsoinfraserviceInstantiation
 612       summary: Activate provided Service Instance
 613       description: ''
 614       operationId: activateServiceInstance
 615       consumes:
 616         - application/json
 617       produces:
 618         - application/json
 619       parameters:
 620         - in: body
 621           name: body
 622           required: false
 623           schema:
 624             type: string
 625         - name: version
 626           in: path
 627           required: true
 628           type: string
 629           pattern: '[vV][5-7]'
 630         - name: serviceInstanceId
 631           in: path
 632           required: true
 633           type: string
 634       responses:
 635         default:
 636           description: successful operation
 637   '/onap/so/infra/serviceInstantiation/{version}/serviceInstances/{serviceInstanceId}/deactivate':
 638     post:
 639       tags:
 640         - onapsoinfraserviceInstantiation
 641       summary: Deactivate provided Service Instance
 642       description: ''
 643       operationId: deactivateServiceInstance
 644       consumes:
 645         - application/json
 646       produces:
 647         - application/json
 648       parameters:
 649         - in: body
 650           name: body
 651           required: false
 652           schema:
 653             type: string
 654         - name: version
 655           in: path
 656           required: true
 657           type: string
 658           pattern: '[vV][5-7]'
 659         - name: serviceInstanceId
 660           in: path
 661           required: true
 662           type: string
 663       responses:
 664         default:
 665           description: successful operation
 666   '/onap/so/infra/serviceInstantiation/{version}/serviceInstances/{serviceInstanceId}':
 667     delete:
 668       tags:
 669         - onapsoinfraserviceInstantiation
 670       summary: Delete provided Service Instance
 671       description: ''
 672       operationId: deleteServiceInstance
 673       consumes:
 674         - application/json
 675       produces:
 676         - application/json
 677       parameters:
 678         - in: body
 679           name: body
 680           required: false
 681           schema:
 682             type: string
 683         - name: version
 684           in: path
 685           required: true
 686           type: string
 687           pattern: '[vV][5-7]'
 688         - name: serviceInstanceId
 689           in: path
 690           required: true
 691           type: string
 692       responses:
 693         default:
 694           description: successful operation
 695   '/onap/so/infra/serviceInstantiation/{version}/serviceInstances/assign':
 696     post:
 697       tags:
 698         - onapsoinfraserviceInstantiation
 699       summary: Assign Service Instance
 700       description: ''
 701       operationId: assignServiceInstance
 702       consumes:
 703         - application/json
 704       produces:
 705         - application/json
 706       parameters:
 707         - in: body
 708           name: body
 709           required: false
 710           schema:
 711             type: string
 712         - name: version
 713           in: path
 714           required: true
 715           type: string
 716           pattern: '[vV][7]'
 717       responses:
 718         default:
 719           description: successful operation
 720   '/onap/so/infra/serviceInstantiation/{version}/serviceInstances/{serviceInstanceId}/unassign':
 721     post:
 722       tags:
 723         - onapsoinfraserviceInstantiation
 724       summary: Unassign Service Instance
 725       description: ''
 726       operationId: unassignServiceInstance
 727       consumes:
 728         - application/json
 729       produces:
 730         - application/json
 731       parameters:
 732         - in: body
 733           name: body
 734           required: false
 735           schema:
 736             type: string
 737         - name: version
 738           in: path
 739           required: true
 740           type: string
 741           pattern: '[vV][7]'
 742         - name: serviceInstanceId
 743           in: path
 744           required: true
 745           type: string
 746       responses:
 747         default:
 748           description: successful operation
 749   '/onap/so/infra/serviceInstantiation/{version}/serviceInstances/{serviceInstanceId}/configurations':
 750     post:
 751       tags:
 752         - onapsoinfraserviceInstantiation
 753       summary: Create Port Mirroring Configuration
 754       description: ''
 755       operationId: createPortConfiguration
 756       consumes:
 757         - application/json
 758       produces:
 759         - application/json
 760       parameters:
 761         - in: body
 762           name: body
 763           required: false
 764           schema:
 765             type: string
 766         - name: version
 767           in: path
 768           required: true
 769           type: string
 770           pattern: '[vV][5-7]'
 771         - name: serviceInstanceId
 772           in: path
 773           required: true
 774           type: string
 775       responses:
 776         default:
 777           description: successful operation
 778   '/onap/so/infra/serviceInstantiation/{version}/serviceInstances/{serviceInstanceId}/configurations/{configurationInstanceId}':
 779     delete:
 780       tags:
 781         - onapsoinfraserviceInstantiation
 782       summary: Delete provided Port
 783       description: ''
 784       operationId: deletePortConfiguration
 785       consumes:
 786         - application/json
 787       produces:
 788         - application/json
 789       parameters:
 790         - in: body
 791           name: body
 792           required: false
 793           schema:
 794             type: string
 795         - name: version
 796           in: path
 797           required: true
 798           type: string
 799           pattern: '[vV][5-7]'
 800         - name: serviceInstanceId
 801           in: path
 802           required: true
 803           type: string
 804         - name: configurationInstanceId
 805           in: path
 806           required: true
 807           type: string
 808       responses:
 809         default:
 810           description: successful operation
 811   '/onap/so/infra/serviceInstantiation/{version}/serviceInstances/{serviceInstanceId}/removeRelationships':
 812     post:
 813       tags:
 814         - onapsoinfraserviceInstantiation
 815       summary: Remove Relationships from Service Instance
 816       description: ''
 817       operationId: removeRelationships
 818       consumes:
 819         - application/json
 820       produces:
 821         - application/json
 822       parameters:
 823         - in: body
 824           name: body
 825           required: false
 826           schema:
 827             type: string
 828         - name: version
 829           in: path
 830           required: true
 831           type: string
 832           pattern: '[vV][6-7]'
 833         - name: serviceInstanceId
 834           in: path
 835           required: true
 836           type: string
 837       responses:
 838         default:
 839           description: successful operation
 840   '/onap/so/infra/serviceInstantiation/{version}/serviceInstances/{serviceInstanceId}/vnfs':
 841     post:
 842       tags:
 843         - onapsoinfraserviceInstantiation
 844       summary: Create VNF on a specified version and serviceInstance
 845       description: ''
 846       operationId: createVnfInstance
 847       consumes:
 848         - application/json
 849       produces:
 850         - application/json
 851       parameters:
 852         - in: body
 853           name: body
 854           required: false
 855           schema:
 856             type: string
 857         - name: version
 858           in: path
 859           required: true
 860           type: string
 861           pattern: '[vV][5-7]'
 862         - name: serviceInstanceId
 863           in: path
 864           required: true
 865           type: string
 866       responses:
 867         default:
 868           description: successful operation
 869   '/onap/so/infra/serviceInstantiation/{version}/serviceInstances/{serviceInstanceId}/vnfs/{vnfInstanceId}/replace':
 870     post:
 871       tags:
 872         - onapsoinfraserviceInstantiation
 873       summary: Replace provided VNF instance
 874       description: ''
 875       operationId: replaceVnfInstance
 876       consumes:
 877         - application/json
 878       produces:
 879         - application/json
 880       parameters:
 881         - in: body
 882           name: body
 883           required: false
 884           schema:
 885             type: string
 886         - name: version
 887           in: path
 888           required: true
 889           type: string
 890           pattern: '[vV][5-7]'
 891         - name: serviceInstanceId
 892           in: path
 893           required: true
 894           type: string
 895         - name: vnfInstanceId
 896           in: path
 897           required: true
 898           type: string
 899       responses:
 900         default:
 901           description: successful operation
 902   '/onap/so/infra/serviceInstantiation/{version}/serviceInstances/{serviceInstanceId}/vnfs/{vnfInstanceId}':
 903     put:
 904       tags:
 905         - onapsoinfraserviceInstantiation
 906       summary: 'Update VNF on a specified version, serviceInstance and vnfInstance'
 907       description: ''
 908       operationId: updateVnfInstance
 909       consumes:
 910         - application/json
 911       produces:
 912         - application/json
 913       parameters:
 914         - in: body
 915           name: body
 916           required: false
 917           schema:
 918             type: string
 919         - name: version
 920           in: path
 921           required: true
 922           type: string
 923           pattern: '[vV][5-7]'
 924         - name: serviceInstanceId
 925           in: path
 926           required: true
 927           type: string
 928         - name: vnfInstanceId
 929           in: path
 930           required: true
 931           type: string
 932       responses:
 933         default:
 934           description: successful operation
 935     delete:
 936       tags:
 937         - onapsoinfraserviceInstantiation
 938       summary: Delete provided VNF instance
 939       description: ''
 940       operationId: deleteVnfInstance
 941       consumes:
 942         - application/json
 943       produces:
 944         - application/json
 945       parameters:
 946         - in: body
 947           name: body
 948           required: false
 949           schema:
 950             type: string
 951         - name: version
 952           in: path
 953           required: true
 954           type: string
 955           pattern: '[vV][5-7]'
 956         - name: serviceInstanceId
 957           in: path
 958           required: true
 959           type: string
 960         - name: vnfInstanceId
 961           in: path
 962           required: true
 963           type: string
 964       responses:
 965         default:
 966           description: successful operation
 967   '/onap/so/infra/serviceInstantiation/{version}/serviceInstances/{serviceInstanceId}/vnfs/{vnfInstanceId}/vfModules':
 968     post:
 969       tags:
 970         - onapsoinfraserviceInstantiation
 971       summary: 'Create VfModule on a specified version, serviceInstance and vnfInstance'
 972       description: ''
 973       operationId: createVfModuleInstance
 974       consumes:
 975         - application/json
 976       produces:
 977         - application/json
 978       parameters:
 979         - in: body
 980           name: body
 981           required: false
 982           schema:
 983             type: string
 984         - name: version
 985           in: path
 986           required: true
 987           type: string
 988           pattern: '[vV][5-7]'
 989         - name: serviceInstanceId
 990           in: path
 991           required: true
 992           type: string
 993         - name: vnfInstanceId
 994           in: path
 995           required: true
 996           type: string
 997       responses:
 998         default:
 999           description: successful operation
1000   '/onap/so/infra/serviceInstantiation/{version}/serviceInstances/{serviceInstanceId}/vnfs/{vnfInstanceId}/vfModules/{vfmoduleInstanceId}/replace':
1001     post:
1002       tags:
1003         - onapsoinfraserviceInstantiation
1004       summary: 'Create VfModule on a specified version, serviceInstance and vnfInstance'
1005       description: ''
1006       operationId: replaceVfModuleInstance
1007       consumes:
1008         - application/json
1009       produces:
1010         - application/json
1011       parameters:
1012         - in: body
1013           name: body
1014           required: false
1015           schema:
1016             type: string
1017         - name: version
1018           in: path
1019           required: true
1020           type: string
1021           pattern: '[vV][5-7]'
1022         - name: serviceInstanceId
1023           in: path
1024           required: true
1025           type: string
1026         - name: vnfInstanceId
1027           in: path
1028           required: true
1029           type: string
1030         - name: vfmoduleInstanceId
1031           in: path
1032           required: true
1033           type: string
1034       responses:
1035         default:
1036           description: successful operation
1037   '/onap/so/infra/serviceInstantiation/{version}/serviceInstances/{serviceInstanceId}/vnfs/{vnfInstanceId}/vfModules/{vfmoduleInstanceId}':
1038     put:
1039       tags:
1040         - onapsoinfraserviceInstantiation
1041       summary: >-
1042         Update VfModule on a specified version, serviceInstance, vnfInstance and
1043         vfModule
1044       description: ''
1045       operationId: updateVfModuleInstance
1046       consumes:
1047         - application/json
1048       produces:
1049         - application/json
1050       parameters:
1051         - in: body
1052           name: body
1053           required: false
1054           schema:
1055             type: string
1056         - name: version
1057           in: path
1058           required: true
1059           type: string
1060           pattern: '[vV][5-7]'
1061         - name: serviceInstanceId
1062           in: path
1063           required: true
1064           type: string
1065         - name: vnfInstanceId
1066           in: path
1067           required: true
1068           type: string
1069         - name: vfmoduleInstanceId
1070           in: path
1071           required: true
1072           type: string
1073       responses:
1074         default:
1075           description: successful operation
1076     delete:
1077       tags:
1078         - onapsoinfraserviceInstantiation
1079       summary: Delete provided VfModule instance
1080       description: ''
1081       operationId: deleteVfModuleInstance
1082       consumes:
1083         - application/json
1084       produces:
1085         - application/json
1086       parameters:
1087         - in: body
1088           name: body
1089           required: false
1090           schema:
1091             type: string
1092         - name: version
1093           in: path
1094           required: true
1095           type: string
1096           pattern: '[vV][5-7]'
1097         - name: serviceInstanceId
1098           in: path
1099           required: true
1100           type: string
1101         - name: vnfInstanceId
1102           in: path
1103           required: true
1104           type: string
1105         - name: vfmoduleInstanceId
1106           in: path
1107           required: true
1108           type: string
1109       responses:
1110         default:
1111           description: successful operation
1112   '/onap/so/infra/serviceInstantiation/{version}/serviceInstances/{serviceInstanceId}/vnfs/{vnfInstanceId}/volumeGroups':
1113     post:
1114       tags:
1115         - onapsoinfraserviceInstantiation
1116       summary: 'Create VolumeGroup on a specified version, serviceInstance, vnfInstance'
1117       description: ''
1118       operationId: createVolumeGroupInstance
1119       consumes:
1120         - application/json
1121       produces:
1122         - application/json
1123       parameters:
1124         - in: body
1125           name: body
1126           required: false
1127           schema:
1128             type: string
1129         - name: version
1130           in: path
1131           required: true
1132           type: string
1133           pattern: '[vV][5-7]'
1134         - name: serviceInstanceId
1135           in: path
1136           required: true
1137           type: string
1138         - name: vnfInstanceId
1139           in: path
1140           required: true
1141           type: string
1142       responses:
1143         default:
1144           description: successful operation
1145   '/onap/so/infra/serviceInstantiation/{version}/serviceInstances/{serviceInstanceId}/vnfs/{vnfInstanceId}/volumeGroups/{volumeGroupInstanceId}':
1146     put:
1147       tags:
1148         - onapsoinfraserviceInstantiation
1149       summary: >-
1150         Update VolumeGroup on a specified version, serviceInstance, vnfInstance
1151         and volumeGroup
1152       description: ''
1153       operationId: updateVolumeGroupInstance
1154       consumes:
1155         - application/json
1156       produces:
1157         - application/json
1158       parameters:
1159         - in: body
1160           name: body
1161           required: false
1162           schema:
1163             type: string
1164         - name: version
1165           in: path
1166           required: true
1167           type: string
1168           pattern: '[vV][5-7]'
1169         - name: serviceInstanceId
1170           in: path
1171           required: true
1172           type: string
1173         - name: vnfInstanceId
1174           in: path
1175           required: true
1176           type: string
1177         - name: volumeGroupInstanceId
1178           in: path
1179           required: true
1180           type: string
1181       responses:
1182         default:
1183           description: successful operation
1184     delete:
1185       tags:
1186         - onapsoinfraserviceInstantiation
1187       summary: Delete provided VolumeGroup instance
1188       description: ''
1189       operationId: deleteVolumeGroupInstance
1190       consumes:
1191         - application/json
1192       produces:
1193         - application/json
1194       parameters:
1195         - in: body
1196           name: body
1197           required: false
1198           schema:
1199             type: string
1200         - name: version
1201           in: path
1202           required: true
1203           type: string
1204           pattern: '[vV][5-7]'
1205         - name: serviceInstanceId
1206           in: path
1207           required: true
1208           type: string
1209         - name: vnfInstanceId
1210           in: path
1211           required: true
1212           type: string
1213         - name: volumeGroupInstanceId
1214           in: path
1215           required: true
1216           type: string
1217       responses:
1218         default:
1219           description: successful operation
1220   '/onap/so/infra/serviceInstantiation/{version}/serviceInstances/{serviceInstanceId}/networks':
1221     post:
1222       tags:
1223         - onapsoinfraserviceInstantiation
1224       summary: 'Create NetworkInstance on a specified version and serviceInstance '
1225       description: ''
1226       operationId: createNetworkInstance
1227       consumes:
1228         - application/json
1229       produces:
1230         - application/json
1231       parameters:
1232         - in: body
1233           name: body
1234           required: false
1235           schema:
1236             type: string
1237         - name: version
1238           in: path
1239           required: true
1240           type: string
1241           pattern: '[vV][5-7]'
1242         - name: serviceInstanceId
1243           in: path
1244           required: true
1245           type: string
1246       responses:
1247         default:
1248           description: successful operation
1249   '/onap/so/infra/serviceInstantiation/{version}/serviceInstances/{serviceInstanceId}/networks/{networkInstanceId}':
1250     put:
1251       tags:
1252         - onapsoinfraserviceInstantiation
1253       summary: >-
1254         Update VolumeGroup on a specified version, serviceInstance,
1255         networkInstance
1256       description: ''
1257       operationId: updateNetworkInstance
1258       consumes:
1259         - application/json
1260       produces:
1261         - application/json
1262       parameters:
1263         - in: body
1264           name: body
1265           required: false
1266           schema:
1267             type: string
1268         - name: version
1269           in: path
1270           required: true
1271           type: string
1272           pattern: '[vV][5-7]'
1273         - name: serviceInstanceId
1274           in: path
1275           required: true
1276           type: string
1277         - name: networkInstanceId
1278           in: path
1279           required: true
1280           type: string
1281       responses:
1282         default:
1283           description: successful operation
1284     delete:
1285       tags:
1286         - onapsoinfraserviceInstantiation
1287       summary: Delete provided Network instance
1288       description: ''
1289       operationId: deleteNetworkInstance
1290       consumes:
1291         - application/json
1292       produces:
1293         - application/json
1294       parameters:
1295         - in: body
1296           name: body
1297           required: false
1298           schema:
1299             type: string
1300         - name: version
1301           in: path
1302           required: true
1303           type: string
1304           pattern: '[vV][5-7]'
1305         - name: serviceInstanceId
1306           in: path
1307           required: true
1308           type: string
1309         - name: networkInstanceId
1310           in: path
1311           required: true
1312           type: string
1313       responses:
1314         default:
1315           description: successful operation
1316   '/onap/so/infra/tasks/{version}':
1317     get:
1318       tags:
1319         - onapsoinfratasks
1320       summary: Finds Manual Tasks
1321       description: ''
1322       operationId: queryFilters
1323       parameters:
1324         - name: taskId
1325           in: query
1326           required: false
1327           type: string
1328         - name: originalRequestId
1329           in: query
1330           required: false
1331           type: string
1332         - name: subscriptionServiceType
1333           in: query
1334           required: false
1335           type: string
1336         - name: nfRole
1337           in: query
1338           required: false
1339           type: string
1340         - name: buildingBlockName
1341           in: query
1342           required: false
1343           type: string
1344         - name: originalRequestDate
1345           in: query
1346           required: false
1347           type: string
1348         - name: originalRequestorId
1349           in: query
1350           required: false
1351           type: string
1352         - name: version
1353           in: path
1354           required: true
1355           type: string
1356           pattern: '[vV]1'
1357       responses:
1358         default:
1359           description: successful operation
1360   '/onap/so/infra/cloudResources/{version}/operationalEnvironments':
1361     post:
1362       tags:
1363         - onapsoinfracloudResources
1364       summary: Create an Operational Environment
1365       description: ''
1366       operationId: createOperationEnvironment
1367       consumes:
1368         - application/json
1369       produces:
1370         - application/json
1371       parameters:
1372         - in: body
1373           name: body
1374           required: false
1375           schema:
1376             type: string
1377         - name: version
1378           in: path
1379           required: true
1380           type: string
1381           pattern: '[vV][1]'
1382       responses:
1383         default:
1384           description: successful operation
1385   '/onap/so/infra/cloudResources/{version}/operationalEnvironments/{operationalEnvironmentId}/activate':
1386     post:
1387       tags:
1388         - onapsoinfracloudResources
1389       summary: Activate an Operational Environment
1390       description: ''
1391       operationId: activateOperationEnvironment
1392       consumes:
1393         - application/json
1394       produces:
1395         - application/json
1396       parameters:
1397         - in: body
1398           name: body
1399           required: false
1400           schema:
1401             type: string
1402         - name: version
1403           in: path
1404           required: true
1405           type: string
1406           pattern: '[vV][1]'
1407         - name: operationalEnvironmentId
1408           in: path
1409           required: true
1410           type: string
1411       responses:
1412         default:
1413           description: successful operation
1414   '/onap/so/infra/cloudResources/{version}/operationalEnvironments/{operationalEnvironmentId}/deactivate':
1415     post:
1416       tags:
1417         - onapsoinfracloudResources
1418       summary: Deactivate an Operational Environment
1419       description: ''
1420       operationId: deactivateOperationEnvironment
1421       consumes:
1422         - application/json
1423       produces:
1424         - application/json
1425       parameters:
1426         - in: body
1427           name: body
1428           required: false
1429           schema:
1430             type: string
1431         - name: version
1432           in: path
1433           required: true
1434           type: string
1435           pattern: '[vV][1]'
1436         - name: operationalEnvironmentId
1437           in: path
1438           required: true
1439           type: string
1440       responses:
1441         default:
1442           description: successful operation
1443   '/onap/so/infra/cloudResourcesRequests/{version}/{requestId}/unlock':
1444     post:
1445       tags:
1446         - onapsoinfracloudResourcesRequests
1447       summary: Unlock CloudOrchestration requests for a specified requestId
1448       description: ''
1449       operationId: unlockOrchestrationRequestForReqId
1450       consumes:
1451         - application/json
1452       produces:
1453         - application/json
1454       parameters:
1455         - in: body
1456           name: body
1457           required: false
1458           schema:
1459             type: string
1460         - name: requestId
1461           in: path
1462           required: true
1463           type: string
1464         - name: version
1465           in: path
1466           required: true
1467           type: string
1468           pattern: '[vV][1]'
1469       responses:
1470         default:
1471           description: successful operation
1472   '/onap/so/infra/cloudResourcesRequests/{version}':
1473     get:
1474       tags:
1475         - onapsoinfracloudResourcesRequests
1476       summary: Get status of an Operational Environment based on filter criteria
1477       description: ''
1478       operationId: getOperationEnvironmentStatusFilter
1479       consumes:
1480         - application/json
1481       produces:
1482         - application/json
1483       parameters:
1484         - name: version
1485           in: path
1486           required: true
1487           type: string
1488           pattern: '[vV][1]'
1489       responses:
1490         default:
1491           description: successful operation
1492   '/onap/so/infra/modelDistributions/{version}/distributions/{distributionId}':
1493     post:
1494       tags:
1495         - onapsoinframodelDistributions
1496       summary: Update model distribution status
1497       description: ''
1498       operationId: updateModelDistributionStatus
1499       consumes:
1500         - application/json
1501       produces:
1502         - application/json
1503       parameters:
1504         - in: body
1505           name: body
1506           required: false
1507           schema:
1508             type: string
1509         - name: version
1510           in: path
1511           required: true
1512           type: string
1513           pattern: '[vV][1]'
1514         - name: distributionId
1515           in: path
1516           required: true
1517           type: string
1518       responses:
1519         default:
1520           description: successful operation