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
1077               pnf:
1078                 summary: PNF
1079                 value:
1080                   requestDetails:
1081                     modelInfo:
1082                       modelInvariantId: 040a21d5-b208-490b-9c69-c12ae2b2b958
1083                       modelName: ORAN_RU_SIM_Service
1084                       modelType: service
1085                       modelVersion: '2.0'
1086                       modelVersionId: 2f40ddbd-0acc-4e59-8fb3-77a6f84ae28c
1087                     owningEntity:
1088                       owningEntityId: 3804b4ac-4d9c-482a-ad0b-5806f8849907
1089                       owningEntityName: oran_owner
1090                     project:
1091                       projectName: oran_project
1092                     requestInfo:
1093                       instanceName: ORAN_RU_SIM
1094                       productFamilyId: oran-service
1095                       requestorId: PORTAL
1096                       source: PORTAL
1097                       suppressRollback: false
1098                     requestParameters:
1099                       aLaCarte: false
1100                       subscriptionServiceType: oran_service
1101                       userParams:
1102                       - Homing_Solution: none
1103                       - service:
1104                           instanceName: ORAN_RU_SIM_Service_1
1105                           instanceParams: []
1106                           modelInfo:
1107                             modelInvariantId: 040a21d5-b208-490b-9c69-c12ae2b2b958
1108                             modelName: ORAN_RU_SIM_Service
1109                             modelType: service
1110                             modelVersion: '2.0'
1111                             modelVersionId: 2f40ddbd-0acc-4e59-8fb3-77a6f84ae28c
1112                           resources:
1113                             pnfs:
1114                             - instanceName: ORAN_RU_PNF_1
1115                               instanceParams: []
1116                               lineOfBusiness:
1117                                 lineOfBusinessName: oran_lob
1118                               modelInfo:
1119                                 modelCustomizationId: 5e3a18ce-8bbd-40fc-a197-becca92ac05b
1120                                 modelCustomizationName: ORAN_RU_PNF_1
1121                                 modelInstanceName: ORAN_RU_PNF_ORAN_RU_SIM_Service
1122                                 modelInvariantId: 486f38e8-1710-4875-b732-a8b3301a7786
1123                                 modelName: ORAN_RU_PNF
1124                                 modelType: pnf
1125                                 modelVersion: '1.0'
1126                                 modelVersionId: e95310e1-e1d2-471f-aa26-d24849a7e61a
1127                               platform:
1128                                 platformName: oran_platform
1129                               productFamilyId: oran-service
1130                             vnfs: []
1131                     subscriberInfo:
1132                       globalSubscriberId: ORANTownCustomer
1133
1134
1135         required: false
1136       responses:
1137         default:
1138           description: successful operation
1139           content: {}
1140       x-codegen-request-body-name: requestBody
1141   /onap/so/infra/serviceInstantiation/{version}/serviceInstances/{serviceInstanceId}/activate:
1142     post:
1143       tags:
1144         - onapsoinfraserviceInstantiation
1145       summary: Activate provided Service Instance
1146       operationId: activateServiceInstance
1147       parameters:
1148         - name: version
1149           in: path
1150           required: true
1151           schema:
1152             pattern: '[vV][5-7]'
1153             type: string
1154         - name: serviceInstanceId
1155           in: path
1156           required: true
1157           schema:
1158             type: string
1159       requestBody:
1160         content:
1161           application/json:
1162             schema:
1163               type: string
1164         required: false
1165       responses:
1166         default:
1167           description: successful operation
1168           content: {}
1169       x-codegen-request-body-name: body
1170   /onap/so/infra/serviceInstantiation/{version}/serviceInstances/{serviceInstanceId}/deactivate:
1171     post:
1172       tags:
1173         - onapsoinfraserviceInstantiation
1174       summary: Deactivate provided Service Instance
1175       operationId: deactivateServiceInstance
1176       parameters:
1177         - name: version
1178           in: path
1179           required: true
1180           schema:
1181             pattern: '[vV][5-7]'
1182             type: string
1183         - name: serviceInstanceId
1184           in: path
1185           required: true
1186           schema:
1187             type: string
1188       requestBody:
1189         content:
1190           application/json:
1191             schema:
1192               type: string
1193         required: false
1194       responses:
1195         default:
1196           description: successful operation
1197           content: {}
1198       x-codegen-request-body-name: body
1199   /onap/so/infra/serviceInstantiation/{version}/serviceInstances/{serviceInstanceId}:
1200     delete:
1201       tags:
1202         - onapsoinfraserviceInstantiation
1203       summary: Delete provided Service Instance
1204       operationId: deleteServiceInstance
1205       parameters:
1206         - name: version
1207           in: path
1208           required: true
1209           schema:
1210             pattern: '[vV][5-7]'
1211             type: string
1212         - name: serviceInstanceId
1213           in: path
1214           required: true
1215           schema:
1216             type: string
1217       requestBody:
1218         content:
1219           application/json:
1220             schema:
1221               type: string
1222         required: false
1223       responses:
1224         default:
1225           description: successful operation
1226           content: {}
1227       x-codegen-request-body-name: body
1228   /onap/so/infra/serviceInstantiation/{version}/serviceInstances/assign:
1229     post:
1230       tags:
1231         - onapsoinfraserviceInstantiation
1232       summary: Assign Service Instance
1233       operationId: assignServiceInstance
1234       parameters:
1235         - name: version
1236           in: path
1237           required: true
1238           schema:
1239             pattern: '[vV][7]'
1240             type: string
1241       requestBody:
1242         content:
1243           application/json:
1244             schema:
1245               type: string
1246         required: false
1247       responses:
1248         default:
1249           description: successful operation
1250           content: {}
1251       x-codegen-request-body-name: body
1252   /onap/so/infra/serviceInstantiation/{version}/serviceInstances/{serviceInstanceId}/unassign:
1253     post:
1254       tags:
1255         - onapsoinfraserviceInstantiation
1256       summary: Unassign Service Instance
1257       operationId: unassignServiceInstance
1258       parameters:
1259         - name: version
1260           in: path
1261           required: true
1262           schema:
1263             pattern: '[vV][7]'
1264             type: string
1265         - name: serviceInstanceId
1266           in: path
1267           required: true
1268           schema:
1269             type: string
1270       requestBody:
1271         content:
1272           application/json:
1273             schema:
1274               type: string
1275         required: false
1276       responses:
1277         default:
1278           description: successful operation
1279           content: {}
1280       x-codegen-request-body-name: body
1281   /onap/so/infra/serviceInstantiation/{version}/serviceInstances/{serviceInstanceId}/configurations:
1282     post:
1283       tags:
1284         - onapsoinfraserviceInstantiation
1285       summary: Create Port Mirroring Configuration
1286       operationId: createPortConfiguration
1287       parameters:
1288         - name: version
1289           in: path
1290           required: true
1291           schema:
1292             pattern: '[vV][5-7]'
1293             type: string
1294         - name: serviceInstanceId
1295           in: path
1296           required: true
1297           schema:
1298             type: string
1299       requestBody:
1300         content:
1301           application/json:
1302             schema:
1303               type: string
1304         required: false
1305       responses:
1306         default:
1307           description: successful operation
1308           content: {}
1309       x-codegen-request-body-name: body
1310   /onap/so/infra/serviceInstantiation/{version}/serviceInstances/{serviceInstanceId}/configurations/{configurationInstanceId}:
1311     delete:
1312       tags:
1313         - onapsoinfraserviceInstantiation
1314       summary: Delete provided Port
1315       operationId: deletePortConfiguration
1316       parameters:
1317         - name: version
1318           in: path
1319           required: true
1320           schema:
1321             pattern: '[vV][5-7]'
1322             type: string
1323         - name: serviceInstanceId
1324           in: path
1325           required: true
1326           schema:
1327             type: string
1328         - name: configurationInstanceId
1329           in: path
1330           required: true
1331           schema:
1332             type: string
1333       requestBody:
1334         content:
1335           application/json:
1336             schema:
1337               type: string
1338         required: false
1339       responses:
1340         default:
1341           description: successful operation
1342           content: {}
1343       x-codegen-request-body-name: body
1344   /onap/so/infra/serviceInstantiation/{version}/serviceInstances/{serviceInstanceId}/removeRelationships:
1345     post:
1346       tags:
1347         - onapsoinfraserviceInstantiation
1348       summary: Remove Relationships from Service Instance
1349       operationId: removeRelationships
1350       parameters:
1351         - name: version
1352           in: path
1353           required: true
1354           schema:
1355             pattern: '[vV][6-7]'
1356             type: string
1357         - name: serviceInstanceId
1358           in: path
1359           required: true
1360           schema:
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}/vnfs:
1374     post:
1375       tags:
1376         - onapsoinfraserviceInstantiation
1377       summary: Create VNF on a specified version and serviceInstance
1378       operationId: createVnfInstance
1379       parameters:
1380         - name: version
1381           in: path
1382           required: true
1383           schema:
1384             pattern: '[vV][5-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}/vnfs/{vnfInstanceId}/replace:
1403     post:
1404       tags:
1405         - onapsoinfraserviceInstantiation
1406       summary: Replace provided VNF instance
1407       operationId: replaceVnfInstance
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         - name: vnfInstanceId
1421           in: path
1422           required: true
1423           schema:
1424             type: string
1425       requestBody:
1426         content:
1427           application/json:
1428             schema:
1429               type: string
1430         required: false
1431       responses:
1432         default:
1433           description: successful operation
1434           content: {}
1435       x-codegen-request-body-name: body
1436   /onap/so/infra/serviceInstantiation/{version}/serviceInstances/{serviceInstanceId}/vnfs/{vnfInstanceId}:
1437     put:
1438       tags:
1439         - onapsoinfraserviceInstantiation
1440       summary: Update VNF on a specified version, serviceInstance and vnfInstance
1441       operationId: updateVnfInstance
1442       parameters:
1443         - name: version
1444           in: path
1445           required: true
1446           schema:
1447             pattern: '[vV][5-7]'
1448             type: string
1449         - name: serviceInstanceId
1450           in: path
1451           required: true
1452           schema:
1453             type: string
1454         - name: vnfInstanceId
1455           in: path
1456           required: true
1457           schema:
1458             type: string
1459       requestBody:
1460         content:
1461           application/json:
1462             schema:
1463               type: string
1464         required: false
1465       responses:
1466         default:
1467           description: successful operation
1468           content: {}
1469       x-codegen-request-body-name: body
1470     delete:
1471       tags:
1472         - onapsoinfraserviceInstantiation
1473       summary: Delete provided VNF instance
1474       operationId: deleteVnfInstance
1475       parameters:
1476         - name: version
1477           in: path
1478           required: true
1479           schema:
1480             pattern: '[vV][5-7]'
1481             type: string
1482         - name: serviceInstanceId
1483           in: path
1484           required: true
1485           schema:
1486             type: string
1487         - name: vnfInstanceId
1488           in: path
1489           required: true
1490           schema:
1491             type: string
1492       requestBody:
1493         content:
1494           application/json:
1495             schema:
1496               type: string
1497         required: false
1498       responses:
1499         default:
1500           description: successful operation
1501           content: {}
1502       x-codegen-request-body-name: body
1503   /onap/so/infra/serviceInstantiation/{version}/serviceInstances/{serviceInstanceId}/vnfs/{vnfInstanceId}/vfModules:
1504     post:
1505       tags:
1506         - onapsoinfraserviceInstantiation
1507       summary: Create VfModule on a specified version, serviceInstance and vnfInstance
1508       operationId: createVfModuleInstance
1509       parameters:
1510         - name: version
1511           in: path
1512           required: true
1513           schema:
1514             pattern: '[vV][5-7]'
1515             type: string
1516         - name: serviceInstanceId
1517           in: path
1518           required: true
1519           schema:
1520             type: string
1521         - name: vnfInstanceId
1522           in: path
1523           required: true
1524           schema:
1525             type: string
1526       requestBody:
1527         content:
1528           application/json:
1529             schema:
1530               type: string
1531         required: false
1532       responses:
1533         default:
1534           description: successful operation
1535           content: {}
1536       x-codegen-request-body-name: body
1537   /onap/so/infra/serviceInstantiation/{version}/serviceInstances/{serviceInstanceId}/vnfs/{vnfInstanceId}/vfModules/{vfmoduleInstanceId}/replace:
1538     post:
1539       tags:
1540         - onapsoinfraserviceInstantiation
1541       summary: Create VfModule on a specified version, serviceInstance and vnfInstance
1542       operationId: replaceVfModuleInstance
1543       parameters:
1544         - name: version
1545           in: path
1546           required: true
1547           schema:
1548             pattern: '[vV][5-7]'
1549             type: string
1550         - name: serviceInstanceId
1551           in: path
1552           required: true
1553           schema:
1554             type: string
1555         - name: vnfInstanceId
1556           in: path
1557           required: true
1558           schema:
1559             type: string
1560         - name: vfmoduleInstanceId
1561           in: path
1562           required: true
1563           schema:
1564             type: string
1565       requestBody:
1566         content:
1567           application/json:
1568             schema:
1569               type: string
1570         required: false
1571       responses:
1572         default:
1573           description: successful operation
1574           content: {}
1575       x-codegen-request-body-name: body
1576   /onap/so/infra/serviceInstantiation/{version}/serviceInstances/{serviceInstanceId}/vnfs/{vnfInstanceId}/vfModules/{vfmoduleInstanceId}:
1577     put:
1578       tags:
1579         - onapsoinfraserviceInstantiation
1580       summary: >-
1581         Update VfModule on a specified version, serviceInstance, vnfInstance and
1582         vfModule
1583       operationId: updateVfModuleInstance
1584       parameters:
1585         - name: version
1586           in: path
1587           required: true
1588           schema:
1589             pattern: '[vV][5-7]'
1590             type: string
1591         - name: serviceInstanceId
1592           in: path
1593           required: true
1594           schema:
1595             type: string
1596         - name: vnfInstanceId
1597           in: path
1598           required: true
1599           schema:
1600             type: string
1601         - name: vfmoduleInstanceId
1602           in: path
1603           required: true
1604           schema:
1605             type: string
1606       requestBody:
1607         content:
1608           application/json:
1609             schema:
1610               type: string
1611         required: false
1612       responses:
1613         default:
1614           description: successful operation
1615           content: {}
1616       x-codegen-request-body-name: body
1617     delete:
1618       tags:
1619         - onapsoinfraserviceInstantiation
1620       summary: Delete provided VfModule instance
1621       operationId: deleteVfModuleInstance
1622       parameters:
1623         - name: version
1624           in: path
1625           required: true
1626           schema:
1627             pattern: '[vV][5-7]'
1628             type: string
1629         - name: serviceInstanceId
1630           in: path
1631           required: true
1632           schema:
1633             type: string
1634         - name: vnfInstanceId
1635           in: path
1636           required: true
1637           schema:
1638             type: string
1639         - name: vfmoduleInstanceId
1640           in: path
1641           required: true
1642           schema:
1643             type: string
1644       requestBody:
1645         content:
1646           application/json:
1647             schema:
1648               type: string
1649         required: false
1650       responses:
1651         default:
1652           description: successful operation
1653           content: {}
1654       x-codegen-request-body-name: body
1655   /onap/so/infra/serviceInstantiation/{version}/serviceInstances/{serviceInstanceId}/vnfs/{vnfInstanceId}/volumeGroups:
1656     post:
1657       tags:
1658         - onapsoinfraserviceInstantiation
1659       summary: Create VolumeGroup on a specified version, serviceInstance, vnfInstance
1660       operationId: createVolumeGroupInstance
1661       parameters:
1662         - name: version
1663           in: path
1664           required: true
1665           schema:
1666             pattern: '[vV][5-7]'
1667             type: string
1668         - name: serviceInstanceId
1669           in: path
1670           required: true
1671           schema:
1672             type: string
1673         - name: vnfInstanceId
1674           in: path
1675           required: true
1676           schema:
1677             type: string
1678       requestBody:
1679         content:
1680           application/json:
1681             schema:
1682               type: string
1683         required: false
1684       responses:
1685         default:
1686           description: successful operation
1687           content: {}
1688       x-codegen-request-body-name: body
1689   /onap/so/infra/serviceInstantiation/{version}/serviceInstances/{serviceInstanceId}/vnfs/{vnfInstanceId}/volumeGroups/{volumeGroupInstanceId}:
1690     put:
1691       tags:
1692         - onapsoinfraserviceInstantiation
1693       summary: >-
1694         Update VolumeGroup on a specified version, serviceInstance, vnfInstance
1695         and volumeGroup
1696       operationId: updateVolumeGroupInstance
1697       parameters:
1698         - name: version
1699           in: path
1700           required: true
1701           schema:
1702             pattern: '[vV][5-7]'
1703             type: string
1704         - name: serviceInstanceId
1705           in: path
1706           required: true
1707           schema:
1708             type: string
1709         - name: vnfInstanceId
1710           in: path
1711           required: true
1712           schema:
1713             type: string
1714         - name: volumeGroupInstanceId
1715           in: path
1716           required: true
1717           schema:
1718             type: string
1719       requestBody:
1720         content:
1721           application/json:
1722             schema:
1723               type: string
1724         required: false
1725       responses:
1726         default:
1727           description: successful operation
1728           content: {}
1729       x-codegen-request-body-name: body
1730     delete:
1731       tags:
1732         - onapsoinfraserviceInstantiation
1733       summary: Delete provided VolumeGroup instance
1734       operationId: deleteVolumeGroupInstance
1735       parameters:
1736         - name: version
1737           in: path
1738           required: true
1739           schema:
1740             pattern: '[vV][5-7]'
1741             type: string
1742         - name: serviceInstanceId
1743           in: path
1744           required: true
1745           schema:
1746             type: string
1747         - name: vnfInstanceId
1748           in: path
1749           required: true
1750           schema:
1751             type: string
1752         - name: volumeGroupInstanceId
1753           in: path
1754           required: true
1755           schema:
1756             type: string
1757       requestBody:
1758         content:
1759           application/json:
1760             schema:
1761               type: string
1762         required: false
1763       responses:
1764         default:
1765           description: successful operation
1766           content: {}
1767       x-codegen-request-body-name: body
1768   /onap/so/infra/serviceInstantiation/{version}/serviceInstances/{serviceInstanceId}/networks:
1769     post:
1770       tags:
1771         - onapsoinfraserviceInstantiation
1772       summary: 'Create NetworkInstance on a specified version and serviceInstance '
1773       operationId: createNetworkInstance
1774       parameters:
1775         - name: version
1776           in: path
1777           required: true
1778           schema:
1779             pattern: '[vV][5-7]'
1780             type: string
1781         - name: serviceInstanceId
1782           in: path
1783           required: true
1784           schema:
1785             type: string
1786       requestBody:
1787         content:
1788           application/json:
1789             schema:
1790               type: string
1791         required: false
1792       responses:
1793         default:
1794           description: successful operation
1795           content: {}
1796       x-codegen-request-body-name: body
1797   /onap/so/infra/serviceInstantiation/{version}/serviceInstances/{serviceInstanceId}/networks/{networkInstanceId}:
1798     put:
1799       tags:
1800         - onapsoinfraserviceInstantiation
1801       summary: >-
1802         Update VolumeGroup on a specified version, serviceInstance,
1803         networkInstance
1804       operationId: updateNetworkInstance
1805       parameters:
1806         - name: version
1807           in: path
1808           required: true
1809           schema:
1810             pattern: '[vV][5-7]'
1811             type: string
1812         - name: serviceInstanceId
1813           in: path
1814           required: true
1815           schema:
1816             type: string
1817         - name: networkInstanceId
1818           in: path
1819           required: true
1820           schema:
1821             type: string
1822       requestBody:
1823         content:
1824           application/json:
1825             schema:
1826               type: string
1827         required: false
1828       responses:
1829         default:
1830           description: successful operation
1831           content: {}
1832       x-codegen-request-body-name: body
1833     delete:
1834       tags:
1835         - onapsoinfraserviceInstantiation
1836       summary: Delete provided Network instance
1837       operationId: deleteNetworkInstance
1838       parameters:
1839         - name: version
1840           in: path
1841           required: true
1842           schema:
1843             pattern: '[vV][5-7]'
1844             type: string
1845         - name: serviceInstanceId
1846           in: path
1847           required: true
1848           schema:
1849             type: string
1850         - name: networkInstanceId
1851           in: path
1852           required: true
1853           schema:
1854             type: string
1855       requestBody:
1856         content:
1857           application/json:
1858             schema:
1859               type: string
1860         required: false
1861       responses:
1862         default:
1863           description: successful operation
1864           content: {}
1865       x-codegen-request-body-name: body
1866   /onap/so/infra/tasks/{version}:
1867     get:
1868       tags:
1869         - onapsoinfratasks
1870       summary: Finds Manual Tasks
1871       operationId: queryFilters
1872       parameters:
1873         - name: taskId
1874           in: query
1875           schema:
1876             type: string
1877         - name: originalRequestId
1878           in: query
1879           schema:
1880             type: string
1881         - name: subscriptionServiceType
1882           in: query
1883           schema:
1884             type: string
1885         - name: nfRole
1886           in: query
1887           schema:
1888             type: string
1889         - name: buildingBlockName
1890           in: query
1891           schema:
1892             type: string
1893         - name: originalRequestDate
1894           in: query
1895           schema:
1896             type: string
1897         - name: originalRequestorId
1898           in: query
1899           schema:
1900             type: string
1901         - name: version
1902           in: path
1903           required: true
1904           schema:
1905             pattern: '[vV]1'
1906             type: string
1907       responses:
1908         default:
1909           description: successful operation
1910           content: {}
1911   /onap/so/infra/cloudResources/{version}/operationalEnvironments:
1912     post:
1913       tags:
1914         - onapsoinfracloudResources
1915       summary: Create an Operational Environment
1916       operationId: createOperationEnvironment
1917       parameters:
1918         - name: version
1919           in: path
1920           required: true
1921           schema:
1922             pattern: '[vV][1]'
1923             type: string
1924       requestBody:
1925         content:
1926           application/json:
1927             schema:
1928               type: string
1929         required: false
1930       responses:
1931         default:
1932           description: successful operation
1933           content: {}
1934       x-codegen-request-body-name: body
1935   /onap/so/infra/cloudResources/{version}/operationalEnvironments/{operationalEnvironmentId}/activate:
1936     post:
1937       tags:
1938         - onapsoinfracloudResources
1939       summary: Activate an Operational Environment
1940       operationId: activateOperationEnvironment
1941       parameters:
1942         - name: version
1943           in: path
1944           required: true
1945           schema:
1946             pattern: '[vV][1]'
1947             type: string
1948         - name: operationalEnvironmentId
1949           in: path
1950           required: true
1951           schema:
1952             type: string
1953       requestBody:
1954         content:
1955           application/json:
1956             schema:
1957               type: string
1958         required: false
1959       responses:
1960         default:
1961           description: successful operation
1962           content: {}
1963       x-codegen-request-body-name: body
1964   /onap/so/infra/cloudResources/{version}/operationalEnvironments/{operationalEnvironmentId}/deactivate:
1965     post:
1966       tags:
1967         - onapsoinfracloudResources
1968       summary: Deactivate an Operational Environment
1969       operationId: deactivateOperationEnvironment
1970       parameters:
1971         - name: version
1972           in: path
1973           required: true
1974           schema:
1975             pattern: '[vV][1]'
1976             type: string
1977         - name: operationalEnvironmentId
1978           in: path
1979           required: true
1980           schema:
1981             type: string
1982       requestBody:
1983         content:
1984           application/json:
1985             schema:
1986               type: string
1987         required: false
1988       responses:
1989         default:
1990           description: successful operation
1991           content: {}
1992       x-codegen-request-body-name: body
1993   /onap/so/infra/cloudResourcesRequests/{version}/{requestId}/unlock:
1994     post:
1995       tags:
1996         - onapsoinfracloudResourcesRequests
1997       summary: Unlock CloudOrchestration requests for a specified requestId
1998       operationId: unlockOrchestrationRequestForReqId
1999       parameters:
2000         - name: requestId
2001           in: path
2002           required: true
2003           schema:
2004             type: string
2005         - name: version
2006           in: path
2007           required: true
2008           schema:
2009             pattern: '[vV][1]'
2010             type: string
2011       requestBody:
2012         content:
2013           application/json:
2014             schema:
2015               type: string
2016         required: false
2017       responses:
2018         default:
2019           description: successful operation
2020           content: {}
2021       x-codegen-request-body-name: body
2022   /onap/so/infra/cloudResourcesRequests/{version}:
2023     get:
2024       tags:
2025         - onapsoinfracloudResourcesRequests
2026       summary: Get status of an Operational Environment based on filter criteria
2027       operationId: getOperationEnvironmentStatusFilter
2028       parameters:
2029         - name: version
2030           in: path
2031           required: true
2032           schema:
2033             pattern: '[vV][1]'
2034             type: string
2035       responses:
2036         default:
2037           description: successful operation
2038           content: {}
2039   /onap/so/infra/modelDistributions/{version}/distributions/{distributionId}:
2040     post:
2041       tags:
2042         - onapsoinframodelDistributions
2043       summary: Update model distribution status
2044       operationId: updateModelDistributionStatus
2045       parameters:
2046         - name: version
2047           in: path
2048           required: true
2049           schema:
2050             pattern: '[vV][1]'
2051             type: string
2052         - name: distributionId
2053           in: path
2054           required: true
2055           schema:
2056             type: string
2057       requestBody:
2058         content:
2059           application/json:
2060             schema:
2061               type: string
2062         required: false
2063       responses:
2064         default:
2065           description: successful operation
2066           content: {}
2067       x-codegen-request-body-name: body
2068   /onap/so/infra/workflowSpecifications/{version}/workflows:
2069     get:
2070       tags:
2071         - onapsoinfraworkflowSpecifications
2072       summary: Retrieve Workflow details based on the filter criteria
2073       operationId: queryWorkflowSpecifications
2074       parameters:
2075         - name: resourceTarget
2076           in: query
2077           schema:
2078             type: string
2079         - name: version
2080           in: path
2081           required: true
2082           schema:
2083             pattern: '[vV][1]'
2084             type: string
2085       responses:
2086         default:
2087           description: List of workflow specifications on successful operation
2088           content:
2089             application/json:
2090               schema:
2091                 $ref: '#/components/schemas/RetrievingWorkflowResponse'
2092   /onap/so/infra/instanceManagement/{version}/serviceInstances/{serviceInstanceId}/workflows/{workflow_UUID}:
2093     post:
2094       tags:
2095         - onapsoinfrainstanceManagement
2096       summary: Executing service level custom workflow
2097       operationId: executeServiceLevelCustomWorkflow
2098       parameters:
2099         - name: version
2100           in: path
2101           required: true
2102           schema:
2103             pattern: '[vV][1]'
2104             type: string
2105         - name: serviceInstanceId
2106           in: path
2107           required: true
2108           schema:
2109             type: string
2110         - name: workflow_UUID
2111           in: path
2112           required: true
2113           schema:
2114             type: string
2115       requestBody:
2116         content:
2117           application/json:
2118             schema:
2119               $ref: '#/components/schemas/ServiceLevelWorkflowExecution'
2120         required: false
2121       responses:
2122         default:
2123           description: successful operation
2124           content: {}
2125       x-codegen-request-body-name: body
2126   /onap/so/infra/instanceManagement/{version}/serviceInstances/{serviceInstanceId}/pnfs/${pnfName}/workflows/${workflow_UUID}:
2127     post:
2128       tags:
2129         - onapsoinfrainstanceManagement
2130       summary: Executing download/activate custom workflow
2131       operationId: executePNFCustomWorkflow
2132       parameters:
2133         - name: version
2134           in: path
2135           required: true
2136           schema:
2137             pattern: '[vV][1]'
2138             type: string
2139         - name: serviceInstanceId
2140           in: path
2141           required: true
2142           schema:
2143             type: string
2144         - name: pnfName
2145           in: path
2146           required: true
2147           schema:
2148             type: string
2149         - name: workflow_UUID
2150           in: path
2151           required: true
2152           schema:
2153             type: string
2154       requestBody:
2155         content:
2156           application/json:
2157             schema:
2158               $ref: '#/components/schemas/PNFCustomWorkflowExecution'
2159         required: false
2160       responses:
2161         default:
2162           description: successful operation
2163           content: {}
2164       x-codegen-request-body-name: body
2165 components:
2166   schemas:
2167     Allocate3gppService:
2168       type: object
2169       properties:
2170         name:
2171           type: string
2172           description: Name of the service to allocate
2173         modelInvariantUuid:
2174           type: string
2175           description: >-
2176             Model Invariant UUID corresponding to the service. For E.g :  NSST
2177             Model invariant uuid in case of NSSI creation
2178         modelUuid:
2179           type: string
2180           description: >-
2181             Model UUID corresponding to the service. For E.g :  NSST Model uuid
2182             in case of NSSI creation
2183         globalSubscriberId:
2184           type: string
2185         subscriptionServiceType:
2186           type: string
2187           description: Service type for the subscription. For E.G :5G
2188         networkType:
2189           type: string
2190           description: Network type. For E.G :AN/CN/TN
2191         additionalProperties:
2192           type: object
2193           properties: {}
2194           description: Map of additional properties required for service allocation
2195       description: This describes the request body for 3gpp service allocation
2196     DeAllocate3gppService:
2197       type: object
2198       properties:
2199         serviceInstanceID:
2200           type: string
2201           description: ID of the service to terminate
2202         globalSubscriberId:
2203           type: string
2204         subscriptionServiceType:
2205           type: string
2206           description: Service type for the subscription. For E.G :5G
2207         networkType:
2208           type: string
2209           description: Network type. For E.G :AN/CN/TN
2210         additionalProperties:
2211           type: object
2212           properties: {}
2213           description: Map of additional properties required for service deallocation
2214       description: >-
2215         This describes the request body for 3gpp service
2216         Termination/Deallocation
2217     Modify3gppService:
2218       type: object
2219       properties:
2220         name:
2221           type: string
2222           description: Name of the service to modify
2223         serviceInstanceID:
2224           type: string
2225           description: ID of the service to modify
2226         globalSubscriberId:
2227           type: string
2228         subscriptionServiceType:
2229           type: string
2230           description: Service type for the subscription. For E.G :5G
2231         networkType:
2232           type: string
2233           description: Network type. For E.G :AN/CN/TN
2234         additionalProperties:
2235           type: object
2236           properties: {}
2237           description: Map of additional properties required for service modification
2238       description: This describes the request body for 3gpp service modification
2239     3gppServiceActivation:
2240       type: object
2241       properties:
2242         serviceInstanceID:
2243           type: string
2244           description: ID of the service to be activated/deactivated
2245         globalSubscriberId:
2246           type: string
2247         subscriptionServiceType:
2248           type: string
2249           description: Service type for the subscription. For E.G :5G
2250         networkType:
2251           type: string
2252           description: Network type. For E.G :AN/CN/TN
2253         additionalProperties:
2254           type: object
2255           properties: {}
2256           description: >-
2257             Map of additional properties required for service
2258             activation/deactivation
2259       description: This describes the request body for 3gpp service activation/deactivation
2260     QuerySubnetCapability:
2261       type: object
2262       properties:
2263         subnetTypes:
2264           type: array
2265           items:
2266             $ref: '#/components/schemas/SubnetTypes'
2267       description: This describes the subnet capabilities that can be queried
2268     SubnetTypes:
2269       type: string
2270       description: This describes allowed subnet types
2271       enum:
2272         - AN
2273         - AN_NF
2274         - CN
2275         - TN_FH
2276         - TN_MH
2277         - TN_BH
2278     3gppServiceResponse:
2279       type: object
2280       properties:
2281         jobId:
2282           type: string
2283           description: Job ID to be used to identify the status of the job
2284         status:
2285           type: string
2286           description: status of the job
2287         statusDescription:
2288           type: object
2289           properties: {}
2290           description: Description on status in case of erroneous response
2291       description: This describes the response for 3gpp services
2292     RetrievingWorkflowResponse:
2293       type: object
2294       properties:
2295         workflowSpecificationList:
2296           type: array
2297           description: List of Workflow specification data
2298           items:
2299             $ref: '#/components/schemas/WorkflowSpecification'
2300       description: Response body of fetching workflows using resource target
2301     WorkflowSpecification:
2302       type: object
2303       properties:
2304         artifactInfo:
2305           type: object
2306           properties:
2307             artifactType:
2308               type: string
2309               description: Type of the artifact to be queried
2310             artifactUuid:
2311               type: string
2312               description: UUID of the artifact
2313             artifactName:
2314               type: string
2315               description: Name of the artifact
2316             artifactVersion:
2317               type: string
2318               description: Artifact's Version
2319             artifactDescription:
2320               type: string
2321               description: ''
2322             workflowName:
2323               type: string
2324               description: Name of the workflow fetched for the resource type
2325             operationName:
2326               type: string
2327               description: Mapped operation name of the corresponding workflow
2328             workflowSource:
2329               type: string
2330               description: ''
2331             workflowResourceTarget:
2332               type: string
2333               description: Type of Resource mapped against the workflow
2334           description: 'Attributes related to artifact information '
2335       description: This describes workflow specification object
2336     ServiceLevelWorkflowExecution:
2337       type: object
2338       properties:
2339         requestInfo:
2340           type: object
2341           properties:
2342             source:
2343               type: string
2344               description: Name of the sender
2345             suppressRollback:
2346               type: boolean
2347               description: Enable/disable rollback suppression
2348             requestorId:
2349               type: string
2350               description: Id of the sender
2351           description: Request object contains source information
2352         modelInfo:
2353           type: object
2354           properties:
2355             modelType:
2356               type: string
2357               description: Type of the model to be executed
2358             modelInvariantUuid:
2359               type: string
2360               description: Model invariant id corresponding to the service
2361             modelUuid:
2362               type: string
2363               description: Model uuid corresponding to the service
2364             modelVersionId:
2365               type: string
2366               description: Model version of the service instance
2367             modelName:
2368               type: string
2369               description: Name of the service
2370             modelVersion:
2371               type: string
2372               description: Version of the service instance
2373           description: Parameters related to the service model
2374         requestParameters:
2375           type: object
2376           properties:
2377             subscriptionServiceType:
2378               type: string
2379               description: Type of service subscription
2380           description: User parameter object
2381         subscriberInfo:
2382           type: object
2383           properties:
2384             globalSubscriberId:
2385               type: string
2386               description: Id of the subscriber sending the request
2387           description: Subscriber id information
2388         project:
2389           type: object
2390           properties:
2391             projectName:
2392               type: string
2393               description: Name of the target project
2394           description: Information about the target project name
2395         owningEntity:
2396           type: object
2397           properties:
2398             owningEntityId:
2399               type: string
2400               description: Id of the owning Entity
2401             owningEntityName:
2402               type: string
2403               description: Name of the owning Entity
2404           description: Object describes the entity details
2405       description: >-
2406         This describes the request body of service level custom workflow
2407         execution
2408     PNFCustomWorkflowExecution:
2409       type: object
2410       properties:
2411         requestInfo:
2412           type: object
2413           properties:
2414             source:
2415               type: string
2416               description: Name of the sender
2417             suppressRollback:
2418               type: boolean
2419               description: Enable/disable rollback suppression
2420             requestorId:
2421               type: string
2422               description: Id of the sender
2423           description: Request object contains source information
2424         modelInfo:
2425           type: object
2426           properties:
2427             modelType:
2428               type: string
2429               description: Type of the model to be executed
2430             modelInvariantUuid:
2431               type: string
2432               description: Model invariant id corresponding to the service
2433             modelUuid:
2434               type: string
2435               description: Model uuid corresponding to the service
2436             modelVersionId:
2437               type: string
2438               description: Model version of the service instance
2439             modelName:
2440               type: string
2441               description: Name of the service
2442             modelVersion:
2443               type: string
2444               description: Version of the service instance
2445           description: Parameters related to the service model
2446         requestParameters:
2447           type: object
2448           properties:
2449             subscriptionServiceType:
2450               type: string
2451               description: Type of service subscription
2452           description: User parameter object
2453         subscriberInfo:
2454           type: object
2455           properties:
2456             globalSubscriberId:
2457               type: string
2458               description: Id of the subscriber sending the request
2459           description: Subscriber id information
2460         project:
2461           type: object
2462           properties:
2463             projectName:
2464               type: string
2465               description: Name of the target project
2466           description: Information about the target project name
2467         owningEntity:
2468           type: object
2469           properties:
2470             owningEntityId:
2471               type: string
2472               description: Id of the owning Entity
2473             owningEntityName:
2474               type: string
2475               description: Name of the owning Entity
2476           description: Object describes the entity details
2477       description: This describes the request body of PNF custom workflow execution
2478     CreateServiceInstanceParamaters:
2479       type: object
2480       properties:
2481         requestDetails:
2482           type: object
2483           description:  Contains data associated with a request
2484           properties:
2485             requestParameters:
2486               type: object
2487               description: Contains all the parameters, associated with this request
2488               properties:
2489                 subscriptionServiceType:
2490                   type: string
2491                   description: Type of service subscriptions of customer resource
2492                 userParams:
2493                   type: array
2494                   description: Array of data that contains information about Service
2495                   items:
2496                     oneOf:
2497                       - $ref: >-
2498                           #/components/schemas/CreateServiceInstParamsUserParamsHoming
2499                       - $ref: >-
2500                           #/components/schemas/CreateServiceInstParamsUserParamsService
2501                 aLaCarte:
2502                   type: boolean
2503                   description: >-
2504                     Enable “A La Carte” mode. In this mode, the user creates and
2505                     submits operations for each object to be created.
2506                 usePreload:
2507                   type: boolean
2508                   description: Special value required to use additional Policy settings
2509             modelInfo:
2510               type: object
2511               description: Contains information about the currently used Service Model model
2512               properties:
2513                 modelInvariantId:
2514                   type: string
2515                   description: >-
2516                     Unique identifier corresponding to the main definition of a
2517                     model in SDC
2518                 modelType:
2519                   type: string
2520                   description: Type of service model, created in SDC
2521                 modelName:
2522                   type: string
2523                   description: Name of the model, which can change from version to version.
2524                 modelVersion:
2525                   type: string
2526                   description: >-
2527                     Unique identifier corresponding to one version of a model in
2528                     SDC
2529                 modelVersionId:
2530                   type: string
2531                   description: The SDC model version for this resource or service model.
2532                 modelUuid:
2533                   type: string
2534                   description: >-
2535                     Unique identifier corresponding to the main definition of a
2536                     model in SDC
2537                 modelInvariantUuid:
2538                   type: string
2539                   description: >-
2540                     Unique identifier corresponding to the main definition of a
2541                     model in SDC
2542             requestInfo:
2543               type: object
2544               description: Represents some information for the request
2545               properties:
2546                 productFamilyId:
2547                   type: string
2548                   description: SDC catalog service type
2549                 source:
2550                   type: string
2551                   description: Determines only the source from whom the request came
2552                 instanceName:
2553                   type: string
2554                   description: Defines the name of the instance to be created
2555                 suppressRollback:
2556                   type: boolean
2557                   description: >-
2558                     If false – the rollback process will not start if something
2559                     goes wrong in execution BB. If true - QueryRainyDayTable
2560                     task will start and make querying policy in table
2561                     rainy_day_handler_macro
2562                 requestorId:
2563                   type: string
2564                   description: User Id or Application Id, initiating the Assessment
2565             subscriberInfo:
2566               type: object
2567               description: >-
2568                 Represents the object that groups service instances used by a
2569                 customer
2570               properties:
2571                 globalSubscriberId:
2572                   type: string
2573                   description: >-
2574                     Global Subscriber Id used across ONAP to uniquely identify
2575                     subscriber.
2576             project:
2577               type: object
2578               description: Represents the project, which will own the service instance
2579               properties:
2580                 projectName:
2581                   type: string
2582                   description: Name of the project deploying a service
2583             owningEntity:
2584               type: object
2585               description: Represents the entity, which will own the service instance
2586               properties:
2587                 owningEntityId:
2588                   type: string
2589                   description: UUID of an owning entity
2590                 owningEntityName:
2591                   type: string
2592                   description: Owning entity name
2593     CreateServiceInstParamsUserParamsHoming:
2594       allOf:
2595         - type: object
2596           properties:
2597             Homing_Solution:
2598               type: string
2599               description: >-
2600                 Switches on an optimization service to deploy services
2601                 automatically across multiple sites and multiple clouds
2602     CreateServiceInstParamsUserParamsService:
2603       allOf:
2604         - type: object
2605           properties:
2606             service:
2607               type: object
2608               description: Includes information about all created instances
2609               properties:
2610                 instanceParams:
2611                   type: array
2612                   description: Includes a set of specific parameters
2613                   items:
2614                     type: object
2615                     properties: {}
2616                 instanceName:
2617                   type: string
2618                   description: Defines the name of the instance to be created
2619                 resources:
2620                   type: object
2621                   properties:
2622                     vnfs:
2623                       type: array
2624                       description: Contains information about  VNF parameters
2625                       items:
2626                         type: object
2627                         properties:
2628                           modelInfo:
2629                             type: object
2630                             description: Contains information about the currently used Service Model model
2631                             properties:
2632                               modelInvariantId:
2633                                 type: string
2634                                 description: >-
2635                                   Unique identifier corresponding to the main
2636                                   definition of a model in SDC
2637                               modelType:
2638                                 type: string
2639                                 description: Type of Service Model, created in SDC
2640                               modelName:
2641                                 type: string
2642                                 description: >-
2643                                   Name of the model, which can change from
2644                                   version to version.
2645                               modelVersion:
2646                                 type: string
2647                                 description: >-
2648                                   Unique identifier corresponding to one version
2649                                   of a model in SDC
2650                               modelVersionId:
2651                                 type: string
2652                                 description: >-
2653                                   The SDC model version for this resource or
2654                                   service model.
2655                               modelUuid:
2656                                 type: string
2657                                 description: >-
2658                                   Unique identifier corresponding to the main
2659                                   definition of a model in SDC
2660                               modelInvariantUuid:
2661                                 type: string
2662                                 description: >-
2663                                   Unique identifier corresponding to the main
2664                                   definition of a model in SDC
2665                           cloudConfiguration:
2666                             type: object
2667                             properties:
2668                               cloudOwner:
2669                                 type: string
2670                                 description: >-
2671                                   Identifies the vendor and cloud name. First
2672                                   part of composite key should be formatted as
2673                                   vendor-cloudname
2674                               lcpCloudRegionId:
2675                                 type: string
2676                                 description: >-
2677                                   Cloud-owner defined type indicator (Openstack
2678                                   region)
2679                               tenantId:
2680                                 type: string
2681                                 description: Unique id relative to the cloud-region.
2682                           platform:
2683                             type: object
2684                             description: >-
2685                               Represents the platform, on which the VNFs/CNFs
2686                               will run
2687                             properties:
2688                               platformName:
2689                                 type: string
2690                                 description: Name of the platform
2691                           lineOfBusiness:
2692                             type: object
2693                             description: >-
2694                               Represents the business line, owns the VNFs/CNFs
2695                               instances
2696                             properties:
2697                               lineOfBusinessName:
2698                                 type: string
2699                                 description: Name of the line-of-business (product)
2700                           productFamilyId:
2701                             type: string
2702                             description: Define SDC catalog service type
2703                           instanceName:
2704                             type: string
2705                             description: Defines the name of the instance to be created
2706                           instanceParams:
2707                             type: array
2708                             description: Includes a set of specific parameters of instance
2709                             items:
2710                               type: object
2711                               properties: {}
2712                           vfModules:
2713                             type: array
2714                             description: Сontains a set of parameters of VF Modules
2715                             items:
2716                               type: object
2717                               properties:
2718                                 modelInfo:
2719                                   type: object
2720                                   description: Contains information about the currently used Service Model model
2721                                   properties:
2722                                     modelInvariantId:
2723                                       type: string
2724                                       description: >-
2725                                         Unique identifier corresponding to the
2726                                         main definition of a model in SDC
2727                                     modelType:
2728                                       type: string
2729                                       description: Type of service model, created in SDC
2730                                     modelName:
2731                                       type: string
2732                                       description: >-
2733                                         Name of the model, which can change from
2734                                         version to version.
2735                                     modelVersion:
2736                                       type: string
2737                                       description: >-
2738                                         Unique identifier corresponding to one
2739                                         version of a model in SDC
2740                                     modelVersionId:
2741                                       type: string
2742                                       description: >-
2743                                         The SDC model version for this resource
2744                                         or service model.
2745                                     modelUuid:
2746                                       type: string
2747                                       description: >-
2748                                         Unique identifier corresponding to the
2749                                         main definition of a model in SDC
2750                                     modelInvariantUuid:
2751                                       type: string
2752                                       description: >-
2753                                         Unique identifier corresponding to the
2754                                         main definition of a model in SDC
2755                                 instanceName:
2756                                   type: string
2757                                   description: >-
2758                                     Defines the name of the instance to be
2759                                     created
2760                                 instanceParams:
2761                                   type: array
2762                                   description: Includes a set of specific parameters
2763                                   items:
2764                                     type: object
2765                                     properties: {}
2766                 modelInfo:
2767                   type: object
2768                   description: Contains information about the currently used Service Model model
2769                   properties:
2770                     modelName:
2771                       type: string
2772                       description: >-
2773                         Name of the model, which can change from
2774                         version to version.
2775                     modelVersionId:
2776                       type: string
2777                       description: >-
2778                         Unique identifier corresponding to one
2779                         version of a model in SDC
2780                     modelInvariantUuid:
2781                       type: string
2782                       description: >-
2783                         Unique identifier corresponding to the
2784                         main definition of a model in SDC
2785                     modelVersion:
2786                       type: string
2787                       description: >-
2788                         The SDC model version for this resource
2789                         or service model.
2790                     modelCustomizationId:
2791                       type: string
2792                       description: >-
2793                         Unique generated identifier of a model in SDC