NSDManagement.yaml 121 KB
Newer Older
swagger: "2.0"
  version: "2.0.0-impl:etsi.org:ETSI_NFV_OpenAPI:1"
  description: >
    SOL005 - NSD 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
    url: https://forge.etsi.org/etsi-forge-copyright-notice.txt
  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
basePath: /nsd/v2
  ###############################################################################
  # API Versions                                                                #
  ###############################################################################
  '/api_versions':
    $ref: '../endpoints/SOL005_endpoints.yaml#/endpoints/api-versions'
  ###############################################################################
  # NS Descriptors                                                              #
  ###############################################################################
    #ETSI GS NFV-SOL 005 V2.4.1 location: 5.4.2
    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 NS descriptor resource.
      description: >
        The POST method is used to create a new NS 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: CreateNsdInfoRequest
          in: body
          required: true
          schema:
            $ref: "definitions/SOL005NSDescriptorManagement_def.yaml#/definitions/CreateNsdInfoRequest"
            description: >
              Parameters of creating an NS descriptor resource, as defined in clause 5.5.2.3.
      responses:
        201:
          description: >
            201 CREATED

            Shall be returned when a new "Individual NS descriptor" resource
            and the associated NS descriptor identifier has been created successfully.
            The response body shall contain a representation of the created NS descriptor
             resource, as defined in clause 5.5.2.2.
            The HTTP response shall include a "Location" HTTP header that contains the
            resource URI of the created NS descriptor resource.
          schema:
            $ref: "definitions/SOL005NSDescriptorManagement_def.yaml#/definitions/NsdInfo"
          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#/components/responses/400"
          $ref: "../responses/SOL005_resp.yaml#/components/responses/401"
          $ref: "../responses/SOL005_resp.yaml#/components/responses/403"
          $ref: "../responses/SOL005_resp.yaml#/components/responses/404"
          $ref: "../responses/SOL005_resp.yaml#/components/responses/405"
          $ref: "../responses/SOL005_resp.yaml#/components/responses/406"
          $ref: "../responses/SOL005_resp.yaml#/components/responses/500"
          $ref: "../responses/SOL005_resp.yaml#/components/responses/503"
          $ref: "../responses/SOL005_resp.yaml#/components/responses/504"
      summary: Query information about multiple NS descriptor resources.
      description: >
        The GET method queries information about multiple NS descriptor resources.
            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 NsdInfo and in data types referenced from it shall
            be supported by the NFVO in the filter expression.
            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.
            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
            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
            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 NsdInfo 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
          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.
        - name: Accept
          description: >
            Content-Types that are acceptable for the response.
            Reference: IETF RFC 7231.
      responses:
        200:
            Shall be returned when information about zero or
            more NS descriptors has been queried successfully.
            The response body shall contain in an array the
            representations of zero or more NS descriptors, as
            defined in clause 5.5.2.2.
            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.
              maximum: 1
              minimum: 0
            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
          schema:
            type: array
            items:
              $ref: "definitions/SOL005NSDescriptorManagement_def.yaml#/definitions/NsdInfo"
          $ref: "../responses/SOL005_resp.yaml#/components/responses/400"
          $ref: "../responses/SOL005_resp.yaml#/components/responses/401"
          $ref: "../responses/SOL005_resp.yaml#/components/responses/403"
          $ref: "../responses/SOL005_resp.yaml#/components/responses/404"
          $ref: "../responses/SOL005_resp.yaml#/components/responses/405"
          $ref: "../responses/SOL005_resp.yaml#/components/responses/406"
          $ref: "../responses/SOL005_resp.yaml#/components/responses/500"
          $ref: "../responses/SOL005_resp.yaml#/components/responses/503"
          $ref: "../responses/SOL005_resp.yaml#/components/responses/504"

  ###############################################################################
  # Individual NS Descriptor                                                    #
  ###############################################################################
    #ETSI GS NFV-SOL 005 V2.4.1 location: 5.4.3
    parameters:
        description: >
          Identifier of the individual NS descriptor resource.
        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: Read information about an individual NS descriptor resource.
      description: >
        The GET method reads information about an individual NS descriptor.
        - name: Accept
          description: >
            Content-Types that are acceptable for the response.
      responses:
        200:
          description: >
            200 OK
            Shall be returned when information about the individual
            NS descriptor has been read successfully.
            The response body shall contain a representation of
            the individual NS descriptor, as defined in
            clause 5.5.2.2.
          schema:
            $ref: "definitions/SOL005NSDescriptorManagement_def.yaml#/definitions/NsdInfo"
              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
          $ref: "../responses/SOL005_resp.yaml#/components/responses/400"
          $ref: "../responses/SOL005_resp.yaml#/components/responses/401"
          $ref: "../responses/SOL005_resp.yaml#/components/responses/403"
          $ref: "../responses/SOL005_resp.yaml#/components/responses/404"
          $ref: "../responses/SOL005_resp.yaml#/components/responses/405"
          $ref: "../responses/SOL005_resp.yaml#/components/responses/406"
          $ref: "../responses/SOL005_resp.yaml#/components/responses/500"
          $ref: "../responses/SOL005_resp.yaml#/components/responses/503"
          $ref: "../responses/SOL005_resp.yaml#/components/responses/504"
      summary: Modify the operational state and/or the user defined data of an individual NS descriptor resource.
        The PATCH method modifies the operational state and/or user defined data of an individual NS descriptor resource.
        This method can be used to:
        1) Enable a previously disabled individual NS descriptor resource, allowing again its use for instantiation of new
        network service with this descriptor. The usage state (i.e. "IN_USE/NOT_IN_USE") shall not change as a
        result.
        2) Disable a previously enabled individual NS descriptor resource, preventing any further use for instantiation of
        new network service(s) with this descriptor. The usage state (i.e. "IN_USE/NOT_IN_USE") shall not change
        as a result.
        3) Modify the user defined data of an individual NS descriptor resource.
      parameters:
        - name: NsdInfoModifications
            $ref: "definitions/SOL005NSDescriptorManagement_def.yaml#/definitions/NsdInfoModifications"
              Parameters for the modification of an individual NS descriptor resource, as defined in clause 5.5.2.1.
              The Content-Type header shall be set to "application/merge-patch+json" according to IETF RFC 7396.
        - name: Content-Type
          description: >
            The MIME type of the body of the request.
            Reference: IETF RFC 7231.
          in: header
          required: true
          type: string
      responses:
            Shall be returned when the operation has been accepted and completed successfully.
            The response body shall contain attribute modifications for an 'Individual NS Descriptor'
            resource (see clause 5.5.2.6).
          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
          schema:
            $ref: "definitions/SOL005NSDescriptorManagement_def.yaml#/definitions/NsdInfoModifications"
          $ref: "../responses/SOL005_resp.yaml#/components/responses/400"
          $ref: "../responses/SOL005_resp.yaml#/components/responses/401"
          $ref: "../responses/SOL005_resp.yaml#/components/responses/403"
          $ref: "../responses/SOL005_resp.yaml#/components/responses/404"
          $ref: "../responses/SOL005_resp.yaml#/components/responses/405"
          $ref: "../responses/SOL005_resp.yaml#/components/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 an operational state
          #    mismatch, i.e. enable an already enabled or
          #    disable an already disabled individual NS
          #    descriptor resource, or the "nsdOnboardingState"
          #    is not 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#/components/responses/409"
          $ref: "../responses/SOL005_resp.yaml#/components/responses/412"
          $ref: "../responses/SOL005_resp.yaml#/components/responses/500"
          $ref: "../responses/SOL005_resp.yaml#/components/responses/503"
          $ref: "../responses/SOL005_resp.yaml#/components/responses/504"
      summary: Delete an individual NS descriptor resource.
        The DELETE method deletes an individual NS descriptor resource.
        An individual NS descriptor resource can only be deleted when there is no NS instance using it (i.e. usageState =
        NOT_IN_USE) and has been disabled already (i.e. operationalState = DISABLED). Otherwise, the DELETE method
        shall fail.
      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
            Shall be returned when the operation has completed successfully.
            The response body shall be empty.
          headers:
            WWW-Authenticate:
              description: >
                Challenge if the corresponding HTTP request has not provided
                authorization, or error details if the corresponding HTTP request
                has provided an invalid authorization token.
            Version:
              description: >
                Version of the API used in the response.
              type: string
              maximum: 1
          $ref: "../responses/SOL005_resp.yaml#/components/responses/400"
          $ref: "../responses/SOL005_resp.yaml#/components/responses/401"
          $ref: "../responses/SOL005_resp.yaml#/components/responses/403"
          $ref: "../responses/SOL005_resp.yaml#/components/responses/404"
          $ref: "../responses/SOL005_resp.yaml#/components/responses/405"
          $ref: "../responses/SOL005_resp.yaml#/components/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 the NS descriptor
          #    resource is in the enabled operational state (i.e.
          #    operationalState = ENABLED) or there are running
          #    NS instances using the concerned individual NS
          #    descriptor resource (i.e. usageState = IN_USE).
          #    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#/components/responses/409"
          $ref: "../responses/SOL005_resp.yaml#/components/responses/500"
          $ref: "../responses/SOL005_resp.yaml#/components/responses/503"
          $ref: "../responses/SOL005_resp.yaml#/components/responses/504"

  ###############################################################################
  ###############################################################################
    #ETSI GS NFV-SOL 005 V2.4.1 location: 5.4.4
    parameters:
        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 NSD.
        The GET method fetches the content of the NSD archive.
        The NSD archive is implemented as a single zip file.
        The content of the NSD archive is provided as onboarded,
        i.e. depending on the security option used, 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 007.

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

        This method shall follow the provisions specified in the T
        ables 5.4.4.3.2-1 and 5.4.4.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: Range
          in: header
          required: false
          type: string
          description: >
            The request may contain a "Range" HTTP header to obtain single
            range of bytes from the NSD archive.
            This can be used to continue an aborted transmission.

            If the Range header is present in the request and the NFVO does
            not support responding to range requests with a 206 response,
            it shall return a 200 OK response instead as defined below.
      responses:
        200:
            Shall be returned when the content of the NSD has been read successfully.
            The payload body shall contain a copy of the ZIP file that contains the NSD file structure.
            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.
            Version:
              description: >
                Version of the API used in the response.
              type: string
              maximum: 1
          #  description: >
          #    206 PARTIAL CONTENT

          #    On success, if the NFVO supports range requests,
          #    a single consecutive byte range from the content of
          #    the NSD file is returned.
          #    The response body shall contain the requested part
          #    of the NSD file.
          #    The "Content-Range" HTTP header shall be
          #    provided according to IETF RFC 7233.
          #    The "Content-Type" HTTP header shall be set as
          #    defined above for the "200 OK" response.
          $ref: "../responses/SOL005_resp.yaml#/components/responses/206"
          $ref: "../responses/SOL005_resp.yaml#/components/responses/400"
          $ref: "../responses/SOL005_resp.yaml#/components/responses/401"
          $ref: "../responses/SOL005_resp.yaml#/components/responses/403"
          $ref: "../responses/SOL005_resp.yaml#/components/responses/404"
          $ref: "../responses/SOL005_resp.yaml#/components/responses/405"
          #  description: >
          #    406 NOT ACCEPTABLE

          #    If the "Accept" header does not contain at least one
          #    name of a content type for which the NFVO can
          #    provide a representation of the NSD, the NFVO
          #    shall respond with this response code.
          #    The "ProblemDetails" structure may be included
          #    with the "detail" attribute providing more information
          #    about the error.
          $ref: "../responses/SOL005_resp.yaml#/components/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
          #    "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#/components/responses/409"
          #  description: >
          #    416 RANGE NOT SATISFIABLE

          #    The byte range passed in the "Range" header did
          #    not match any available byte range in the NSD file
          #    (e.g. "access after end of file").
          #    The response body may contain a ProblemDetails
          #    structure.
          $ref: "../responses/SOL005_resp.yaml#/components/responses/416"
          $ref: "../responses/SOL005_resp.yaml#/components/responses/500"
          $ref: "../responses/SOL005_resp.yaml#/components/responses/503"
          $ref: "../responses/SOL005_resp.yaml#/components/responses/504"
      summary: Upload the content of a NSD.
        The PUT method is used to upload the content of an NSD archive.
        The NSD to be uploaded is implemented as a single ZIP file as defined in clause 5.4.4.3.2.
        The "Content-Type" HTTP header in the PUT request shall be set to "application/zip".
        This method shall follow the provisions specified in the Tables 5.4.4.3.3-1 and
        5.4.4.3.3-2 for URI query parameters, request and response data structures, and response codes.
      parameters:
        - name: Content-Type
            The payload body contains a ZIP file that represents the NSD archive, as specified above.
            The request shall set the "Content-Type" HTTP header to "application/zip".
          in: header
          required: true
          type: string
          enum:
            - application/zip
      responses:
        202:
            202 ACCEPTED
            Shall be returned when the NSD 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
            "NsdOnBoardingNotification" and "NsdOnBoardingFailureNotification"
            from the NFVO or by reading the status of the individual NS descriptor
          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
            204 NO CONTENT
            The NSD content successfully uploaded and
            validated (synchronous mode).
            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
          $ref: "../responses/SOL005_resp.yaml#/components/responses/400"
          $ref: "../responses/SOL005_resp.yaml#/components/responses/401"
          $ref: "../responses/SOL005_resp.yaml#/components/responses/403"
          $ref: "../responses/SOL005_resp.yaml#/components/responses/404"
          $ref: "../responses/SOL005_resp.yaml#/components/responses/405"
          $ref: "../responses/SOL005_resp.yaml#/components/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
          #            NsdOnboardingState 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#/components/responses/409"
          $ref: "../responses/SOL005_resp.yaml#/components/responses/500"
          $ref: "../responses/SOL005_resp.yaml#/components/responses/503"
          $ref: "../responses/SOL005_resp.yaml#/components/responses/504"

  ###############################################################################
  # NSD                                                                         #
  ###############################################################################
  '/ns_descriptors/{nsdInfoId}/nsd':
    #ETSI GS NFV-SOL 005 V2.4.1 location: 5.4.4a
    parameters:
      - name: nsdInfoId
        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 NSD within an NSD archive.
        The NSD can be implemented as a single file or as a collection of
        multiple files. If the NSD is implemented in the form of multiple files,
        a ZIP file embedding these files shall be returned. If the NSD 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 NSD 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 NSD 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 NSD; for a multi-file NSD,
            a ZIP file shall be returned.
        The default format of the ZIP file shall be the one specified in ETSI GS NFV-SOL 007
        where only the YAML files representing the NSD, and information necessary to navigate
        the ZIP file and to identify the file that is the entry point for parsing the NSD and
        (if requested) further security information are included. This means that the content
        of the ZIP archive shall contain the following files from the NSD archive:
        •	TOSCA.meta (if available in the NSD 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 NSD 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 NSD archive (if available in the NSD archive);
        -	the signing certificates of the individual files included in the ZIP archive
            (if available in the NSD archive);
        -	the signatures of the individual files (if available in the NSD archive).
        This method shall follow the provisions specified in the Tables 5.4.4a.3.2-1 and 5.4.4a.3.2-2 for
        URI query parameters, request and response data structures, and response codes.
      parameters:
        - name: include_signatures
          in: query
          required: false
          type: string
          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.
        - name: Accept
          in: header
          required: true
          type: string
          enum:
            - text/plain
            - application/zip
          description: >
            The request shall contain the appropriate entries in the "Accept"
            HTTP header as defined above.
      responses:
        200:
          description: >
            200 OK

            Shall be returned when the content of the NSD has been read successfully.
            The payload body shall contain a copy of the file representing the NSD or
            a ZIP file that contains the file or multiple files representing the NSD,
            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:
              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#/components/responses/400"
          $ref: "../responses/SOL005_resp.yaml#/components/responses/401"
          $ref: "../responses/SOL005_resp.yaml#/components/responses/403"
          $ref: "../responses/SOL005_resp.yaml#/components/responses/404"
          $ref: "../responses/SOL005_resp.yaml#/components/responses/405"
          $ref: "../responses/SOL005_resp.yaml#/components/responses/406"
          $ref: "../responses/SOL005_resp.yaml#/components/responses/409"
          $ref: "../responses/SOL005_resp.yaml#/components/responses/500"
          $ref: "../responses/SOL005_resp.yaml#/components/responses/503"
          $ref: "../responses/SOL005_resp.yaml#/components/responses/504"

  ###############################################################################
  # NSD Archive Manifest                                                        #
  ###############################################################################
  '/ns_descriptors/{nsdInfoId}/manifest':
    #ETSI GS NFV-SOL 005 V2.4.1 location: 5.4.4b
    parameters:
      - name: nsdInfoId
        description: >
          Identifier of the individual NS 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 NS 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:
      summary: Fetch the content of the manifest in an NSD archive.
      description: >
        The GET method reads the content of the manifest file within an NSD archive.
        This method shall follow the provisions specified in the Tables 5.4.4b.3.2-1
        and 5.4.4b.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
          in: query
          required: false
          type: string
          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 NSD 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.
      responses:
        200:
          description: >
            200 OK
            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
            NSD archive, 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 NSD archive;
            -	a copy of the related individual certificate file.
          headers:
            Content-Type: