VNFLifecycleManagement.yaml 97 KB
Newer Older
1 2
swagger: "2.0"

3
info:
4
  version: "1.3.0-impl:etsi.org:ETSI_NFV_OpenAPI:1"
5
  title: SOL002 - VNF Lifecycle Management interface
6
  description: >
7
    SOL002 - VNF Lifecycle Management interface
8
    IMPORTANT: Please note that this file might be not aligned to the current
9 10 11 12
    version of the ETSI Group Specification it refers to and has not been
    approved by the ETSI NFV ISG. In case of discrepancies the published ETSI
    Group Specification takes precedence.
    Please report bugs to https://forge.etsi.org/bugzilla/buglist.cgi?component=Nfv-Openapis
13
  license:
14
    name: ETSI Forge copyright notice
15
    url: https://forge.etsi.org/etsi-forge-copyright-notice.txt
16 17
  contact:
    name: NFV-SOL WG
18

19
externalDocs:
20 21
  description: ETSI GS NFV-SOL 002 V2.6.1
  url: https://www.etsi.org/deliver/etsi_gs/NFV-SOL/001_099/002/02.06.01_60/gs_nfv-sol002v020601p.pdf
22

23
basePath: /vnflcm/v1
24

25
schemes:
26 27 28
  - http
  - https

29
consumes:
30 31
  - application/json

32
produces:
33 34 35
  - application/json

paths:
36 37 38
  ###############################################################################
  # API Versions                                                                #
  ###############################################################################
39
  '/api-versions':
40 41
    $ref: '../../endpoints/SOL002SOL003_endpoints.yaml#/endpoints/api-versions'

42 43 44
  ###############################################################################
  # VNF instances                                                               #
  ###############################################################################
45 46
  '/vnf_instances':
    #SOL003 location: 5.4.2
47 48 49 50 51 52 53
    parameters:
      - name: Version
        description: >
          Version of the API requested to use when responding to this request.
        in: header
        required: true
        type: string
54 55 56 57 58 59 60
      - name: Authorization
        description: >
          The authorization token for the request.
          Reference: IETF RFC 7235
        in: header
        required: false
        type: string
61
    post:
62 63
      description: >
        The POST method creates a new VNF instance resource.
64 65
      parameters:
        - name: createVnfRequest
66 67
          description: >
            The VNF creation parameters, as defined in clause 5.5.2.3.
68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87
          in: body
          required: true
          schema:
            $ref: "../../definitions/SOL002SOL003VNFLifecycleManagement_def.yaml#/definitions/CreateVnfRequest"
        - name: Accept
          description: >
            Content-Types that are acceptable for the response.
            Reference: IETF RFC 7231
          in: header
          required: true
          type: string
        - name: Content-Type
          description: >
            The MIME type of the body of the request.
            Reference: IETF RFC 7231
          in: header
          required: true
          type: string
      responses:
        201:
88 89 90
          description: >
            201 CREATED

91 92 93 94 95 96
            Shall be returned when a new "Individual VNF Instance" resource and 
            the associated VNF instance identifier has been created successfully.
            The response body shall contain a representation of the created VNF 
            instance, as defined in clause 5.5.2.2.
            The HTTP response shall include a "Location" HTTP header that contains 
            the resource URI of the created VNF instance.
97 98
          headers:
            Content-Type:
99 100
              description: >
                The MIME type of the body of the response.
101 102 103 104
              type: string
              maximum: 1
              minimum: 1
            Location:
105 106
              description: >
                The resource URI of the created VNF instance
107 108
              type: string
              format: url
109 110
              maximum: 1
              minimum: 1
111 112 113 114 115 116 117 118
            WWW-Authenticate:
              description: >
                Challenge if the corresponding HTTP request has not provided
                authorization, or error details if the corresponding HTTP
                request has provided an invalid authorization token.
              type: string
              maximum: 1
              minimum: 0
119
            Version:
120 121
              description: >
                The used API version.
122 123 124
              type: string
              maximum: 1
              minimum: 1
125
          schema:
126
            $ref: "definitions/SOL002VNFLifecycleManagement_def.yaml#/definitions/VnfInstance"
127 128 129 130 131 132 133 134 135
        400:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/400"
        401:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/401"
        403:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/403"
        404:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/404"
        405:
136
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/405"
137 138 139 140 141 142
        406:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/406"
        416:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/416"
        422:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/422"
143 144
        429:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/429"
145 146 147 148
        500:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/500"
        503:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/503"
149 150
        504:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/504"
151 152 153 154 155 156 157 158 159 160 161
    get:
      description: >
        The GET method queries information about multiple VNF instances.
      parameters:
        - name: Accept
          description: >
            Content-Types that are acceptable for the response.
            Reference: IETF RFC 7231
          in: header
          required: true
          type: string
162 163
        - name: filter
          description: >
164
            Attribute-based filtering expression according to clause 5.2 of ETSI GS NFV-SOL 013.
165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195
            The VNFM shall support receiving this parameter as part of the URI query string.
            The EM may supply this parameter. All attribute names that appear in the VnfInstance
            and in data types referenced from it shall be supported by the VNFM in the filter expression.
            EXAMPLE
            objects
            obj1: {"id":123, "weight":100, "parts":[{"id":1, "color":"red"}, {"id":2, "color":"green"}]}
            obj2: {"id":456, "weight":500, "parts":[{"id":3, "color":"green"}, {"id":4, "color":"blue"}]}

            Request 1:
            GET …/container

            Response 1:
            [
                {"id":123, "weight":100, "parts":[{"id":1, "color":"red"}, {"id":2, "color":"green"}]},
                {"id":456, "weight":500, "parts":[{"id":3, "color":"green"}, {"id":4, "color":"blue"}]}
            ]

            Request 2:
            GET …/container?filter=(eq.weight,100)

            Response 2:
            [
                {"id":123, "weight":100, "parts":[{"id":1, "color":"red"}, {"id":2, "color":"green"}]}
            ]
          #Request 2 in EXAMPLE from clause 4.3.2 probably wrong, since "," should be used after opOne (eq), "." is used
          in: query
          required: false
          type: string
        - name: all_fields
          description: >
            Include all complex attributes in the response.
196
            See clause 5.3 of ETSI GS NFV-SOL 013 for details. The VNFM shall support this parameter.
197 198 199 200 201 202
          in: query
          required: false
          type: string
        - name: fields
          description: >
            Complex attributes to be included into the response.
203
            See clause 5.3 of ETSI GS NFV-SOL 013 for details. The VNFM should support this parameter.
204 205 206 207 208 209
          in: query
          required: false
          type: string
        - name: exclude_fields
          description: >
            Complex attributes to be excluded from the response.
210
            See clause 5.3 of ETSI GS NFV-SOL 013 for details. The VNFM should support this parameter.
211 212 213 214 215 216
          in: query
          required: false
          type: string
        - name: exclude_default
          description: >
            Indicates to exclude the following complex attributes from the response.
217
            See clause 5.3 of ETSI GS NFV-SOL 013 for details. The VNFM shall support this parameter.
218 219 220 221 222 223 224 225 226 227
            The following attributes shall be excluded from the VnfInstance structure
            in the response body if this parameter is provided, or none of the parameters
            "all_fields," "fields", "exclude_fields", "exclude_default" are provided:
            -	vnfConfigurableProperties
            -	instantiatedVnfInfo
            -	metadata
            -	extensions
          in: query
          required: false
          type: string
228 229
      responses:
        200:
230
          description: >
231
            200 OK
232

233
            Information about zero or more VNF instances has been queried
234
            successfully. The response body shall contain in an array the
235 236 237 238 239 240 241 242 243 244 245 246 247 248 249
            representations of zero or more VNF instances.
          headers:
            Content-Type:
              description: The MIME type of the body of the response.
              type: string
              maximum: 1
              minimum: 1
            WWW-Authenticate:
              description: >
                Challenge if the corresponding HTTP request has not provided
                authorization, or error details if the corresponding HTTP
                request has provided an invalid authorization token.
              type: string
              maximum: 1
              minimum: 0
250 251 252 253 254
            Version:
              description: The used API version.
              type: string
              maximum: 1
              minimum: 1
255 256 257
          schema:
            type: array
            items:
258
              $ref: "definitions/SOL002VNFLifecycleManagement_def.yaml#/definitions/VnfInstance"
259
        400:
260
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/400"
261 262 263 264 265 266 267
        401:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/401"
        403:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/403"
        404:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/404"
        405:
268
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/405"
269 270 271 272
        406:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/406"
        416:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/416"
273 274 275 276
        422:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/422"
        429:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/429"
277 278 279 280
        500:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/500"
        503:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/503"
281 282 283 284 285 286
        504:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/504"

  ###############################################################################
  # Individual VNF instance                                                     #
  ###############################################################################
287 288 289 290 291 292 293 294 295 296 297 298 299
  '/vnf_instances/{vnfInstanceId}':
    #SOL003 location: 5.4.3.2
    parameters:
      - name: vnfInstanceId
        description: >
          Identifier of the VNF instance. This identifier can be retrieved from
          the resource referenced by the "Location" HTTP header in the response
          to a POST request creating a new VNF instance resource. It can also
          be retrieved from the "id" attribute in the payload body of that
          response.
        in: path
        type: string
        required: true
300 301 302 303 304 305
      - name: Version
        description: >
          Version of the API requested to use when responding to this request.
        in: header
        required: true
        type: string
306 307 308 309 310 311 312
      - name: Authorization
        description: >
          The authorization token for the request.
          Reference: IETF RFC 7235
        in: header
        required: false
        type: string
313 314
    get:
      description: >
315
        Information about a VNF instance by reading an "Individual VNF instance".
316 317
      responses:
        200:
318
          description: >
319
            200 OK
320

321 322 323
            Information about an individual VNF instance has been read successfully.
            The response body shall contain a representation of the VNF instance,
            as defined in clause 5.5.2.2.
324 325 326 327 328 329 330 331 332 333 334 335 336 337
          headers:
            Content-Type:
              description: The MIME type of the body of the response.
              type: string
              maximum: 1
              minimum: 1
            WWW-Authenticate:
              description: >
                Challenge if the corresponding HTTP request has not provided
                authorization, or error details if the corresponding HTTP
                request has provided an invalid authorization token.
              type: string
              maximum: 1
              minimum: 0
338 339 340 341 342
            Version:
              description: The used API version.
              type: string
              maximum: 1
              minimum: 1
343
          schema:
344
            $ref: "definitions/SOL002VNFLifecycleManagement_def.yaml#/definitions/VnfInstance"
345 346 347 348 349 350 351 352 353
        400:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/400"
        401:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/401"
        403:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/403"
        404:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/404"
        405:
354
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/405"
355 356 357 358
        406:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/406"
        416:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/416"
359 360 361 362
        422:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/422"
        429:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/429"
363 364 365 366
        500:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/500"
        503:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/503"
367 368
        504:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/504"
369 370 371
    patch:
      #SOL003 location: 5.4.3.3.4
      description: >
372
        This method modifies an "Individual VNF instance" resource. Changes to
373 374 375 376 377 378 379 380 381 382 383
        the VNF configurable properties are applied to the configuration in
        the VNF instance, and are reflected in the representation of this
        resource. Other changes are applied to the VNF instance information
        managed by the VNFM, and are reflected in the representation of this
        resource
      parameters:
        - name: vnfInfoModifications
          description: Input parameters for VNF info modification
          required: true
          in: body
          schema:
384
            $ref: "../../definitions/SOL002SOL003VNFLifecycleManagement_def.yaml#/definitions/VnfInfoModificationRequest"
385 386
      responses:
        202:
387 388 389 390 391
          description: >
            202 ACCEPTED

            The request was accepted for processing, but the processing has not been completed.
            On success, the HTTP response shall include a "Location" HTTP header that contains
392 393
            the URI of the newly-created an "Individual VNF LCM operation occurrence" resource 
            corresponding to the operation.
394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423
            The response body shall be empty.
          headers:
            Content-Type:
              description: The MIME type of the body of the response.
              type: string
              maximum: 1
              minimum: 1
            WWW-Authenticate:
              description: >
                Challenge if the corresponding HTTP request has not provided
                authorization, or error details if the corresponding HTTP
                request has provided an invalid authorization token.
              type: string
              maximum: 1
              minimum: 0
            Version:
              description: The used API version.
              type: string
              maximum: 1
              minimum: 1
            Location:
              description: >
                Used in redirection, or when a new resource has been created.
                This header field shall be present if the response status code is 201 or 3xx.
                In the present document this header field is also used if the response status
                code is 202 and a new resource was created.
              type: string
              format: url
              maximum: 1
              minimum: 1
424
        400:
425
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/400"
426 427 428 429 430 431 432
        401:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/401"
        403:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/403"
        404:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/404"
        405:
433
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/405"
434 435 436
        406:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/406"
        409:
437 438 439 440
          description: >
            409 CONFLICT

            Error: The operation cannot be executed currently, due to a conflict with the state
441
            of the "Individual VNF instance" resource.
442 443 444 445
            Typically, this is due to the fact that another LCM operation is ongoing.
            The response body shall contain a ProblemDetails structure, in which the "detail"
            attribute should convey more information about the error.
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/409"
446 447
        412:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/412"
448 449 450 451 452 453
        416:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/416"
        422:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/422"
        429:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/429"
454 455 456 457
        500:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/500"
        503:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/503"
458 459
        504:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/504"
460 461
    delete:
      description: >
462
        This method deletes an "Individual VNF instance" resource.
463 464
      responses:
        204:
465
          description: >
466
            204 NO CONTENT
467

468
            The "Individual VNF instance" resource and the associated VNF identifier were
469 470 471 472 473 474 475 476 477 478 479
            deleted successfully.
            The response body shall be empty.
          headers:
            WWW-Authenticate:
              description: >
                Challenge if the corresponding HTTP request has not provided
                authorization, or error details if the corresponding HTTP
                request has provided an invalid authorization token.
              type: string
              maximum: 1
              minimum: 0
480 481 482 483 484
            Version:
              description: The used API version.
              type: string
              maximum: 1
              minimum: 1
485
        400:
486
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/400"
487 488 489 490 491 492 493
        401:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/401"
        403:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/403"
        404:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/404"
        405:
494
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/405"
495 496 497
        406:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/406"
        409:
498 499 500 501
          description: >
            409 CONFLICT

            Error: The operation cannot be executed currently, due to a conflict with the state of the resource.
502
            Typically, this is due to the fact that the "Individual VNF instance" resource is in INSTANTIATED state.
503 504 505 506 507 508 509 510 511
            The response body shall contain a ProblemDetails structure, in which the "detail" attribute shall
            convey more information about the error.
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/409"
        416:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/416"
        422:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/422"
        429:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/429"
512 513 514 515
        500:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/500"
        503:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/503"
516 517 518 519 520 521
        504:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/504"

  ###############################################################################
  # Instantiate VNF task                                                        #
  ###############################################################################
522 523 524 525 526 527 528 529 530 531 532 533 534
  '/vnf_instances/{vnfInstanceId}/instantiate':
    #SOL003 location: 5.4.4.2
    parameters:
      - name: vnfInstanceId
        description: >
          Identifier of the VNF instance. This identifier can be retrieved from
          the resource referenced by the "Location" HTTP header in the response
          to a POST request creating a new VNF instance resource. It can also
          be retrieved from the "id" attribute in the payload body of that
          response.
        in: path
        type: string
        required: true
535 536 537 538 539 540
      - name: Version
        description: >
          Version of the API requested to use when responding to this request.
        in: header
        required: true
        type: string
541 542 543 544 545 546 547
      - name: Authorization
        description: >
          The authorization token for the request.
          Reference: IETF RFC 7235
        in: header
        required: false
        type: string
548
    post:
549 550 551 552 553 554 555 556 557
      #SOL003 location: 5.4.4.3.1
      description: >
        The POST method instantiates a VNF instance.
      parameters:
        - name: InstantiateVnfRequest
          description: Parameters for the VNF instantiation.
          in: body
          required: true
          schema:
558
            $ref: "definitions/SOL002VNFLifecycleManagement_def.yaml#/definitions/InstantiateVnfRequest"
559
      responses:
560
        202:
561
          description: >
562
            202 ACCEPTED
563

564
            The request has been accepted for processing, but the processing has not been completed.
565 566 567
            The response body shall be empty.
            The HTTP response shall include a "Location" HTTP header that contains the URI of the
            newly-created "VNF LCM operation occurrence" resource corresponding to the operation.
568 569 570 571 572 573 574 575 576 577 578 579 580 581
          headers:
            Content-Type:
              description: The MIME type of the body of the response.
              type: string
              maximum: 1
              minimum: 1
            WWW-Authenticate:
              description: >
                Challenge if the corresponding HTTP request has not provided
                authorization, or error details if the corresponding HTTP
                request has provided an invalid authorization token.
              type: string
              maximum: 1
              minimum: 0
582 583 584 585 586
            Version:
              description: The used API version.
              type: string
              maximum: 1
              minimum: 1
587 588 589 590 591 592 593 594 595 596
            Location:
              description: >
                Used in redirection, or when a new resource has been created.
                This header field shall be present if the response status code is 201 or 3xx.
                In the present document this header field is also used if the response status
                code is 202 and a new resource was created.
              type: string
              format: url
              maximum: 1
              minimum: 1
597 598 599 600 601 602 603 604 605
        400:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/400"
        401:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/401"
        403:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/403"
        404:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/404"
        405:
606
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/405"
607 608 609
        406:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/406"
        409:
610 611 612 613
          description: >
            409 CONFLICT

            Error: The operation cannot be executed currently, due to a conflict with the state of the resource.
614
            Typically, this is due to the fact that the "Individual VNF instance" resource is in INSTANTIATED state.
615 616 617
            The response body shall contain a ProblemDetails structure, in which the "detail" attribute shall
            convey more information about the error.
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/409"
618 619
        416:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/416"
620 621 622 623
        422:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/422"
        429:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/429"
624 625 626 627
        500:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/500"
        503:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/503"
628 629 630 631 632 633
        504:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/504"

  ###############################################################################
  # Scale VNF task                                                              #
  ###############################################################################
634 635 636 637 638 639 640 641 642 643 644 645 646
  '/vnf_instances/{vnfInstanceId}/scale':
    #SOL003 location: 5.4.5.2
    parameters:
      - name: vnfInstanceId
        description: >
          Identifier of the VNF instance to be scaled. This identifier can be
          retrieved from the resource referenced by the "Location" HTTP header
          in the response to a POST request creating a new VNF instance
          resource. It can also be retrieved from the "id" attribute in the
          payload body of that response.
        in: path
        type: string
        required: true
647 648 649 650 651 652
      - name: Version
        description: >
          Version of the API requested to use when responding to this request.
        in: header
        required: true
        type: string
653 654 655 656 657 658 659
      - name: Authorization
        description: >
          The authorization token for the request.
          Reference: IETF RFC 7235
        in: header
        required: false
        type: string
660
    post:
661 662 663 664 665 666 667 668 669 670 671 672 673
      #SOL003 location: 5.4.5.3.1
      description: >
        The POST method requests to scale a VNF instance resource
        incrementally.
      parameters:
        - name: ScaleVnfRequest
          description: Parameters for the scale VNF operation.
          in: body
          required: true
          schema:
            $ref: "../../definitions/SOL002SOL003VNFLifecycleManagement_def.yaml#/definitions/ScaleVnfRequest"
      responses:
        202:
674 675 676
          description: >
            202 ACCEPTED

677
            The request has been accepted for processing, but the processing has not been completed.
678 679
            The response body shall be empty.
            The HTTP response shall include a "Location" HTTP header that contains the URI of the
680
            newly-created "Individual VNF LCM operation occurrence" resource corresponding to the operation.
681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709
          headers:
            Content-Type:
              description: The MIME type of the body of the response.
              type: string
              maximum: 1
              minimum: 1
            WWW-Authenticate:
              description: >
                Challenge if the corresponding HTTP request has not provided
                authorization, or error details if the corresponding HTTP
                request has provided an invalid authorization token.
              type: string
              maximum: 1
              minimum: 0
            Version:
              description: The used API version.
              type: string
              maximum: 1
              minimum: 1
            Location:
              description: >
                Used in redirection, or when a new resource has been created.
                This header field shall be present if the response status code is 201 or 3xx.
                In the present document this header field is also used if the response status
                code is 202 and a new resource was created.
              type: string
              format: url
              maximum: 1
              minimum: 1
710 711 712 713 714 715 716
        400:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/400"
        401:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/401"
        403:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/403"
        404:
717
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/404"
718
        405:
719
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/405"
720 721 722
        406:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/406"
        409:
723 724 725 726
          description: >
            409 CONFLICT

            Error: The operation cannot be executed currently, due to a conflict with the state of the resource.
727
            Typically, this is due to the fact that the "Individual VNF instance" resource is in NOT_INSTANTIATED state,
728 729 730 731 732 733 734 735 736 737
            or that another lifecycle management operation is ongoing.
            The response body shall contain a ProblemDetails structure, in which the "detail" attribute shall
            convey more information about the error.
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/409"
        416:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/416"
        422:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/422"
        429:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/429"
738 739 740 741
        500:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/500"
        503:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/503"
742 743 744 745 746 747
        504:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/504"

  ###############################################################################
  # Scale VNF to Level task                                                     #
  ###############################################################################
748 749 750 751 752 753 754 755 756 757 758 759 760
  '/vnf_instances/{vnfInstanceId}/scale_to_level':
    #SOL003 location: 5.4.6.2
    parameters:
      - name: vnfInstanceId
        description: >
          Identifier of the VNF instance to be scaled to a target level. This
          identifier can be retrieved from the resource referenced by the
          "Location" HTTP header in the response to a POST request creating a
          new VNF instance resource. It can also be retrieved from the "id"
          attribute in the payload body of that response.
        in: path
        type: string
        required: true
761 762 763 764 765 766
      - name: Version
        description: >
          Version of the API requested to use when responding to this request.
        in: header
        required: true
        type: string
767 768 769 770 771 772 773
      - name: Authorization
        description: >
          The authorization token for the request.
          Reference: IETF RFC 7235
        in: header
        required: false
        type: string
774
    post:
775 776 777 778 779 780 781 782 783 784 785 786 787
      #SOL003 location: 5.4.6.3.1
      description: >
        The POST method requests to scale a VNF instance resource to a target
        level.
      parameters:
        - name: ScaleVnfToLevelRequest
          description: Parameters for the scale VNF to Level operation.
          in: body
          required: true
          schema:
            $ref: "../../definitions/SOL002SOL003VNFLifecycleManagement_def.yaml#/definitions/ScaleVnfToLevelRequest"
      responses:
        202:
788 789 790
          description: >
            202 ACCEPTED

791
            The request has been accepted for processing, but the processing has not been completed.
792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823
            The response body shall be empty.
            The HTTP response shall include a "Location" HTTP header that contains the URI of the
            newly-created "VNF LCM operation occurrence" resource corresponding to the operation.
          headers:
            Content-Type:
              description: The MIME type of the body of the response.
              type: string
              maximum: 1
              minimum: 1
            WWW-Authenticate:
              description: >
                Challenge if the corresponding HTTP request has not provided
                authorization, or error details if the corresponding HTTP
                request has provided an invalid authorization token.
              type: string
              maximum: 1
              minimum: 0
            Version:
              description: The used API version.
              type: string
              maximum: 1
              minimum: 1
            Location:
              description: >
                Used in redirection, or when a new resource has been created.
                This header field shall be present if the response status code is 201 or 3xx.
                In the present document this header field is also used if the response status
                code is 202 and a new resource was created.
              type: string
              format: url
              maximum: 1
              minimum: 1
824 825 826 827 828 829 830
        400:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/400"
        401:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/401"
        403:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/403"
        404:
831
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/404"
832
        405:
833
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/405"
834 835 836
        406:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/406"
        409:
837 838 839 840
          description: >
            409 CONFLICT

            Error: The operation cannot be executed currently, due to a conflict with the state of the resource.
841
            Typically, this is due to the fact that the "Individual VNF instance" resource is in NOT_INSTANTIATED state,
842 843 844 845 846 847 848 849 850 851
            or that another lifecycle management operation is ongoing.
            The response body shall contain a ProblemDetails structure, in which the "detail" attribute shall
            convey more information about the error.
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/409"
        416:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/416"
        422:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/422"
        429:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/429"
852 853 854 855
        500:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/500"
        503:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/503"
856 857 858 859 860 861
        504:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/504"

  ###############################################################################
  # Change VNF Flavour task                                                     #
  ###############################################################################
862 863 864 865 866 867 868 869 870 871 872 873 874 875
  '/vnf_instances/{vnfInstanceId}/change_flavour':
    #SOL003 location: 5.4.7.2
    parameters:
      - name: vnfInstanceId
        description: >
          The identifier of the VNF instance of which the deployment flavour
          is requested to be changed. This identifier can be retrieved from
          the resource referenced by the "Location" HTTP header in the
          response to a POST request creating a new VNF instance resource. It
          can also be retrieved from the "id" attribute in the payload body of
          that response.
        in: path
        type: string
        required: true
876 877 878 879 880 881
      - name: Version
        description: >
          Version of the API requested to use when responding to this request.
        in: header
        required: true
        type: string
882 883 884 885 886 887 888
      - name: Authorization
        description: >
          The authorization token for the request.
          Reference: IETF RFC 7235
        in: header
        required: false
        type: string
889
    post:
890 891 892 893 894 895 896 897
      description: >
        The POST method changes the deployment flavour of a VNF instance.
      parameters:
        - name: ChangeVnfFlavourRequest
          description: Parameters for the Change VNF Flavour operation.
          in: body
          required: true
          schema:
898
            $ref: "definitions/SOl002VNFLifecycleManagement_def.yaml#/definitions/ChangeVnfFlavourRequest"
899 900
      responses:
        202:
901 902 903
          description: >
            202 ACCEPTED

904
            The request has been accepted for processing, but the processing has not been completed.
905 906
            The response body shall be empty.
            The HTTP response shall include a "Location" HTTP header that contains the URI of the
907
            newly-created "Individual VNF LCM operation occurrence" resource corresponding to the operation.
908 909 910 911 912 913 914 915 916 917 918 919 920 921 922 923 924 925 926 927 928 929 930 931 932 933 934 935 936
          headers:
            Content-Type:
              description: The MIME type of the body of the response.
              type: string
              maximum: 1
              minimum: 1
            WWW-Authenticate:
              description: >
                Challenge if the corresponding HTTP request has not provided
                authorization, or error details if the corresponding HTTP
                request has provided an invalid authorization token.
              type: string
              maximum: 1
              minimum: 0
            Version:
              description: The used API version.
              type: string
              maximum: 1
              minimum: 1
            Location:
              description: >
                Used in redirection, or when a new resource has been created.
                This header field shall be present if the response status code is 201 or 3xx.
                In the present document this header field is also used if the response status
                code is 202 and a new resource was created.
              type: string
              format: url
              maximum: 1
              minimum: 1
937 938 939 940 941 942 943
        400:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/400"
        401:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/401"
        403:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/403"
        404:
944
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/404"
945
        405:
946
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/405"
947 948 949
        406:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/406"
        409:
950 951 952 953
          description: >
            409 CONFLICT

            Error: The operation cannot be executed currently, due to a conflict with the state of the resource.
954
            Typically, this is due to the fact that the "Individual VNF instance" resource is in NOT_INSTANTIATED state,
955 956 957 958 959 960 961 962 963 964
            or that another lifecycle management operation is ongoing.
            The response body shall contain a ProblemDetails structure, in which the "detail" attribute shall
            convey more information about the error.
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/409"
        416:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/416"
        422:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/422"
        429:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/429"
965 966 967 968
        500:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/500"
        503:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/503"
969 970 971 972 973 974
        504:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/504"

  ###############################################################################
  # Terminate VNF task                                                          #
  ###############################################################################
975 976 977 978 979 980 981 982 983 984 985 986 987
  '/vnf_instances/{vnfInstanceId}/terminate':
    #SOL003 location: 5.4.8.2
    parameters:
      - name: vnfInstanceId
        description: >
          The identifier of the VNF instance to be terminated. This identifier
          can be retrieved from the resource referenced by the "Location" HTTP
          header in the response to a POST request creating a new VNF instance
          resource. It can also be retrieved from the "id" attribute in the
          payload body of that response.
        in: path
        type: string
        required: true
988 989 990 991 992 993
      - name: Version
        description: >
          Version of the API requested to use when responding to this request.
        in: header
        required: true
        type: string
994 995 996 997 998 999 1000
      - name: Authorization
        description: >
          The authorization token for the request.
          Reference: IETF RFC 7235
        in: header
        required: false
        type: string
1001
    post:
1002 1003 1004 1005 1006 1007 1008 1009
      description: >
        The POST method terminates a VNF instance.
      parameters:
        - name: TerminateVnfRequest
          description: Parameters for the VNF termination.
          in: body
          required: true
          schema:
1010
            $ref: "definitions/SOL002VNFLifecycleManagement_def.yaml#/definitions/TerminateVnfRequest"
1011 1012
      responses:
        202:
1013 1014 1015
          description: >
            202 ACCEPTED

1016
            The request has been accepted for processing.
1017 1018 1019 1020 1021 1022 1023 1024 1025 1026 1027 1028 1029 1030 1031 1032 1033 1034 1035 1036 1037 1038 1039 1040 1041 1042 1043 1044 1045 1046 1047 1048
            The response body shall be empty.
            The HTTP response shall include a "Location" HTTP header that contains the URI of the
            newly-created "VNF LCM operation occurrence" resource corresponding to the operation.
          headers:
            Content-Type:
              description: The MIME type of the body of the response.
              type: string
              maximum: 1
              minimum: 1
            WWW-Authenticate:
              description: >
                Challenge if the corresponding HTTP request has not provided
                authorization, or error details if the corresponding HTTP
                request has provided an invalid authorization token.
              type: string
              maximum: 1
              minimum: 0
            Version:
              description: The used API version.
              type: string
              maximum: 1
              minimum: 1
            Location:
              description: >
                Used in redirection, or when a new resource has been created.
                This header field shall be present if the response status code is 201 or 3xx.
                In the present document this header field is also used if the response status
                code is 202 and a new resource was created.
              type: string
              format: url
              maximum: 1
              minimum: 1
1049 1050 1051 1052 1053 1054 1055 1056 1057
        400:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/400"
        401:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/401"
        403:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/403"
        404:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/404"
        405:
1058
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/405"
1059 1060 1061
        406:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/406"
        409:
1062 1063 1064 1065
          description: >
            409 CONFLICT

            Error: The operation cannot be executed currently, due to a conflict with the state of the resource.
1066
            Typically, this is due to the fact that the "Individual VNF instance" resource is in NOT_INSTANTIATED state,
1067 1068 1069 1070 1071 1072 1073 1074 1075 1076
            or that another lifecycle management operation is ongoing.
            The response body shall contain a ProblemDetails structure, in which the "detail" attribute shall
            convey more information about the error.
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/409"
        416:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/416"
        422:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/422"
        429:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/429"
1077 1078 1079 1080
        500:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/500"
        503:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/503"
1081 1082 1083 1084 1085 1086
        504:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/504"

  ###############################################################################
  # Heal VNF task                                                               #
  ###############################################################################
1087 1088 1089 1090 1091 1092 1093 1094 1095 1096 1097 1098 1099
  '/vnf_instances/{vnfInstanceId}/heal':
    #SOL003 location: 5.4.9.2
    parameters:
      - name: vnfInstanceId
        description: >
          Identifier of the VNF instance to be healed. This identifier can be
          retrieved from the resource referenced by the "Location" HTTP
          header in the response to a POST request creating a new VNF instance
          resource. It can also be retrieved from the "id" attribute in the
          payload body of that response.
        in: path
        type: string
        required: true
1100 1101 1102 1103 1104 1105
      - name: Version
        description: >
          Version of the API requested to use when responding to this request.
        in: header
        required: true
        type: string
1106 1107 1108 1109 1110 1111 1112
      - name: Authorization
        description: >
          The authorization token for the request.
          Reference: IETF RFC 7235
        in: header
        required: false
        type: string
1113
    post:
1114
      description: >
1115
        The POST method requests to heal a VNF instance.
1116 1117 1118 1119 1120 1121
      parameters:
        - name: HealVnfRequest
          description: Parameters for the Heal VNF operation.
          in: body
          required: true
          schema:
1122
            $ref: "definitions/SOl002VNFLifecycleManagement_def.yaml#/definitions/HealVnfRequest"
1123 1124
      responses:
        202:
1125 1126 1127
          description: >
            202 ACCEPTED

1128
            The request has been accepted for processing, but the processing has not been completed.
1129 1130
            The response body shall be empty.
            The HTTP response shall include a "Location" HTTP header that contains the URI of the
1131
            newly-created "Individual VNF LCM operation occurrence" resource corresponding to the operation.
1132 1133 1134 1135 1136 1137 1138 1139 1140 1141 1142 1143 1144 1145 1146 1147 1148 1149 1150 1151 1152 1153 1154 1155 1156 1157 1158 1159 1160
          headers:
            Content-Type:
              description: The MIME type of the body of the response.
              type: string
              maximum: 1
              minimum: 1
            WWW-Authenticate:
              description: >
                Challenge if the corresponding HTTP request has not provided
                authorization, or error details if the corresponding HTTP
                request has provided an invalid authorization token.
              type: string
              maximum: 1
              minimum: 0
            Version:
              description: The used API version.
              type: string
              maximum: 1
              minimum: 1
            Location:
              description: >
                Used in redirection, or when a new resource has been created.
                This header field shall be present if the response status code is 201 or 3xx.
                In the present document this header field is also used if the response status
                code is 202 and a new resource was created.
              type: string
              format: url
              maximum: 1
              minimum: 1
1161 1162 1163 1164 1165 1166 1167
        400:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/400"
        401:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/401"
        403:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/403"
        404:
1168
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/404"
1169
        405:
1170
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/405"
1171 1172 1173
        406:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/406"
        409:
1174 1175 1176 1177
          description: >
            409 CONFLICT

            Error: The operation cannot be executed currently, due to a conflict with the state of the resource.
1178
            Typically, this is due to the fact that the "Individual VNF instance" resource is in NOT_INSTANTIATED state,
1179 1180 1181 1182 1183 1184 1185 1186 1187 1188
            or that another lifecycle management operation is ongoing.
            The response body shall contain a ProblemDetails structure, in which the "detail" attribute shall
            convey more information about the error.
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/409"
        416:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/416"
        422:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/422"
        429:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/429"
1189 1190 1191 1192
        500:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/500"
        503:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/503"
1193 1194 1195 1196 1197 1198
        504:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/504"

  ###############################################################################
  # Operate VNF task                                                            #
  ###############################################################################
1199 1200 1201 1202 1203 1204 1205 1206 1207 1208 1209 1210 1211
  '/vnf_instances/{vnfInstanceId}/operate':
    #SOL003 location: 5.4.9.2
    parameters:
      - name: vnfInstanceId
        description: >
          Identifier of the VNF instance to be operated. This identifier can
          be retrieved from the resource referenced by the "Location" HTTP
          header in the response to a POST request creating a new VNF instance
          resource. It can also be retrieved from the "id" attribute in the
          payload body of that response.
        in: path
        type: string
        required: true
1212 1213 1214 1215 1216 1217
      - name: Version
        description: >
          Version of the API requested to use when responding to this request.
        in: header
        required: true
        type: string
1218 1219 1220 1221 1222 1223 1224
      - name: Authorization
        description: >
          The authorization token for the request.
          Reference: IETF RFC 7235
        in: header
        required: false
        type: string
1225
    post:
1226
      description: >
1227
        The POST method changes the operational state of a VNF instance.
1228 1229 1230 1231 1232 1233
      parameters:
        - name: OperateVnfRequest
          description: Parameters for the Operate VNF operation.
          in: body
          required: true
          schema:
1234
            $ref: "definitions/SOL002VNFLifecycleManagement_def.yaml#/definitions/OperateVnfRequest"
1235 1236
      responses:
        202:
1237 1238 1239
          description: >
            202 ACCEPTED

1240
            The request has been accepted for processing, but the processing has not been completed.
1241 1242 1243 1244 1245 1246 1247 1248 1249 1250 1251 1252 1253 1254 1255 1256 1257 1258 1259 1260 1261 1262 1263 1264 1265 1266 1267 1268 1269 1270 1271 1272
            The response body shall be empty.
            The HTTP response shall include a "Location" HTTP header that contains the URI of the
            newly-created "VNF LCM operation occurrence" resource corresponding to the operation.
          headers:
            Content-Type:
              description: The MIME type of the body of the response.
              type: string
              maximum: 1
              minimum: 1
            WWW-Authenticate:
              description: >
                Challenge if the corresponding HTTP request has not provided
                authorization, or error details if the corresponding HTTP
                request has provided an invalid authorization token.
              type: string
              maximum: 1
              minimum: 0
            Version:
              description: The used API version.
              type: string
              maximum: 1
              minimum: 1
            Location:
              description: >
                Used in redirection, or when a new resource has been created.
                This header field shall be present if the response status code is 201 or 3xx.
                In the present document this header field is also used if the response status
                code is 202 and a new resource was created.
              type: string
              format: url
              maximum: 1
              minimum: 1
1273 1274 1275 1276 1277 1278 1279
        400:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/400"
        401:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/401"
        403:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/403"
        404:
1280
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/404"
1281
        405:
1282
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/405"
1283 1284 1285
        406:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/406"
        409:
1286 1287 1288 1289 1290 1291 1292 1293 1294 1295 1296 1297 1298 1299 1300
          description: >
            409 CONFLICT

            Error: The operation cannot be executed currently, due to a conflict with the state of the resource.
            Typically, this is due to the fact that the VNF instance resource is in NOT_INSTANTIATED state,
            or that another lifecycle management operation is ongoing.
            The response body shall contain a ProblemDetails structure, in which the "detail" attribute shall
            convey more information about the error.
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/409"
        416:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/416"
        422:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/422"
        429:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/429"
1301 1302 1303 1304
        500:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/500"
        503:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/503"
1305 1306 1307 1308 1309 1310 1311
        504:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/504"

  ###############################################################################
  # Change external VNF connectivity task                                       #
  ###############################################################################
  '/vnf_instances/{vnfInstanceId}/change_ext_conn':
1312 1313 1314 1315 1316 1317 1318 1319 1320 1321 1322 1323 1324
    #SOL003 location: 5.4.9.2
    parameters:
      - name: vnfInstanceId
        description: >
          Identifier of the VNF instance of which the external connectivity is
          requested to be changed. This identifier can be retrieved from the
          resource referenced by the "Location" HTTP header in the response to
          a POST request creating a new VNF instance resource. It can also be
          retrieved from the "id" attribute in the payload body of that
          response.
        in: path
        type: string
        required: true
1325 1326 1327 1328 1329 1330
      - name: Version
        description: >
          Version of the API requested to use when responding to this request.
        in: header
        required: true
        type: string
1331 1332 1333 1334 1335 1336 1337
      - name: Authorization
        description: >
          The authorization token for the request.
          Reference: IETF RFC 7235
        in: header
        required: false
        type: string
1338
    post:
1339 1340 1341 1342
      description: >
        The POST method changes the external connectivity of a VNF instance.
      parameters:
        - name: ChangeExtVnfConnectivityRequest
1343
          description: >
1344 1345 1346 1347
            Parameters for the Change external VNF connectivity operation.
          in: body
          required: true
          schema:
1348
            $ref: "definitions/SOL002VNFLifecycleManagement_def.yaml#/definitions/ChangeExtVnfConnectivityRequest"
1349 1350
      responses:
        202:
1351 1352 1353
          description: >
            202 ACCEPTED

1354
            The request has been accepted for processing, but the processing has not been completed.
1355 1356 1357 1358 1359 1360 1361 1362 1363 1364 1365 1366 1367 1368 1369 1370 1371 1372 1373 1374 1375 1376 1377 1378 1379 1380 1381 1382 1383 1384 1385 1386
            The response body shall be empty.
            The HTTP response shall include a "Location" HTTP header that contains the URI of the
            newly-created "VNF LCM operation occurrence" resource corresponding to the operation.
          headers:
            Content-Type:
              description: The MIME type of the body of the response.
              type: string
              maximum: 1
              minimum: 1
            WWW-Authenticate:
              description: >
                Challenge if the corresponding HTTP request has not provided
                authorization, or error details if the corresponding HTTP
                request has provided an invalid authorization token.
              type: string
              maximum: 1
              minimum: 0
            Version:
              description: The used API version.
              type: string
              maximum: 1
              minimum: 1
            Location:
              description: >
                Used in redirection, or when a new resource has been created.
                This header field shall be present if the response status code is 201 or 3xx.
                In the present document this header field is also used if the response status
                code is 202 and a new resource was created.
              type: string
              format: url
              maximum: 1
              minimum: 1
1387 1388 1389 1390 1391 1392 1393 1394 1395
        400:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/400"
        401:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/401"
        403:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/403"
        404:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/404"
        405:
1396
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/405"
1397 1398 1399
        406:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/406"
        409:
1400 1401 1402 1403 1404 1405 1406 1407 1408 1409 1410 1411 1412 1413
          description: >
            409 CONFLICT

            Error: The operation cannot be executed currently, due to a conflict with the state of the resource.
            Typically, this is due to the fact that another lifecycle management operation is ongoing.
            The response body shall contain a ProblemDetails structure, in which the "detail" attribute shall
            convey more information about the error.
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/409"
        416:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/416"
        422:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/422"
        429:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/429"
1414 1415 1416 1417
        500:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/500"
        503:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/503"
1418 1419 1420 1421 1422 1423
        504:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/504"

  ###############################################################################
  # VNF LCM operation occurrences                                               #
  ###############################################################################
1424 1425
  '/vnf_lcm_op_occs':
    #SOL003 location: 5.4.12
1426 1427 1428 1429 1430 1431 1432
    parameters:
      - name: Version
        description: >
          Version of the API requested to use when responding to this request.
        in: header
        required: true
        type: string
1433 1434 1435 1436 1437 1438 1439
      - name: Authorization
        description: >
          The authorization token for the request.
          Reference: IETF RFC 7235
        in: header
        required: false
        type: string
1440
    get:
1441 1442 1443
      description: >
        The client can use this method to query status information about
        multiple VNF lifecycle management operation occurrences.
1444 1445 1446
      parameters:
        - name: filter
          description: >
1447
            Attribute-based filtering expression according to clause 5.2 of ETSI GS NFV-SOL 013.
1448 1449 1450 1451 1452 1453 1454 1455 1456 1457 1458 1459 1460 1461 1462 1463 1464 1465 1466 1467 1468 1469 1470 1471 1472 1473 1474 1475 1476 1477 1478 1479
            The VNFM shall support receiving this parameter as part of the URI query string.
            The EM/VNF may supply this parameter. All attribute names that appear in the VnfLcmOpOcc
            and in data types referenced from it shall be supported by the VNFM in the filter expression.

            EXAMPLE
            objects
            obj1: {"id":123, "weight":100, "parts":[{"id":1, "color":"red"}, {"id":2, "color":"green"}]}
            obj2: {"id":456, "weight":500, "parts":[{"id":3, "color":"green"}, {"id":4, "color":"blue"}]}

            Request 1:
            GET …/container

            Response 1:
            [
                {"id":123, "weight":100, "parts":[{"id":1, "color":"red"}, {"id":2, "color":"green"}]},
                {"id":456, "weight":500, "parts":[{"id":3, "color":"green"}, {"id":4, "color":"blue"}]}
            ]

            Request 2:
            GET …/container?filter=(eq.weight,100)

            Response 2:
            [
                {"id":123, "weight":100, "parts":[{"id":1, "color":"red"}, {"id":2, "color":"green"}]}
            ]
          #Request 2 in EXAMPLE from clause 4.3.2 probably wrong, since "," should be used after opOne (eq), "." is used
          in: query
          required: false
          type: string
        - name: all_fields
          description: >
            Include all complex attributes in the response.
1480
            See clause 5.3 of ETSI GS NFV-SOL 013 for details. The VNFM shall support this parameter.
1481 1482 1483 1484 1485 1486
          in: query
          required: false
          type: string
        - name: fields
          description: >
            Complex attributes to be included into the response.
1487
            See clause 5.3 of ETSI GS NFV-SOL 013 for details. The VNFM should support this parameter.
1488 1489 1490 1491 1492 1493
          in: query
          required: false
          type: string
        - name: exclude_fields
          description: >
            Complex attributes to be excluded from the response.
1494
            See clause 5.3 of ETSI GS NFV-SOL 013 for details. The VNFM should support this parameter.
1495 1496 1497 1498 1499 1500
          in: query
          required: false
          type: string
        - name: exclude_default
          description: >
            Indicates to exclude the following complex attributes from the response.
1501
            See clause 5.3 of ETSI GS NFV-SOL 013 for details. The VNFM shall support this parameter.
1502 1503 1504 1505 1506 1507 1508 1509 1510 1511 1512 1513 1514 1515
            The following attributes shall be excluded from the VnfLcmOpOcc structure
            in the response body if this parameter is provided, or none of the parameters
            "all_fields", "fields", "exclude_fields", "exclude_default" are provided:
            -	operationParams
            -	error
            -	resourceChanges
            -	changedInfo
            -	changedExtConnectivity
          in: query
          required: false
          type: string
        - name: nextpage_opaque_marker
          description: >
            Marker to obtain the next page of a paged response.
1516 1517 1518
            Shall be supported by the VNFM if the VNFM supports 
            alternative 2 (paging) according to clause 5.4.2.1 
            of ETSI GS NFV-SOL 013 for this resource.
1519 1520 1521
          in: query
          required: false
          type: string
1522 1523 1524
      responses:
        200:
          description: >
1525
            200 OK
1526

1527 1528 1529 1530 1531 1532 1533 1534 1535
            Status information for zero or more VNF lifecycle management operation 
            occurrences has been queried successfully.
            The response body shall contain in an array the status information 
            about zero or more VNF lifecycle operation occurrences, as defined in 
            clause 5.5.2.13.
            If the VNFM supports alternative 2 (paging) according to clause 5.4.2.1 
            of ETSI GS NFV-SOL 013 for this resource, inclusion of the Link HTTP 
            header in this response shall follow the provisions in clause 5.4.2.3 
            of ETSI GS NFV-SOL 013.
1536 1537 1538 1539 1540 1541 1542 1543 1544 1545 1546 1547 1548 1549
          headers:
            Content-Type:
              description: The MIME type of the body of the response.
              type: string
              maximum: 1
              minimum: 1
            WWW-Authenticate:
              description: >
                Challenge if the corresponding HTTP request has not provided
                authorization, or error details if the corresponding HTTP
                request has provided an invalid authorization token.
              type: string
              maximum: 1
              minimum: 0
1550
            Version:
1551 1552
              description: >
                The used API version.
1553 1554 1555
              type: string
              maximum: 1
              minimum: 1
1556 1557 1558 1559 1560 1561
            Link:
              description: >
                Reference to other resources. Used for paging in the present document, see clause 4.7.2.1.
              type: string
              maximum: 1
              minimum: 0
1562
            schema:
1563
          schema:
1564
            $ref: "../../definitions/SOL002SOL003VNFLifecycleManagement_def.yaml#/definitions/VnfLcmOpOcc"
1565 1566 1567 1568 1569 1570 1571 1572 1573
        400:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/400"
        401:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/401"
        403:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/403"
        404:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/404"
        405:
1574
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/405"
1575 1576
        406:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/406"
1577 1578 1579 1580 1581 1582
        416:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/416"
        422:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/422"
        429:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/429"
1583 1584 1585 1586
        500:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/500"
        503:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/503"
1587 1588
        504:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/504"
1589
   ###############################################################################
1590 1591
  # Individual VNF LCM operation occurrence                                     #
  ###############################################################################
1592 1593 1594 1595 1596 1597 1598 1599 1600 1601 1602 1603 1604 1605
  '/vnf_lcm_op_occs/{vnfLcmOpOccId}':
    #SOL003 location: 5.4.13
    parameters:
      - name: vnfLcmOpOccId
        description: >
          Identifier of a VNF lifecycle management operation occurrence.
          This identifier can be retrieved from the resource referenced by the
          "Location" HTTP header in the response to a PATCH or POST request
          triggering a VNF LCM operation. It can also be retrieved from the
          "vnfLcmOpOccId" attribute in the
          VnfLcmOperationOccurrenceNotification.
        in: path
        required: true
        type: string
1606 1607 1608 1609 1610 1611
      - name: Version
        description: >
          Version of the API requested to use when responding to this request.
        in: header
        required: true
        type: string
1612 1613 1614 1615 1616 1617 1618
      - name: Authorization
        description: >
          The authorization token for the request.
          Reference: IETF RFC 7235
        in: header
        required: false
        type: string
1619
    get:
1620 1621
      description: >
        The client can use this method to retrieve status information about a
1622 1623
        VNF lifecycle management operation occurrence by reading an "Individual
        VNF LCM operation occurrence" resource.
1624 1625 1626
      responses:
        200:
          description: >
1627
            200 OK
1628

1629 1630 1631
            Information about an individual VNF instance has been queried
            successfully. The response body shall contain status information 
            about a VNF lifecycle management operation occurrence.
1632 1633 1634 1635 1636 1637 1638 1639 1640 1641 1642 1643 1644 1645
          headers:
            Content-Type:
              description: The MIME type of the body of the response.
              type: string
              maximum: 1
              minimum: 1
            WWW-Authenticate:
              description: >
                Challenge if the corresponding HTTP request has not provided
                authorization, or error details if the corresponding HTTP
                request has provided an invalid authorization token.
              type: string
              maximum: 1
              minimum: 0
1646 1647 1648 1649 1650
            Version:
              description: The used API version.
              type: string
              maximum: 1
              minimum: 1
1651
          schema:
1652
            $ref: "../../definitions/SOL002SOL003VNFLifecycleManagement_def.yaml#/definitions/VnfLcmOpOcc"
1653 1654 1655 1656 1657 1658 1659 1660 1661
        400:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/400"
        401:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/401"
        403:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/403"
        404:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/404"
        405:
1662
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/405"
1663 1664
        406:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/406"
1665 1666 1667 1668 1669 1670
        416:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/416"
        422:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/422"
        429:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/429"
1671 1672 1673 1674
        500:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/500"
        503:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/503"
1675 1676 1677 1678 1679 1680
        504:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/504"

  ###############################################################################
  # Retry operation task                                                        #
  ###############################################################################
1681 1682 1683 1684 1685 1686 1687 1688 1689 1690 1691 1692 1693 1694
  '/vnf_lcm_op_occs/{vnfLcmOpOccId}/retry':
    #SOL003 location: 5.4.14
    parameters:
      - name: vnfLcmOpOccId
        description: >
          Identifier of a VNF lifecycle management operation occurrence to be
          retried. This identifier can be retrieved from the resource
          referenced by the "Location" HTTP header in the response to a PATCH
          or POST request triggering a VNF LCM operation. It can also be
          retrieved from the "vnfLcmOpOccId" attribute in the
          VnfLcmOperationOccurrenceNotification.
        in: path
        required: true
        type: string
1695 1696 1697 1698 1699 1700
      - name: Version
        description: >
          Version of the API requested to use when responding to this request.
        in: header
        required: true
        type: string
1701 1702 1703 1704 1705 1706 1707
      - name: Authorization
        description: >
          The authorization token for the request.
          Reference: IETF RFC 7235
        in: header
        required: false
        type: string
1708
    post:
1709 1710 1711
      description: >
        The POST method initiates retrying a VNF lifecycle operation if that
        operation has experienced a temporary failure, i.e. the related
1712 1713
        "Individual VNF LCM operation occurrence" resource is in "FAILED_TEMP" 
        state.
1714 1715
      responses:
        202:
1716 1717 1718
          description: >
            202 ACCEPTED

1719 1720
            The request has been accepted for processing, but processing has 
            not been completed.
1721 1722 1723 1724 1725 1726 1727 1728 1729 1730 1731 1732 1733 1734 1735
            The response shall have an empty payload body.
          headers:
            WWW-Authenticate:
              description: >
                Challenge if the corresponding HTTP request has not provided
                authorization, or error details if the corresponding HTTP
                request has provided an invalid authorization token.
              type: string
              maximum: 1
              minimum: 0
            Version:
              description: The used API version.
              type: string
              maximum: 1
              minimum: 1
1736 1737 1738 1739 1740 1741 1742
        400:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/400"
        401:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/401"
        403:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/403"
        404:
1743
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/404"
1744
        405:
1745
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/405"
1746 1747 1748
        406:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/406"
        409:
1749 1750 1751 1752 1753 1754 1755 1756 1757 1758 1759 1760 1761 1762 1763 1764
          description: >
            409 CONFLICT

            Error: The operation cannot be executed currently, due to a conflict with the state of
            the VNF LCM operation occurrence resource.
            Typically, this is due to the fact that the VNF LCM operation occurrence is not in FAILED_TEMP state
            or another error handling action is starting such as rollback or fail.
            The response body shall contain a ProblemDetails structure, in which the "detail" attribute shall
            convey more information about the error.
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/409"
        416:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/416"
        422:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/422"
        429:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/429"
1765 1766 1767 1768
        500:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/500"
        503:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/503"
1769 1770 1771 1772 1773 1774
        504:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/504"

  ###############################################################################
  # Rollback operation task                                                     #
  ###############################################################################
1775 1776 1777 1778 1779 1780 1781 1782 1783 1784 1785 1786 1787 1788
  '/vnf_lcm_op_occs/{vnfLcmOpOccId}/rollback':
    #SOL003 location: 5.4.15  
    parameters:
      - name: vnfLcmOpOccId
        description: >
          Identifier of a VNF lifecycle management operation occurrence to be
          be rolled back. This identifier can be retrieved from the resource
          referenced by the "Location" HTTP header in the response to a PATCH
          or POST request triggering a VNF LCM operation. It can also be
          retrieved from the "vnfLcmOpOccId" attribute in the
          VnfLcmOperationOccurrenceNotification.
        in: path
        required: true
        type: string
1789 1790 1791 1792 1793 1794
      - name: Version
        description: >
          Version of the API requested to use when responding to this request.
        in: header
        required: true
        type: string
1795 1796 1797 1798 1799 1800 1801
      - name: Authorization
        description: >
          The authorization token for the request.
          Reference: IETF RFC 7235
        in: header
        required: false
        type: string
1802
    post:
1803 1804 1805
      description: >
        The POST method initiates rolling back a VNF lifecycle operation if
        that operation has experienced a temporary failure, i.e. the related
1806 1807
        "Individual VNF LCM operation occurrence" resource is in "FAILED_TEMP" 
        state.
1808 1809
      responses:
        202:
1810 1811 1812
          description: >
            202 ACCEPTED

1813
            The request has been accepted for processing, but processing has not been completed.
1814 1815 1816 1817 1818 1819 1820 1821 1822 1823 1824 1825 1826 1827 1828
            The response shall have an empty payload body.
          headers:
            WWW-Authenticate:
              description: >
                Challenge if the corresponding HTTP request has not provided
                authorization, or error details if the corresponding HTTP
                request has provided an invalid authorization token.
              type: string
              maximum: 1
              minimum: 0
            Version:
              description: The used API version.
              type: string
              maximum: 1
              minimum: 1
1829 1830 1831 1832 1833 1834 1835
        400:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/400"
        401:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/401"
        403:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/403"
        404:
1836
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/404"
1837
        405:
1838
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/405"
1839 1840 1841
        406:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/406"
        409: