VNFPackageManagement.yaml 107 KB
Newer Older
swagger: "2.0"

info:
  version: "2.0.0-impl:etsi.org:ETSI_NFV_OpenAPI:1"
  title: SOL003 - VNF Package Management interface
    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.

    In clause 4.3.2 of ETSI GS NFV-SOL 003 v2.4.1, an attribute-based
    filtering mechanism is defined. This mechanism is currently not
    included in the corresponding OpenAPI design for this GS version. Changes
    to the attribute-based filtering mechanism are being considered in v2.5.1
    of this GS for inclusion in the corresponding future ETSI NFV OpenAPI
    design.
    Please report bugs to https://forge.etsi.org/bugzilla/buglist.cgi?component=Nfv-Openapis&list_id=61&product=NFV&resolution=
  license:
    name: "ETSI Forge copyright notice"
    url: https://forge.etsi.org/etsi-forge-copyright-notice.txt
  description: ETSI GS NFV-SOL 003 V2.7.1
  url: https://www.etsi.org/deliver/etsi_gs/NFV-SOL/001_099/003/02.07.01_60/gs_NFV-SOL003v020701p.pdf

schemes:
  - https

consumes:
  - "application/json"
produces:
  - "application/json"

paths:
  ###############################################################################
  # API Versions                                                                #
  ###############################################################################
    $ref: '../../endpoints/SOL002SOL003_endpoints.yaml#/endpoints/api-versions'
  ###############################################################################
  # VNF packages                                                                #
  ###############################################################################
  '/onboarded_vnf_packages':
    #SOL003 location: 10.4.2
    get:
      description: >
        Query VNF Package Info.
        The GET method queries the information of the VNF packages matching the filter.
        This method shall follow the provisions specified in the tables 10.4.2.3.2-1 and 10.4.2.3.2-2
        for URI query parameters, request and response data structures, and response codes.
      parameters:
        - name: Accept
          description: >
            Content-Types that are acceptable for the response.
            Reference: IETF RFC 7231
          in: header
          required: true
          type: string
        - name: Authorization
          description: >
            The authorization token for the request.
            Reference: IETF RFC 7235
          in: header
Gergely Csatari's avatar
Gergely Csatari committed
          required: false
          type: string
            Attribute-based filtering expression according to clause 5.2 of ETSI GS NFV SOL 013.
            The VNFM shall support receiving this parameter as part of the 
            URI query string. The NFVO may supply this parameter. 
            All attribute names that appear in the VnfPkgInfo and in data 
            types referenced from it shall be supported by the VNFM in the 
            filter expression.
          in: query
          required: false
          type: string
        - name: all_fields
          description: >
            Include all complex attributes in the response.
            See clause 5.3 of ETSI GS NFV SOL 013 for details. The VNFM shall support this parameter.
          in: query
          required: false
          type: string
        - name: fields
          description: >
            Complex attributes to be included into the response.
            See clause 5.3 of ETSI GS NFV SOL 013 for details. The VNFM should support this parameter.
          in: query
          required: false
          type: string
        - name: exclude_fields
          description: >
            Complex attributes to be excluded from the response.
            See clause 5.3 of ETSI GS NFV SOL 013 for details. The VNFM should support this parameter.
            The following attributes shall be excluded from the VnfPkgInfo structure in the response
            body if this parameter is provided, or none of the parameters "all_fields," "fields", "exclude_fields",
            "exclude_default" are provided:
            -	softwareImages
            -	additionalArtifacts
            -	userDefinedData.
            -	checksum
            -	onboardingFailureDetails
          in: query
          required: false
          type: string
        - name: exclude_default
          description: >
            Indicates to exclude the following complex attributes from the response.
            See clause 5.3 of ETSI GS NFV SOL 013 for details. The VNFM shall support this parameter.
            The following attributes shall be excluded from the VnfPkgInfo structure
            in the response body if this parameter is provided, or none of the parameters
            "all_fields," "fields", "exclude_fields", "exclude_default" are provided:
            -	softwareImages
            -	additionalArtifacts
            -	userDefinedData.
          in: query
          required: false
          type: string
        - name: nextpage_opaque_marker
          description: >
            Marker to obtain the next page of a paged response. Shall be supported by the 
            NFVO if the NFVO supports alternative 2 (paging) according to clause 5.4.2.1 of ETSI GS NFV-SOL 013
            for this resource.
          in: query
          required: false
          type: string
        - name: Version
          description: >
            Version of the API requested to use when responding to this request.
          in: header
          required: true
          type: string
      responses:
        200:
          description: >
            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.
              type: string
              maximum: 1
              minimum: 1
Gergely Csatari's avatar
Gergely Csatari committed
            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.
              type: string
              maximum: 1
              minimum: 0
            Version:
              description: >
                Version of the API used in the response.
              type: string
              maximum: 1
              minimum: 1
            Link:
              description: >
                Reference to other resources. Used for paging in the present document, see clause 4.7.2.1.
              type: string
              maximum: 1
              minimum: 0
          schema:
            type: array
            items:
              $ref: "definitions/VNFPackageManagement_def.yaml#/definitions/VnfPkgInfo"
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/400"
        401:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/401"
        403:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/403"
        404:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/404"
        405:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/405"
        406:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/406"
        422:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/422"
        500:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/500"
        503:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/503"
        504:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/504"

  ###############################################################################
  # Individual VNF package                                                      #
  ###############################################################################
  '/vnf_packages/{vnfPkgId}':
    parameters:
      - name: vnfPkgId
        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.
        in: path
        type: string
        required: true
    get:
      description: >
        Query VNF Package Info.
        The GET method reads the information of an individual VNF package.
        This method shall follow the provisions specified in the tables
        10.4.3.3.2-1 and 10.4.3.3.2-2 for URI query parameters,
        request and response data structures, and response codes.
      parameters:
        - name: Accept
          description: >
            Content-Types that are acceptable for the response.
            Reference: IETF RFC 7231
          in: header
          required: true
          type: string
        - name: Authorization
          description: >
            The authorization token for the request.
            Reference: IETF RFC 7235
          in: header
          required: false
          type: string
        - name: Version
          description: >
            Version of the API requested to use when responding to this request.
          in: header
          required: true
          type: string
        - name: include_signature
          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.
          in: query
          required: false
          type: string
      responses:
        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.
              type: string
              maximum: 1
              minimum: 1
            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.
              type: string
              maximum: 1
              minimum: 0
            Version:
              description: >
                Version of the API used in the response.
              type: string
              maximum: 1
              minimum: 1
          schema:
            $ref: "definitions/VNFPackageManagement_def.yaml#/definitions/VnfPkgInfo"
        400:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/400"
        401:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/401"
        403:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/403"
        404:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/404"
        405:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/405"
        416:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/416"
        500:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/500"
        503:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/503"
        504:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/504"
  '/onboarded_vnf_packages/{vnfdId}':
    parameters:
      - name: vnfdId
        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.
        in: path
        type: string
        required: true
    get:
      description: >
        Query VNF Package Info.
        The GET method reads the information of an individual VNF package.
        This method shall follow the provisions specified in the tables
        10.4.3.3.2-1 and 10.4.3.3.2-2 for URI query parameters,
        request and response data structures, and response codes.
      parameters:
        - name: Accept
          description: >
            Content-Types that are acceptable for the response.
            Reference: IETF RFC 7231
          in: header
          required: true
          type: string
        - name: Authorization
          description: >
            The authorization token for the request.
            Reference: IETF RFC 7235
          in: header
Gergely Csatari's avatar
Gergely Csatari committed
          required: false
          type: string
        - name: Version
          description: >
            Version of the API requested to use when responding to this request.
          in: header
          required: true
          type: string
      responses:
        200:
          description: >
            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.
              type: string
              maximum: 1
              minimum: 1
Gergely Csatari's avatar
Gergely Csatari committed
            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.
              type: string
              maximum: 1
              minimum: 0
            Version:
              description: >
                Version of the API used in the response.
              type: string
              maximum: 1
              minimum: 1
            $ref: "definitions/VNFPackageManagement_def.yaml#/definitions/VnfPkgInfo"
        400:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/400"
        401:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/401"
        403:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/403"
        404:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/404"
        405:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/405"
        406:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/406"
        416:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/416"
        500:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/500"
        503:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/503"
        504:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/504"

  ###############################################################################
  # VNFD in an individual VNF package                                           #
  ###############################################################################
  '/vnf_packages/{vnfPkgId}/vnfd':
    parameters:
      - name: vnfPkgId
        description: >
          Identifier of the on-boarded VNF package. The identifier is
          allocated by the NFVO.
          This identifier can be retrieved from the "vnfPkgId"
          attribute in the VnfPackageOnboardingNotification or
          VnfPackageChangeNotification.
        in: path
        type: string
        required: true
    get:
      description: >
Gergely Csatari's avatar
Gergely Csatari committed
        Query VNF Package Info

        The GET method reads the content of the VNFD within a VNF package.
        The VNFD is implemented as a collection of one or more files.
        A ZIP archive embedding these files shall be returned when reading this resource.
        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 needed to navigate the ZIP
        archive 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)
        Three examples are provided below.

        NOTE:	These examples do not show the security related files.

        EXAMPLE 1:	Assuming a request is sent for the following VNF package
                    (as described in clause A.1 in ETSI GS NFV-SOL 004):
                    !------TOSCA-Metadata
                            !-----	TOSCA.meta (metadata for navigating the ZIP file)
                    !------Definitions
                            !-----	MRF.yaml (main VNFD file)
                            !-----	OtherTemplates (e.g. type definitions, referenced by the main VNFD file)
                    !------Files
                            !-----	ChangeLog.txt
                            !-----	image(s)
                            !-----	other artifacts
                    !------Tests
                            !-----	file(s)
                    !------Licenses
                            !-----	file(s)
                    !------Scripts
                            !-----	install.sh
                    !----- MRF.mf

                    The NFVO will return a ZIP file of the following format:
                    !------TOSCA-Metadata
                            !----- TOSCA.meta
                    !------Definitions
                            !----- MRF.yaml
                            !----- OtherTemplates

        EXAMPLE 2:	Assuming a request is sent for the following VNF package
                    (a VNF package without a TOSCA-Metadata directory, as
                    described in clause A.2 in ETSI GS NFV-SOL 004):
                    !------MRF.yaml (main VNFD file)
                    !------MRF.mf
                    !------ChangeLog.txt
                    !------Tests
                            !----- file(s)
                    !------Licenses
                            !----- file(s)
                    !------Artifacts
                            !----- install.sh
                            !----- start.yang

                    The NFVO will return a ZIP file of the following format:
                    !------MRF.yaml

        EXAMPLE 3:	Assuming a request is sent for the following VNF package
                    (a VNF package with the YANG VNFD without a TOSCA-Metadata directory,
                    as described in clause A.3 in ETSI GS NFV SOL 004):
                    !----CompanyVNFD.yaml
                    !----CompanyVNFD.xml
                    !----CompanyVNFD.mf
                    !----ChangeLog.txt
                    !-----Files
                    !-----Instance Data Files
                            !---- start.xml
                    !-----Licenses
                    !-----Scripts
                            !----- install.sh

                    The NFVO will return a ZIP file of the following format:
                    !----CompanyVNFD.yaml
                    !----CompanyVNFD.xml	(indicated in the yang_definitions metadata in CompanyVNFD.yaml)

        This method shall follow the provisions specified in the tables 10.4.4.3.2-1
        and 10.4.4.3.2-2 for URI query parameters, request and response data structures,
        nd response codes.
      parameters:
        - name: Accept
          description: >
            Content-Types that are acceptable for the response.
            Permitted values: "text/plain" and/or "application/zip"
            Reference: IETF RFC 7231
          in: header
          required: true
          type: string
          enum:
            - text/plain
            - application/zip
Gergely Csatari's avatar
Gergely Csatari committed
            - text/plain+application/zip
        - name: Authorization
          description: >
            The authorization token for the request.
            Reference: IETF RFC 7235
          in: header
Gergely Csatari's avatar
Gergely Csatari committed
          required: false
          type: string
        - name: Version
          description: >
            Version of the API requested to use when responding to this request.
          in: header
          required: true
          type: string
        - name: include_signatures
          description: >
            If this parameter is provided, the NFVO shall include in the ZIP
            archive the security information as specified above.
            This URI query parameter is a flag, i.e. it shall have no value.
            The NFVO shall support this parameter.
          in: query
          required: false
          type: string
      responses:
        200:
          description: >
            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.
              type: string
              enum:
                - text/plain
                - application/zip
              maximum: 1
              minimum: 1
Gergely Csatari's avatar
Gergely Csatari committed
            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.
              type: string
              maximum: 1
              minimum: 0
            Version:
              description: >
                Version of the API used in the response.
              type: string
              maximum: 1
              minimum: 1
        400:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/400"
        401:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/401"
        403:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/403"
        404:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/404"
        405:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/405"
        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".
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/409"
        416:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/416"
        500:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/500"
        503:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/503"
        504:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/504"

  '/onboarded_vnf_packages/{vnfdId}/vnfd':
    parameters:
      - name: vnfdId
        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.
        in: path
        type: string
        required: true
    get:
      description: >
        Query VNF Package Info

        The GET method reads the content of the VNFD within a VNF package.
        The VNFD is implemented as a collection of one or more files.
        A ZIP archive embedding these files shall be returned when reading this resource.
        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 needed to navigate the ZIP
        archive 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)
        Three examples are provided below.

        NOTE:	These examples do not show the security related files.

        EXAMPLE 1:	Assuming a request is sent for the following VNF package
                    (as described in clause A.1 in ETSI GS NFV-SOL 004):
                    !------TOSCA-Metadata
                            !-----	TOSCA.meta (metadata for navigating the ZIP file)
                    !------Definitions
                            !-----	MRF.yaml (main VNFD file)
                            !-----	OtherTemplates (e.g. type definitions, referenced by the main VNFD file)
                    !------Files
                            !-----	ChangeLog.txt
                            !-----	image(s)
                            !-----	other artifacts
                    !------Tests
                            !-----	file(s)
                    !------Licenses
                            !-----	file(s)
                    !------Scripts
                            !-----	install.sh
                    !----- MRF.mf

                    The NFVO will return a ZIP file of the following format:
                    !------TOSCA-Metadata
                            !----- TOSCA.meta
                    !------Definitions
                            !----- MRF.yaml
                            !----- OtherTemplates

        EXAMPLE 2:	Assuming a request is sent for the following VNF package
                    (a VNF package without a TOSCA-Metadata directory, as
                    described in clause A.2 in ETSI GS NFV-SOL 004):
                    !------MRF.yaml (main VNFD file)
                    !------MRF.mf
                    !------ChangeLog.txt
                    !------Tests
                            !----- file(s)
                    !------Licenses
                            !----- file(s)
                    !------Artifacts
                            !----- install.sh
                            !----- start.yang

                    The NFVO will return a ZIP file of the following format:
                    !------MRF.yaml

        EXAMPLE 3:	Assuming a request is sent for the following VNF package
                    (a VNF package with the YANG VNFD without a TOSCA-Metadata directory,
                    as described in clause A.3 in ETSI GS NFV SOL 004):
                    !----CompanyVNFD.yaml
                    !----CompanyVNFD.xml
                    !----CompanyVNFD.mf
                    !----ChangeLog.txt
                    !-----Files
                    !-----Instance Data Files
                            !---- start.xml
                    !-----Licenses
                    !-----Scripts
                            !----- install.sh

                    The NFVO will return a ZIP file of the following format:
                    !----CompanyVNFD.yaml
                    !----CompanyVNFD.xml	(indicated in the yang_definitions metadata in CompanyVNFD.yaml)

        This method shall follow the provisions specified in the tables 10.4.4.3.2-1
        and 10.4.4.3.2-2 for URI query parameters, request and response data structures,
        nd response codes.
      parameters:
        - name: Accept
          description: >
            Content-Types that are acceptable for the response.
            Permitted values: "text/plain" and/or "application/zip"
            Reference: IETF RFC 7231
          in: header
          required: true
          type: string
          enum:
            - text/plain
            - application/zip
            - text/plain+application/zip
        - name: Authorization
          description: >
            The authorization token for the request.
            Reference: IETF RFC 7235
          in: header
          required: false
          type: string
        - name: Version
          description: >
            Version of the API requested to use when responding to this request.
          in: header
          required: true
          type: string
        - name: include_signatures
          description: >
            If this parameter is provided, the NFVO shall include in the ZIP
            archive the security information as specified above.
            This URI query parameter is a flag, i.e. it shall have no value.
            The NFVO shall support this parameter.
          in: query
          required: false
          type: string
      responses:
        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.
              type: string
              enum:
                - text/plain
                - application/zip
              maximum: 1
              minimum: 1
            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.
              type: string
              maximum: 1
              minimum: 0
            Version:
              description: >
                Version of the API used in the response.
              type: string
              maximum: 1
              minimum: 1
        400:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/400"
        401:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/401"
        403:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/403"
        404:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/404"
        405:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/405"
          #          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".
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/409"
        416:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/416"
        500:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/500"
        503:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/503"
        504:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/504"

  ###############################################################################
  ###############################################################################
    parameters:
      - name: vnfPkgId
        description: >
          Identifier of the on-boarded VNF package. The identifier is
          allocated by the NFVO.
          This identifier can be retrieved from the "vnfPkgId"
          attribute in the VnfPackageOnboardingNotification or
          VnfPackageChangeNotification.
        in: path
        type: string
        required: true
    get:
      description: >
        Query VNF Package Manifest

        The GET method reads the content of the manifest within a VNF package.
        This method shall follow the provisions specified in the tables 10.4.4a.3.2-1
        and 10.4.4a.3.2-2 for URI query parameters, request and response data structures,
        and response codes.
      parameters:
        - name: Accept
          description: >
            Content-Types that are acceptable for the response.
            Permitted values: "text/plain" and/or "application/zip"
            Reference: IETF RFC 7231
          in: header
          required: true
          type: string
          enum:
            - text/plain
            - application/zip
        - name: Authorization
          description: >
            The authorization token for the request.
            Reference: IETF RFC 7235
          in: header
Gergely Csatari's avatar
Gergely Csatari committed
          required: false
          type: string
        - name: Version
          description: >
            Version of the API requested to use when responding to this request.
          in: header
          required: true
          type: string
        - name: include_signatures
          description: >
            If this parameter is provided, the NFVO shall return the manifest and related security
            information (such as certificate) in a ZIP archive.
            If this parameter is not given, the NFVO shall provide only a copy of the manifest file.
            This URI query parameter is a flag, i.e. it shall have no value.
            The NFVO shall support this parameter.
          in: query
          required: false
          type: string
      responses:
        200:
          description: >
            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.
              type: string
              maximum: 1
              minimum: 1
Gergely Csatari's avatar
Gergely Csatari committed
            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.
              type: string
              maximum: 1
              minimum: 0
            Version:
              description: >
                Version of the API used in the response.
              type: string
              maximum: 1
              minimum: 1
        400:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/400"
        401:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/401"
        403:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/403"
        404:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/404"
        405:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/405"
        406:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/406"
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/409"
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/416"
        500:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/500"
        503:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/503"
        504:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/504"

  '/onboarded_vnf_packages/{vnfdId}/manifest':
    parameters:
      - name: vnfdId
        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.
        in: path
        type: string
        required: true
Giacomo Bernini's avatar
Giacomo Bernini committed
    get:
      description: >
        Query VNF Package Manifest

        The GET method reads the content of the manifest within a VNF package.
        This method shall follow the provisions specified in the tables 10.4.4a.3.2-1
        and 10.4.4a.3.2-2 for URI query parameters, request and response data structures,
        and response codes.
Giacomo Bernini's avatar
Giacomo Bernini committed
      parameters:
        - name: Accept
          description: >
            Content-Types that are acceptable for the response.
            Permitted values: "text/plain" and/or "application/zip"
            Reference: IETF RFC 7231
Giacomo Bernini's avatar
Giacomo Bernini committed
          in: header
          required: true
          type: string
          enum:
            - text/plain
            - application/zip
Giacomo Bernini's avatar
Giacomo Bernini committed
        - name: Authorization
          description: >
            The authorization token for the request.
            Reference: IETF RFC 7235
          in: header
          required: false
          type: string
        - name: Version
          description: >
            Version of the API requested to use when responding to this request.
          in: header
          required: true
          type: string
        - name: include_signatures
          description: >
            If this parameter is provided, the NFVO shall return the manifest and related security
            information (such as certificate) in a ZIP archive.
            If this parameter is not given, the NFVO shall provide only a copy of the manifest file.
            This URI query parameter is a flag, i.e. it shall have no value.
            The NFVO shall support this parameter.
          in: query
          required: false
          type: string
Giacomo Bernini's avatar
Giacomo Bernini committed
      responses:
        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".
Giacomo Bernini's avatar
Giacomo Bernini committed

            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.
Giacomo Bernini's avatar
Giacomo Bernini committed
          headers:
            Content-Type:
              description: The MIME type of the body of the response.
              type: string