VNFLifecycleManagement.yaml 171 KB
Newer Older
        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.
          style: simple
          explode: false
          schema:
            type: string
        Version:
          description: The used API version.
          style: simple
          explode: false
          schema:
            type: string
        Content-Type:
          description: |
            The MIME type of the body of the response. Reference: IETF RFC 7231
          style: simple
          explode: false
          schema:
            type: string
        ETag:
          description: >
            Used to provide the current entity-tag for the selected resource representation. It can be sent in
            "200 OK", "201 Created" and "204 No Content" responses.
          style: simple
          schema:
            type: string
        Last-Modified:
          description: >
            Used to provide a timestamp indicating the date and time at which the server believes the selected resource
            representation was last modified. It can be sent in "200 OK", "201 Created" and "204 No Content" responses.
          style: simple
          schema:
            type: string
            format: date-time
      content:
        application/json:
          schema:
Francesca Moscatelli's avatar
Francesca Moscatelli committed
              $ref: "./definitions/SOL003VNFLifecycleManagement_def.yaml#/definitions/VnfSnapshotInfo"
    IndividualVnfSnapshot.Patch.200:
      description: |
        200 OK

        Shall be returned when the modification of VNF snapshot information has been accepted and completed.
      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.
          style: simple
          explode: false
          schema:
            type: string
        Version:
          description: The used API version.
          style: simple
          explode: false
          schema:
            type: string
        Content-Type:
          description: |
            The MIME type of the body of the response. Reference: IETF RFC 7231
          style: simple
          explode: false
          schema:
            type: string
ishaqm's avatar
ishaqm committed
        ETag:
          description: >
            Used to provide the current entity-tag for the selected resource representation. It can be sent in
            "200 OK", "201 Created" and "204 No Content" responses.
          style: simple
          schema:
            type: string
        Last-Modified:
          description: >
            Used to provide a timestamp indicating the date and time at which the server believes the selected resource
            representation was last modified. It can be sent in "200 OK", "201 Created" and "204 No Content" responses.
          style: simple
          schema:
            type: string
            format: date-time
      content:
        application/json:
          schema:
            $ref: "definitions/SOL003VNFLifecycleManagement_def.yaml#/definitions/VnfSnapshotInfoModifications"

    IndividualVnfSnapshot.Patch.409:
      description: |
        409 CONFLICT

        Shall be returned upon the following error: The
        operation cannot be executed currently, due to a
        conflict with the state of the "Individual VNF
        snapshot" resource.
        Typically, this is due to the fact another
        modification is ongoing or that the "Individual VNF
        snapshot" resource information is not empty due to
        a previously successful modification or currently
        being modified due to an underlying VNF snapshot
        operation.
        The response body shall contain a ProblemDetails
        structure, in which the "detail" attribute should
        convey more information about the error.
      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.
          style: simple
          explode: false
          schema:
            type: string
        Version:
          description: The used API version.
          style: simple
          explode: false
          schema:
            type: string
        Content-Type:
          description: |
            The MIME type of the body of the response. Reference: IETF RFC 7231
          style: simple
          explode: false
          schema:
            type: string
      content:
        application/json:
          schema:
            $ref: "../General_Definitions/SOL003_def.yaml#/definitions/ProblemDetails"
    IndividualVnfSnapshot.Patch.412:
      description: |
        412 Precondition Failed

        Shall be returned upon the following error: A
        precondition given in an HTTP request header is
        not fulfilled.
        Typically, this is due to an ETag mismatch,
        indicating that the resource was modified by
        another entity.
        The response body should contain a
        ProblemDetails structure, in which the "detail"
        attribute should convey more information about the
        error
      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.
          style: simple
          explode: false
          schema:
            type: string
        Version:
          description: The used API version.
          style: simple
          explode: false
          schema:
            type: string
        Content-Type:
          description: |
            The MIME type of the body of the response. Reference: IETF RFC 7231
          style: simple
          explode: false
          schema:
            type: string

    IndividualVnfSnapshot.Delete.204:
      description: |
        204 NO CONTENT

        Shall be returned when the VNF snapshot resource and the associated VNF snapshot were 
        deleted successfully.
        The response body shall be empty.
      headers:
        WWW-Authenticate:
          description: |
            Challenge if the corresponding HTTP request has not provided authorization, or error details if the
            corresponding HTTP request has provided an invalid authorization token.
          style: simple
          explode: false
          schema:
            type: string
        Version:
          description: The used API version.
          style: simple
          explode: false
          schema:
            type: string
    IndividualVnfSnapshot.Delete.409:
      description: |
        409 CONFLICT

        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 snapshot
        is in use by some operation such as reverting a VNF
        instance to a VNF snapshot or creating a VNF
        snapshot package.
        The response body shall contain a ProblemDetails
        structure, in which the "detail" attribute shall convey
        more information about the error.
      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.
          style: simple
          explode: false
          schema:
            type: string
        Version:
          description: The used API version.
          style: simple
          explode: false
          schema:
            type: string
        Content-Type:
          description: |
            The MIME type of the body of the response. Reference: IETF RFC 7231
          style: simple
          explode: false
          schema:
            type: string
      content:
        application/json:
          schema:
            $ref: "../General_Definitions/SOL003_def.yaml#/definitions/ProblemDetails"
    IndividualVnfSnapshotState.Get.200:
      description: |
        200 OK

        Shall be returned when the whole content of the VNF state snapshot file has been read successfully.

ishaqm's avatar
ishaqm committed
        The message content shall contain a copy of the VNF state snapshot file and the "Content-Type" HTTP
        header shall be set according to the content type of the VNF state snapshot file. If the VNF state 
        snapshot content is encrypted, the header shall be set to the value "application/cms" (IETF RFC 7193). 
        
        If the content type cannot be determined, the header shall be set to the value "application/octet-stream".
      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.
          style: simple
          explode: false
          schema:
            type: string
        Version:
          description: The used API version.
          style: simple
          explode: false
          schema:
            type: string
        Content-Type:
          description: |
            The MIME type of the body of the response. Reference: IETF RFC 7231
          style: simple
          explode: false
          schema:
            type: string
      content:
        application/*:
          schema:
            type: string
            format: binary

    IndividualVnfSnapshotState.Get.206:
      description: |
        206 PARTIAL CONTENT

        If the VNFM supports range requests, this response shall be returned when a single consecutive byte
        range from the content of the VNF state snapshot file has been read successfully according to the request.

        The response body shall contain the requested part of the VNF state snapshot file. The "Content-Type" HTTP 
        header shall be set according to the content type of the VNF state snapshot file. If the content type cannot 
        be determined, the header shall be set to the value "application/octet-stream".

ishaqm's avatar
ishaqm committed
        The "Content-Range" HTTP header shall be provided according to IETF RFC 9110.
      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.
          style: simple
          explode: false
          schema:
            type: string
        Version:
          description: The used API version.
          style: simple
          explode: false
          schema:
            type: string
        Content-Range:
          required : true
          style: simple
          explode: false
          schema:
            type: string
      content:
        application/*:
          schema:
            type: string
            format: binary

    IndividualVnfSnapshotState.Get.409:
      description: |
        409 CONFLICT

        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
        snapshot creation process is not completed.
        The response body shall contain a ProblemDetails
        structure, in which the "detail" attribute shall convey
        more information about the error.
      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.
          style: simple
          explode: false
          schema:
            type: string
        Version:
          description: The used API version.
          style: simple
          explode: false
          schema:
            type: string
        Content-Type:
          description: |
            The MIME type of the body of the response. Reference: IETF RFC 7231
          style: simple
          explode: false
          schema:
            type: string
      content:
        application/json:
          schema:
            $ref: "../General_Definitions/SOL003_def.yaml#/definitions/ProblemDetails"

    IndividualVnfSnapshotState.Get.416:
      description: |
        416 RANGE NOT SATISFIABLE

        Shall be returned upon the following error: The byte
        range passed in the "Range" header did not match
        any available byte range in the VNF state snapshot
        file (e.g. "access after end of file").
        The response body may contain a ProblemDetails
        structure
      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.
          style: simple
          explode: false
          schema:
            type: string
        Version:
          description: The used API version.
          style: simple
          explode: false
          schema:
            type: string
        Content-Type:
          description: |
            The MIME type of the body of the response. Reference: IETF RFC 7231
          style: simple
          explode: false
          schema:
            type: string