VNFPackageManagement.yaml 88 KB
Newer Older
  title: SOL005 - VNF Package Management Interface
rameshnaraya's avatar
rameshnaraya committed
    SOL005 - VNF Package Management Interface

    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.

    Please report bugs to https://forge.etsi.org/rep/nfv/SOL005/issues

    name: ETSI Forge copyright notice
    url: https://forge.etsi.org/etsi-forge-copyright-notice.txt
Pietro Piscione's avatar
Pietro Piscione committed
  version: 2.4.0-impl:etsi.org:ETSI_NFV_OpenAPI:1
  description: ETSI GS NFV-SOL 005 V3.7.1
  url: https://www.etsi.org/deliver/etsi_gs/NFV-SOL/001_099/005/03.07.01_60/gs_NFV-SOL005v030701p.pdf
servers:
  - url: http://127.0.0.1/vnfpkgm/v2
  - url: https://127.0.0.1/vnfpkgm/v2

  /api_versions:
    $ref: ../endpoints/SOL005_endpoints.yaml#/endpoints/api-versions
      - $ref: ../components/SOL005_params.yaml#/components/parameters/Version
      - $ref: ../components/SOL005_params.yaml#/components/parameters/Authorization
        The GET method queries the information of the VNF packages matching the filter. See clause 9.4.2.3.2.
        - in: query
          name: filter
          description: >
            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 VnfPkgInfo and in data types referenced from 
            it shall be supported by the NFVO in the filter expression. 
          schema:
            type: string
        - $ref: ../components/SOL005_params.yaml#/components/parameters/all_fields
        - $ref: ../components/SOL005_params.yaml#/components/parameters/fields
        - $ref: ../components/SOL005_params.yaml#/components/parameters/exclude_fields
        - in: query
          name: exclude_default
          description: >
            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 
            VnfPkgInfo structure in the response body if this parameter is provided, or none of the parameters 
            "all_fields", "fields", "exclude_fields", "exclude_default" are provided:
            -	softwareImages
            -	additionalArtifacts
            -	userDefinedData
            -	checksum
            -	onboardingFailureDetails
          schema:
            type: string
        - $ref: ../components/SOL005_params.yaml#/components/parameters/nextpage_opaque_marker
        - $ref: ../components/SOL005_params.yaml#/components/parameters/Accept
          $ref: '#/components/responses/VnfPackages.Get.200'
        "400":
          $ref: ../responses/SOL005_resp.yaml#/components/responses/400
        "401":
          $ref: ../responses/SOL005_resp.yaml#/components/responses/401
        "403":
          $ref: ../responses/SOL005_resp.yaml#/components/responses/403
        "404":
          $ref: ../responses/SOL005_resp.yaml#/components/responses/404
        "405":
          $ref: ../responses/SOL005_resp.yaml#/components/responses/405
        "406":
          $ref: ../responses/SOL005_resp.yaml#/components/responses/406
        "500":
          $ref: ../responses/SOL005_resp.yaml#/components/responses/500
        "503":
          $ref: ../responses/SOL005_resp.yaml#/components/responses/503
        "504":
          $ref: ../responses/SOL005_resp.yaml#/components/responses/504
        The POST method creates a new individual VNF package resource. See clause 9.4.2.3.1.
      parameters:
        - $ref: ../components/SOL005_params.yaml#/components/parameters/ContentType
        - $ref: ../components/SOL005_params.yaml#/components/parameters/Accept
      requestBody:
        $ref: '#/components/requestBodies/VnfPackageCreationRequest'
      responses:
        "201":
          $ref: '#/components/responses/VnfPackages.Post.201'
        "400":
          $ref: ../responses/SOL005_resp.yaml#/components/responses/400
        "401":
          $ref: ../responses/SOL005_resp.yaml#/components/responses/401
        "403":
          $ref: ../responses/SOL005_resp.yaml#/components/responses/403
        "404":
          $ref: ../responses/SOL005_resp.yaml#/components/responses/404
        "405":
          $ref: ../responses/SOL005_resp.yaml#/components/responses/405
        "406":
          $ref: ../responses/SOL005_resp.yaml#/components/responses/406
        "409":
          $ref: ../responses/SOL005_resp.yaml#/components/responses/409
        "416":
          $ref: ../responses/SOL005_resp.yaml#/components/responses/416
        "500":
          $ref: ../responses/SOL005_resp.yaml#/components/responses/500
        "503":
          $ref: ../responses/SOL005_resp.yaml#/components/responses/503
        "504":
          $ref: ../responses/SOL005_resp.yaml#/components/responses/504
      - $ref: '#/components/parameters/VnfPkgId'
      - $ref: ../components/SOL005_params.yaml#/components/parameters/Version
      - $ref: ../components/SOL005_params.yaml#/components/parameters/Authorization
        The GET method reads the information of an individual VNF package. See clause 9.4.3.3.2.
        - $ref: ../components/SOL005_params.yaml#/components/parameters/Accept
          $ref: '#/components/responses/IndividualVnfPackage.Get.200'
        "400":
          $ref: ../responses/SOL005_resp.yaml#/components/responses/400
        "401":
          $ref: ../responses/SOL005_resp.yaml#/components/responses/401
        "403":
          $ref: ../responses/SOL005_resp.yaml#/components/responses/403
        "404":
          $ref: ../responses/SOL005_resp.yaml#/components/responses/404
        "405":
          $ref: ../responses/SOL005_resp.yaml#/components/responses/405
        "406":
          $ref: ../responses/SOL005_resp.yaml#/components/responses/406
        "500":
          $ref: ../responses/SOL005_resp.yaml#/components/responses/500
        "503":
          $ref: ../responses/SOL005_resp.yaml#/components/responses/503
        "504":
          $ref: ../responses/SOL005_resp.yaml#/components/responses/504
        The DELETE method deletes an individual VNF Package resource. See clause 9.4.3.3.5.
          $ref: '#/components/responses/IndividualVnfPackage.Delete.204'
        "400":
          $ref: ../responses/SOL005_resp.yaml#/components/responses/400
        "401":
          $ref: ../responses/SOL005_resp.yaml#/components/responses/401
        "403":
          $ref: ../responses/SOL005_resp.yaml#/components/responses/403
        "404":
          $ref: ../responses/SOL005_resp.yaml#/components/responses/404
        "405":
          $ref: ../responses/SOL005_resp.yaml#/components/responses/405
        "406":
          $ref: ../responses/SOL005_resp.yaml#/components/responses/406
        "409":
          $ref: '#/components/responses/IndividualVnfPackage.Delete.409'
        "500":
          $ref: ../responses/SOL005_resp.yaml#/components/responses/500
        "503":
          $ref: ../responses/SOL005_resp.yaml#/components/responses/503
        "504":
          $ref: ../responses/SOL005_resp.yaml#/components/responses/504
        The PATCH method updates the information of a VNF package. See clause 9.4.3.3.4.
      parameters:
        - $ref: ../components/SOL005_params.yaml#/components/parameters/ContentType
      requestBody:
        $ref: '#/components/requestBodies/VnfPackageModificationRequest'
      responses:
        "200":
          $ref: '#/components/responses/IndividualVnfPackage.Patch.200'
        "400":
          $ref: ../responses/SOL005_resp.yaml#/components/responses/400
        "401":
          $ref: ../responses/SOL005_resp.yaml#/components/responses/401
        "403":
          $ref: ../responses/SOL005_resp.yaml#/components/responses/403
        "404":
          $ref: ../responses/SOL005_resp.yaml#/components/responses/404
        "405":
          $ref: ../responses/SOL005_resp.yaml#/components/responses/405
        "406":
          $ref: ../responses/SOL005_resp.yaml#/components/responses/406
        "409":
          $ref: '#/components/responses/IndividualVnfPackage.Patch.409'
        "500":
          $ref: ../responses/SOL005_resp.yaml#/components/responses/500
        "503":
          $ref: ../responses/SOL005_resp.yaml#/components/responses/503
        "504":
          $ref: ../responses/SOL005_resp.yaml#/components/responses/504
  /vnf_packages/{vnfPkgId}/vnfd:
      - $ref: '#/components/parameters/VnfPkgId'
      - $ref: ../components/SOL005_params.yaml#/components/parameters/Version
      - $ref: ../components/SOL005_params.yaml#/components/parameters/Authorization
        The GET method reads the content of the VNFD within a VNF package. See clause 9.4.4.3.2.
        - $ref: ../components/SOL005_params.yaml#/components/parameters/Accept
        - in: query
          name: include_signatures
          description: >
            If this parameter is provided, the NFVO shall include in the ZIP archive the security 
            information as specified above.
            This URI query parameter is a flag, i.e. it shall have no value.
            The NFVO shall support this parameter.
          schema:
            type: string
          $ref: '#/components/responses/IndividualVnfPackageVnfd.Get.200'
        "400":
          $ref: ../responses/SOL005_resp.yaml#/components/responses/400
        "401":
          $ref: ../responses/SOL005_resp.yaml#/components/responses/401
        "403":
          $ref: ../responses/SOL005_resp.yaml#/components/responses/403
        "404":
          $ref: ../responses/SOL005_resp.yaml#/components/responses/404
        "405":
          $ref: ../responses/SOL005_resp.yaml#/components/responses/405
        "406":
          $ref: ../responses/SOL005_resp.yaml#/components/responses/406
        "409":
          $ref: '#/components/responses/IndividualVnfPackageVnfd.Get.409'
        "500":
          $ref: ../responses/SOL005_resp.yaml#/components/responses/500
        "503":
          $ref: ../responses/SOL005_resp.yaml#/components/responses/503
        "504":
          $ref: ../responses/SOL005_resp.yaml#/components/responses/504
  /vnf_packages/{vnfPkgId}/ext_artifacts_access:
    parameters:
      - $ref: '#/components/parameters/VnfPkgId'
      - $ref: ../components/SOL005_params.yaml#/components/parameters/Version
      - $ref: ../components/SOL005_params.yaml#/components/parameters/Authorization
        The GET method reads the access configuration information that is used by the NFVO to get the content of external
        VNF package artifacts. See clause 9.4.4a.3.2.
        - $ref: ../components/SOL005_params.yaml#/components/parameters/Accept
          $ref: '#/components/responses/IndividualVnfPackageExtArtifacts.Get.200'
        "400":
          $ref: ../responses/SOL005_resp.yaml#/components/responses/400
        "401":
          $ref: ../responses/SOL005_resp.yaml#/components/responses/401
        "403":
          $ref: ../responses/SOL005_resp.yaml#/components/responses/403
        "404":
          $ref: ../responses/SOL005_resp.yaml#/components/responses/404
        "405":
          $ref: ../responses/SOL005_resp.yaml#/components/responses/405
        "406":
          $ref: ../responses/SOL005_resp.yaml#/components/responses/406
        "500":
          $ref: ../responses/SOL005_resp.yaml#/components/responses/500
        "503":
          $ref: ../responses/SOL005_resp.yaml#/components/responses/503
        "504":
          $ref: ../responses/SOL005_resp.yaml#/components/responses/504
      description: |
        The PUT method provides the access configuration information for the NFVO to download the content of external
        VNF package artifacts. See clause 9.4.4a.3.4.
        - $ref: ../components/SOL005_params.yaml#/components/parameters/ContentType
      requestBody:
        $ref: '#/components/requestBodies/VnfPackageExtArtifactsRequest'
        "200":
          $ref: '#/components/responses/IndividualVnfPackageExtArtifacts.Put.200'
        "202":
          $ref: '#/components/responses/IndividualVnfPackageExtArtifacts.Put.202'
        "400":
          $ref: ../responses/SOL005_resp.yaml#/components/responses/400
        "401":
          $ref: ../responses/SOL005_resp.yaml#/components/responses/401
        "403":
          $ref: ../responses/SOL005_resp.yaml#/components/responses/403
        "404":
          $ref: ../responses/SOL005_resp.yaml#/components/responses/404
        "405":
          $ref: ../responses/SOL005_resp.yaml#/components/responses/405
        "406":
          $ref: ../responses/SOL005_resp.yaml#/components/responses/406
        "409":
          $ref: '#/components/responses/IndividualVnfPackageExtArtifacts.Put.409'
        "500":
          $ref: ../responses/SOL005_resp.yaml#/components/responses/500
        "503":
          $ref: ../responses/SOL005_resp.yaml#/components/responses/503
        "504":
          $ref: ../responses/SOL005_resp.yaml#/components/responses/504
  /vnf_packages/{vnfPkgId}/manifest:
      - $ref: '#/components/parameters/VnfPkgId'
      - $ref: ../components/SOL005_params.yaml#/components/parameters/Version
      - $ref: ../components/SOL005_params.yaml#/components/parameters/Authorization
        The GET method reads the content of the manifest within a VNF package. See clause 9.4.4b.3.2.
        - $ref: ../components/SOL005_params.yaml#/components/parameters/Accept
        - in: query
          name: include_signatures
          description: >
            If this parameter is provided, the NFVO shall return the manifest and related security information 
            (such as certificate) in a ZIP archive.
            If this parameter is not given, the NFVO shall provide only a copy of the manifest file.  
            This URI query parameter is a flag, i.e. it shall have no value.
            The NFVO shall support this parameter.
          schema:
            type: string
          $ref: '#/components/responses/IndividualVnfPackageManifest.Get.200'
        "400":
          $ref: ../responses/SOL005_resp.yaml#/components/responses/400
        "401":
          $ref: ../responses/SOL005_resp.yaml#/components/responses/401
        "403":
          $ref: ../responses/SOL005_resp.yaml#/components/responses/403
        "404":
          $ref: ../responses/SOL005_resp.yaml#/components/responses/404
        "405":
          $ref: ../responses/SOL005_resp.yaml#/components/responses/405
        "406":
          $ref: '#/components/responses/IndividualVnfPackageManifest.Get.406'
          $ref: '#/components/responses/IndividualVnfPackageManifest.Get.409'
        "500":
          $ref: ../responses/SOL005_resp.yaml#/components/responses/500
        "503":
          $ref: ../responses/SOL005_resp.yaml#/components/responses/503
        "504":
          $ref: ../responses/SOL005_resp.yaml#/components/responses/504
  /vnf_packages/{vnfPkgId}/package_content:
    parameters:
      - $ref: '#/components/parameters/VnfPkgId'
      - $ref: ../components/SOL005_params.yaml#/components/parameters/Version
      - $ref: ../components/SOL005_params.yaml#/components/parameters/Authorization
        The GET method fetches the content of a VNF package identified by the VNF package identifier allocated by the
        NFVO. See clause 9.4.5.3.2.
        - $ref: ../components/SOL005_params.yaml#/components/parameters/Accept
        - $ref: ../components/SOL005_params.yaml#/components/parameters/Range
          $ref: '#/components/responses/IndividualVnfPackageContent.Get.200'
          $ref: '#/components/responses/IndividualVnfPackageContent.Get.206'
        "400":
          $ref: ../responses/SOL005_resp.yaml#/components/responses/400
        "401":
          $ref: ../responses/SOL005_resp.yaml#/components/responses/401
        "403":
          $ref: ../responses/SOL005_resp.yaml#/components/responses/403
        "404":
          $ref: ../responses/SOL005_resp.yaml#/components/responses/404
        "405":
          $ref: ../responses/SOL005_resp.yaml#/components/responses/405
        "406":
          $ref: ../responses/SOL005_resp.yaml#/components/responses/406
        "409":
          $ref: '#/components/responses/IndividualVnfPackageContent.Get.409'
          $ref: '#/components/responses/IndividualVnfPackageContent.Get.416'
        "500":
          $ref: ../responses/SOL005_resp.yaml#/components/responses/500
        "503":
          $ref: ../responses/SOL005_resp.yaml#/components/responses/503
        "504":
          $ref: ../responses/SOL005_resp.yaml#/components/responses/504
Francesca Moscatelli's avatar
Francesca Moscatelli committed
        The PUT method uploads the content of a VNF package.
        See clause 9.4.5.3.3.
      parameters:
        - $ref: ../components/SOL005_params.yaml#/components/parameters/Accept
        - $ref: ../components/SOL005_params.yaml#/components/parameters/ContentType
      requestBody:
        $ref: '#/components/requestBodies/VnfPackageContentRequest'
          $ref: '#/components/responses/IndividualVnfPackageContent.Put.202'
        "400":
          $ref: ../responses/SOL005_resp.yaml#/components/responses/400
        "401":
          $ref: ../responses/SOL005_resp.yaml#/components/responses/401
        "403":
          $ref: ../responses/SOL005_resp.yaml#/components/responses/403
        "404":
          $ref: ../responses/SOL005_resp.yaml#/components/responses/404
        "405":
          $ref: ../responses/SOL005_resp.yaml#/components/responses/405
        "406":
          $ref: ../responses/SOL005_resp.yaml#/components/responses/406
        "409":
          $ref: '#/components/responses/IndividualVnfPackageContent.Put.409'
        "416":
          $ref: ../responses/SOL005_resp.yaml#/components/responses/416
        "500":
          $ref: ../responses/SOL005_resp.yaml#/components/responses/500
        "503":
          $ref: ../responses/SOL005_resp.yaml#/components/responses/503
        "504":
          $ref: ../responses/SOL005_resp.yaml#/components/responses/504
  /vnf_packages/{vnfPkgId}/artifacts:
      - $ref: '#/components/parameters/VnfPkgId'
      - $ref: ../components/SOL005_params.yaml#/components/parameters/Version
      - $ref: ../components/SOL005_params.yaml#/components/parameters/Authorization
        The GET method shall return an archive that contains a set of artifacts according to the provisions for
        inclusion/exclusion defined below, embedded in a directory structure being the same as in the VNF package.
        See clause 9.4.5a.3.2.
        - $ref: ../components/SOL005_params.yaml#/components/parameters/Accept
        - $ref: ../components/SOL005_params.yaml#/components/parameters/Range
        - in: query
          name: include_signatures
          description: >
            If this parameter is provided, the NFVO shall include in the ZIP archive the individual signatures and, 
            if provided, related certificates for the included artifacts, in the format in which they are provided 
            in the VNF package.
            If this parameter is not given, the NFVO shall only provide copies of the artifact files.
            This URI query parameter is a flag, i.e. it shall have no value. The NFVO shall support this parameter.
          schema:
            type: string
        - $ref: ../components/SOL005_params.yaml#/components/parameters/exclude_all_mano_artifacts
        - $ref: ../components/SOL005_params.yaml#/components/parameters/exclude_all_non_mano_artifacts
        - $ref: ../components/SOL005_params.yaml#/components/parameters/select_non_mano_artifact_sets
        - $ref: ../components/SOL005_params.yaml#/components/parameters/include_external_artifacts
          $ref: '#/components/responses/IndividualVnfPackageArtifacts.Get.200'
          $ref: '#/components/responses/IndividualVnfPackageArtifacts.Get.206'
        "400":
          $ref: ../responses/SOL005_resp.yaml#/components/responses/400
        "401":
          $ref: ../responses/SOL005_resp.yaml#/components/responses/401
        "403":
          $ref: ../responses/SOL005_resp.yaml#/components/responses/403
        "404":
          $ref: ../responses/SOL005_resp.yaml#/components/responses/404
        "405":
          $ref: ../responses/SOL005_resp.yaml#/components/responses/405
        "406":
          $ref: ../responses/SOL005_resp.yaml#/components/responses/406
        "409":
          $ref: '#/components/responses/IndividualVnfPackageArtifacts.Get.409'
          $ref: '#/components/responses/IndividualVnfPackageArtifacts.Get.416'
        "500":
          $ref: ../responses/SOL005_resp.yaml#/components/responses/500
        "503":
          $ref: ../responses/SOL005_resp.yaml#/components/responses/503
        "504":
          $ref: ../responses/SOL005_resp.yaml#/components/responses/504
  /vnf_packages/{vnfPkgId}/package_content/upload_from_uri:
    parameters:
      - $ref: '#/components/parameters/VnfPkgId'
      - $ref: ../components/SOL005_params.yaml#/components/parameters/Version
      - $ref: ../components/SOL005_params.yaml#/components/parameters/Authorization
Francesca Moscatelli's avatar
Francesca Moscatelli committed
        The POST method provides the information for the NFVO to get the content of a VNF package.
        See clause 9.4.6.3.1.
        - $ref: ../components/SOL005_params.yaml#/components/parameters/ContentType
      requestBody:
        $ref: '#/components/requestBodies/VnfPackageUploadFromUriRequest'
          $ref: '#/components/responses/IndividualVnfPackageUploadFromUri.Post.202'
        "400":
          $ref: ../responses/SOL005_resp.yaml#/components/responses/400
        "401":
          $ref: ../responses/SOL005_resp.yaml#/components/responses/401
        "403":
          $ref: ../responses/SOL005_resp.yaml#/components/responses/403
        "404":
          $ref: ../responses/SOL005_resp.yaml#/components/responses/404
        "405":
          $ref: ../responses/SOL005_resp.yaml#/components/responses/405
        "406":
          $ref: ../responses/SOL005_resp.yaml#/components/responses/406
        "409":
          $ref: '#/components/responses/IndividualVnfPackageUploadFromUri.Post.409'
        "416":
          $ref: ../responses/SOL005_resp.yaml#/components/responses/416
        "500":
          $ref: ../responses/SOL005_resp.yaml#/components/responses/500
        "503":
          $ref: ../responses/SOL005_resp.yaml#/components/responses/503
        "504":
          $ref: ../responses/SOL005_resp.yaml#/components/responses/504
  /vnf_packages/{vnfPkgId}/artifacts/{artifactPath}:
      - $ref: '#/components/parameters/VnfPkgId'
      - $ref: '#/components/parameters/ArtifactPath'
      - $ref: ../components/SOL005_params.yaml#/components/parameters/Version
      - $ref: ../components/SOL005_params.yaml#/components/parameters/Authorization
Francesca Moscatelli's avatar
Francesca Moscatelli committed
        The GET method fetches the content of an artifact within a VNF package.
        See clause 9.4.7.3.2.
        - $ref: ../components/SOL005_params.yaml#/components/parameters/Accept
        - $ref: ../components/SOL005_params.yaml#/components/parameters/Range
        - in: query
          name: include_signatures
          description: >
            If this parameter is provided, the NFVO shall return the artifact and related security 
            information (such as signature and optional certificate) in a ZIP archive.
            If this parameter is not given, the NFVO shall provide only a copy of the artifact file.
            This URI query parameter is a flag, i.e. it shall have no value.
            The NFVO shall support this parameter.
          schema:
            type: string
          $ref: '#/components/responses/IndividualVnfPackageArtifact.Get.200'
          $ref: '#/components/responses/IndividualVnfPackageArtifact.Get.206'
        "400":
          $ref: ../responses/SOL005_resp.yaml#/components/responses/400
        "401":
          $ref: ../responses/SOL005_resp.yaml#/components/responses/401
        "403":
          $ref: ../responses/SOL005_resp.yaml#/components/responses/403
        "404":
          $ref: ../responses/SOL005_resp.yaml#/components/responses/404
        "405":
          $ref: ../responses/SOL005_resp.yaml#/components/responses/405
        "406":
          $ref: '#/components/responses/IndividualVnfPackageArtifact.Get.406'
          $ref: '#/components/responses/IndividualVnfPackageArtifact.Get.409'
          $ref: '#/components/responses/IndividualVnfPackageArtifact.Get.416'
        "500":
          $ref: ../responses/SOL005_resp.yaml#/components/responses/500
        "503":
          $ref: ../responses/SOL005_resp.yaml#/components/responses/503
        "504":
          $ref: ../responses/SOL005_resp.yaml#/components/responses/504
      - $ref: ../components/SOL005_params.yaml#/components/parameters/Version
      - $ref: ../components/SOL005_params.yaml#/components/parameters/Authorization
      description: |
        The GET method queries the list of active subscriptions of the functional block that invokes the method.
        It can be used e.g. for resynchronization after error situations. See clause 9.4.7.3.2.
        - $ref: ../components/SOL005_params.yaml#/components/parameters/Accept
        - in: query
          name: filter
          description: >
            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 PkgmSubscription and in data types referenced 
            from it shall be supported by the NFVO in the filter expression.
          schema:
            type: string
        - $ref: ../components/SOL005_params.yaml#/components/parameters/nextpage_opaque_marker
          $ref: '#/components/responses/VnfPkgSubscriptions.Get.200'
        "400":
          $ref: ../responses/SOL005_resp.yaml#/components/responses/400
        "401":
          $ref: ../responses/SOL005_resp.yaml#/components/responses/401
        "403":
          $ref: ../responses/SOL005_resp.yaml#/components/responses/403
        "404":
          $ref: ../responses/SOL005_resp.yaml#/components/responses/404
        "405":
          $ref: ../responses/SOL005_resp.yaml#/components/responses/405
        "406":
          $ref: ../responses/SOL005_resp.yaml#/components/responses/406
        "500":
          $ref: ../responses/SOL005_resp.yaml#/components/responses/500
        "503":
          $ref: ../responses/SOL005_resp.yaml#/components/responses/503
        "504":
          $ref: ../responses/SOL005_resp.yaml#/components/responses/504
        The POST method creates a new subscription. See clause 9.4.8.3.1.
      parameters:
        - $ref: ../components/SOL005_params.yaml#/components/parameters/Accept
        - $ref: ../components/SOL005_params.yaml#/components/parameters/ContentType
      requestBody:
        $ref: '#/components/requestBodies/VnfPkgSubscriptionRequest'
      responses:
        "201":
          $ref: '#/components/responses/VnfPkgSubscriptions.Post.201'
          $ref: '#/components/responses/VnfPkgSubscriptions.Post.303'
        "400":
          $ref: ../responses/SOL005_resp.yaml#/components/responses/400
        "401":
          $ref: ../responses/SOL005_resp.yaml#/components/responses/401
        "403":
          $ref: ../responses/SOL005_resp.yaml#/components/responses/403
        "404":
          $ref: ../responses/SOL005_resp.yaml#/components/responses/404
        "405":
          $ref: ../responses/SOL005_resp.yaml#/components/responses/405
        "406":
          $ref: ../responses/SOL005_resp.yaml#/components/responses/406
        "422":
          $ref: '#/components/responses/VnfPkgSubscriptions.Post.422'
        "500":
          $ref: ../responses/SOL005_resp.yaml#/components/responses/500
        "503":
          $ref: ../responses/SOL005_resp.yaml#/components/responses/503
        "504":
          $ref: ../responses/SOL005_resp.yaml#/components/responses/504
  /subscriptions/{subscriptionId}:
      - $ref: '#/components/parameters/SubscriptionId'
      - $ref: ../components/SOL005_params.yaml#/components/parameters/Version
      - $ref: ../components/SOL005_params.yaml#/components/parameters/Authorization
        The GET method reads an individual subscription. See clause 9.4.9.3.2.
        - $ref: ../components/SOL005_params.yaml#/components/parameters/Accept
          $ref: '#/components/responses/VnfPkgSubscription.Get.200'
        "400":
          $ref: ../responses/SOL005_resp.yaml#/components/responses/400
        "401":
          $ref: ../responses/SOL005_resp.yaml#/components/responses/401
        "403":
          $ref: ../responses/SOL005_resp.yaml#/components/responses/403
        "404":
          $ref: ../responses/SOL005_resp.yaml#/components/responses/404
        "405":
          $ref: ../responses/SOL005_resp.yaml#/components/responses/405
        "406":
          $ref: ../responses/SOL005_resp.yaml#/components/responses/406
        "500":
          $ref: ../responses/SOL005_resp.yaml#/components/responses/500
        "503":
          $ref: ../responses/SOL005_resp.yaml#/components/responses/503
        "504":
          $ref: ../responses/SOL005_resp.yaml#/components/responses/504
        The DELETE method terminates an individual subscription. See clause 9.4.9.3.5.
          $ref: '#/components/responses/VnfPkgSubscription.Delete.204'
        "400":
          $ref: ../responses/SOL005_resp.yaml#/components/responses/400
        "401":
          $ref: ../responses/SOL005_resp.yaml#/components/responses/401
        "403":
          $ref: ../responses/SOL005_resp.yaml#/components/responses/403
        "404":
          $ref: ../responses/SOL005_resp.yaml#/components/responses/404
        "405":
          $ref: ../responses/SOL005_resp.yaml#/components/responses/405
        "406":
          $ref: ../responses/SOL005_resp.yaml#/components/responses/406
        "500":
          $ref: ../responses/SOL005_resp.yaml#/components/responses/500
        "503":
          $ref: ../responses/SOL005_resp.yaml#/components/responses/503
        "504":
          $ref: ../responses/SOL005_resp.yaml#/components/responses/504

components:
  parameters:
    VnfPkgId:
      name: vnfPkgId
      in: path
      description: |
        Identifier of the VNF package. The identifier is allocated by the NFVO.
      required: true
      style: simple
      explode: false
      schema:
        type: string

    ArtifactPath:
      name: artifactPath
      in: path
      description: |
        For an artifact contained as a file in the VNF package, this variable shall contain a sequence of one or more path
        segments representing the path of the artifact within the VNF package, relative to the root of the package.
        See note 3. EXAMPLE: foo/bar/m%40ster.sh For an external artifact represented as a URI in the VNF package manifest,
        this variable shall contain a sequence of one or more path segments as synthesized by the NFVO (see clause 9.5.3.3),
        representing this artifact. See note 2 and note 3
      required: true
      style: simple
      explode: false
      schema:
        type: string
    SubscriptionId:
      name: subscriptionId
      in: path
      description: |
        Identifier of this subscription. This identifier can be retrieved from the resource referenced by the "Location"
        HTTP header in the response to a POST request creating a new "Individual subscription" resource. It can also be retrieved
Pietro Piscione's avatar
Pietro Piscione committed
        from the "id" attribute in the message content of that response.
      required: true
      style: simple
      explode: false
      schema:
        type: string

  requestBodies:
    VnfPackageCreationRequest:
      description: |
        IndividualVNF package resource creation parameters, as defined in clause 9.5.2.2
      content:
        application/json:
          schema:
            $ref: ./definitions/SOL005VNFPackageManagement_def.yaml#/definitions/CreateVnfPkgInfoRequest
      required: true

    VnfPackageModificationRequest:
      description: |
        Parameters for VNF package information modifications.
      content:
        application/json:
          schema:
            $ref: ./definitions/SOL005VNFPackageManagement_def.yaml#/definitions/VnfPkgInfoModifications
      required: true

    VnfPackageExtArtifactsRequest:
      description: |
Pietro Piscione's avatar
Pietro Piscione committed
        The message content contains the access configuration information based on which the NFVO can obtain the
        external VNF package artifact files.
      content:
        application/json:
          schema:
            $ref: ./definitions/SOL005VNFPackageManagement_def.yaml#/definitions/ExternalArtifactsAccessConfig
      required: true

    VnfPackageContentRequest:
      content:
        application/binary:
          schema:
            properties:
              file:
                type: string
                description: |
Pietro Piscione's avatar
Pietro Piscione committed
                  The message content contains a ZIP file that represents the VNF package. The "Content-Type" HTTP header shall
                  be set according to the type of the file, i.e. to "application/zip" for a VNF Package as defined in ETSI GS NFV-SOL 004.
                format: binary
      required: true

    VnfPackageUploadFromUriRequest:
      description: |
Pietro Piscione's avatar
Pietro Piscione committed
        The message content contains the address information based on which the NFVO can obtain the content of the VNF package.
        The message content contains the address information based on which the NFVO can obtain the content of the VNF package.
Pietro Piscione's avatar
Pietro Piscione committed
            $ref: ./definitions/SOL005VNFPackageManagement_def.yaml#/definitions/UploadVnfPackageFromUriRequest
      required: true

    VnfPkgSubscriptionRequest:
      description: |
        Details of the subscription to be created.
      content:
        application/json:
          schema:
            $ref: ./definitions/SOL005VNFPackageManagement_def.yaml#/definitions/PkgmSubscriptionRequest
      required: true

  responses:
    VnfPackages.Get.200:
      description: |
        200 OK
        Shall be returned when information about zero or more VNF packages has been queried successfully.
        The response body shall contain in an array the VNF package info representations that match the attribute
        filter, i.e. zero or more VNF package info representations as defined in clause 9.5.2.5.
        If the "filter" URI parameter or one of the "all_fields", "fields", "exclude_fields" or "exclude_default"
        URI parameters was supplied in the request and is supported, 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, respectively.
        If the NFVO supports alternative 2 (paging) according to clause 5.4.2.1 of ETSI GS NFV SOL 013 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.
      headers:
        Version:
          description: |
            Version of the API used in the response.
          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:
            type: array
            items:
              $ref: ./definitions/SOL005VNFPackageManagement_def.yaml#/definitions/VnfPkgInfo

    VnfPackages.Post.201:
      description: |
        201 Created
        Shall be returned when an "Individual VNF package" resource has been created successfully. The response body
        shall contain a representation of the new individual VNF package resource, as defined in clause 9.5.2.5.
        The HTTP response shall include a "Location" HTTP header that contains the resource URI of the individual
        VNF package resource.
      headers:
        Version:
          description: |
            Version of the API used in the response.
          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.This header field shall be present if the response has a
            non-empty message body.
          style: simple
          explode: false
          schema:
            type: string
      content:
        application/json:
          schema:
            $ref: ./definitions/SOL005VNFPackageManagement_def.yaml#/definitions/VnfPkgInfo

    IndividualVnfPackage.Get.200:
      description: |
        200 OK
        Shall be returned when information of the VNF package has been read successfully. The response body shall
        contain the VNF package info representation defined in clause 9.5.2.5.
      headers:
        Version:
          description: |
            Version of the API used in the response.
          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.This header field shall be present if the response has a
            non-empty message body.
          style: simple
          explode: false
          schema:
            type: string
      content:
        application/json:
          schema:
            $ref: ./definitions/SOL005VNFPackageManagement_def.yaml#/definitions/VnfPkgInfo

    IndividualVnfPackage.Delete.204:
      description: |
        204 No Content
        The VNF package has been deleted successfully. The response body shall be empty.
      headers:
        Version:
          description: |
            Version of the API used in the response.
          style: simple
          explode: false
          schema:
            type: string
      content: {}

    IndividualVnfPackage.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 operational state of the VNF package resource is "ENABLED", or the
        usage state is "IN_USE" (i.e. "Individual VNF instance" resource created from the concerned VNF package exists).
        The response body shall contain a ProblemDetails structure, in which the "detail" attribute shall convey more
        information about the error.
      headers:
        Version:
          description: |
            Version of the API used in the response.
          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:
            $ref: "../definitions/SOL005_def.yaml#/definitions/ProblemDetails"

    IndividualVnfPackage.Patch.200:
      description: |
        200 OK
        Shall be returned when the operation has been completed successfully. The response body shall contain
        attribute modifications for an "Individual VNF package" resource.
      headers:
        Version:
          description: |
            Version of the API used in the response.
          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
Pietro Piscione's avatar
Pietro Piscione committed
        ETag:
          description: |
            Etag used in the header response.
          style: simple
          explode: false
          schema:
            type: string
        Last-Modified:
          description: |
            Last-modified used in the header response.
          style: simple
          explode: false
          schema:
            type: string
        If-Unmodified-Since:
          description: |
            Response header available in case the related "Last-Modified" or "ETag" headers 
            have been received in previous responses related to the target resource. 
            The API consumer should provide the "If-Unmodified-Since" or the "If-Match" header fields 
            as conditions (see sections 3.1 and 3.4 of IETF RFC 9110). 
          style: simple
          explode: false
          schema:
              type: string
        If-Match:
          description: |
            Response header available in case the related "Last-Modified" or "ETag" headers 
            have been received in previous responses related to the target resource. 
            The API consumer should provide the "If-Unmodified-Since" or the "If-Match" header fields 
            as conditions (see sections 3.1 and 3.4 of IETF RFC 9110). 
          style: simple
          explode: false
          schema:
              type: string
            $ref: ./definitions/SOL005VNFPackageManagement_def.yaml#/definitions/VnfPkgInfoModifications
    IndividualVnfPackage.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 resource.
        Typically, this is due to any of the following scenarios:
        - Disable a VNF package resource of which the operational state is not "ENABLED"
        - Enable a VNF package resource of which the operational state is not "DISABLED"
        The response body shall contain a ProblemDetails structure, in which the "detail"
        attribute shall convey more information about the error.
      headers:
        Version:
          description: |
            Version of the API used in the response.
          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:
            $ref: "../definitions/SOL005_def.yaml#/definitions/ProblemDetails"

    IndividualVnfPackageVnfd.Get.200:
Pietro Piscione's avatar
Pietro Piscione committed
        Shall be returned when the content of the VNFD has been read successfully. The message content shall contain a
        copy of the file representing the VNFD or a ZIP file that contains the file or multiple files representing
        the VNFD, as specified above. The "Content-Type" HTTP header shall be set according to the format of the
        returned file, i.e. to "text/plain" for a YAML file or to "application/zip" for a ZIP file.
      headers:
        Version:
          description: |
            Version of the API used in the response.
          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: {}

    IndividualVnfPackageVnfd.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 "onboardingState" of the VNF package has a value different from
        "ONBOARDED".
        The response body shall contain a ProblemDetails structure, in which the "detail" attribute shall convey
        more information about the error.
      headers:
        Version:
          description: |
            Version of the API used in the response.
          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:
            $ref: "../definitions/SOL005_def.yaml#/definitions/ProblemDetails"

    IndividualVnfPackageExtArtifacts.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: |
            Version of the API used in the response.
          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:
            $ref: ./definitions/SOL005VNFPackageManagement_def.yaml#/definitions/ExternalArtifactsAccessConfig

    IndividualVnfPackageExtArtifacts.Put.200:
      description: |
        200 OK
        Shall be returned when the attribute "onboardingState" = "CREATED" or when the attribute "onboardingState" = "ERROR"
        and the VNF 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: |
            Version of the API used in the response.
          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
Pietro Piscione's avatar
Pietro Piscione committed
        ETag:
          description: |
            Etag used in the header response.
          style: simple
          explode: false
          schema:
            type: string
        Last-Modified:
          description: |
            Last-modified used in the header response.
          style: simple
          explode: false
          schema:
            type: string
        If-Unmodified-Since:
          description: |
            Response header available in case the related "Last-Modified" or "ETag" headers 
            have been received in previous responses related to the target resource. 
            The API consumer should provide the "If-Unmodified-Since" or the "If-Match" header fields 
            as conditions (see sections 3.1 and 3.4 of IETF RFC 9110). 
          style: simple
          explode: false
          schema:
              type: string
        If-Match:
          description: |
            Response header available in case the related "Last-Modified" or "ETag" headers 
            have been received in previous responses related to the target resource. 
            The API consumer should provide the "If-Unmodified-Since" or the "If-Match" header fields 
            as conditions (see sections 3.1 and 3.4 of IETF RFC 9110). 
          style: simple
          explode: false
          schema:
              type: string
            $ref: ./definitions/SOL005VNFPackageManagement_def.yaml#/definitions/ExternalArtifactsAccessConfig

    IndividualVnfPackageExtArtifacts.Put.202:
      description: |
        202 ACCEPTED

        "onboardingState" = "ERROR" and the VNF package has been uploaded successfully previously, to indicate that
        the access configuration information has been stored successfully by the NFVO and the NFVO now starts downloading external artifacts.
        The response body shall be empty.
        Prior to returning the 202 response, the NFVO shall set the "onboardingState" attribute to "UPLOADING".
        Subsequently to returning the 202 response, the NFVO shall retry the download of those external artifacts
        that have failed downloading, or that were downloaded successfully previously and for which modified access configuration information has been provided in the request.
      headers:
        Version:
          description: |
            Version of the API used in the response.
          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
        Location:
          description: The resource URI of the created NS instance
          style: simple
          explode: false
          schema:
            type: string
            format: url
      content: {}

    IndividualVnfPackageExtArtifacts.Put.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 "onboardingState" attribute contains a value different
        from "CREATED" or "ERROR".
        The response body shall contain a ProblemDetails structure, in which the "detail" attribute shall
        convey more information about the error.
      headers:
        Version:
          description: |
            Version of the API used in the response.
          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:
            $ref: "../definitions/SOL005_def.yaml#/definitions/ProblemDetails"

    IndividualVnfPackageManifest.Get.200:
Pietro Piscione's avatar
Pietro Piscione committed
  
        Shall be returned when the content of the manifest has been read successfully. If the "include_signatures" URI query 
        parameter was absent in the request, or if the manifest file has all security-related information embedded (i.e. 
        there is no separate certificate file), the message content shall contain a copy of the manifest file of the VNF
        package, and the "Content-Type" HTTP header shall be set to "text/plain". 
        If the "include_signatures" URI query parameter was present in the related request and the manifest file does 
        not have all the security-related information embedded (i.e. there is a separate certificate file), 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 manifest file of the VNF package 
      headers:
        Version:
          description: |
            Version of the API used in the response.
          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: {}

    IndividualVnfPackageManifest.Get.406:
        406 Not Acceptable

        If the related request contained an "Accept" header not compatible with the Content type "application/zip" but
        the "include_signatures" flag was provided, the NFVO shall respond with this response code.
        The "ProblemDetails" structure may be included with the "detail" attribute providing more information about the error.
      headers:
        Version:
          description: |
            Version of the API used in the response.
          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

    IndividualVnfPackageManifest.Get.409:
        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 "onboardingState" of the VNF package has a value different
        from "ONBOARDED".
        The response body shall contain a ProblemDetails structure, in which the "detail" attribute shall convey
        more information about the error.
      headers:
        Version:
          description: |
            Version of the API used in the response.
          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:
            $ref: "../definitions/SOL005_def.yaml#/definitions/ProblemDetails"
    IndividualVnfPackageContent.Get.200:
        Shall be returned when the whole content of the VNF package file has been read successfully. The response body
        shall include a copy of the VNF package file. The "Content-Type" HTTP header shall be set according to the type
        of the file, i.e. to "application/zip" for a VNF Package as defined in ETSI GS NFV-SOL 004.
      headers:
        Version:
          description: |
            Version of the API used in the response.
          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: {}

    IndividualVnfPackageContent.Get.206:
        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 VNF package file has been read successfully according to the request.
        The response body shall contain the requested part of the VNF package file.
Pietro Piscione's avatar
Pietro Piscione committed
        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:
        Version:
          description: |
            Version of the API used in the response.
          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
    IndividualVnfPackageContent.Get.409:
        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 "onboardingState" of the VNF package has a value different from
        "ONBOARDED".
        The response body shall contain a ProblemDetails structure, in which the "detail" attribute shall convey
        more information about the error.
      headers:
        Version:
          description: |
            Version of the API used in the response.
          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:
            $ref: "../definitions/SOL005_def.yaml#/definitions/ProblemDetails"
    IndividualVnfPackageContent.Get.416:
        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 package file (e.g. "access after end of file").
        The response body may contain a ProblemDetails structure.
      headers:
        Version:
          description: |
            Version of the API used in the response.
          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

    IndividualVnfPackageContent.Put.202:
      description: |
        202 ACCEPTED
        Shall be returned when the VNF package has been accepted for uploading, but the processing has not been completed.
        It is expected to take some time for processing. The response body shall be empty. See note.
      headers:
        Version:
          description: |
            Version of the API used in the response.
          style: simple
          explode: false
            type: string
      content: {}
    IndividualVnfPackageContent.Put.409:
        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 onboarding state of the VNF package resource is not "CREATED"
        or "ERROR".
        The response body shall contain a ProblemDetails structure, in which the "detail" attribute shall convey
        more information about the error.
      headers:
        Version:
          description: |
            Version of the API used in the response.
          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:
            $ref: "../definitions/SOL005_def.yaml#/definitions/ProblemDetails"

    IndividualVnfPackageArtifacts.Get.200:
      description: |
        200 OK
        Shall be returned when the whole content of the archive containing the artifact files has been read successfully.
Pietro Piscione's avatar
Pietro Piscione committed
        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, the separate certificate files from the VNF package.
        The "Content-Type" HTTP header shall be set to "application/zip".
      headers:
        Version:
          description: |
            Version of the API used in the response.
          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: {}

    IndividualVnfPackageArtifacts.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 archive that would have been returned in a "200 OK" response has been
        read 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".
Pietro Piscione's avatar
Pietro Piscione committed
        The "Content-Range" HTTP header shall be provided according to IETF RFC 9110.
      headers:
        Version:
          description: |
            Version of the API used in the response.
          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

    IndividualVnfPackageArtifacts.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 "onboardingState" of the VNF package has a value different from "ONBOARDED".
        The response body shall contain a ProblemDetails structure, in which the "detail" attribute shall
        convey more information about the error.
      headers:
        Version:
          description: |
            Version of the API used in the response.
          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:
            $ref: "../definitions/SOL005_def.yaml#/definitions/ProblemDetails"

    IndividualVnfPackageArtifacts.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 archive file (e.g. "access after end of file").
        The response body may contain a ProblemDetails structure.
      headers:
        Versio