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