NSLifecycleManagement.yaml 88.4 KB
Newer Older
  version: "1.3.0-impl:etsi.org:ETSI_NFV_OpenAPI:1"
  title: "SOL005 - NS Lifecycle Management Interface"
rameshnaraya's avatar
rameshnaraya committed
    SOL005 - NS Lifecycle Management Interface
    IMPORTANT: Please note that this file might be not aligned to the current
    version of the ETSI Group Specification it refers to and has not been
    approved by the ETSI NFV ISG. In case of discrepancies the published ETSI
    Group Specification takes precedence.
    Please report bugs to https://forge.etsi.org/bugzilla/buglist.cgi?component=Nfv-Openapis
  license:
    name: "ETSI Forge copyright notice"
    url: https://forge.etsi.org/etsi-forge-copyright-notice.txt
    name: "NFV-SOL WG"
externalDocs:
  description: ETSI GS NFV-SOL 005 V2.7.1
  url: https://www.etsi.org/deliver/etsi_gs/NFV-SOL/001_099/005/02.07.01_60/gs_NFV-SOL005v020701p.pdf
basePath: /nslcm/v1
  - application/json
  - application/json
  ###############################################################################
  # API Versions                                                                #
  ###############################################################################
  '/api_versions':
    $ref: '../endpoints/SOL005_endpoints.yaml#/endpoints/api-versions'

  ###############################################################################
  # NSInstances                                                                 #
  ###############################################################################
    #ETSI GS NFV-SOL 005 V2.7.1 location: 6.4.2
    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  
      summary: Create a NS instance resource.
      description: >
        The POST method creates a new NS instance resource.
        As the result of successfully executing this method, a new "Individual NS instance" resource as defined in clause 6.4.3
        shall have been created, and the value of the "instantiationState" attribute in the representation of that resource shall be
        "NOT_INSTANTIATED". A notification of type NsIdentifierCreationNotification shall be triggered as part of
        successfully executing this method as defined in clause 6.5.2.6.
      parameters:
        - name: Accept
          description: >
            Content-Types that are acceptable for the response.
            Reference: IETF RFC 7231
          in: header
          required: true
          type: string
        - name: Content-Type
          description: >
            The MIME type of the body of the request.
            Reference: IETF RFC 7231
          in: header
          required: true
        - name: body
          in: body
rameshnaraya's avatar
rameshnaraya committed
          required: true
          schema:
            $ref: "definitions/SOL005NSLifecycleManagement_def.yaml#/definitions/CreateNsRequest"
          description: >
            The NS creation parameters, as defined in clause 6.5.2.7.
          description: >
            201 Created
            Shall be returned when a new "Individual NS
            instance" resource and the associated NS instance
            identifier has been created successfully.
            The response body shall contain a representation of
            the created NS instance, as defined in
            clause 6.5.2.10.
            The HTTP response shall include a "Location" HTTP
            header that contains the resource URI of the created
            NS instance.
rameshnaraya's avatar
rameshnaraya committed
          schema:
            $ref: "definitions/SOL005NSLifecycleManagement_def.yaml#/definitions/NsInstance"
rameshnaraya's avatar
rameshnaraya committed
            Content-Type:
              type: string
rameshnaraya's avatar
rameshnaraya committed
              description: >
                The MIME type of the body of the response.This header
                field shall be present if the response has a non-empty message
                body.
              type: string
              description: >
                Challenge if the corresponding HTTP request has not provided
rameshnaraya's avatar
rameshnaraya committed
                authorization, or error details if the corresponding HTTP request
                has provided an invalid authorization token.
              maximum: 1
              minimum: 0
            Version:
              description: >
                Version of the API used in the response.
              type: string
              maximum: 1
          $ref: "../responses/SOL005_resp.yaml#/responses/400"
          $ref: "../responses/SOL005_resp.yaml#/responses/401"
          $ref: "../responses/SOL005_resp.yaml#/responses/403"
          $ref: "../responses/SOL005_resp.yaml#/responses/404"
          $ref: "../responses/SOL005_resp.yaml#/responses/405"
          $ref: "../responses/SOL005_resp.yaml#/responses/406"
          $ref: "../responses/SOL005_resp.yaml#/responses/409"
          $ref: "../responses/SOL005_resp.yaml#/responses/416"
          $ref: "../responses/SOL005_resp.yaml#/responses/500"
          $ref: "../responses/SOL005_resp.yaml#/responses/503"
        504:
          $ref: "../responses/SOL005_resp.yaml#/responses/504"
      summary: Query multiple NS instances.
        The GET method queries information about multiple NS instances.
        This method shall support the URI query parameters, request and response data structures, and response codes, as
        specified in the Tables 6.4.2.3.2-1 and 6.4.2.3.2-2.
      parameters:
            Attribute-based filtering expression according to clause 5.2 of ETSI GS NFV-SOL 013.
            The NFVO shall support receiving this parameter as part of the URI
            query string. The OSS/BSS may supply this parameter.
            All attribute names that appear in the NsInstance and in data types
            referenced from it shall be supported by the NFVO in the filter expression.
        - name: all_fields
          in: query
            Include all complex attributes in the response. See clause 5.3 of ETSI GS NFV-SOL 013 for details.
            The NFVO shall support this parameter.
        - name: fields
          in: query
            "Complex attributes to be included into the response. See clause 5.3 of ETSI GS NFV-SOL 013 for
            details. The NFVO should support this parameter."          
            "Complex attributes to be excluded from the response. See clause 5.3 of ETSI GS NFV-SOL 013 for
            details. The NFVO should support this parameter."
            "Indicates to exclude the following complex attributes from the response.
            See clause 5.3 of ETSI GS NFV-SOL 013 for details. The NFVO shall support this parameter.
            The following attributes shall be excluded from the NsInstance structure in
            the response body if this parameter is provided, or none of the parameters
            "all_fields," "fields", "exclude_fields", "exclude_default" are provided:
            - vnfInstances
            - pnfInfo
            - virtualLinkInfo
            - vnffgInfo
            - sapInfo
            - nsScaleStatus
            - additionalAffinityOrAntiAffinityRules"
        - name: nextpage_opaque_marker
          in: query
          description: >
            Marker to obtain the next page of a paged response. Shall be supported by the NFVO
            if the NFVO supports alternative 2 (paging) according to clause 5.4.2.1 of
            ETSI GS NFV-SOL 013 for this resource.
        - name: Accept
          description: >
            Content-Types that are acceptable for the response.
            Reference: IETF RFC 7231
          in: header
          required: true
          type: string
      responses:
        200:
          description: >
            Shall be returned when information about zero or
            more NS instances has been queried successfully.
            The response body shall contain in an array the
            representations of zero or more NS instances, as
            defined in clause 6.5.2.8.
            If the "filter" URI parameter or one of the "all_fields",
            "fields" (if supported), "exclude_fields" (if supported)
            or "exclude_default" URI parameters was supplied in
            the request, the data in the response body shall have
            been transformed according to the rules specified in
            clauses 5.2.2 and 5.3.2 of ETSI
            GS NFV-SOL 013 [16], respectively.
            If the NFVO supports alternative 2 (paging)
            according to clause 5.4.2.1 of ETSI
            GS NFV-SOL 013 [16] for this resource, inclusion of
            the Link HTTP header in this response shall follow
            the provisions in clause 5.4.2.3 of ETSI
            GS NFV-SOL 013 [16].
          headers:
            Content-Type:
              description: The MIME type of the body of the response.
              type: string
              maximum: 1
              minimum: 1
            WWW-Authenticate:
              type: string
              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.
              maximum: 1
            Version:
              description: >
                Version of the API used in the response.
              type: string
              maximum: 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
rameshnaraya's avatar
rameshnaraya committed
              properties:
                NsInstance:
                  $ref: "definitions/SOL005NSLifecycleManagement_def.yaml#/definitions/NsInstance"
          $ref: "../responses/SOL005_resp.yaml#/responses/400"
          $ref: "../responses/SOL005_resp.yaml#/responses/401"
          $ref: "../responses/SOL005_resp.yaml#/responses/403"
          $ref: "../responses/SOL005_resp.yaml#/responses/404"
          $ref: "../responses/SOL005_resp.yaml#/responses/405"
          $ref: "../responses/SOL005_resp.yaml#/responses/406"
          $ref: "../responses/SOL005_resp.yaml#/responses/409"
          $ref: "../responses/SOL005_resp.yaml#/responses/416"
          $ref: "../responses/SOL005_resp.yaml#/responses/500"
          $ref: "../responses/SOL005_resp.yaml#/responses/503"
        504:
          $ref: "../responses/SOL005_resp.yaml#/responses/504"

  ###############################################################################
  # Individual NS instance                                                      #
  ###############################################################################
  '/ns_instances/{nsInstanceId}':
    #ETSI GS NFV-SOL 005 V2.7.1 location: 6.4.3
    parameters:
      - name: nsInstanceId
        description: >
          Identifier of the NS instance.
        in: path
        type: string
        required: true
      - 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
rameshnaraya's avatar
rameshnaraya committed
      summary: Read an individual NS instance resource.
      description: >
        The GET method retrieves information about a NS instance by 
        reading an individual NS instance resource.   
      parameters:
        - name: Accept
          description: >
            Content-Types that are acceptable for the response.
            Reference: IETF RFC 7231
          in: header
          required: true
          type: string
        - name: Content-Type
          description: >
            The MIME type of the body of the request.
            Reference: IETF RFC 7231
          in: header
          required: true
          type: string
      responses:
        200:
          description: >
            200 OK
            Shall be returned when information about an
            individual NS instance has been read successfully.
            The response body shall contain a representation of
            the NS instance, as defined in clause 6.5.2.10.
rameshnaraya's avatar
rameshnaraya committed
          schema:
            $ref: "definitions/SOL005NSLifecycleManagement_def.yaml#/definitions/NsInstance"
          headers:
            Content-Type:
              type: string
rameshnaraya's avatar
rameshnaraya committed
              description: >
                The MIME type of the body of the response.This header
                field shall be present if the response has a non-empty message body.
              type: string
              description: >
                Challenge if the corresponding HTTP request has not provided
rameshnaraya's avatar
rameshnaraya committed
                authorization, or error details if the corresponding HTTP request
                has provided an invalid authorization token.
            Version:
              description: >
                Version of the API used in the response.
              type: string
              maximum: 1
          $ref: "../responses/SOL005_resp.yaml#/responses/400"
          $ref: "../responses/SOL005_resp.yaml#/responses/401"
          $ref: "../responses/SOL005_resp.yaml#/responses/403"
          $ref: "../responses/SOL005_resp.yaml#/responses/404"
          $ref: "../responses/SOL005_resp.yaml#/responses/405"
          $ref: "../responses/SOL005_resp.yaml#/responses/406"
          $ref: "../responses/SOL005_resp.yaml#/responses/416"
          $ref: "../responses/SOL005_resp.yaml#/responses/500"
          $ref: "../responses/SOL005_resp.yaml#/responses/503"
        504:
          $ref: "../responses/SOL005_resp.yaml#/responses/504"
rameshnaraya's avatar
rameshnaraya committed
      summary: Delete NS instance resource.
      description: >
        Delete NS Identifier
        This method deletes an individual NS instance resource.
        As the result of successfully executing this method, the "Individual NS instance" resource shall not exist any longer.
        A notification of type "NsIdentifierDeletionNotification" shall be triggered as part of successfully executing this method
        as defined in clause 6.5.2.7.
      responses:
        204:
          description: >
            204 No Content
            Shall be returned when the "Individual NS instance"
            resource and the associated NS identifier have been
            deleted successfully.
            The response body shall be empty.
          headers:
            WWW-Authenticate:
              type: string
              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.
            Version:
              description: >
                Version of the API used in the response.
              type: string
              maximum: 1
          $ref: "../responses/SOL005_resp.yaml#/responses/400"
          $ref: "../responses/SOL005_resp.yaml#/responses/401"
          $ref: "../responses/SOL005_resp.yaml#/responses/403"
          $ref: "../responses/SOL005_resp.yaml#/responses/404"
          $ref: "../responses/SOL005_resp.yaml#/responses/405"
          $ref: "../responses/SOL005_resp.yaml#/responses/406"
            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 NS instance
            resource is in INSTANTIATED state.
            The response body shall contain a ProblemDetails
            structure, in which the "detail" attribute shall convey
            more information about the error.
          $ref: "../responses/SOL005_resp.yaml#/responses/409"
          $ref: "../responses/SOL005_resp.yaml#/responses/412"
          $ref: "../responses/SOL005_resp.yaml#/responses/500"
          $ref: "../responses/SOL005_resp.yaml#/responses/503"
        504:
          $ref: "../responses/SOL005_resp.yaml#/responses/504"
  ###############################################################################
  # Instantiate NS task                                                         #
  ###############################################################################
  '/ns_instances/{nsInstanceId}/instantiate':
    #ETSI GS NFV-SOL 005 V2.7.1 location: 6.4.4
    parameters:
      - name: nsInstanceId
        description: >
          Identifier of the NS instance to be instantiated.
        in: path
        type: string
        required: true
rameshnaraya's avatar
rameshnaraya committed
      summary: Instantiate a NS.
      description: >
        The POST method requests to instantiate a NS instance resource.
        The steps and conditions that apply as the result of successfully executing this method are specified in clause 6.4.1.2.
        In addition, once the NFVO has successfully completed the underlying NS LCM operation occurrence, it shall set the
        "nsState" attribute to the value "INSTANTIATED" in the representation of the "Individual NS instance" resource.
        - 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
        - name: body
          in: body
            $ref: "definitions/SOL005NSLifecycleManagement_def.yaml#/definitions/InstantiateNsRequest"
          description: >
            Parameters for the instantiate NS operation, as defined in
            clause 6.5.2.11.
            Shall be returned when the request has been
            accepted for processing, but the processing has not
            been completed.
            The response body shall be empty.
            The HTTP response shall include a "Location" HTTP
            header that contains the URI of the newly-created
            "Individual NS LCM operation occurrence" resource
            corresponding to the operation.
          $ref: "../responses/SOL005_resp.yaml#/responses/202"
          $ref: "../responses/SOL005_resp.yaml#/responses/400"
          $ref: "../responses/SOL005_resp.yaml#/responses/401"
          $ref: "../responses/SOL005_resp.yaml#/responses/403"
          $ref: "../responses/SOL005_resp.yaml#/responses/404"
          $ref: "../responses/SOL005_resp.yaml#/responses/405"
          $ref: "../responses/SOL005_resp.yaml#/responses/406"
            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 NS instance
            resource is in the INSTANTIATED state, or that
            another lifecycle management operation is ongoing.
            The response body shall contain a ProblemDetails
            structure, in which the "detail" attribute shall convey
            more information about the error.
          $ref: "../responses/SOL005_resp.yaml#/responses/409"
          $ref: "../responses/SOL005_resp.yaml#/responses/416"
          $ref: "../responses/SOL005_resp.yaml#/responses/500"
          $ref: "../responses/SOL005_resp.yaml#/responses/503"
        504:
          $ref: "../responses/SOL005_resp.yaml#/responses/504"

  ###############################################################################
  # Scale NS task                                                               #
  ###############################################################################
  '/ns_instances/{nsInstanceId}/scale':
    #ETSI GS NFV-SOL 005 V2.7.1 location: 6.4.5
    parameters:
      - name: nsInstanceId
        description: >
          Identifier of the NS instance to be scaled.
        in: path
        type: string
        required: true
rameshnaraya's avatar
rameshnaraya committed
      summary: Scale a NS instance.
      description: >
        The POST method requests to scale a NS instance resource.
        The steps and conditions that apply as the result of successfully executing this method are specified in clause 6.4.1.2.
        In addition, once the NFVO has successfully completed the underlying NS LCM operation occurrence, it shall reflect
        the result of scaling the NS instance by updating the "nsScaleStatus" attribute in the representation of the "Individual
        NS instance" resource.
      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
        - name: body
          in: body
            $ref: "definitions/SOL005NSLifecycleManagement_def.yaml#/definitions/ScaleNsRequest"
          description: >
            Parameters for the scale NS operation, as defined in
            clause 6.5.2.14.
            Shall be returned when the request has been
            accepted for processing, but the processing has not
            been completed.
            The response body shall be empty.
            The HTTP response shall include a "Location" HTTP
            header that contains the URI of the newly-created
            "Individual NS lifecycle operation occurrence"
            resource corresponding to the operation.
          $ref: "../responses/SOL005_resp.yaml#/responses/202"
          $ref: "../responses/SOL005_resp.yaml#/responses/400"
          $ref: "../responses/SOL005_resp.yaml#/responses/401"
          $ref: "../responses/SOL005_resp.yaml#/responses/403"
          $ref: "../responses/SOL005_resp.yaml#/responses/404"
          $ref: "../responses/SOL005_resp.yaml#/responses/405"
          $ref: "../responses/SOL005_resp.yaml#/responses/406"
            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 NS instance
            resource is in NOT_INSTANTIATED state, or that
            another lifecycle management operation is ongoing.
            The response body shall contain a ProblemDetails
            structure, in which the "detail" attribute shall convey
            more information about the error.
          $ref: "../responses/SOL005_resp.yaml#/responses/409"
          $ref: "../responses/SOL005_resp.yaml#/responses/500"
          $ref: "../responses/SOL005_resp.yaml#/responses/503"
        504:
          $ref: "../responses/SOL005_resp.yaml#/responses/504"

  ###############################################################################
  # Update NS task                                                              #
  ###############################################################################
  '/ns_instances/{nsInstanceId}/update':
    #ETSI GS NFV-SOL 005 V2.7.1 location: 6.4.6
    parameters:
      - name: nsInstanceId
        description: >
          Identifier of the NS instance to be updated.
        in: path
        type: string
        required: true
rameshnaraya's avatar
rameshnaraya committed
      summary: Updates a NS instance.
        The POST method updates an NS instance.
      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
        - name: body
          in: body
            $ref: "definitions/SOL005NSLifecycleManagement_def.yaml#/definitions/UpdateNsRequest"
          description: >
            Parameters for the update NS operation, as defined in clause 6.5.2.12.
            Shall be returned when the request has been
            accepted for processing, but the processing has not
            been completed.
            The response body shall be empty.
            The HTTP response shall include a "Location" HTTP
            header that contains the URI of the newly-created
            "Individual NS lifecycle operation occurrence"
            resource corresponding to the operation.
          $ref: "../responses/SOL005_resp.yaml#/responses/202"
          $ref: "../responses/SOL005_resp.yaml#/responses/400"
          $ref: "../responses/SOL005_resp.yaml#/responses/401"
          $ref: "../responses/SOL005_resp.yaml#/responses/403"
          $ref: "../responses/SOL005_resp.yaml#/responses/404"
          $ref: "../responses/SOL005_resp.yaml#/responses/405"
          $ref: "../responses/SOL005_resp.yaml#/responses/406"
            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 NS instance
            resource is in NOT_INSTANTIATED state, or that
            another lifecycle management operation is ongoing.
            The response body shall contain a ProblemDetails
            structure, in which the "detail" attribute shall convey
            more information about the error.
          $ref: "../responses/SOL005_resp.yaml#/responses/409"
          $ref: "../responses/SOL005_resp.yaml#/responses/500"
          $ref: "../responses/SOL005_resp.yaml#/responses/503"
        504:
          $ref: "../responses/SOL005_resp.yaml#/responses/504"

  ###############################################################################
  # Heal NS task                                                                #
  ###############################################################################
  '/ns_instances/{nsInstanceId}/heal':
    #ETSI GS NFV-SOL 005 V2.7.1 location: 6.4.7
    parameters:
      - name: nsInstanceId
        description: >
          Identifier of the NS instance to be healed.
        in: path
        type: string
        required: true
    post:
      summary: Heal a NS instance.
      description: >
        The POST method requests to heal an NS instance.
        This method shall follow the provisions specified in the Tables 6.4.7.3.1-1 and 6.4.7.3.1-2 for URI query parameters,
        request and response data structures, and response codes.
        The steps and conditions that apply as the result of successfully executing this method are specified in clause 6.4.1.2.
        - 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
        - name: body
          in: body
            $ref: "definitions/SOL005NSLifecycleManagement_def.yaml#/definitions/HealNsRequest"
          description: >
            Parameters for the heal NS operation, as defined in clause 6.5.2.13.
            Shall be returned when the request has been
            accepted for processing, but the processing has not
            been completed.
            The response body shall be empty.
            The HTTP response shall include a "Location" HTTP
            header that contains the URI of the newly-created
            "Individual NS lifecycle operation occurrence"
            resource corresponding to the operation.
          $ref: "../responses/SOL005_resp.yaml#/responses/202"
          $ref: "../responses/SOL005_resp.yaml#/responses/400"
          $ref: "../responses/SOL005_resp.yaml#/responses/401"
          $ref: "../responses/SOL005_resp.yaml#/responses/403"
          $ref: "../responses/SOL005_resp.yaml#/responses/404"
          $ref: "../responses/SOL005_resp.yaml#/responses/405"
          $ref: "../responses/SOL005_resp.yaml#/responses/406"
            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 NS instance
            resource is in NOT_INSTANTIATED state, or that
            another lifecycle management operation is ongoing.
            The response body shall contain a ProblemDetails
            structure, in which the "detail" attribute shall convey
            more information about the error.
          $ref: "../responses/SOL005_resp.yaml#/responses/409"
          $ref: "../responses/SOL005_resp.yaml#/responses/500"
          $ref: "../responses/SOL005_resp.yaml#/responses/503"
        504:
          $ref: "../responses/SOL005_resp.yaml#/responses/504"
  ###############################################################################
  # Terminate NS task                                                           #
  ###############################################################################
  '/ns_instances/{nsInstanceId}/terminate':
    #ETSI GS NFV-SOL 005 V2.7.1 location: 6.4.8
    parameters:
      - name: nsInstanceId
        description: >
          The identifier of the NS instance to be terminated.
        in: path
        type: string
        required: true
    post:
      summary: Terminate a NS instance.
      description: >
        Terminate NS task.  
        The POST method terminates an NS instance.
        This method shall follow the provisions specified in the Tables 6.4.8.3.1-1 and 6.4.8.3.1-2 for URI query parameters,
        request and response data structures, and response codes.
        The steps and conditions that apply as the result of successfully executing this method are specified in clause 6.4.1.2.
        In addition, once the NFVO has successfully completed the underlying NS LCM operation occurrence, it shall set the
        "nsState" attribute in the representation of the "Individual NS instance" resource to the value "NOT_INSTANTIATED".
        This method can only be used with an NS instance in the INSTANTIATED state. Terminating an NS instance does not
        delete the NS instance identifier, but rather transitions the NS into the NOT_INSTANTIATED state.
        - 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
        - name: body
          in: body
            $ref: "definitions/SOL005NSLifecycleManagement_def.yaml#/definitions/TerminateNsRequest"
          description: >
            The terminate NS request parameters, as defined in  clause 6.5.2.15.
          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
            "NS lifecycle operation occurrence" resource
            corresponding to the operation.
          $ref: "../responses/SOL005_resp.yaml#/responses/202"
          $ref: "../responses/SOL005_resp.yaml#/responses/400"
          $ref: "../responses/SOL005_resp.yaml#/responses/401"
          $ref: "../responses/SOL005_resp.yaml#/responses/403"
          $ref: "../responses/SOL005_resp.yaml#/responses/404"
          $ref: "../responses/SOL005_resp.yaml#/responses/405"
          $ref: "../responses/SOL005_resp.yaml#/responses/406"
            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 NS instance
            resource is in NOT_INSTANTIATED state, or that
            another lifecycle management operation is ongoing.
            The response body shall contain a ProblemDetails
            structure, in which the "detail" attribute shall convey
            more information about the error.
          $ref: "../responses/SOL005_resp.yaml#/responses/409"
          $ref: "../responses/SOL005_resp.yaml#/responses/500"
          $ref: "../responses/SOL005_resp.yaml#/responses/503"
        504:
          $ref: "../responses/SOL005_resp.yaml#/responses/504"
  ###############################################################################
  # NS LCM operation occurrences                                                #
  ###############################################################################
  '/ns_lcm_op_occs':
    #ETSI GS NFV-SOL 005 V2.7.1 location: 6.4.9
rameshnaraya's avatar
rameshnaraya committed
      summary: Query multiple NS LCM operation occurrences.
        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 NS instance
        resource is in NOT_INSTANTIATED state, or that
        another lifecycle management operation is ongoing.
        The response body shall contain a ProblemDetails
        structure, in which the "detail" attribute shall convey
        more information about the error
            Attribute-based filtering expression according to clause 5.2 of ETSI GS NFV SOL 013[16].
            The NFVO shall support receiving this parameter as part of the URI query string.
            The OSS/BSS may supply this parameter.
            All attribute names that appear in the NsLcmOpOcc and in data types referenced
            from it shall be supported by the NFVO in the filter expression.