Skip to content
VNFLifecycleManagement.yaml 76 KiB
Newer Older
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 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 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 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 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 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 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 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 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 876 877 878 879 880 881 882 883 884 885 886 887 888 889 890 891 892 893 894 895 896 897 898 899 900 901 902 903 904 905 906 907 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 937 938 939 940 941 942 943 944 945 946 947 948 949 950 951 952 953 954 955 956 957 958 959 960 961 962 963 964 965 966 967 968 969 970 971 972 973 974 975 976 977 978 979 980 981 982 983 984 985 986 987 988 989 990 991 992 993 994 995 996 997 998 999 1000
swagger: "2.0"

info:
  version: "2.3.0"
  title: SOL003
  license:
    name: "ETSI Forge copyright notice"
    url: https://forge.etsi.org/etsi-forge-copyright-notice.txt

basePath: "/vnflcm/v1"

schemes:
  - https

consumes:
  - "application/json"
produces:
  - "application/json"

paths:
###############################################################################
# VNF instances                                                               #
###############################################################################
  '/vnf_instances':
    #SOL003 location: 5.4.2
    post:
      #TODO: Add headers defined in 4.3.4.2
      description: "The POST method creates a new VNF instance resource."
      parameters:
        - name: createVnfRequest
          description: The VNF creation parameters
          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: Authorization
          description: >
            The authorization token for the request.
            Reference: IETF RFC 7235
          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:
          description: A VNF Instance identifier was created successfully
          headers:
            #TODO: Add headers defined in 4.3.4.3
            Content-Type:
              description: The MIME type of the body of the response.
              type: string
              maximum: 1
              minimum: 1
            Location:
              description: The resource URI of the created VNF instance
              type: string
              format: url
            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
          schema:
            $ref: "definitions/VNFLifecycleManagement_def.yaml#/definitions/VnfInstance"
        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:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/404"
        406:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/406"
        409:
          $ref: "responses/VNFLifecycleManagement_resp.yaml#/responses/409-inconsistent-state"
        416:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/416"
        422:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/422"
        500:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/500"
        503:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/503"
    get:
      description: >
        The GET method queries information about multiple VNF instances.
      parameters:
        - name: filter
          description: >
            Attribute-based filtering parameters. The VNFM shall support
            receiving filtering parameters as part of the URI query string.
            The NFVO may supply filtering parameters. All attribute names
            that appear in the VnfInstance and in data types referenced
            from it shall be supported in attribute-based filtering
            parameters.
          in: query
          minimum: 0
          maximum: 1
          type: array
          allowEmptyValue: true
          collectionFormat: multi
          items:
            type: string
            pattern: '[a-zA-Z][.a-zA-Z]*\.(eq|neq|gt|lt|gte|lte|cont|ncont)\?=[0-9](,[0-9])*'
        - name: all_fields
          description: >
            Include all complex attributes in the response. This URI query
            parameter requests that all complex attributes are included in
            the response, including those suppressed by exclude_default. It
            is inverse to the "exclude_default" parameter. The API producer 
            shall support this parameter for certain resources. Details are
            defined in the clauses specifying the actual resources. The VNFM
            shall support this parameter.
          in: query
          minimum: 0
          maximum: 1
          type: boolean
        - name: fields
          description: >
            Complex attributes to be included into the response. This URI
            query parameter requests that only the listed complex
            attributes are included in the response.
            The parameter shall be formatted as a list of attribute names.
            An attribute name shall either be the name of an attribute, or a
            path consisting of the names of multiple attributes with
            parent-child relationship, separated by ".". Attribute names in
            the list shall be separated by comma (","). Valid attribute
            names for a particular GET request are the names of all complex
            attributes in the expected response that have a lower cardinality
            bound of 0 and that are not conditionally mandatory.
            The API producer should support this parameter for certain
            resources. Details are defined in the clauses specifying the
            actual resources.
            The VNFM should support this parameter.
          in: query
          minimum: 0
          maximum: 1
          type: array
          collectionFormat: csv
          items:
            type: string
            pattern: '(([a-zA-Z])?(\.[a-zA-Z])*)?,(([a-zA-Z])?(\.[a-zA-Z])*)*'
        - name: exclude_fields
          description: >
            Complex attributes to be excluded from the response. This URI
            query parameter requests that the listed complex attributes are
            excluded from the response. For the format, eligible attributes
            and support by the API producer, the provisions defined for the
            "fields" parameter shall apply.
            The VNFM should support this parameter.
          in: query
          minimum: 0
          maximum: 1
          type: array
          collectionFormat: csv
          items:
            type: string
            pattern: '(([a-zA-Z])?(\.[a-zA-Z])*)?,(([a-zA-Z])?(\.[a-zA-Z])*)*'
        - name: exclude_default
          description: >
            Indicates to exclude the following complex attributes from the
            response.
            Presence of this URI query parameter requests that a default set
            of complex attributes shall be excluded from the response. The
            default set is defined per resource in the present document. Not
            every resource will necessarily have such a default set. Only
            complex attributes with a lower cardinality bound of zero that are
            not conditionally mandatory can be included in the set.
            The API producer shall support this parameter for certain
            resources. Details are defined in the clauses specifying the
            actual resources. This parameter is a flag, i.e. it has no
            value.
            If a resource supports attribute selectors and none of the
            attribute selector parameters is specified in a GET request, the
            "exclude_default" parameter shall be assumed as the default.
            The VNFM shall support this parameter.
            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
            * vimConnectionInfo
            * instantiatedVnfInfo
            * metadata
            * extensions
          in: query
          minimum: 0
          maximum: 1
          type: boolean
        - name: Accept
          description: >
            Content-Types that are acceptable for the response.
            Reference: IETF RFC 7231
          in: header
          required: true
          type: string
        - name: Authorization
          description: >
            The authorization token for the request.
            Reference: IETF RFC 7235
          in: header
          required: true
          type: string
      responses:
        200:
          description: > 
            Information about zero or more VNF instances was queried
            successfully. The response body shall contain
            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
          schema:
            type: array
            items:
              $ref: "definitions/VNFLifecycleManagement_def.yaml#/definitions/VnfInstance"
        400:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/400-attr-selector"
        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:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/404"
        406:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/406"
        409:
          $ref: "responses/VNFLifecycleManagement_resp.yaml#/responses/409-inconsistent-state"
        416:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/416"
        500:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/500"
        503:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/503"
###############################################################################
# Individual VNF instance                                                     #
###############################################################################
  '/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
    get:
      description: >
        Information about an individual VNF instance was queried successfully.
      responses:
        200:
          description: > 
            Information about zero or more VNF instances was queried
            successfully. The response body shall contain
            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
          schema:
            $ref: "definitions/VNFLifecycleManagement_def.yaml#/definitions/VnfInstance"
        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:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/404"
        406:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/406"
        409:
          $ref: "responses/VNFLifecycleManagement_resp.yaml#/responses/409-inconsistent-state"
        416:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/416"
        500:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/500"
        503:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/503"
    patch:
      #SOL003 location: 5.4.3.3.4
      description: >
        This method modifies an individual VNF instance resource. Changes to
        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:
            $ref: "../../definitions/SOL002SOL003VNFLifecycleManagement_def.yaml#/definitions/VnfInfoModifications"
      responses:
        202:
          $ref: "responses/VNFLifecycleManagement_resp.yaml#/responses/202-with-Location"
        400:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/400-attr-selector"
        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:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/404"
        406:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/406"
        409:
          $ref: "responses/VNFLifecycleManagement_resp.yaml#/responses/409-another-lcm-operation-ongoing"
        412:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/412"
        500:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/500"
        503:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/503"
    delete:
      #SOL003 location: 5.4.3.3.5
      description: >
        This method deletes an individual VNF instance resource.
      responses:
        204:
          description: > 
            The VNF instance resource and the associated VNF identifier were
            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
        400:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/400-attr-selector"
        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:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/404"
        406:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/406"
        409:
          $ref: "responses/VNFLifecycleManagement_resp.yaml#/responses/409-state-conflict-INSTANTIATED"
        412:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/412"
        500:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/500"
        503:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/503"
###############################################################################
# Instantiate VNF task                                                        #
###############################################################################
  '/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
    post: 
      #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:
            $ref: "definitions/VNFLifecycleManagement_def.yaml#/definitions/InstantiateVnfRequest"
      responses:
        200:
          description: > 
            Information about zero or more VNF instances was queried
            successfully. The response body shall contain
            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
          schema:
            $ref: "definitions/VNFLifecycleManagement_def.yaml#/definitions/VnfInstance"
        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:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/404"
        406:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/406"
        409:
          $ref: "responses/VNFLifecycleManagement_resp.yaml#/responses/409-state-conflict-INSTANTIATED"
        416:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/416"
        500:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/500"
        503:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/503"
    get:
      description: >
        Information about an individual VNF instance was queried successfully.
      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
      responses:
        200:
          description: > 
            Information about zero or more VNF instances was queried
            successfully. The response body shall contain
            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
          schema:
            $ref: "definitions/VNFLifecycleManagement_def.yaml#/definitions/VnfInstance"
        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:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/404"
        406:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/406"
        409:
          $ref: "responses/VNFLifecycleManagement_resp.yaml#/responses/409-inconsistent-state"
        416:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/416"
        500:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/500"
        503:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/503"
    patch:
      #SOL003 location: 5.4.3.3.4
      description: >
        This method modifies an individual VNF instance resource. Changes to
        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:
            $ref: "../../definitions/SOL002SOL003VNFLifecycleManagement_def.yaml#/definitions/VnfInfoModifications"
        - 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
      responses:
        202:
          $ref: "responses/VNFLifecycleManagement_resp.yaml#/responses/202-with-Location"
        400:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/400-attr-selector"
        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:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/404"
        406:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/406"
        409:
          $ref: "responses/VNFLifecycleManagement_resp.yaml#/responses/409-inconsistent-state"
        412:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/412"
        500:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/500"
        503:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/503"
    delete:
      #SOL003 location: 5.4.3.3.5
      description: >
        This method deletes an individual VNF instance resource.
      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
      responses:
        204:
          description: > 
            The VNF instance resource and the associated VNF identifier were
            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
        400:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/400-attr-selector"
        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:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/404"
        406:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/406"
        409:
          $ref: "responses/VNFLifecycleManagement_resp.yaml#/responses/409-inconsistent-state"
        412:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/412"
        500:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/500"
        503:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/503"
###############################################################################
# Scale VNF task                                                              #
###############################################################################
  '/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
    post: 
      #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:
          $ref: "responses/VNFLifecycleManagement_resp.yaml#/responses/202-with-Location"
        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-task-not-suported"
        405:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/404"
        406:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/406"
        409:
          $ref: "responses/VNFLifecycleManagement_resp.yaml#/responses/409-state-conflict-NOT-INSTANTIATED"
        500:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/500"
        503:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/503"
###############################################################################
# Scale VNF to Level task                                                     #
###############################################################################
  '/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
    post: 
      #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:
          $ref: "responses/VNFLifecycleManagement_resp.yaml#/responses/202-with-Location"
        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-task-not-suported"
        405:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/404"
        406:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/406"
        409:
          $ref: "responses/VNFLifecycleManagement_resp.yaml#/responses/409-state-conflict-NOT-INSTANTIATED"
        500:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/500"
        503:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/503"
###############################################################################
# Change VNF Flavour task                                                     #
###############################################################################
  '/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
    post: 
      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:
            $ref: "definitions/VNFLifecycleManagement_def.yaml#/definitions/ChangeVnfFlavourRequest"
      responses:
        202:
          $ref: "responses/VNFLifecycleManagement_resp.yaml#/responses/202-with-Location"
        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-task-not-suported"
        405:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/404"
        406:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/406"
        409:
          $ref: "responses/VNFLifecycleManagement_resp.yaml#/responses/409-state-conflict-NOT-INSTANTIATED"
        500:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/500"
        503:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/503"
###############################################################################
# Terminate VNF task                                                         #
###############################################################################
  '/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
    post: 
      description: >
        The POST method terminates a VNF instance.
      parameters:
        - name: TerminateVnfRequest
          description: Parameters for the VNF termination.
          in: body
          required: true
          schema:
            $ref: "definitions/VNFLifecycleManagement_def.yaml#/definitions/TerminateVnfRequest"
      responses:
        202:
          $ref: "responses/VNFLifecycleManagement_resp.yaml#/responses/202-with-Location"
        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:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/404"
        406:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/406"
        409:
          $ref: "responses/VNFLifecycleManagement_resp.yaml#/responses/409-state-conflict-NOT-INSTANTIATED"
        500:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/500"
        503:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/503"
###############################################################################
# Heal VNF task                                                               #
###############################################################################
  '/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
    post: 
      description: >
        The POST method requests to heal a VNF instance resource.
      parameters:
        - name: HealVnfRequest
          description: Parameters for the Heal VNF operation.
          in: body
          required: true
          schema:
            $ref: "definitions/VNFLifecycleManagement_def.yaml#/definitions/HealVnfRequest"
      responses:
        202:
          $ref: "responses/VNFLifecycleManagement_resp.yaml#/responses/202-with-Location"
        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-task-not-suported"
        405:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/404"
        406:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/406"
        409:
          $ref: "responses/VNFLifecycleManagement_resp.yaml#/responses/409-state-conflict-NOT-INSTANTIATED"
        500:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/500"
        503:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/503"
###############################################################################
# Operate VNF task                                                            #
###############################################################################
  '/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
    post: 
      description: >
        The POST method changes the operational state of a VNF instance resource.
      parameters:
        - name: OperateVnfRequest
          description: Parameters for the Operate VNF operation.
          in: body
          required: true
          schema:
            $ref: "definitions/VNFLifecycleManagement_def.yaml#/definitions/OperateVnfRequest"
      responses:
        202:
          $ref: "responses/VNFLifecycleManagement_resp.yaml#/responses/202-with-Location"
        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-task-not-suported"
        405:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/404"
        406:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/406"
        409:
          $ref: "responses/VNFLifecycleManagement_resp.yaml#/responses/409-state-conflict-NOT-INSTANTIATED"
        500:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/500"
        503:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/503"
###############################################################################
# Change external VNF connectivity task                                       #
###############################################################################
  '/vnf_instances/{vnfInstanceId}/change_ext_vls':
    #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
    post: 
      description: >
        The POST method changes the external connectivity of a VNF instance.
      parameters:
        - name: ChangeExtVnfConnectivityRequest
          description: > 
            Parameters for the Change external VNF connectivity operation.
          in: body
          required: true
          schema:
            $ref: "definitions/VNFLifecycleManagement_def.yaml#/definitions/ChangeExtVnfConnectivityRequest"
      responses:
        202:
          $ref: "responses/VNFLifecycleManagement_resp.yaml#/responses/202-with-Location"
        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:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/404"
        406:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/406"
        409:
          $ref: "responses/VNFLifecycleManagement_resp.yaml#/responses/409-another-lcm-operation-ongoing"
        500:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/500"
        503:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/503"
###############################################################################
# VNF LCM operation occurrences                                               #
###############################################################################
  '/vnf_lcm_op_occs':
    #SOL003 location: 5.4.12
    get: 
      description: >
        The client can use this method to query status information about
        multiple VNF lifecycle management operation occurrences.
      parameters:
        - name: filter
          description: >
            Attribute-based filtering parameters. The VNFM shall support
            receiving filtering parameters as part of the URI query string.
            The NFVO may supply filtering parameters. All attribute names
            that appear in the VnfLcmOpOcc and in data types referenced
            from it shall be supported in attribute-based filtering
            parameters.
          in: query
          minimum: 0
          maximum: 1
          type: array
          allowEmptyValue: true
          collectionFormat: multi
          items:
            type: string
            pattern: '[a-zA-Z][.a-zA-Z]*\.(eq|neq|gt|lt|gte|lte|cont|ncont)\?=[0-9](,[0-9])*'
        - name: all_fields
          description: >
            Include all complex attributes in the response. This URI query
            parameter requests that all complex attributes are included in
            the response, including those suppressed by exclude_default. It
            is inverse to the "exclude_default" parameter. The API producer 
            shall support this parameter for certain resources. Details are
            defined in the clauses specifying the actual resources. The VNFM