NSDManagement.yaml 99.8 KB
Newer Older
              description: The MIME type of the body of the response.
              type: string
              maximum: 1
              minimum: 1
            WWW-Authenticate:
              type: string
              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.
              maximum: 1
              minimum: 0
            Version:
              description: >
                Version of the API used in the response.
              type: string
              maximum: 1
              minimum: 1
        400:
          $ref: "../responses/SOL005_resp.yaml#/responses/400"
        401:
          $ref: "../responses/SOL005_resp.yaml#/responses/401"
        403:
          $ref: "../responses/SOL005_resp.yaml#/responses/403"
        404:
          $ref: "../responses/SOL005_resp.yaml#/responses/404"
        405:
          $ref: "../responses/SOL005_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
#            "nsdOnboardingState" 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.
          $ref: "../responses/SOL005_resp.yaml#/responses/409"
          $ref: "../responses/SOL005_resp.yaml#/responses/500"
          $ref: "../responses/SOL005_resp.yaml#/responses/503"
        504:
          $ref: "../responses/SOL005_resp.yaml#/responses/504"

  ###############################################################################
  # PNF Descriptors                                                             #
  ###############################################################################
    #ETSI GS NFV-SOL 005 V2.4.1 location: 5.4.5
    parameters:
      - 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

    post:
      summary: Create a new PNF descriptor resource.
      description: >
        The POST method is used to create a new PNF descriptor resource
      parameters:
        - name: Accept
          description: >
            Content-Types that are acceptable for the response.
            Reference: IETF RFC 7231.
          in: header
          required: true
          type: string
        - name: Content-Type
          description: >
            The MIME type of the body of the request.
            Reference: IETF RFC 7231.
          in: header
          required: true
          type: string
        - name: CreatePnfdInfoRequest
          in: body
          required: true
          schema:
            $ref: "definitions/SOL005NSDescriptorManagement_def.yaml#/definitions/CreatePnfdInfoRequest"
            description: >
              Parameters of creating a PNF descriptor resource.
      responses:
        201:
          description: >
            201 CREATED

            Shall be returned when a new "Individual PNF descriptor"
            resource and the associated PNF descriptor identifier
            has been created successfully.
            The response body shall contain a representation of the
             created PNF descriptor resource, as defined in clause 5.5.2.5.
            The HTTP response shall include a "Location" HTTP header that
            contains the resource URI of the created PNF descriptor resource.
          schema:
            $ref: "definitions/SOL005NSDescriptorManagement_def.yaml#/definitions/PnfdInfo"
          headers:
            Content-Type:
              type: string
              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.
            WWW-Authenticate:
              type: string
              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.
              maximum: 1
              minimum: 0
            Version:
              description: >
                Version of the API used in the response.
              type: string
              maximum: 1
              minimum: 1
        400:
          $ref: "../responses/SOL005_resp.yaml#/responses/400"
        401:
          $ref: "../responses/SOL005_resp.yaml#/responses/401"
        403:
          $ref: "../responses/SOL005_resp.yaml#/responses/403"
        404:
          $ref: "../responses/SOL005_resp.yaml#/responses/404"
        405:
          $ref: "../responses/SOL005_resp.yaml#/responses/405"
        406:
          $ref: "../responses/SOL005_resp.yaml#/responses/406"
        500:
          $ref: "../responses/SOL005_resp.yaml#/responses/500"
        503:
          $ref: "../responses/SOL005_resp.yaml#/responses/503"
        504:
          $ref: "../responses/SOL005_resp.yaml#/responses/504"
      summary: Query information about multiple PNF descriptor resources.
        "The GET method queries information about multiple PNF descriptor
        resources."
      parameters:
        - name: filter
          in: query
          required: false
          type: string
          description: >
            Attribute-based filtering expression according to clause 5.2
            of ETSI GS NFV-SOL 013.
            The NFVO shall support receiving this filtering parameter as part
            of the URI query string. The OSS/BSS may supply this parameter.
            All attribute names that appear in the PnfdInfo and in data types
            referenced from it shall be supported by the NFVO in the filter expression.
        - name: all_fields
          in: query
          required: false
          type: string
          description: >
            Include all complex attributes in the response. See clause 5.3
            of ETSI GS NFV-SOL 013 for details. The NFVO shall support this parameter.
        - name: fields
          in: query
          required: false
          type: string
          description: >
            Complex attributes to be included into the response. See clause 5.3 of
            ETSI GS NFV-SOL 013 for details.
            The NFVO should support this parameter.
        - name: exclude_fields
          in: query
          required: false
          type: string
          description: >
            Complex attributes to be excluded from the response. See clause 5.3
            of ETSI GS NFV-SOL 013 for details.
            The NFVO should support this parameter.
        - name: exclude_default
          in: query
          required: false
          type: string
          description: >
            Indicates to exclude the following complex attributes from the response.
            See clause 5.3 of ETSI GS NFV-SOL 013 for details. The NFVO shall support
            this parameter.
            The following attributes shall be excluded from the PnfdInfo structure in
            the response body if this parameter is provided, or none of the parameters
            "all_fields," "fields", "exclude_fields", "exclude_default" are provided:
            -	userDefinedData
            -	onboardingFailureDetails
        - name: nextpage_opaque_marker
          in: query
          type: string
          required: false
          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.
      responses:
        200:
            Shall be returned when information about zero or more PNF descriptors has
            been queried successfully.
            The response body shall contain in an array the representations of zero or
            more PNF descriptors, as defined in clause 5.5.2.5.
            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:
            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.
            Version:
              description: >
                Version of the API used in the response.
              type: string
              maximum: 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
            description: >
              Information about zero or more PNF descriptors.
              The response body shall contain a representation in an array the representations
              of zero or more PNF descriptors, as defined in clause  5.5.2.2.
              If the NFVO supports alternative 2 (paging) according to clause 4.7.2.1 for this resource,
              inclusion of the Link HTTP header in this response shall follow the provisions in clause 4.7.2.3.
              $ref: "definitions/SOL005NSDescriptorManagement_def.yaml#/definitions/PnfdInfo"
          $ref: "../responses/SOL005_resp.yaml#/responses/400"
          $ref: "../responses/SOL005_resp.yaml#/responses/401"
          $ref: "../responses/SOL005_resp.yaml#/responses/403"
          $ref: "../responses/SOL005_resp.yaml#/responses/404"
          $ref: "../responses/SOL005_resp.yaml#/responses/405"
          $ref: "../responses/SOL005_resp.yaml#/responses/406"
          $ref: "../responses/SOL005_resp.yaml#/responses/500"
          $ref: "../responses/SOL005_resp.yaml#/responses/503"
        504:
          $ref: "../responses/SOL005_resp.yaml#/responses/504"
  ###############################################################################
  # Individual PNF Descriptor                                                   #
  ###############################################################################
    #ETSI GS NFV-SOL 005 V2.4.1 location: 5.4.6
    parameters:
        description: >
          Identifier of the individual PNF descriptor resource.
        required: true
      summary: Read an individual PNFD resource.
        The GET method reads information about an individual PNF descriptor.
      parameters:
        - name: Accept
          in: header
          required: true
          type: string
          description: >
            Content-Types that are acceptable for the response. This header
            field shall be present if the response is expected to have a non-empty
            message body.
        - name: Authorization
          in: header
          required: false
          type: string
          description: >
            The authorization token for the request. Details are specified
            in clause 4.5.3 of GS NFV-SOL 005.
        - name: Version
          description: >
            Version of the API requested to use when responding to this request.
          in: header
          required: true
          type: string
      responses:
        200:
            Shall be returned when information about the individual PNFD
            descriptor has been read successfully.
            The response body shall contain a representation of the
            individual PNF descriptor, as defined in clause 5.5.2.5.
          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.
            Version:
              description: >
                Version of the API used in the response.
              type: string
              maximum: 1
            $ref: "definitions/SOL005NSDescriptorManagement_def.yaml#/definitions/PnfdInfo"
          $ref: "../responses/SOL005_resp.yaml#/responses/400"
          $ref: "../responses/SOL005_resp.yaml#/responses/401"
          $ref: "../responses/SOL005_resp.yaml#/responses/403"
          $ref: "../responses/SOL005_resp.yaml#/responses/404"
          $ref: "../responses/SOL005_resp.yaml#/responses/405"
          $ref: "../responses/SOL005_resp.yaml#/responses/406"
          $ref: "../responses/SOL005_resp.yaml#/responses/500"
          $ref: "../responses/SOL005_resp.yaml#/responses/503"
        504:
          $ref: "../responses/SOL005_resp.yaml#/responses/504"

    patch:
      summary: Modify the user defined data of an individual PNF descriptor resource.
        The PATCH method modifies the user defined data of an individual PNF descriptor resource.
      parameters:
        - name: Accept
          in: header
          required: true
          type: string
          description: >
            Content-Types that are acceptable for the response. This header
            field shall be present if the response is expected to have a non-empty
            message body.
        - name: Content-Type
          in: header
          required: true
          type: string
          description: >
            The MIME type of the body of the request. This header field
            shall be present if the request has a non-empty message body.
        - name: PnfdInfoModifications
            $ref: "definitions/SOL005NSDescriptorManagement_def.yaml#/definitions/PnfdInfoModifications"
              Parameters for the modification of an individual
              PNF descriptor resource, as defined in clause 5.5.2.4.
              The Content-Type header shall be set to "application/merge-patch+json"
              according to IETF RFC 7396.
      responses:
        200:
            Shall be returned when the operation has been accepted
            and completed successfully.
            The response body shall contain attribute modifications
            for an 'Individual PNF Descriptor' resource (see clause 5.5.2.4).
            $ref: "definitions/SOL005NSDescriptorManagement_def.yaml#/definitions/PnfdInfoModifications"
          headers:
            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.
            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.
              maximum: 1
              minimum: 0
            Version:
              description: >
                Version of the API used in the response.
              type: string
              maximum: 1
              minimum: 1
          $ref: "../responses/SOL005_resp.yaml#/responses/400"
          $ref: "../responses/SOL005_resp.yaml#/responses/401"
          $ref: "../responses/SOL005_resp.yaml#/responses/403"
          $ref: "../responses/SOL005_resp.yaml#/responses/404"
          $ref: "../responses/SOL005_resp.yaml#/responses/405"
          $ref: "../responses/SOL005_resp.yaml#/responses/406"
          $ref: "../responses/SOL005_resp.yaml#/responses/412"
          $ref: "../responses/SOL005_resp.yaml#/responses/500"
          $ref: "../responses/SOL005_resp.yaml#/responses/503"
        504:
          $ref: "../responses/SOL005_resp.yaml#/responses/504"
    delete:
      summary: Delete an individual PNF descriptor resource.
      description: >
        The DELETE method deletes an individual PNF descriptor resource.
        An individual PNF descriptor resource can only be deleted when t
        here is no NS instance using it or there is NSD referencing it.
        To delete all PNFD versions identified by a particular value of
        the "pnfdInvariantId" attribute, the procedure is to first use t
        he GET method with filter "pnfdInvariantId" towards the PNF
        descriptors resource to find all versions of the PNFD. Then,
        he API consumer uses the DELETE method described in this clause
        to delete each PNFD version individually.
        This method shall follow the provisions specified in the Tables
        5.4.6.3.5-1 and 5.4.6.3.5-2 for URI query parameters, request
        and response data structures, and response codes.
      responses:
        204:
          description: >
            204 NO CONTENT

            Shall be returned when the operation
            has completed successfully.
            The response body shall be empty.
          headers:
            WWW-Authenticate:
              type: string
              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.
              maximum: 1
              minimum: 0
            Version:
              description: >
                Version of the API used in the response.
              type: string
              maximum: 1
              minimum: 1
        400:
          $ref: "../responses/SOL005_resp.yaml#/responses/400"
        401:
          $ref: "../responses/SOL005_resp.yaml#/responses/401"
        403:
          $ref: "../responses/SOL005_resp.yaml#/responses/403"
        404:
          $ref: "../responses/SOL005_resp.yaml#/responses/404"
        405:
          $ref: "../responses/SOL005_resp.yaml#/responses/405"
        406:
          $ref: "../responses/SOL005_resp.yaml#/responses/406"
        500:
          $ref: "../responses/SOL005_resp.yaml#/responses/500"
        503:
          $ref: "../responses/SOL005_resp.yaml#/responses/503"
        504:
          $ref: "../responses/SOL005_resp.yaml#/responses/504"
  ###############################################################################
  # PNFD Archive Content                                                        #
  ###############################################################################
    #ETSI GS NFV-SOL 005 V2.4.1 location: 5.4.7
    parameters:
        description: >
          Identifier of the individual PNF descriptor.
          This identifier can be retrieved from the resource referenced
          by the "Location" HTTP header in the response to a POST request
          creating a new PNF descriptor resource. It can also be retrieved
          from the "id" attribute in the payload body of that response.
        required: true
      - 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
      summary: Fetch the content of a PNFD.
        The GET method fetches the content of the PNFD archive.
        The content of the PNFD archive 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.

        NOTE:	Information about the applicable security option can be obtained
        by evaluating the "archiveSecurityOption" attribute in the "pnfdInfo" structure.

        This method shall follow the provisions specified in the Tables 5.4.7.3.2-1
        and 5.4.7.3.2-2 for URI query parameters, request and response data structures,
        and response codes.
        - name: Accept
          description: >
            Content-Types that are acceptable for the response.
          in: header
          required: true
          type: string
          enum:
            - text/plain
        - name: Range
          description: >
            The request may contain a "Range" HTTP header to obtain
            single range of bytes from the PNFD archive. This can be
            used to continue an aborted transmission.
            If the NFVO does not support range requests, the NFVO
            shall ignore the "Range" header, process the GET request,
            and return the whole PNFD archive with a 200 OK response
            (rather than returning a 4xx error status code).
          in: header
          required: false
          type: string
      responses:
        200:
            Shall be returned when the content of the PNFD archive has
            The payload body shall contain a copy of the PNFD archive
            The "Content-Type" HTTP header shall be set to "application/zip".
          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.
              maximum: 1
              minimum: 0
            Version:
              description: >
                Version of the API used in the response.
              type: string
              maximum: 1
              minimum: 1
        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 PNFD archive
            has been read successfully according to the request.
            The response body shall contain the requested part of the PNFD archive.
            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-Type:
              description: >
                The MIME type of the body of the response.
              type: string
              maximum: 1
              minimum: 1
            Content-Range:
              description: >
                The "Content-Range" HTTP header shall be provided according to IETF RFC 7233.
              type: string
              maximum: 1
              minimum: 1
            WWW-Authenticate:
              type: string
              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.
              maximum: 1
              minimum: 0
            Version:
              description: >
                Version of the API used in the response.
              type: string
              maximum: 1
              minimum: 1
          $ref: "../responses/SOL005_resp.yaml#/responses/400"
          $ref: "../responses/SOL005_resp.yaml#/responses/401"
          $ref: "../responses/SOL005_resp.yaml#/responses/403"
          $ref: "../responses/SOL005_resp.yaml#/responses/404"
          $ref: "../responses/SOL005_resp.yaml#/responses/405"
          $ref: "../responses/SOL005_resp.yaml#/responses/406"
#          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 pnfdOnboardingState
#            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.
          $ref: "../responses/SOL005_resp.yaml#/responses/409"
        416:
          $ref: "../responses/SOL005_resp.yaml#/responses/416"
          $ref: "../responses/SOL005_resp.yaml#/responses/500"
          $ref: "../responses/SOL005_resp.yaml#/responses/503"
        504:
          $ref: "../responses/SOL005_resp.yaml#/responses/504"
      summary: Upload the content of a PNFD.
        The PUT method is used to upload the content of a PNFD archive.
        This resource represents the content of the individual PNF descriptor, i.e. PNFD content. 
        The client can use this resource to upload and download the content of the PNFD.        
      parameters:
        - name: Accept
          description: >
            Content-Types that are acceptable for the response.
          in: header
          required: true
          type: string
          enum:
            - text/plain
        - name: Content-type
          description: >
            The request shall set the "Content-Type" HTTP header to "application/zip".
          in: header
          type: string
          enum:
            - application/zip
      responses:
        202:
          description: >
            202 ACCEPTED

            Shall be returned when the PNFD archive has been accepted for uploading,
            but the processing has not been completed. It is expected to take some
            time for processing (asynchronous mode).
            The response body shall be empty.
            The API consumer can track the uploading progress by receiving the
            "PnfdOnBoardingNotification" and "PnfdOnBoardingFailureNotification"
            from the NFVO or by reading the status of the individual PNF descriptor
            resource using the GET method.
          headers:
            WWW-Authenticate:
              type: string
              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.
              maximum: 1
              minimum: 0
            Version:
              description: >
                Version of the API used in the response.
              type: string
              maximum: 1
              minimum: 1
            204 NO CONTENT
            Shall be returned when the PNFD archive content has been
            uploaded and validated successfully.
          headers:
            WWW-Authenticate:
              type: string
              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.
              maximum: 1
              minimum: 0
            Version:
              description: >
                Version of the API used in the response.
              type: string
              maximum: 1
              minimum: 1
          $ref: "../responses/SOL005_resp.yaml#/responses/400"
          $ref: "../responses/SOL005_resp.yaml#/responses/401"
          $ref: "../responses/SOL005_resp.yaml#/responses/403"
          $ref: "../responses/SOL005_resp.yaml#/responses/404"
          $ref: "../responses/SOL005_resp.yaml#/responses/405"
          $ref: "../responses/SOL005_resp.yaml#/responses/406"
#          description: >
#            409 CONFLICT
#
#            Error: The operation cannot be executed currently,
#            due to a conflict with the state of the resource.
#            Typically, this is due to the fact that the
#            PnfdOnboardingState has a value other than
#            CREATED.
#            The response body shall contain a ProblemDetails
#            structure, in which the "detail" attribute shall convey
#            more information about the error.
          $ref: "../responses/SOL005_resp.yaml#/responses/409"
        500:
          $ref: "../responses/SOL005_resp.yaml#/responses/500"
        503:
          $ref: "../responses/SOL005_resp.yaml#/responses/503"

  ###############################################################################
  # PNFD                                                                        #
  ###############################################################################
  '/pnf_descriptors/{pnfdInfoId}/pnfd':
    #ETSI GS NFV-SOL 005 V2.4.1 location: 5.4.7a
    parameters:
      - name: pnfdInfoId
        description: >
          Identifier of the individual PNF descriptor.
          This identifier can be retrieved from the resource referenced
          by the "Location" HTTP header in the response to a POST request
          creating a new PNF descriptor resource. It can also be retrieved
          from the "id" attribute in the payload body of that response.
        in: path
        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

    get:
      description: >
        The GET method reads the content of the PNFD within a PNFD archive.
        The PNFD can be implemented as a single file or as a collection of
        multiple files. If the PNFD is implemented in the form of multiple
        files, a ZIP file embedding these files shall be returned. If the
        PNFD is implemented as a single file, either that file or a ZIP file
        embedding that file shall be returned.
        The selection of the format is controlled by the "Accept" HTTP header
        passed in the GET request:
        •	If the "Accept" header contains only "text/plain" and the PNFD is
            implemented as a single file, the file shall be returned; otherwise,
            an error message shall be returned.
        •	If the "Accept" header contains only "application/zip", the single
            file or the multiple files that make up the PNFD shall be returned
            embedded in a ZIP file.
        •	If the "Accept" header contains both "text/plain" and "application/zip",
            it is up to the NFVO to choose the format to return for a single-file PNFD;
            for a multi-file PNFD, a ZIP file shall be returned.
        The default format of the ZIP file shall be the one specified in ETSI GS
        NFV-SOL 004 where only the YAML files representing the PNFD, and information
        necessary to navigate the ZIP file and to identify the file that is the entry
        point for parsing the PNFD and (if requested) further security information
        are included. This means that the content of the ZIP archive shall contain
        the following files from the PNFD archive:
        •	TOSCA.meta (if available in the PNFD archive);
        •	the main service template (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 PNFD referenced (recursively) from the main
            service template;
        •	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 PNFD archive
                (if available in the PNFD archive);
            -	the signing certificates of the individual files included in the
                ZIP archive (if available in the PNFD archive);
            -	the signatures of the individual files (if available in the PNFD archive).
        This method shall follow the provisions specified in the Tables 5.4.7a.3.2-1 and
        5.4.7a.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.
          in: header
          required: true
          type: string
          enum:
            - text/plain
        - name: Range
          description: >
            The request may contain a "Range" HTTP header to obtain
            single range of bytes from the PNFD archive. This can be
            used to continue an aborted transmission.
            If the NFVO does not support range requests, the NFVO
            shall ignore the "Range" header, process the GET request,
            and return the whole PNFD archive with a 200 OK response
            (rather than returning a 4xx error status code).
          in: header
          required: false
          type: string
        - name: include_signatures
          description: >
            If this parameter is provided, the NFVO shall include in the
            ZIP file 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 PNFD has been read successfully.
            The payload body shall contain a copy of the file representing the PNFD
            or a ZIP file that contains the file or multiple files representing the
            PNFD, as specified above.
            The "Content-Type" HTTP header shall be set according to the format of
            the returned file. It shall be set to "text/plain" for a YAML file.
          headers:
            Content-Type:
              type: string
              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.
            WWW-Authenticate:
              type: string
              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.
              maximum: 1
              minimum: 0
            Version:
              description: >
                Version of the API used in the response.
              type: string
              maximum: 1
              minimum: 1
        400:
          $ref: "../responses/SOL005_resp.yaml#/responses/400"
        401:
          $ref: "../responses/SOL005_resp.yaml#/responses/401"
        403:
          $ref: "../responses/SOL005_resp.yaml#/responses/403"
        404:
          $ref: "../responses/SOL005_resp.yaml#/responses/404"
        405:
          $ref: "../responses/SOL005_resp.yaml#/responses/405"
        406:
          $ref: "../responses/SOL005_resp.yaml#/responses/406"
        409:
          $ref: "../responses/SOL005_resp.yaml#/responses/409"
          $ref: "../responses/SOL005_resp.yaml#/responses/500"
          $ref: "../responses/SOL005_resp.yaml#/responses/503"
        504:
          $ref: "../responses/SOL005_resp.yaml#/responses/504"

  ###############################################################################
  # PNFD Archive Manifest                                                               #
  ###############################################################################
  '/pnf_descriptors/{pnfdInfoId}/manifest':
    #ETSI GS NFV-SOL 005 V2.4.1 location: 5.4.7b
    parameters:
      - name: pnfdInfoId
        description: >
          Identifier of the individual PNF descriptor.
          This identifier can be retrieved from the resource referenced
          by the "Location" HTTP header in the response to a POST request
          creating a new PNF descriptor resource. It can also be retrieved
          from the "id" attribute in the payload body of that response.
        in: path
        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

    get:
      description: >
        The GET method reads the content of the manifest file within a PNFD archive.
        This method shall follow the provisions specified in the Tables 5.4.7b.3.2-1
        and 5.4.7b.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.
          in: header
          required: true
          type: string
          enum:
            - text/plain
            - application/zip
        - name: include_signatures
          description: >
            If this parameter is provided, the NFVO shall return the manifest
            and related security information (signature and certificate) either
            in a single text file if the signature and certificate are included
            in the manifest file, or in a zip file containing the manifest and
            the certificate file, if this is provided as a separate file in the
            PNFD archive.
            If this parameter is not given, the NFVO shall provide only a copy
            of the manifest file, as onboarded. If the security information is
            included in the onboarded manifest, it shall also be included in
            the returned copy.
            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 file 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 PNFD archive,