VNFPackageManagement.yaml 63.6 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 and has not been approved by the ETSI NFV ISG. In case of discrepancies the published ETSI Group Specification
    takes precedence. Please report bugs to https://forge.etsi.org/bugzilla/buglist.cgi?component=Nfv-Openapis
  contact:
    name: NFV-SOL WG
    name: ETSI Forge copyright notice
    url: https://forge.etsi.org/etsi-forge-copyright-notice.txt
  version: 2.0.0-impl:etsi.org:ETSI_NFV_OpenAPI:1

  description: ETSI GS NFV-SOL 005 V2.7.1
  url: https://www.etsi.org/deliver/etsi_gs/NFV-SOL/001_099/005/02.07.01_60/gs_NFV-SOL005v020701p.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
rameshnaraya's avatar
rameshnaraya committed
      summary: Query VNF packages information.
      description: |
        The GET method queries the information of the VNF packages matching the filter. This method shall follow the
        provisions specified in the  Tables 9.4.2.3.2-1 and 9.4.2.3.2-2 for URI query parameters, request and response
        data structures, and response codes.
        - $ref: ../components/SOL005_params.yaml#/components/parameters/filter
        - $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
        - $ref: ../components/SOL005_params.yaml#/components/parameters/exclude_default
        - $ref: ../components/SOL005_params.yaml#/components/parameters/nextpage_opaque_marker
        - $ref: ../components/SOL005_params.yaml#/components/parameters/Accept
        "200":
          $ref: '#/components/responses/VnfPackages.Get'
        "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
    post:
      summary: Create a new individual VNF package resource.
      description: |
        The POST method creates a new individual VNF package resource.
        Upon successful creation of the "Individual VNF package" resource, the NFVO shall set the "onboardingState"
        attribute in the "VnPkgInfo" structure to "CREATED", the "operationalState" attribute to "DISABLED", and the
        "usageState" attribute to "NOT_IN_USE".
      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'
        "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
    get:
      summary: Read information about an individual VNF package.
        The GET method reads the information of a VNF package.
        - $ref: ../components/SOL005_params.yaml#/components/parameters/Accept
        "200":
          $ref: '#/components/responses/IndividualVnfPackage.Get'
        "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

    delete:
      summary: Delete an individual VNF package.
        The DELETE method deletes an individual VNF Package resource.
      responses:
        "204":
          $ref: '#/components/responses/IndividualVnfPackage.Delete'
        "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
        "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
    patch:
      summary: Update information about an individual VNF package.
      description: |
        The PATCH method updates the information of a VNF package.
        This method shall follow the provisions specified in the  Tables 9.4.3.3.4-1 and 9.4.3.3.4-2 for URI query
        parameters, request and response data structures, and response codes.
      parameters:
        - $ref: ../components/SOL005_params.yaml#/components/parameters/ContentType
      requestBody:
        $ref: '#/components/requestBodies/VnfPackageModificationRequest'
      responses:
        "200":
          $ref: '#/components/responses/IndividualVnfPackage.Patch'
        "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
        "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
    get:
      summary: Read VNFD of an on-boarded VNF package.
        The GET method reads the content of the VNFD within a VNF package.
        The default format of the ZIP archive shall be the one specified in ETSI GS NFV-SOL 004 where only the files
        representing the VNFD and information necessary to navigate the ZIP file and to identify the file that is the
        entry point for parsing the VNFD and (if requested) further security information are included. This means that
        the structure of the ZIP archive shall correspond to the directory structure used in the VNF package and that
        the archive shall contain the following files from the package: • TOSCA.meta (if available in the package).
        The main TOSCA definitions YAML file (either as referenced from TOSCA.meta or available as a file with the extension
        ".yml" or ".yaml" from the root of the archive). Every component of the VNFD referenced (recursively) from the main
        TOSCA definitions YAML file. • The related security information, if the "include_signatures" URI parameter is provided,
        as follows:
        - the manifest file;
        - the singleton certificate file in the root of the VNF package (if available in the package);
        - the signing certificates of the individual files included in the ZIP archive (if available in the package);
        - the signatures of the individual files (if available in the package).
      parameters:
        - $ref: ../components/SOL005_params.yaml#/components/parameters/Accept
        - $ref: ../components/SOL005_params.yaml#/components/parameters/include_signatures
        "200":
          $ref: '#/components/responses/IndividualVnfPackageVnfd.Get'
        "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
        "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
      summary: Get the content of external VNF package artifacts.
        The GET method reads the access configuration information that is used by the NFVO to get the content of external
        VNF package artifacts. This method shall follow the provisions specified in the Tables 9.4.4a.3.2-1 and 9.4.4a.3.2-2
        for URI query parameters, request and response data structures, and response codes.
        - $ref: ../components/SOL005_params.yaml#/components/parameters/Accept
        "200":
          $ref: '#/components/responses/IndividualVnfPackageExtArtifacts.Get'
        "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
    put:
      summary: Download the content of external VNF package artifacts.
      description: |
        The PUT method provides the access configuration information for the NFVO to download the content of external
        VNF package artifacts. As precondition for invoking this method, the individual VNF package resource shall have
        been created, and the value of "onboardingState" attribute shall equal to "CREATED" or "ERROR". The resource
        representation in the payload body of the PUT request shall replace the current state of the resource. This method
        shall follow the provisions specified in the Tables 9.4.4a.3.3-1 and 9.4.4a.3.3-2 for URI query parameters, request
        and response data structures, and response codes.
        - $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: ../responses/SOL005_resp.yaml#/components/responses/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.
        - $ref: ../components/SOL005_params.yaml#/components/parameters/Accept
        - $ref: ../components/SOL005_params.yaml#/components/parameters/include_signatures
        "200":
          $ref: '#/components/responses/IndividualVnfPackageManifest.Get'
        "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
        "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
rameshnaraya's avatar
rameshnaraya committed
      summary: Fetch an on-boarded VNF package.
        The GET method fetches the content of a VNF package identified by the VNF package identifier allocated by the
        NFVO. The content of the package is provided as onboarded, i.e. depending on the security option used, the CSAR
        or the CSAR wrapped in a ZIP archive together with an external signature is returned, as defined in clause 5.1
        of ETSI GS NFV-SOL 004 [5]. NOTE: Information about the applicable security option can be obtained by evaluating
        the "packageSecurityOption" attribute in the "VnfPkgInfo" structure. This method shall follow the provisions
        specified in the Tables 9.4.5.3.2-1 and 9.4.5.3.2-2 for URI query parameters, request and response data structures,
        and response codes.
        - $ref: ../components/SOL005_params.yaml#/components/parameters/Accept
        - $ref: ../components/SOL005_params.yaml#/components/parameters/Range
        "200":
          $ref: '#/components/responses/IndividualVnfPackageContent.Get'
        "206":
          $ref: ../responses/SOL005_resp.yaml#/components/responses/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: ../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
rameshnaraya's avatar
rameshnaraya committed
      summary: Upload a VNF package by providing the content of the VNF package.
      description: |
        The PUT method uploads the content of a VNF package. This method shall follow the provisions specified in the
        Tables 9.4.5.3.3-1 and 9.4.5.3.3-2 for URI query parameters, request and response data structures, and response
        codes. Upon start of the upload of the package, the NFVO shall set the "onboardingState" attribute in the "VnfPkgInfo"
        structure to "UPLOADING". Upon successful upload of the package, if the package references external artifacts, the
        NFVO shall obtain the external artifacts. Subsequently, upon success, the NFVO shall set that attribute to "PROCESSING"
        and shall process the package, which shall include checking package consistency. Upon successful processing, the NFVO
        shall set the "onboardingState" attribute to "ONBOARDED". If an error occurs during uploading the package, downloading
        the external artifacts or processing the package, the NFVO shall set the "onboardingState" attribute to "ERROR" and
        shall populate the "onboardingFailureDetails" attribute in "VnfPkgInfo".
      parameters:
        - $ref: ../components/SOL005_params.yaml#/components/parameters/Accept
        - $ref: ../components/SOL005_params.yaml#/components/parameters/ContentType
      requestBody:
        $ref: '#/components/requestBodies/VnfPackageContentRequest'
        "202":
          $ref: '#/components/responses/IndividualVnfPackageContent.Put'
        "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
  /vnf_packages/{vnfPkgId}/artifacts:
      - $ref: '#/components/parameters/VnfPkgId'
      - $ref: ../components/SOL005_params.yaml#/components/parameters/Version
      - $ref: ../components/SOL005_params.yaml#/components/parameters/Authorization
    get:
      summary: Fetch set of VNF package artifacts.
        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.
        The criteria for exclusion/inclusion of an artifact in the archive are defined as follows:
        * Artifacts that are software images shall be excluded from the archive.
        * Artifacts that are external to the VNF package shall be excluded from the archive.
        * All additional artifacts included in the VNF package that are MANO artifacts shall be included in the archive,
          unless the URI query parameter "exclude_all_mano_artifacts" has been provided, in which case such artifacts
          shall be excluded.
        * All additional artifacts included in the VNF package that are non-MANO artifacts shall be included in the archive,
          unless:
          - the URI query parameter "exclude_all_non_mano_artifacts" has been provided, in which case such artifacts shall
            be excluded;
          - the URI query parameter "select_non_mano_artifact_sets" has been provided and is supported by the NFVO,
            in which case only those non-MANO artifacts shall be included whose non-MANO artifact set identifier matches
            one of the values of the query parameter. Package metadata such as manifest file or VNFD shall not be included
            in the archive. This method shall follow the provisions specified in the Tables 9.4.5a.3.2-1 and 9.4.5a.3.2-2
            for URI query parameters, request and response data structures, and response codes.
        - $ref: ../components/SOL005_params.yaml#/components/parameters/Accept
        - $ref: ../components/SOL005_params.yaml#/components/parameters/Range
        - $ref: ../components/SOL005_params.yaml#/components/parameters/include_signatures
        - $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
        "200":
          $ref: '#/components/responses/IndividualVnfPackageArtifacts.Get'
        "206":
          $ref: ../responses/SOL005_resp.yaml#/components/responses/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: ../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
  /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
      summary: Upload a VNF package by providing the address information of the VNF
        package.
      description: |
        The POST method provides the information for the NFVO to get the content of a VNF package. This method shall
        follow the provisions specified in the Tables 9.4.6.3.1-1 and 9.4.6.3.1-2 for URI query parameters, request
        and response data structures, and response codes. Upon start of obtaining the package, the NFVO shall set the
        "onboardingState" attribute in the "VnfPkgInfo" structure to "UPLOADING". Upon successfully obtaining the
        package, if the package references external artifacts, the NFVO shall obtain the external artifacts. Subsequently,
        upon success, the NFVO shall set that attribute to "PROCESSING" and shall process the package, which shall include
        checking package consistency. Upon successful processing, the NFVO shall set the "onboardingState" attribute to
        "ONBOARDED", the "operationalState" attribute to "ENABLED", and the "usageState" attribute to "NOT_IN_USE".
        In addition, the NFVO shall set the value of the attributes in the "VnfPkgInfo" that are copied from the VNFD
        (refer to clause 9.5.2.5). If an error occurs during obtaining the package, downloading the external artifacts or processing
        the package, the NFVO shall set the "onboardingState" attribute to "ERROR" and shall populate the "onboardingFailureDetails"
        attribute in "VnfPkgInfo".
        - $ref: ../components/SOL005_params.yaml#/components/parameters/ContentType
      requestBody:
        $ref: '#/components/requestBodies/VnfPackageUploadFromUriRequest'
        "202":
          $ref: '#/components/responses/IndividualVnfPackageUploadFromUri.Post'
        "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
  /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
    get:
      summary: Fetch individual VNF package artifact.
      description: |
        The GET method fetches the content of an artifact within a VNF package. This method shall follow the provisions
        specified in the Tables 9.4.7.3.2-1 and 9.4.7.3.2-2 for URI query parameters, request and response data structures,
        and response codes.
        - $ref: ../components/SOL005_params.yaml#/components/parameters/Accept
        - $ref: ../components/SOL005_params.yaml#/components/parameters/Range
        - $ref: ../components/SOL005_params.yaml#/components/parameters/include_signatures
        "200":
          $ref: '#/components/responses/IndividualVnfPackageArtifact.Get'
        "206":
          $ref: ../responses/SOL005_resp.yaml#/components/responses/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: ../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/SOL005_params.yaml#/components/parameters/Version
      - $ref: ../components/SOL005_params.yaml#/components/parameters/Authorization
      summary: Query multiple subscriptions.
      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. This method shall follow the provisions
        specified in the Tables 9.4.8.3.2-1 and 9.4.8.3.2-2 for URI query parameters, request and response data
        structures, and response codes.
        - $ref: ../components/SOL005_params.yaml#/components/parameters/Accept
        - $ref: ../components/SOL005_params.yaml#/components/parameters/filter
        - $ref: ../components/SOL005_params.yaml#/components/parameters/nextpage_opaque_marker
        "200":
          $ref: '#/components/responses/VnfPkgSubscriptions.Get'
        "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
    post:
      summary: Subscribe to notifications related to on-boarding and/or changes of VNF packages.
      description: |
        The POST method creates a new subscription. This method shall follow the provisions specified in the Tables
        9.4.8.3.1-1 and 9.4.8.3.1-2 for URI query parameters, request and response data structures, and response codes.
        As the result of successfully executing this method, a new "Individual subscription" resource shall exist as
        defined in clause 9.4.9. This method shall not trigger any notification. Creation of two subscription resources
        with the same callbackURI and the same filter can result in performance degradation and will provide duplicates
        of notifications to the OSS, and might make sense only in very rare use cases. Consequently, the NFVO may either
        allow creating a subscription resource if another subscription resource with the same filter and callbackUri
        already exists (in which case it shall return the "201 Created" response code), or may decide to not create a
        duplicate subscription resource (in which case it shall return a "303 See Other" response code referencing the
        existing subscription resource with the same filter and callbackUri).
      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'
        "303":
          $ref: ../responses/SOL005_resp.yaml#/components/responses/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: ../responses/SOL005_resp.yaml#/components/responses/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
      summary: Read an individual subscription resource.
      description: |
        Query Subscription Information The GET method reads an individual subscription.
        - $ref: ../components/SOL005_params.yaml#/components/parameters/Accept
        "200":
          $ref: '#/components/responses/VnfPkgSubscription.Get'
        "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
      summary: Terminate a subscription.
      description: |
        The DELETE method terminates an individual subscription. This method shall follow the provisions specified in the
        Tables 9.4.9.3.5-1 and 9.4.9.3.5-2 for URI query parameters, request and response data structures, and response codes.
        As the result of successfully executing this method, the "Individual subscription" resource shall not exist any longer.
        This means that no notifications for that subscription shall be sent to the formerly-subscribed API consumer.
        NOTE: Due to race conditions, some notifications might still be received by the formerly-subscribed API consumer
        for a certain time period after the deletion.
        "204":
          $ref: '#/components/responses/VnfPkgSubscription.Delete'
        "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
        from the "id" attribute in the payload body 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: |
        The payload body 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: |
                  The payload body 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: |
        The payload body contains the address information based on which the NFVO can obtain the content of the VNF package.
      content:
        application/json:
          schema:
            $ref: ./definitions/SOL005VNFPackageManagement_def.yaml#/definitions/UploadVnfPkgFromUriRequest
      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:
      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:
      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:
      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:
      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.Patch:
      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