VNFPackageManagement.yaml 86.4 KB
Newer Older
openapi: 3.0.2
  title: SOL003 - VNF Package Management interface
  description: |
    SOL003 - 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/SOL002-SOL003/issues
  contact:
    name: NFV-SOL WG
  license:
    name: ETSI Forge copyright notice
    url: https://forge.etsi.org/etsi-forge-copyright-notice.txt
  version: "2.2.0-impl:etsi.org:ETSI_NFV_OpenAPI:1"
  description: ETSI GS NFV-SOL 003 V3.5.1
  url: https://www.etsi.org/deliver/etsi_gs/NFV-SOL/001_099/003/03.05.01_60/gs_NFV-SOL003v030501p.pdf
servers:
  - url: http://127.0.0.1/vnfpkgm/v2
  - url: https://127.0.0.1/vnfpkgm/v2
  ###############################################################################
  # API Versions                                                                #
  ###############################################################################
  /api_versions:
    $ref: '../../endpoints/SOL002SOL003_endpoints.yaml#/endpoints/api-versions'
  ###############################################################################
  # VNF packages                                                                #
  ###############################################################################
  /onboarded_vnf_packages:
    #SOL003 location: 10.4.2
    get:
      description: |
        The GET method queries the information of the VNF packages matching the filter. See clause 10.4.2.3.2.
      parameters:
        - $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/Accept
        - $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/Authorization
        - $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/filter
        - $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/all_fields
        - $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/fields
        - $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/exclude_fields
        - $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/exclude_default
        - $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/nextpage_opaque_marker
        - $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/Version
      responses:
        200:
          $ref: '#/components/responses/OnboardedVnfPackages.Get.200'
          $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/400"
          $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/401"
          $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/403"
          $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/404"
          $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/405"
          $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/406"
          $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/422"
          $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/500"
          $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/503"
          $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/504"
  /vnf_packages:
    $ref: '#/paths/~1onboarded_vnf_packages'
  ###############################################################################
  # Individual VNF package                                                      #
  ###############################################################################
  /vnf_packages/{vnfPkgId}:
    parameters:
      - $ref: '#/components/parameters/VnfPkgId'
      description: |
        The GET method reads the information of an individual VNF package. Clause 10.4.3.3.2.
        - $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/Accept
        - $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/Authorization
        - $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/Version
        - $ref: '#/components/parameters/include_signature'
          $ref: '#/components/responses/IndividualVnfPackage.Get.200'
          $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/400"
          $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/401"
          $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/403"
          $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/404"
          $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/405"
          $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/416"
          $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/500"
          $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/503"
          $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/504"
  /onboarded_vnf_packages/{vnfdId}:
      - $ref: '#/components/parameters/VnfdId'
        The GET method reads the information of an individual VNF package. Clause 10.4.3.3.2.
      parameters:
        - $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/Accept
        - $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/Authorization
        - $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/Version
      responses:
        200:
          $ref: '#/components/responses/IndividualOnboardedVnfPackage.Get.200'
          $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/400"
          $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/401"
          $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/403"
          $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/404"
          $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/405"
          $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/406"
          $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/416"
          $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/500"
          $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/503"
          $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/504"
  ###############################################################################
  # VNFD in an individual VNF package                                           #
  ###############################################################################
  /vnf_packages/{vnfPkgId}/vnfd:
    parameters:
      - $ref: '#/components/parameters/VnfPkgId'
        The GET method reads the content of the VNFD within a VNF package. See clause 10.4.4.3.2.
      parameters:
        - $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/Accept
        - $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/Authorization
        - $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/Version
        - $ref: '#/components/parameters/include_signature'
      responses:
        200:
          $ref: '#/components/responses/VnfdInIndividualVnfPackage.Get.200'
          $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/400"
          $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/401"
          $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/403"
          $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/404"
          $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/405"
          $ref: '#/components/responses/VnfdInIndividualVnfPackage.Get.409'
          $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/416"
          $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/500"
          $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/503"
          $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/504"
  /onboarded_vnf_packages/{vnfdId}/vnfd:
      - $ref: '#/components/parameters/VnfdId'
        The GET method reads the content of the VNFD within a VNF package. See clause 10.4.4.3.2.
        - $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/Accept
        - $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/Authorization
        - $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/Version
        - $ref: '#/components/parameters/include_signature'
          $ref: '#/components/responses/VnfdInIndividualOnboardedVnfPackage.Get.200'
          $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/400"
          $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/401"
          $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/403"
          $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/404"
          $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/405"
          $ref: '#/components/responses/VnfdInIndividualOnboardedVnfPackage.Get.409'
          $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/416"
          $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/500"
          $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/503"
          $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/504"
  ###############################################################################
  ###############################################################################
  /vnf_packages/{vnfPkgId}/manifest:
    parameters:
      - $ref: '#/components/parameters/VnfPkgId'
        The GET method reads the content of the manifest within a VNF package. See clause 10.4.4a.3.1.
      parameters:
        - $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/Accept
        - $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/Authorization
        - $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/Version
        - $ref: '#/components/parameters/include_signature'
      responses:
        200:
          $ref: '#/components/responses/ManifestInIndividualVnfPackage.Get.200'
          $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/400"
          $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/401"
          $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/403"
          $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/404"
          $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/405"
          $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/406"
          $ref: '#/components/responses/ManifestInIndividualVnfPackage.Get.409'
          $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/416"
          $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/500"
          $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/503"
          $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/504"
  /onboarded_vnf_packages/{vnfdId}/manifest:
      - $ref: '#/components/parameters/VnfdId'
Giacomo Bernini's avatar
Giacomo Bernini committed
    get:
        The GET method reads the content of the manifest within a VNF package. See clause 10.4.4a.3.1.
Giacomo Bernini's avatar
Giacomo Bernini committed
      parameters:
        - $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/Accept
        - $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/Authorization
        - $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/Version
        - $ref: '#/components/parameters/include_signature'
Giacomo Bernini's avatar
Giacomo Bernini committed
      responses:
        200:
          $ref: '#/components/responses/ManifestInIndividualOnboardedVnfPackage.Get.200'
Giacomo Bernini's avatar
Giacomo Bernini committed
        400:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/400"
Giacomo Bernini's avatar
Giacomo Bernini committed
        401:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/401"
Giacomo Bernini's avatar
Giacomo Bernini committed
        403:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/403"
Giacomo Bernini's avatar
Giacomo Bernini committed
        404:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/404"
Giacomo Bernini's avatar
Giacomo Bernini committed
        405:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/405"
Giacomo Bernini's avatar
Giacomo Bernini committed
        406:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/406"
Giacomo Bernini's avatar
Giacomo Bernini committed
        409:
          $ref: '#/components/responses/ManifestInIndividualOnboardedVnfPackage.Get.409'
Giacomo Bernini's avatar
Giacomo Bernini committed
        416:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/416"
Giacomo Bernini's avatar
Giacomo Bernini committed
        500:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/500"
Giacomo Bernini's avatar
Giacomo Bernini committed
        503:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/503"
Giacomo Bernini's avatar
Giacomo Bernini committed
        504:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/504"
  ###############################################################################
  ###############################################################################
  /vnf_packages/{vnfPkgId}/package_content:
    parameters:
      - $ref: '#/components/parameters/VnfPkgId'
        The GET method fetches the content of a VNF package identified by the VNF package identifier allocated by the NFVO.
        See clause 10.4.5.3.2.
      parameters:
        - $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/Accept
        - $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/Authorization
        - $ref: '#/components/parameters/Range'
        - $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/Version
      responses:
        200:
          $ref: '#/components/responses/IndividualVnfPackageContent.Get.200'
          $ref: '#/components/responses/IndividualVnfPackageContent.Get.206'
          $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/400"
          $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/401"
          $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/403"
          $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/404"
          $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/405"
          $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/406"
          $ref: '#/components/responses/IndividualVnfPackageContent.Get.409'
          #  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 package file (e.g. "access after end of file").
          $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/416"
          $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/500"
          $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/503"
          $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/504"
  /onboarded_vnf_packages/{vnfdId}/package_content:
      - $ref: '#/components/parameters/VnfdId'
        The GET method fetches the content of a VNF package identified by the VNF package identifier allocated by the NFVO.
        See clause 10.4.5.3.2.
      parameters:
        - $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/Accept
        - $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/Authorization
        - $ref: '#/components/parameters/Range'
        - $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/Version
          $ref: '#/components/responses/IndividualOnboardedVnfPackageContent.Get.200'
          $ref: '#/components/responses/IndividualOnboardedVnfPackageContent.Get.206'
          $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/400"
          $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/401"
          $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/403"
          $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/404"
          $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/405"
          $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/406"
          $ref: '#/components/responses/IndividualOnboardedVnfPackageContent.Get.409'
          #  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 package file (e.g. "access after end of file").
          $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/416"
          $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/500"
          $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/503"
          $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/504"

  ###############################################################################
  # VNF package artifacts                                                       #
  ###############################################################################
  /vnf_packages/{vnfPkgId}/artifacts:
      - $ref: '#/components/parameters/VnfPkgId'
        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 10.4.5a.3.2.
        - $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/Accept
        - $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/Authorization
        - $ref: '#/components/parameters/Range'
        - $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/Version
          $ref: '#/components/responses/IndividualVnfPackageArtifacts.Get.200'
          $ref: '#/components/responses/IndividualVnfPackageArtifacts.Get.206'
          $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/400"
          $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/401"
          $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/403"
          $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/404"
          $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/405"
          $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/406"
          $ref: '#/components/responses/IndividualVnfPackageArtifacts.Get.409'
          $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/416"
          $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/500"
          $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/503"
          $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/504"
  /onboarded_vnf_packages/{vnfdId}/artifacts:
      - $ref: '#/components/parameters/VnfdId'
        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 10.4.5a.3.2.
        - $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/Accept
        - $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/Authorization
        - $ref: '#/components/parameters/Range'
        - $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/Version
          $ref: '#/components/responses/IndividualOnboardedVnfPackageArtifacts.Get.200'
          $ref: '#/components/responses/IndividualOnboardedVnfPackageArtifacts.Get.206'
          $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/400"
          $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/401"
          $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/403"
          $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/404"
          $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/405"
          $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/406"
          $ref: '#/components/responses/IndividualOnboardedVnfPackageArtifacts.Get.409'
          $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/416"
          $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/500"
          $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/503"
          $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/504"

  ###############################################################################
  # Individual VNF package artifact                                             #
  ###############################################################################
  /vnf_packages/{vnfPkgId}/artifacts/{artifactPath}:
      - $ref: '#/components/parameters/ArtifactPath'
      - $ref: '#/components/parameters/VnfPkgId'
        The GET method fetches the content of an artifact within a VNF package. See clause 10.4.6.3.2.
        - $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/Accept
        - $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/Authorization
        - $ref: '#/components/parameters/Range'
        - $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/Version
        - $ref: '#/components/parameters/include_signature'
      responses:
        200:
          $ref: '#/components/responses/IndividualVnfPackageArtifact.Get.200'
          $ref: '#/components/responses/IndividualVnfPackageArtifact.Get.206'
          $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/400"
          $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/401"
          $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/403"
          $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/404"
          $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/405"
          $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/406"
          $ref: '#/components/responses/IndividualVnfPackageArtifact.Get.409'
          #  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 artifact file
          #    (e.g. "access after end of file").
          #    The response body may contain a ProblemDetails structure.
          $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/416"
          $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/500"
          $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/503"
          $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/504"
  /onboarded_vnf_packages/{vnfdId}/artifacts/{artifactPath}:
      - $ref: '#/components/parameters/ArtifactPath'
      - $ref: '#/components/parameters/VnfdId'
        The GET method fetches the content of an artifact within a VNF package. See clause 10.4.6.3.2.
        - $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/Accept
        - $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/Authorization
        - $ref: '#/components/parameters/Range'
        - $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/Version
        - $ref: '#/components/parameters/include_signature'
          $ref: '#/components/responses/IndividualOnboardedVnfPackageArtifact.Get.200'
          $ref: '#/components/responses/IndividualOnboardedVnfPackageArtifact.Get.206'
          $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/400"
          $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/401"
          $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/403"
          $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/404"
          $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/405"
          $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/406"
          $ref: '#/components/responses/IndividualOnboardedVnfPackageArtifact.Get.409'
          #  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 artifact file
          #    (e.g. "access after end of file").
          #    The response body may contain a ProblemDetails structure.
          $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/416"
          $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/500"
          $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/503"
          $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/504"
  ###############################################################################
  # Subscriptions                                                               #
  ###############################################################################
  /subscriptions:
    parameters:
      - $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/Accept
      - $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/Authorization
      - $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/Version
        The POST method creates a new subscription. See clause 10.4.7.3.1.
      requestBody:
        $ref: '#/components/requestBodies/PkgmSubscriptionRequest'
      responses:
        201:
          $ref: '#/components/responses/Subscriptions.Post.201'
          #  description: |
          #    303 SEE OTHER

          #    Shall be returned when a subscription with the same callback URI and the same filter
          #    already exists and the policy of the NFVO is to not create redundant subscriptions.
          #    The HTTP response shall include a "Location" HTTP header that contains the resource
          #    URI of the existing "Individual subscription" resource.
          #    The response body shall be empty.
          $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/303"
          $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/400"
          $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/401"
          $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/403"
          $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/404"
          $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/405"
          $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/406"
          $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/422"
          $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/500"
          $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/503"
          $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/504"
        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 10.4.7.3.2.
      parameters:
        - $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/filter
        - $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/nextpage_opaque_marker
      responses:
        200:
          $ref: '#/components/responses/Subscriptions.Get.200'
          $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/400"
          $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/401"
          $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/403"
          $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/404"
          $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/405"
          $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/406"
          $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/422"
          $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/500"
          $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/503"
          $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/504"
  ###############################################################################
  # Individual subscription                                                     #
  ###############################################################################
  /subscriptions/{subscriptionId}:
    #SOL003 location: 10.4.8
    parameters:
      - $ref: '#/components/parameters/SubscriptionId'
      - $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/Authorization
      - $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/Version
        The GET method reads an individual subscription. See clause 10.4.8.3.2.
      parameters:
        - $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/Accept
      responses:
        200:
          $ref: '#/components/responses/IndividualSubscription.Get.200'
          $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/400"
          $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/401"
          $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/403"
          $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/404"
          $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/405"
          $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/406"
          $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/422"
          $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/500"
          $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/503"
          $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/504"
        The DELETE method terminates an individual subscription. See clause 10.4.8.3.5.
      responses:
        204:
          $ref: '#/components/responses/IndividualSubscription.Delete.204'
          $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/400"
          $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/401"
          $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/403"
          $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/404"
          $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/405"
          $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/406"
          $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/422"
          $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/500"
          $ref: "../../responses/SOL002SOL003_resp.yaml#/components/responses/503"
          $ref: "../../responses/SOL002SOL003_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.
        This identifier can be retrieved from the "vnfPkgId" attribute in
        the VnfPackageOnboardingNotification or
        VnfPackageChangeNotification.
      required: true
      style: simple
      explode: false
      schema:
        type: string

    VnfdId:
      name: vnfdId
      in: path
      description: |
        Identifier of the VNFD and the VNF package.
        The identifier is allocated by the VNF provider.
        This identifier can be retrieved from the "vnfdId" attribute
        in the VnfPackageOnboardingNotification or VnfPackageChangeNotification.
Francesca Moscatelli's avatar
Francesca Moscatelli committed
        This identifier can be retrieved from the "vnfdId" attribute in the 
        VnfPackageOnboardingNotification or VnfPackageChangeNotification.
      required: true
      style: simple
      explode: false
      schema:
        type: string

    ArtifactPath:
      name: artifactPath
      in: path
      description: |
        SequenceFor 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.

        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 10.5.3.3),
        representing this artifact.

        Since multiple path segments are allowed to be contained in this variable,
        the "/" character that separates these segments is not percent-encoded.
        Each individual segment is percent-encoded if necessary as defined in clause
        4.1 of ETSI GS NFV-SOL 013.
      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 from
        the "id" attribute in the payload body of that response.
      required: true
      style: simple
      explode: false
      schema:
        type: string

    include_signature:
      name: include_signature
      in: query
      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.    
      required: false
      schema:
        type: string

    Range:
      name: Range
      in: header
      description: |
        The request may contain a "Range" HTTP header to obtain single
        range of bytes from the VNF package file. This can be used to
        continue an aborted transmission.

        If the "Range" header is present in the request and the NFVO
        does not support responding to range requests with a 206 response,
        it shall return a 200 OK response instead.
      required: false
      schema:
        type: string

  requestBodies:
    PkgmSubscriptionRequest:
      description: |
        Representation of the created subscription resource.
        The HTTP response shall include a "Location" HTTP header that
        points to the created subscription resource.
      content:
        application/json:
          schema:
            $ref: "definitions/SOL003VNFPackageManagement_def.yaml#/definitions/PkgmSubscriptionRequest"
      required: true

  responses:
    OnboardedVnfPackages.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 10.5.2.2.
        If the "filter" URI parameter or one of the "all_fields", "fields" (if supported), "exclude_fields"
        (if supported) or "exclude_default" URI parameters was supplied in the request, the data in the
        response body shall have been transformed according to the rules specified in clauses 5.2.2 and
        5.3.2 of ETSI GS NFV-SOL 013, respectively.
        If the VNFM 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:
        Content-Type:
          description: The MIME type of the body of 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
        Version:
          description: The used API version.
          style: simple
          explode: false
          schema:
            type: string
        Link:
          description: |
            Reference to other resources. Used for paging in the present document, see clause 4.7.2.1.
          style: simple
          explode: false
          schema:
            type: string
      content:
        application/json:
          schema:
            type: array
            items:
              $ref: "definitions/SOL003VNFPackageManagement_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 10.5.2.2.
      headers:
        Content-Type:
          description: The MIME type of the body of 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
        Version:
          description: The used API version.
          style: simple
          explode: false
          schema:
            type: string
      content:
        application/json:
          schema:
            $ref: "definitions/SOL003VNFPackageManagement_def.yaml#/definitions/VnfPkgInfo"

    IndividualOnboardedVnfPackage.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 10.5.2.2.
      headers:
        Content-Type:
          description: The MIME type of the body of 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
        Version:
          description: The used API version.
          style: simple
          explode: false
          schema:
            type: string
      content:
        application/json:
          schema:
            $ref: "definitions/SOL003VNFPackageManagement_def.yaml#/definitions/VnfPkgInfo"

    VnfdInIndividualVnfPackage.Get.200:
      description: |
        200 OK

        Shall be returned when the content of the VNFD has been read successfully.
        The payload body 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:
        Content-Type:
          description: The MIME type of the body of the response.
          style: simple
          explode: false
          required: true
          schema:
            type: string
            enum:
              - text/plain
              - application/zip
        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

    VnfdInIndividualVnfPackage.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:
        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: "../../definitions/SOL002SOL003_def.yaml#/definitions/ProblemDetails"

    VnfdInIndividualOnboardedVnfPackage.Get.200:
      description: |
        200 OK

        Shall be returned when the content of the VNFD has been read successfully.
        The payload body 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:
        Content-Type:
          description: The MIME type of the body of the response.
          style: simple
          explode: false
          required: true
          schema:
            type: string
            enum:
              - text/plain
              - application/zip
        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

    VnfdInIndividualOnboardedVnfPackage.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:
        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: "../../definitions/SOL002SOL003_def.yaml#/definitions/ProblemDetails"

    ManifestInIndividualVnfPackage.Get.200:
      description: |
        200 OK

        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 payload body 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
        payload body shall contain a ZIP archive which includes:
        •	a copy of the manifest file of the VNF package;
        •	a copy of the related individual certificate file.
      headers:
        Content-Type:
          description: The MIME type of the body of the response.
          style: simple
          explode: false
          required: true
          schema:
            type: string
            enum:
              - text/plain
              - application/zip
        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

    ManifestInIndividualVnfPackage.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:
        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: "../../definitions/SOL002SOL003_def.yaml#/definitions/ProblemDetails"

    ManifestInIndividualOnboardedVnfPackage.Get.200:
      description: |
        200 OK

        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 payload body 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
        payload body shall contain a ZIP archive which includes:
        •	a copy of the manifest file of the VNF package;
        •	a copy of the related individual certificate file.
      headers:
        Content-Type:
          description: The MIME type of the body of the response.
          style: simple
          explode: false
          required: true
          schema:
            type: string
            enum:
              - text/plain
              - application/zip
        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

    ManifestInIndividualOnboardedVnfPackage.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:
        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: "../../definitions/SOL002SOL003_def.yaml#/definitions/ProblemDetails"

    IndividualVnfPackageContent.Get.200:
      description: |
        200 OK

        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:
        Content-Type:
          description: The MIME type of the body of 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
        Version:
          description: The used API version.
          style: simple
          explode: false
          schema:
            type: string

    IndividualVnfPackageContent.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 VNF package file
        has been read successfully according to the request.
        The response body shall contain the requested part of the VNF package file.
        The "Content-Range" HTTP header shall be provided according to IETF RFC 7233.
        The "Content-Type" HTTP header shall be set as defined above for the "200 OK" response.
      headers:
        Content-Range:
          required : true
          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
        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

    IndividualVnfPackageContent.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:
        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: "../../definitions/SOL002SOL003_def.yaml#/definitions/ProblemDetails"

    IndividualOnboardedVnfPackageContent.Get.200:
      description: |
        200 OK

        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:
        Content-Type:
          description: The MIME type of the body of 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
        Version:
          description: The used API version.
          style: simple
          explode: false
          schema:
            type: string

    IndividualOnboardedVnfPackageContent.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:
        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: "../../definitions/SOL002SOL003_def.yaml#/definitions/ProblemDetails"

    IndividualVnfPackageArtifact.Get.200:
      description: |
        200 OK

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

        If the "include_signatures" request URI parameter was not provided in
        the related request, the payload body shall contain a copy of the artifact
        file from the VNF package, as defined by ETSI GS NFV-SOL 004 and the "Content-Type"
        HTTP header shall be set according to the content type of the artifact file.
        If the artifact is encrypted, the header shall be set to the value "application/cms"
        (IETF RFC 7193). If the content type cannot be determined, the header shall be set
        to the value "application/octet-stream".

        If the "include_signatures" request URI parameter was provided in the related request,
        the "Content-Type" HTTP header shall be set to "application/zip and the payload body
        shall contain a ZIP archive which includes:
        •	a copy of the artifact file from the VNF package, as defined by ETSI GS NFV SOL 004;
        •	the related security information (individual signature file and optional related
            individual certificate file).
      headers:
        Content-Type:
          description: |
            The MIME type of the body of the response.
            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".
          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
        Version:
          description: The used API version.
          style: simple
          explode: false
          schema:
            type: string

    IndividualVnfPackageArtifact.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:
        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: "../../definitions/SOL002SOL003_def.yaml#/definitions/ProblemDetails"

    IndividualOnboardedVnfPackageArtifact.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:
        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: "../../definitions/SOL002SOL003_def.yaml#/definitions/ProblemDetails"

    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:
        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: "../../definitions/SOL002SOL003_def.yaml#/definitions/ProblemDetails"

    IndividualOnboardedVnfPackageArtifacts.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:
        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: "../../definitions/SOL002SOL003_def.yaml#/definitions/ProblemDetails"

    IndividualOnboardedVnfPackageContent.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 VNF package file
        has been read successfully according to the request.
        The response body shall contain the requested part of the VNF package file.
        The "Content-Range" HTTP header shall be provided according to IETF RFC 7233.
        The "Content-Type" HTTP header shall be set as defined above for the "200 OK" response.
      headers:
        Content-Range:
          required : true
          style: simple
          explode: false
          schema:
            type: string
        Content-Type:
          description: The MIME type of the body of the response.
          style: simple
          explode: false
          required: true
          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
        Version:
          description: The used API version.
          style: simple
          explode: false
          schema:
            type: string

1696 1697 1698 1699 1700 1701 1702 1703 1704 1705 1706 1707 1708 1709 1710 1711 1712 1713 1714 1715 1716 1717 1718 1719 1720 1721 1722 1723 1724 1725 1726 1727 1728 1729 1730 1731 1732 1733 1734 1735 1736 1737 1738 1739 1740 1741 1742 1743 1744 1745 1746 1747 1748 1749 1750 1751 1752 1753 1754 1755 1756 1757 1758 1759 1760 1761 1762 1763 1764 1765 1766 1767 1768 1769 1770 1771 1772 1773 1774 1775 1776 1777 1778 1779 1780 1781 1782 1783 1784 1785 1786 1787 1788 1789 1790 1791 1792 1793 1794 1795 1796 1797 1798 1799 1800 1801 1802 1803 1804 1805 1806 1807 1808 1809 1810 1811 1812 1813 1814 1815 1816 1817 1818 1819 1820 1821 1822 1823 1824 1825 1826 1827 1828 1829 1830 1831 1832 1833 1834 1835 1836 1837 1838 1839 1840 1841 1842 1843 1844 1845 1846 1847 1848 1849 1850 1851 1852 1853 1854 1855 1856 1857 1858 1859 1860 1861 1862 1863 1864 1865 1866 1867 1868 1869 1870 1871 1872 1873 1874 1875 1876 1877 1878 1879 1880 1881 1882 1883 1884 1885 1886 1887 1888 1889 1890 1891 1892 1893 1894 1895 1896 1897 1898 1899 1900 1901 1902 1903 1904 1905 1906 1907 1908 1909 1910 1911 1912 1913 1914 1915 1916 1917 1918 1919 1920 1921 1922 1923 1924 1925 1926 1927 1928 1929 1930 1931 1932 1933 1934 1935 1936 1937 1938 1939 1940 1941 1942 1943 1944 1945 1946 1947 1948 1949 1950 1951 1952 1953 1954 1955 1956 1957 1958 1959 1960 1961 1962 1963 1964 1965 1966 1967 1968 1969 1970 1971 1972 1973 1974 1975 1976 1977 1978 1979 1980 1981 1982 1983 1984 1985 1986 1987 1988 1989 1990 1991 1992 1993 1994 1995 1996 1997 1998 1999 2000 2001 2002 2003 2004 2005 2006 2007 2008 2009 2010 2011 2012 2013 2014 2015 2016 2017 2018 2019 2020 2021 2022 2023 2024 2025 2026 2027 2028 2029 2030 2031 2032 2033 2034 2035 2036
    IndividualVnfPackageArtifacts.Get.200:
      description: |
        200 OK

        Shall be returned when the whole content of the archive containing
        the artifact files has been read successfully.
        The payload body shall be a ZIP archive containing the requested
        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:
        Content-Type:
          description: |
            The MIME type of the body of the response.
            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".
          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
        Version:
          description: The used API version.
          style: simple
          explode: false
          schema:
            type: string

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

        If the NFVO supports range requests and the "include_signatures" request
        URI parameter was not present in the related request, this response shall
        be returned when a single consecutive byte range from the content of the
        artifact file, if the NFVO supports range requests has been read successfully
        according to the request.
        The response body shall contain the requested part of the VNF
        package file.
        The "Content-Range" HTTP header shall be provided according to
        IETF RFC 7233.
        The "Content-Type" HTTP header shall be set as defined above for
        the "200 OK" response.
      headers:
        Content-Range:
          required : true
          style: simple
          explode: false
          schema:
            type: string
        Content-Type:
          description: The MIME type of the body of the response.
          style: simple
          explode: false
          required: true
          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
        Version:
          description: The used API version.
          style: simple
          explode: false
          schema:
            type: string

    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".
        The "Content-Range" HTTP header shall be provided according to IETF RFC 7233.
      headers:
        Content-Range:
          required : true
          style: simple
          explode: false
          schema:
            type: string
        Content-Type:
          description: |
            The MIME type of the body of the response.
            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".
          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
        Version:
          description: The used API version.
          style: simple
          explode: false
          schema:
            type: string

    IndividualOnboardedVnfPackageArtifacts.Get.200:
      description: |
        200 OK

        Shall be returned when the whole content of the archive containing
        the artifact files has been read successfully.
        The payload body shall be a ZIP archive containing the requested
        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:
        Content-Type:
          description: |
            The MIME type of the body of the response.
            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".
          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
        Version:
          description: The used API version.
          style: simple
          explode: false
          schema:
            type: string

    IndividualOnboardedVnfPackageArtifacts.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".
        The "Content-Range" HTTP header shall be provided according to IETF RFC 7233.
      headers:
        Content-Range:
          required : true
          style: simple
          explode: false
          schema:
            type: string
        Content-Type:
          description: |
            The MIME type of the body of the response.
            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".
          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
        Version:
          description: The used API version.
          style: simple
          explode: false
          schema:
            type: string

    IndividualOnboardedVnfPackageArtifact.Get.200:
      description: |
        200 OK

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

        If the "include_signatures" request URI parameter was not provided in
        the related request, the payload body shall contain a copy of the artifact
        file from the VNF package, as defined by ETSI GS NFV-SOL 004 and the "Content-Type"
        HTTP header shall be set according to the content type of the artifact file.
        If the artifact is encrypted, the header shall be set to the value "application/cms"
        (IETF RFC 7193). If the content type cannot be determined, the header shall be set
        to the value "application/octet-stream".

        If the "include_signatures" request URI parameter was provided in the related request,
        the "Content-Type" HTTP header shall be set to "application/zip and the payload body
        shall contain a ZIP archive which includes:
        •	a copy of the artifact file from the VNF package, as defined by ETSI GS NFV SOL 004;
        •	the related security information (individual signature file and optional related
            individual certificate file).
      headers:
        Content-Type:
          description: |
            The MIME type of the body of the response.
            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".
          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
        Version:
          description: The used API version.
          style: simple
          explode: false
          schema:
            type: string

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

        If the NFVO supports range requests and the "include_signatures" request
        URI parameter was not present in the related request, this response shall
        be returned when a single consecutive byte range from the content of the
        artifact file, if the NFVO supports range requests has been read successfully
        according to the request.
        The response body shall contain the requested part of the VNF
        package file.
        The "Content-Range" HTTP header shall be provided according to
        IETF RFC 7233.
        The "Content-Type" HTTP header shall be set as defined above for
        the "200 OK" response.
      headers:
        Content-Range:
          required : true
          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
        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

    Subscriptions.Post.201:
      description: |
        201 CREATED

        Shall be returned when the subscription has been created successfully.
        The response body shall contain a representation of the created "Individual subscription" resource.
        The HTTP response shall include a "Location" HTTP header that points to the created resource.
      headers:
        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 PM Job
          style: simple
          explode: false
          schema:
            type: string
            format: url
        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:
        application/json:
          schema:
            type: array
            items:
              $ref: "definitions/SOL003VNFPackageManagement_def.yaml#/definitions/PkgmSubscription"

    Subscriptions.Get.200:
      description: |
        200 OK

        Shall be returned when the list of subscriptions has been queried successfully.
        The response body shall contain in an array the representations of all active
        subscriptions of the functional block that invokes the method, i.e. zero or more
        representations of VNF package management subscriptions as defined in clause 10.5.2.4.
        If the "filter" URI parameter was supplied in the request, the data in the response
        body shall have been transformed according to the rules specified in clause 5.2.2
        of ETSI GS NFV-SOL 013
        If the VNFM 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:
        Content-Type:
          description: The MIME type of the body of 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
        Version:
          description: The used API version.
          style: simple
          explode: false
          schema:
            type: string
        Link:
          description: |
            Reference to other resources. Used for paging in the present document, see clause 4.7.2.1.
          style: simple
          explode: false
          schema:
            type: string
      content:
        application/json:
          schema:
            type: array
            items:
              $ref: "definitions/SOL003VNFPackageManagement_def.yaml#/definitions/PkgmSubscription"

    IndividualSubscription.Get.200:
      description: |
        200 OK

        Shall be returned when information about an individual subscription has been read successfully.
        The response body shall contain a representation of the "Individual subscription" resource.
      headers:
        Content-Type:
          description: The MIME type of the body of 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
        Version:
          description: The used API version.
          style: simple
          explode: false
          schema:
            type: string
      content:
        application/json:
          schema:
            $ref: "definitions/SOL003VNFPackageManagement_def.yaml#/definitions/PkgmSubscription"

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

        Shall be returned when the "Individual subscription" resource has been deleted successfully.
      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