VNFLifecycleManagement.yaml 98.9 KB
Newer Older
swagger: "2.0"

info:
  version: "1.3.0-impl:etsi.org:ETSI_NFV_OpenAPI:1"
  title: SOL003 - VNF Lifecycle Management interface
    SOL003 - VNF Lifecycle Management interface definition

    IMPORTANT: Please note that this file might be not aligned to the current
    version of the ETSI Group Specification it refers to. In case of
    discrepancies the published ETSI Group Specification takes precedence.

    In clause 4.3.2 of ETSI GS NFV-SOL 003 v2.4.1, an attribute-based
    filtering mechanism is defined. This mechanism is currently not
    included in the corresponding OpenAPI design for this GS version. Changes
    to the attribute-based filtering mechanism are being considered in v2.5.1
    of this GS for inclusion in the corresponding future ETSI NFV OpenAPI
    design.
    Please report bugs to https://forge.etsi.org/bugzilla/buglist.cgi?component=Nfv-Openapis&list_id=61&product=NFV&resolution=
  license:
    name: "ETSI Forge copyright notice"
    url: https://forge.etsi.org/etsi-forge-copyright-notice.txt
  description: ETSI GS NFV-SOL 003 V2.6.1
  url: https://www.etsi.org/deliver/etsi_gs/NFV-SOL/001_099/003/02.06.01_60/gs_NFV-SOL003v020601p.pdf

basePath: "/vnflcm/v1"

schemes:
  - https

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

paths:
  ###############################################################################
  # API Versions                                                                #
  ###############################################################################
  '/api-versions':
    $ref: '../../endpoints/SOL002SOL003_endpoints.yaml#/endpoints/api-versions'
  ###############################################################################
  # VNF instances                                                               #
  ###############################################################################
  '/vnf_instances':
    #SOL003 location: 5.4.2
    post:
Gergely Csatari's avatar
Gergely Csatari committed
      description: >
Gergely Csatari's avatar
Gergely Csatari committed
        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
Gergely Csatari's avatar
Gergely Csatari committed
          required: false
          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
        - name: Version
          description: >
            Version of the API requested to use when responding to this request.
          in: header
          required: true
          type: string
          description: >
          201 CREATED

          A VNF Instance identifier was created successfully.
          headers:
            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
Gergely Csatari's avatar
Gergely Csatari committed
            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: >
                Version of the API used in the response.
              type: string
              maximum: 1
              minimum: 1
            $ref: "../../definitions/SOL002SOL003VNFLifecycleManagement_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/405"
        406:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/406"
        422:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/422"
        500:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/500"
        503:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/503"
        504:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/504"
    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
        - name: Authorization
          description: >
            The authorization token for the request.
            Reference: IETF RFC 7235
          in: header
Gergely Csatari's avatar
Gergely Csatari committed
          required: false
        - name: filter
          description: >
            Attribute-based filtering expression according to clause 4.3.2.
            The VNFM shall support receiving this parameter as part of the 
            URI query string. The NFVO 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.
          in: query
          required: false
          type: string
        - name: all_fields
          description: >
            Include all complex attributes in the response.
            See clause 4.3.3 for details. The VNFM shall support this parameter.
          in: query
          required: false
          type: string
        - name: fields
          description: >
            Complex attributes to be included into the response.
            See clause 4.3.3 for details. The VNFM should support this parameter.
          in: query
          required: false
          type: string
        - name: exclude_fields
          description: >
            Complex attributes to be excluded from the response.
            See clause 4.3.3 for details. The VNFM should support this parameter.
          in: query
          required: false
          type: string
        - name: exclude_default
          description: >
            Indicates to exclude the following complex attributes from the response.
            See clause 4.3.3 for details. 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
          required: false
          type: string
        - name: nextpage_opaque_marker
          description: >
            Marker to obtain the next page of a paged response. Shall be supported by the 
            VNFM if the VNFM supports alternative 2 (paging) according to clause 4.7.2.1 
            for this resource.
          in: query
          required: false
          type: string
        - name: Version
          description: >
            Version of the API requested to use when responding to this request.
          in: header
          required: true
          type: string
          description: >
            Information about zero or more VNF instances was queried
            successfully. The response body shall contain in an array
            the representations of zero or more VNF instances, as defined
            in clause 5.5.2.2.
            If the VNFM supports alternative 2 (paging) according to 
            clause 4.7.2.1 for this resource, inclusion of the Link 
            HTTP header in this response shall follow the provisions 
            in clause 4.7.2.3.
          headers:
            Content-Type:
              description: The MIME type of the body of the response.
              type: string
              maximum: 1
              minimum: 1
Gergely Csatari's avatar
Gergely Csatari committed
            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: >
                Version of the API used in the response.
              type: string
              maximum: 1
              minimum: 1
            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
          schema:
            type: array
            items:
              $ref: "../../definitions/SOL002SOL003VNFLifecycleManagement_def.yaml#/definitions/VnfInstance"
          $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/405"
        406:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/406"
        416:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/416"
        500:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/500"
        503:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/503"
        504:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/504"
  ###############################################################################
  # 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: >
        The GET method retrieves information about a VNF instance by reading
        an individual VNF instance resource.
Gergely Csatari's avatar
Gergely Csatari committed
      parameters:
        - 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: false
          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
        - name: Version
          description: >
            Version of the API requested to use when responding to this request.
          in: header
          required: true
          type: string
          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
Gergely Csatari's avatar
Gergely Csatari committed
            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: >
                Version of the API used in the response.
              type: string
              maximum: 1
              minimum: 1
            $ref: "../../definitions/SOL002SOL003VNFLifecycleManagement_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/405"
        406:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/406"
        416:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/416"
        500:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/500"
        503:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/503"
        504:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/504"
    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: VnfInfoModificationRequest
          description: >
            Input parameters for VNF info modification.
          required: true
          in: body
          schema:
            $ref: "../definitions/SOL003_def.yaml#/definitions/VnfInfoModificationRequest"
Gergely Csatari's avatar
Gergely Csatari committed
        - name: Authorization
          description: >
            The authorization token for the request.
            Reference: IETF RFC 7235
          in: header
          required: false
          type: string
        - name: Content-Type
          description: >
            The Content-Type header shall be set to
            "application/merge-patch+json" according to IETF RFC 7396.
          in: header
          required: true
          type: string
          enum: ["application/merge-patch+json"]
        - name: Version
          description: >
            Version of the API requested to use when responding to this request.
          in: header
          required: true
          type: string
          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 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
            Location:
              description: The resource URI of the created VNF instance
              type: string
              format: url
              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/SOL002SOL003VNFLifecycleManagement_def.yaml#/definitions/VnfInstance"
          $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/405"
        406:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/406"
        409:
          description: >
            Shall be returned upon the following error: The operation cannot be executed currently,
            due to a conflict with the state of the "Individual VNF instance" resource.
            Typically, this is due to the fact that another LCM operation is ongoing.
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/409"
        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.
Gergely Csatari's avatar
Gergely Csatari committed
      parameters:
        - name: Authorization
          description: >
            The authorization token for the request.
            Reference: IETF RFC 7235
          in: header
          required: false
          type: string
        - name: Version
          description: >
            Version of the API requested to use when responding to this request.
          in: header
          required: true
          type: string
          description: >
            The VNF instance resource and the associated VNF identifier were
            deleted successfully.
            The response body shall be empty.
Gergely Csatari's avatar
Gergely Csatari committed
          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: >
                Version of the API used in the response.
              type: string
              maximum: 1
              minimum: 1
          $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/405"
        406:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/406"
        409:
          description: >
            Shall be returned upon the following 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 "Individual VNF instance" resource is in INSTANTIATED state.
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/409"
        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
      #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"
Gergely Csatari's avatar
Gergely Csatari committed
        - 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: false
          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
        - name: Version
          description: >
            Version of the API requested to use when responding to this request.
          in: header
          required: true
          type: string
          description: >
            Shall be returned when the request has been accepted for processing
            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.
            Location:
              description: The resource URI of the created VNF instance
Gergely Csatari's avatar
Gergely Csatari committed
            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: >
                Version of the API used in the response.
              type: string
              maximum: 1
              minimum: 1
        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/405"
        406:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/406"
        409:
          description: >
            Shall be returned upon the following 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 "Individual VNF instance" resource is in INSTANTIATED state,
            or that a required child attribute of the "extensions" attribute has not been set.
            Those attributes are marked as "required" in the VNFD.
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/409"
        416:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/416"
        500:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/500"
        503:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/503"
        504:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/504"
  ###############################################################################
  # 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
      #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"
Gergely Csatari's avatar
Gergely Csatari committed
        - 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: false
          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
        - name: Version
          description: >
            Version of the API requested to use when responding to this request.
          in: header
          required: true
          type: string
          description: >
            202 ACCEPTED

            Shall be returned when the request has been accepted for processing.
            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:
            Location:
              description: The resource URI of the created VNF instance
              type: string
              format: url
              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: >
                Version of the API used in the response.
              type: string
              maximum: 1
              minimum: 1
        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:
          description: >
            Shall be returned upon the following error: The API producer did not find a current representation
            for the target resource or is not willing to disclose that one exists.
            The general cause for this error and its handling is specified in clause 6.4 of ETSI GS NFV-SOL 013,
            including rules for the presence of the response body.
            Specifically in case of this task resource, the response code 404 shall also returned if
            the task is not supported for the VNF instance represented by the parent resource, which means that the
            task resource consequently does not exist.
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/404"
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/405"
        406:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/406"
        409:
          description: >
            Shall be returned upon the following 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 "Individual VNF instance" resource is in
            NOT_INSTANTIATED state, or that another lifecycle management operation is ongoing, or that
            a required child attribute of the "extensions" attribute has not been set.
            Those attributes are marked as "required" in the VNFD.
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/409"
        500:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/500"
        503:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/503"
        504:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/504"

  ###############################################################################
  # 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
      #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"
Gergely Csatari's avatar
Gergely Csatari committed
        - 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: false
          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
        - name: Version
          description: >
            Version of the API requested to use when responding to this request.
          in: header
          required: true
          type: string
          description: >
            202 ACCEPTED

            Shall be returned when the request has been accepted for processing.
            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:
            Location:
              description: The resource URI of the created VNF instance
              type: string
              format: url
              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: >
                Version of the API used in the response.
              type: string
              maximum: 1
              minimum: 1
        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:
          description: >
            Shall be returned upon the following error: The API producer did not find a current representation
            for the target resource or is not willing to disclose that one exists.
            The general cause for this error and its handling is specified in clause 6.4 of ETSI GS NFV-SOL 013,
            including rules for the presence of the response body.
            Specifically in case of this task resource, the response code 404 shall also returned if the task
            is not supported for the VNF instance represented by the parent resource, which means that the task resource
            consequently does not exist.
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/404"
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/405"
        406:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/406"
        409:
          description: >
            Shall be returned upon the following 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,
            that another lifecycle management operation is ongoing, or that a required child attribute of
            the "extensions" attribute has not been set.
            Those attributes are marked as "required" in the VNFD.
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/409"
        500:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/500"
        503:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/503"
        504:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/504"
  ###############################################################################
  # 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
      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"
Gergely Csatari's avatar
Gergely Csatari committed
        - 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: false
          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
        - name: Version
          description: >
            Version of the API requested to use when responding to this request.
          in: header
          required: true
          type: string
          description: >
            202 ACCEPTED

            Shall be returned when the request has been accepted for processing.
            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:
            Location:
              description: The resource URI of the created VNF instance
              type: string
              format: url
              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: >
                Version of the API used in the response.
              type: string
              maximum: 1
              minimum: 1
        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:
          description: >
            Shall be returned upon the following error: The API producer did not find a current representation
            for the target resource or is not willing to disclose that one exists.
            The general cause for this error and its handling is specified in clause 6.4 of ETSI GS NFV-SOL 013,
            including rules for the presence of the response body.
            Specifically in case of this task resource, the response code 404 shall also returned if the task
            is not supported for the VNF instance represented by the parent resource, which means that the task resource
            consequently does not exist.
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/404"
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/405"
        406:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/406"
        409:
          description: >
            Shall be returned upon the following 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,
            that another lifecycle management operation is ongoing, or that a required child attribute of
            the "extensions" attribute has not been set.
            Those attributes are marked as "required" in the VNFD.
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/409"
        500:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/500"
        503:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/503"
        504:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/504"

  ###############################################################################
  # 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
      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"
Gergely Csatari's avatar
Gergely Csatari committed
        - 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: false
          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
        - name: Version
          description: >
            Version of the API requested to use when responding to this request.
          in: header
          required: true
          type: string
          description: >
            202 ACCEPTED

            Shall be returned when the request has been accepted for processing.
            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:
            Location:
              description: The resource URI of the created VNF instance
              type: string
              format: url
              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: >
                Version of the API used in the response.
              type: string
              maximum: 1
              minimum: 1
        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/405"
        406:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/406"
        409:
          description: >
            Shall be returned upon the following 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,
            that another lifecycle management operation is ongoing, or that a required child attribute of
            the "extensions" attribute has not been set.
            Those attributes are marked as "required" in the VNFD.
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/409"
        500:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/500"
        503:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/503"
        504:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/504"

  ###############################################################################
  # 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
      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"
Gergely Csatari's avatar
Gergely Csatari committed
        - 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: false
          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
        - name: Version
          description: >
            Version of the API requested to use when responding to this request.
          in: header
          required: true
          type: string
          description: >
            202 ACCEPTED

            Shall be returned when the request has been accepted for processing.
            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:
            Location:
              description: The resource URI of the created VNF instance
              type: string
              format: url
              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: >
                Version of the API used in the response.
              type: string
              maximum: 1
              minimum: 1
        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:
          description: >
            Shall be returned upon the following error: The API producer did not find a current representation
            for the target resource or is not willing to disclose that one exists.
            The general cause for this error and its handling is specified in clause 6.4 of ETSI GS NFV-SOL 013,
            including rules for the presence of the response body.
            Specifically in case of this task resource, the response code 404 shall also returned if the task is
            not supported for the VNF instance represented by the parent resource, which means that the task resource
            consequently does not exist.
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/404"
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/405"
        406:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/406"
        409:
          description: >
            Shall be returned upon the following 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,
            that another lifecycle management operation is ongoing, or that a required child attribute of
            the "extensions" attribute has not been set.
            Those attributes are marked as "required" in the VNFD.
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/409"
        500:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/500"
        503:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/503"
        504:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/504"

  ###############################################################################
  # 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
      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"
Gergely Csatari's avatar
Gergely Csatari committed
        - 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: false
          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
        - name: Version
          description: >
            Version of the API requested to use when responding to this request.
          in: header
          required: true
          type: string
          description: >
            202 ACCEPTED

            Shall be returned when the request has been accepted for processing.
            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:
            Location:
              description: The resource URI of the created VNF instance
              type: string
              format: url
              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: >
                Version of the API used in the response.
              type: string
              maximum: 1
              minimum: 1
        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:
          description: >
            Shall be returned upon the following error: The API producer did not find a current representation
            for the target resource or is not willing to disclose that one exists.
            The general cause for this error and its handling is specified in clause 6.4 of ETSI GS NFV-SOL 013,
            including rules for the presence of the response body.
            Specifically in case of this task resource, the response code 404 shall also returned if the task is
            not supported for the VNF instance represented by the parent resource, which means that the task resource
            consequently does not exist.
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/404"
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/405"
        406:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/406"
        409:
          description: >
            Shall be returned upon the following 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,
            that another lifecycle management operation is ongoing, or that a required child attribute of
            the "extensions" attribute has not been set.
            Those attributes are marked as "required" in the VNFD.
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/409"
        500:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/500"
        503:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/503"
        504:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/504"

  ###############################################################################
  # Change external VNF connectivity task                                       #
  ###############################################################################
  '/vnf_instances/{vnfInstanceId}/change_ext_conn':
    #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
      description: >
        Change External VNF Connectivity.
        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"
Gergely Csatari's avatar
Gergely Csatari committed
        - 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: false
          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
        - name: Version
          description: >
            Version of the API requested to use when responding to this request.
          in: header
          required: true
          type: string
          description: >
            202 ACCEPTED

            Shall be returned when the request has been accepted for processing.
            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:
            Location:
              description: The resource URI of the created VNF instance
              type: string
              format: url
              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: >
                Version of the API used in the response.
              type: string
              maximum: 1
              minimum: 1
        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/405"
        406:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/406"
        409:
          description: >
            Shall be returned upon the following 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,
            or that a required child attribute of the "extensions" attribute has not been set.
            Those attributes are marked as "required" in the VNFD.
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/409"
        500:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/500"
        503:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/503"
        504:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/504"

  ###############################################################################
  # VNF LCM operation occurrences                                               #
  ###############################################################################
  '/vnf_lcm_op_occs':
    #SOL003 location: 5.4.12
      description: >
Gergely Csatari's avatar
Gergely Csatari committed
        Get Operation Status


        The client can use this method to query status information about
        multiple VNF lifecycle management operation occurrences.
Gergely Csatari's avatar
Gergely Csatari committed
      parameters:
        - 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: false
          type: string
        - name: filter
          description: >
            Attribute-based filtering expression according to clause 4.3.2.
            The VNFM shall support receiving this parameter as part of the 
            URI query string. The NFVO 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.
          in: query
          required: false
          type: string
        - name: all_fields
          description: >
            Include all complex attributes in the response.
            See clause 4.3.3 for details. The VNFM shall support this parameter.
          in: query
          required: false
          type: string
        - name: fields
          description: >
            Complex attributes to be included into the response.
            See clause 4.3.3 for details. The VNFM should support this parameter.
          in: query
          required: false
          type: string
        - name: exclude_fields
          description: >
            Complex attributes to be excluded from the response.
            See clause 4.3.3 for details. The VNFM should support this parameter.
          in: query
          required: false
          type: string
        - name: exclude_default
          description: >
            Indicates to exclude the following complex attributes from the response.
            See clause 4.3.3 for details. The VNFM shall support this parameter.
            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:
            -	vnfConfigurableProperties
            - vimConnectionInfo
            -	instantiatedVnfInfo
            -	metadata
            -	extensions
          in: query
          required: false
          type: string
        - name: nextpage_opaque_marker
          description: >
            Marker to obtain the next page of a paged response. Shall be supported by the 
            VNFM if the VNFM supports alternative 2 (paging) according to clause 4.7.2.1 
            for this resource.
          in: query
          required: false
          type: string
        - name: Version
          description: >
            Version of the API requested to use when responding to this request.
          in: header
          required: true
          type: string
      responses:
        200:
          description: >
            Status information for zero or more VNF lifecycle management
            operation occurrences was queried successfully. The response body
            shall contain in an array the status information about zero or 
            more VNF lifecycle operation occurrences.
            If the VNFM supports alternative 2 (paging) according to 
            clause 4.7.2.1 for this resource, inclusion of the Link 
            HTTP header in this response shall follow the provisions 
            in clause 4.7.2.3.
          headers:
            Content-Type:
              description: The MIME type of the body of the response.
              type: string
              maximum: 1
              minimum: 1
Gergely Csatari's avatar
Gergely Csatari committed
            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: >
                Version of the API used in the response.
              type: string
              maximum: 1
              minimum: 1
            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
          schema:
            $ref: "definitions/VNFLifecycleManagement_def.yaml#/definitions/VnfLcmOpOcc"
        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"
        500:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/500"
        503:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/503"
  ###############################################################################
  # Individual VNF LCM operation occurrence                                     #
  ###############################################################################
  '/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
      description: >
Gergely Csatari's avatar
Gergely Csatari committed
        Get Operation Status


        The client can use this method to retrieve status information about a
        VNF lifecycle management operation occurrence by reading an individual
        "VNF LCM operation occurrence" resource.
Gergely Csatari's avatar
Gergely Csatari committed
      parameters:
        - 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: false
          type: string
        - name: Version
          description: >
            Version of the API requested to use when responding to this request.
          in: header
          required: true
          type: string
      responses:
        200:
          description: >
            Information about an individual VNF instance was queried
            successfully. The response body shall contain status
            information about a VNF lifecycle management operation
            occurrence.
          headers:
            Content-Type:
              description: The MIME type of the body of the response.
              type: string
              maximum: 1
              minimum: 1
Gergely Csatari's avatar
Gergely Csatari committed
            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: >
                Version of the API used in the response.
              type: string
              maximum: 1
              minimum: 1
          schema:
            $ref: "definitions/VNFLifecycleManagement_def.yaml#/definitions/VnfLcmOpOcc"
        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"
        500:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/500"
        503:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/503"
  ###############################################################################
  # Retry operation task                                                        #
  ###############################################################################
  '/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
      description: >
        The POST method initiates retrying a VNF lifecycle operation if that
        operation has experienced a temporary failure, i.e. the related
        "VNF LCM operation occurrence" resource is in "FAILED_TEMP" state.
Gergely Csatari's avatar
Gergely Csatari committed
      parameters:
        - name: Authorization
          description: >
            The authorization token for the request.
            Reference: IETF RFC 7235
          in: header
          required: false
          type: string
        - name: Version
          description: >
            Version of the API requested to use when responding to this request.
          in: header
          required: true
          type: string
          description: >
            202 ACCEPTED

            The request was accepted for processing, but processing has not been completed.
            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
        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-FAILED_TEMP"
        500:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/500"
        503:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/503"
  ###############################################################################
  # Rollback operation task                                                     #
  ###############################################################################
  '/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
      description: >
        The POST method initiates rolling back a VNF lifecycle operation if
        that operation has experienced a temporary failure, i.e. the related
        "VNF LCM operation occurrence" resource is in "FAILED_TEMP" state.
Gergely Csatari's avatar
Gergely Csatari committed
      parameters:
        - name: Authorization
          description: >
            The authorization token for the request.
            Reference: IETF RFC 7235
          in: header
          required: false
          type: string
        - name: Version
          description: >
            Version of the API requested to use when responding to this request.
          in: header
          required: true
          type: string
          description: >
            202 ACCEPTED

            The request was accepted for processing, but processing has not been completed.
            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
        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-FAILED_TEMP"
        500:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/500"
        503:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/503"
  ###############################################################################
  # Fail operation task                                                         #
  ###############################################################################
  '/vnf_lcm_op_occs/{vnfLcmOpOccId}/fail':
    #SOL003 location: 5.4.16  
    parameters:
      - name: vnfLcmOpOccId
        description: >
          Identifier of a VNF lifecycle management operation occurrence to be
          be marked as "failed". 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
      description: >
        The POST method marks a VNF lifecycle management operation occurrence
        as "finally failed" if that operation occurrence is in "FAILED_TEMP"
        state.
Gergely Csatari's avatar
Gergely Csatari committed
      parameters:
        - 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: false
          type: string
        - name: Version
          description: >
            Version of the API requested to use when responding to this request.
          in: header
          required: true
          type: string
          description: >
            The state of the VNF lifecycle management operation occurrence was
            changed successfully. The response shall include a representation
            of the VNF lifecycle operation occurrence resource.
          headers:
            Content-Type:
              description: The MIME type of the body of the response.
              type: string
              maximum: 1
              minimum: 1
Gergely Csatari's avatar
Gergely Csatari committed
            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: >
                Version of the API used in the response.
              type: string
              maximum: 1
              minimum: 1
          schema:
            $ref: "definitions/VNFLifecycleManagement_def.yaml#/definitions/VnfLcmOpOcc"