VNFSnapshotPackageManagement.yaml 50.7 KB
Newer Older
        Shall be returned when the information about the VNF snapshot package has been received successfully, but 
        the uploading has not been completed. It is expected to take some time for processing.

        The response body shall be empty.

        The API consumer can track the uploading progress by reading the status of the 
        "Individual VNF snapshot package" resource using the GET method.
      headers:
        Version:
          description: The used API version.
          style: simple
          explode: false
          schema:
            type: string
        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

    BuildVnfSnapshotPkg.Post.202:
      description: |
        202 ACCEPTED

        Shall be returned when the information for building the VNF snapshot package has been received successfully, but 
        the build has not been completed. It is expected to take some time for processing.

        The response body shall be empty.

        The API consumer can track the uploading progress by reading the status of the 
        "Individual VNF snapshot package" resource using the GET method.
      headers:
        Version:
          description: The used API version.
          style: simple
          explode: false
          schema:
            type: string
        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

    ExtractVnfSnapshotPkg.Post.202:
      description: |
        202 ACCEPTED

        Shall be returned when the information for extracting the VNF snapshot package has been received successfully, but 
        the extraction has not been completed. It is expected to take some time for processing.

        The response body shall be empty.

        The API consumer can track the uploading progress by reading the status of the 
        "Individual VNF snapshot package" resource using the GET method.
      headers:
        Version:
          description: The used API version.
          style: simple
          explode: false
          schema:
            type: string
        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

    CancelVnfSnapshotPkg.Post.202:
      description: |
        202 ACCEPTED

        Shall be returned when the information for cancelling the ongoing operation with the content of the VNF snapshot package 
        has been received successfully, but the stopping of the operation has not been completed. It is expected to take some 
        time for processing.

        The response body shall be empty.

        The API consumer can track the uploading progress by reading the status of the 
        "Individual VNF snapshot package" resource using the GET method.
      headers:
        Version:
          description: The used API version.
          style: simple
          explode: false
          schema:
            type: string
        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

    ExternalArtifactsAccess.Get.200:
      description: |
        200 OK

        Shall be returned when the access configuration information has been read successfully. 

        If no information has been provided previously, an empty array shall be returned.
      headers:
        Version:
          description: The used API version.
          style: simple
          explode: false
          schema:
            type: string
        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
        Content-Type:
          description: The MIME type of the body of the response.
          style: simple
          explode: false
          schema:
            type: string
      content:
        application/json:
          schema:
piscione's avatar
piscione committed
            $ref: definitions/SOL005VNFSnapshotPackageManagement_def.yaml#/definitions/VnfSnapshotPkgExtArtifactsAccessConfig

    ExternalArtifactsAccess.Put.200:
      description: |
        200 OK

        Shall be returned when the attribute "state" equals "CREATED" or when the attribute "state" equals "ERROR" 
        and the VNF snapshot package has not been uploaded successfully previously, to indicate that the access 
        configuration information has been stored successfully by the NFVO.

        The response body shall contain a representation of the state of the resource.
      headers:
        Version:
          description: The used API version.
          style: simple
          explode: false
          schema:
            type: string
        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
        Content-Type:
          description: The MIME type of the body of the response.
          style: simple
          explode: false
          schema:
            type: string
      content:
        application/json:
          schema:
piscione's avatar
piscione committed
            $ref: definitions/SOL005VNFSnapshotPackageManagement_def.yaml#/definitions/VnfSnapshotPkgExtArtifactsAccessConfig

    IndividualArtifact.Get.200:
      description: |
        200 OK

        Shall be returned when the whole content of the artifact file has been read successfully.

        The response body shall include a copy of the artifact file from the VNF snapshot package. 
        The VNF snapshot package format is defined in ETSI GS NFV-SOL 010.

        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".        
      headers:
        Version:
          description: The used API version.
          style: simple
          explode: false
          schema:
            type: string
        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
        Content-Type:
          description: The MIME type of the body of the response.
          style: simple
          explode: false
          schema:
            type: string
      content:
        application/*:
          schema:
            type: string
            format: binary
    
    IndividualArtifact.Get.206:
      description: |
        206 PARTIAL CONTENT

        If the NFVO supports range requests, 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 snapshot package. 
        The VNF snapshot package format is defined in ETSI GS NFV-SOL 010. 
        
        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 7233.
      headers:
        Version:
          description: The used API version.
          style: simple
          explode: false
          schema:
            type: string
        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
        Content-Type:
          description: The MIME type of the body of the response.
          style: simple
          explode: false
          schema:
            type: string
        Content-Range:
          description: The Content-Range response HTTP header indicates where in a full body message a partial message belongs.
          style: simple
          explode: false
          schema:
            type: string
      content:
        application/*:
          schema:
            type: string
            format: binary

    IndividualArtifact.Get.302:

        Shall be returned if the referred "Individual VNF snapshot package artifact" is external to the main
        VNF snapshot package file created from a build process.

        The HTTP response shall include a "Location" HTTP header that contains the resource URI of the artifact.

        The response body shall be empty.
      headers:
        Version:
          description: The used API version.
          style: simple
          explode: false
          schema:
            type: string
        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
        Location:
          description: The resource URI of the artifact.
          style: simple
          explode: false
          schema:
            type: string
            format: url