docs/api/swagger/swagger.yaml

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