Commit a8d1e23c authored by Mubeena Ishaq's avatar Mubeena Ishaq
Browse files

update SOL003VNFLifecycleManagement

parent 74ceb754
Loading
Loading
Loading
Loading
+3 −3
Original line number Diff line number Diff line
@@ -791,7 +791,7 @@ paths:
        back, i.e. the related "Individual VNF LCM operation occurrence" is either in "PROCESSING" or "ROLLING_BACK" state.
        See clause 5.4.17.3.1.
      requestBody:
        $ref: '#/components/requestBodies/VnfInstanceCancelModeRequest'
        $ref: '#/components/requestBodies/CancelModeRequest'
      responses:
        "202":
          $ref: '#/components/responses/VnfLcmOpOccCancel.Post.202'
@@ -1454,14 +1454,14 @@ components:
            $ref: ./definitions/SOL002VNFLifecycleManagement_def.yaml#/definitions/ChangeCurrentVnfPkgRequest
      required: true

    VnfInstanceCancelModeRequest:
    CancelModeRequest:
      description: |
        The POST request to this resource shall include a CancelMode structure in the message content to 
        choose between "graceful" and "forceful" cancellation.
      content:
        application/json:
          schema:
            $ref: ../../definitions/SOL002SOL003VNFLifecycleManagement_def.yaml#/definitions/CancelMode
            $ref: ../../definitions/SOL002SOL003VNFLifecycleManagement_def.yaml#/definitions/CancelModeRequest

    VnfLcmSubscriptionRequest:
      description: |
+10 −10
Original line number Diff line number Diff line
@@ -573,17 +573,17 @@ components:

    Subscriptions.Post.422:
      description: |
        422 Unprocessable Entity
        422 Unprocessable Content

        Shall be returned upon the following error: The content type of the message content is supported and
        the message content of a request contains syntactically correct data but the data cannot be processed.
        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 resource, the response code 422 shall also be returned if the VNFM has 
        tested the Notification endpoint as described in clause 8.4.7.3.2 and the test has failed.
        In this case, the "detail" attribute in the "ProblemDetails" structure shall convey more information
        about the error.

        Shall be returned when a subscription with
        the same callback URI and the same filter
        already exists and the policy of the VNFM
        is to not create redundant subscriptions.
        The HTTP response shall include a
        "Location" HTTP header that contains the
        resource URI of the existing "Individual
        subscription" resource.
        The response body shall be empty
      headers:
        WWW-Authenticate:
          description: |
+12 −0
Original line number Diff line number Diff line
@@ -777,6 +777,8 @@ paths:
        The POST method initiates cancelling an ongoing VNF lifecycle operation while it is being executed or rolled
        back, i.e. the related "Individual VNF LCM operation occurrence" resource is either in "STARTING" or
        "PROCESSING" or "ROLLING_BACK" state. See clause 5.4.17.3.1.
      requestBody:
          $ref: '#/components/requestBodies/CancelModeRequest'
      parameters:
        - $ref: ../../components/SOL003_params.yaml#/components/parameters/Authorization
        - $ref: ../../components/SOL003_params.yaml#/components/parameters/Version
@@ -1429,6 +1431,16 @@ components:
            $ref: "../../definitions/SOL002SOL003VNFLifecycleManagement_def.yaml#/definitions/CreateVnfRequest"
      required: true

    CancelModeRequest:
      description:
        The POST request to this resource shall include a CancelMode structure in the message content to choose between
        "graceful" and "forceful" cancellation.
      content:
        application/json:
          schema:
            $ref: "../../definitions/SOL002SOL003VNFLifecycleManagement_def.yaml#/definitions/CancelModeRequest"
      required: true

    VnfInfoModificationRequest:
      description: |
        Parameters for the VNF modification, as defined in clause 5.5.2.12.
+27 −29
Original line number Diff line number Diff line
@@ -734,7 +734,7 @@ components:
      description: >
        Flag (i.e. parameter without value) that instructs the NFVO to exclude
        the set of additional MANO artifacts (i.e. those that are not images)
        from the response payload body.
        from the response message content.
        The NFVO shall support this parameter. The VNFM may supply this
        parameter.
      in: query
@@ -746,7 +746,7 @@ components:
      name: exclude_all_non_mano_artifacts 
      description: >
        Flag (i.e. parameter without value) that instructs the NFVO to exclude
        the set of non-MANO artifacts from the response payload body.
        the set of non-MANO artifacts from the response message content.
        The NFVO shall support this parameter. The VNFM may supply this
        parameter.
      in: query
@@ -758,7 +758,7 @@ components:
      name: include_external_artifacts 
      description: >
        Flag (i.e. parameter without value) that instructs the NFVO to include
        external artifacts in the response payload body. It shall not be treated
        external artifacts in the response message content. It shall not be treated
        as an error if this flag is provided but there is no external artifact to
        include in the result. If this parameter is missing, no external artifacts
        shall be included.
@@ -1489,7 +1489,7 @@ components:
        a single consecutive byte range from the content of the VNF package file
        has been read successfully according to the request.
        The response body shall contain the requested part of the VNF package file.
        The "Content-Range" HTTP header shall be provided according to IETF RFC 7233.
        The "Content-Range" HTTP header shall be provided according to IETF RFC 9110.
        The "Content-Type" HTTP header shall be set as defined above for the "200 OK" response.
      headers:
        Content-Range:
@@ -1696,7 +1696,7 @@ components:
        been read successfully.

        If the "include_signatures" request URI parameter was not provided in
        the related request, the payload body shall contain a copy of the artifact
        the related request, the message content shall contain a copy of the artifact
        file from the VNF package, as defined by ETSI GS NFV-SOL 004 and the "Content-Type"
        HTTP header shall be set according to the content type of the artifact file.
        If the artifact is encrypted, the header shall be set to the value "application/cms"
@@ -1704,7 +1704,7 @@ components:
        to the value "application/octet-stream".

        If the "include_signatures" request URI parameter was provided in the related request,
        the "Content-Type" HTTP header shall be set to "application/zip and the payload body
        the "Content-Type" HTTP header shall be set to "application/zip and the message content
        shall contain a ZIP archive which includes:
        •	a copy of the artifact file from the VNF package, as defined by ETSI GS NFV SOL 004;
        •	the related security information (individual signature file and optional related
@@ -2052,7 +2052,7 @@ components:

        Shall be returned when the whole content of the archive containing
        the artifact files has been read successfully.
        The payload body shall be a ZIP archive containing the requested
        The message content shall be a ZIP archive containing the requested
        set of artifacts selected according to the provisions specified above
        in this clause, and, if the flag "include_signatures" was provided in
        the related request, the applicable signature files and, if available,
@@ -2089,17 +2089,14 @@ components:
      description: |
        206 PARTIAL CONTENT

        If the NFVO supports range requests and the "include_signatures" request
        URI parameter was not present in the related request, this response shall
        be returned when a single consecutive byte range from the content of the
        artifact file, if the NFVO supports range requests has been read successfully
        according to the request.
        The response body shall contain the requested part of the VNF
        package file.
        The "Content-Range" HTTP header shall be provided according to
        IETF RFC 7233.
        The "Content-Type" HTTP header shall be set as defined above for
        the "200 OK" response.
        If the NFVO supports range requests and the "include_signatures" request URI parameter was not
        present in the related request, this response shall be returned when a single consecutive byte range from
        the content of the artifact file has been read successfully according to the request.
        The response body shall contain the requested part of the artifact file from the VNF package, as defined
        by ETSI GS NFV-SOL 004.
        The "Content-Type" HTTP header shall be set according to the content type of the artifact file. If the
        content type cannot be determined, the header shall be set to the value "application/octet-stream".
        The "Content-Range" HTTP header shall be provided according to IETF RFC 9110.
      headers:
        Content-Range:
          required : true
@@ -2139,7 +2136,7 @@ components:
        successfully according to the request.
        The response body shall contain the requested part of the archive.
        The "Content-Type" HTTP header shall be set to "application/zip".
        The "Content-Range" HTTP header shall be provided according to IETF RFC 7233.
        The "Content-Range" HTTP header shall be provided according to IETF RFC 9110.
      headers:
        Content-Range:
          required : true
@@ -2432,16 +2429,17 @@ components:

    Subscriptions.Post.422:
      description: |
        422 Unprocessable Entity

        Shall be returned when a subscription with the
        same callback URI and the same filter already
        exists and the policy of the NFVO is to not create
        redundant subscriptions.
        The HTTP response shall include a "Location"
        HTTP header that contains the resource URI of
        the existing "Individual subscription" resource.
        The response body shall be empty.
        422 Unprocessable Content

        Shall be returned upon the following error: The content type of the message content
        is supported and the  message content of a request contains syntactically correct
        data but the data cannot be processed.
        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 resource, the response code 422 shall also be returned if the NFVO has
        tested the Notification endpoint as described in clause 10.4.9.3.2 and the test has failed.
        In this case, the "detail" attribute in the "ProblemDetails" structure shall convey more
        information about the error.
      headers:
        Content-Type:
          description: The MIME type of the body of the response.
+9 −5
Original line number Diff line number Diff line
@@ -16,7 +16,6 @@ definitions:
      - id
      - operationalState
      - usageState
      - vnfmInfo
      - _links
    properties:
      id:
@@ -125,7 +124,10 @@ definitions:
        $ref: "#/definitions/PackageUsageStateType"
      vnfmInfo:
        description: >
          Specifies VNFMs compatible with the VNF. This information is copied from the VNFD. See note 3.
          Specifies VNFMs compatible with the VNF. This information is copied from the VNFD of the on-boarded VNF package. See note 3.
          It shall be present after the VNF package content has been on-boarded and absent otherwise.
        type: array
        items:
          $ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/String"
      userDefinedData:
        description: >
@@ -379,6 +381,9 @@ definitions:
    description: >
      This type represents an artifact other than a software image which is
      contained in or external to a VNF package.

      NOTE : The attribute name "artifactURI" does not comply with the naming convention defined in clause 4.3 in ETSI GS 
             NFV-SOL 015. This is to maintain the backward compatibility.
    type: object
    required:
      - artifactPath
@@ -412,8 +417,7 @@ definitions:
      artifactURI:
        description: >
          URI of the artifact as defined in the VNF package manifest.
          Shall be present if the artifact is external to the package
          and shall be absent otherwise.
          Shall be present if the artifact is external to the package and shall be absent otherwise.

          EXAMPLE: https://example.com/m%40ster.sh
        type: array
Loading