openapi: 3.0.2

info:
  title: SOL005 - NSD Management Interface 
  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
  contact:
    name: NFV-SOL WG
  license:
    name: ETSI Forge copyright notice
    url: https://forge.etsi.org/etsi-forge-copyright-notice.txt
  version: 2.0.0-impl:etsi.org:ETSI_NFV_OpenAPI:1

externalDocs:
  description: ETSI GS NFV-SOL 005 V3.3.1
  url: https://www.etsi.org/deliver/etsi_gs/NFV-SOL/001_099/005/02.06.01_60/gs_NFV-SOL005v020701p.pdf

servers:
  - url: http://127.0.0.1/nsd/v2
  - url: https://127.0.0.1/nsd/v2

paths:
  ###############################################################################
  # API Versions                                                                #
  ###############################################################################
  /api_versions:
    $ref: '../endpoints/SOL005_endpoints.yaml#/endpoints/api-versions'

  ###############################################################################
  # NS Descriptors                                                              #
  ###############################################################################
  /ns_descriptors:
    #ETSI GS NFV-SOL 005 V2.4.1 location: 5.4.2
    parameters:
      - $ref: ../components/SOL005_params.yaml#/components/parameters/Authorization
      - $ref: ../components/SOL005_params.yaml#/components/parameters/Version
      - $ref: ../components/SOL005_params.yaml#/components/parameters/Accept

    post:
      summary: Create a new NS descriptor resource.
      description: |
        The POST method is used to create a new NS descriptor resource.
      parameters:
        - $ref: ../components/SOL005_params.yaml#/components/parameters/ContentType
      requestBody:
        $ref: '#/components/requestBodies/CreateNsdInfoRequest'
      responses:
        201:
          $ref: '#/components/responses/NSDescriptors.Post.201'
        400:
          $ref: "../responses/SOL005_resp.yaml#/components/responses/400"
        401:
          $ref: "../responses/SOL005_resp.yaml#/components/responses/401"
        403:
          $ref: "../responses/SOL005_resp.yaml#/components/responses/403"
        404:
          $ref: "../responses/SOL005_resp.yaml#/components/responses/404"
        405:
          $ref: "../responses/SOL005_resp.yaml#/components/responses/405"
        406:
          $ref: "../responses/SOL005_resp.yaml#/components/responses/406"
        500:
          $ref: "../responses/SOL005_resp.yaml#/components/responses/500"
        503:
          $ref: "../responses/SOL005_resp.yaml#/components/responses/503"
        504:
          $ref: "../responses/SOL005_resp.yaml#/components/responses/504"

    get:
      summary: Query information about multiple NS descriptor resources.
      description: |
        The GET method queries information about multiple NS descriptor resources.
      parameters:      
        - $ref: ../components/SOL005_params.yaml#/components/parameters/filter
        - $ref: ../components/SOL005_params.yaml#/components/parameters/all_fields
        - $ref: ../components/SOL005_params.yaml#/components/parameters/fields
        - $ref: ../components/SOL005_params.yaml#/components/parameters/exclude_fields
        - $ref: ../components/SOL005_params.yaml#/components/parameters/exclude_default
        - $ref: ../components/SOL005_params.yaml#/components/parameters/nextpage_opaque_marker
      responses:
        200:
          $ref: '#/components/responses/NSDescriptors.Get.200'
        400:
          $ref: "../responses/SOL005_resp.yaml#/components/responses/400"
        401:
          $ref: "../responses/SOL005_resp.yaml#/components/responses/401"
        403:
          $ref: "../responses/SOL005_resp.yaml#/components/responses/403"
        404:
          $ref: "../responses/SOL005_resp.yaml#/components/responses/404"
        405:
          $ref: "../responses/SOL005_resp.yaml#/components/responses/405"
        406:
          $ref: "../responses/SOL005_resp.yaml#/components/responses/406"
        500:
          $ref: "../responses/SOL005_resp.yaml#/components/responses/500"
        503:
          $ref: "../responses/SOL005_resp.yaml#/components/responses/503"
        504:
          $ref: "../responses/SOL005_resp.yaml#/components/responses/504"

  ###############################################################################
  # Individual NS Descriptor                                                    #
  ###############################################################################
  /ns_descriptors/{nsdInfoId}:
    #ETSI GS NFV-SOL 005 V2.4.1 location: 5.4.3
    parameters:
      - $ref: '#/components/parameters/NsdInfoId'
      - $ref: ../components/SOL005_params.yaml#/components/parameters/Authorization
      - $ref: ../components/SOL005_params.yaml#/components/parameters/Version

    get:
      summary: Read information about an individual NS descriptor resource.
      description: |
        The GET method reads information about an individual NS descriptor.
      parameters:
        - $ref: ../components/SOL005_params.yaml#/components/parameters/Accept
      responses:
        200:
          $ref: '#/components/responses/IndividualNSDescriptor.Get.200'
        400:
          $ref: "../responses/SOL005_resp.yaml#/components/responses/400"
        401:
          $ref: "../responses/SOL005_resp.yaml#/components/responses/401"
        403:
          $ref: "../responses/SOL005_resp.yaml#/components/responses/403"
        404:
          $ref: "../responses/SOL005_resp.yaml#/components/responses/404"
        405:
          $ref: "../responses/SOL005_resp.yaml#/components/responses/405"
        406:
          $ref: "../responses/SOL005_resp.yaml#/components/responses/406"
        500:
          $ref: "../responses/SOL005_resp.yaml#/components/responses/500"
        503:
          $ref: "../responses/SOL005_resp.yaml#/components/responses/503"
        504:
          $ref: "../responses/SOL005_resp.yaml#/components/responses/504"

    patch:
      summary: Modify the operational state and/or the user defined data of an individual NS descriptor resource.
      description: |
        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.
      requestBody:
        $ref: '#/components/requestBodies/NsdInfoModifications'
      responses:
        200:
          $ref: '#/components/responses/IndividualNSDescriptor.Patch.200'
        400:
          $ref: "../responses/SOL005_resp.yaml#/components/responses/400"
        401:
          $ref: "../responses/SOL005_resp.yaml#/components/responses/401"
        403:
          $ref: "../responses/SOL005_resp.yaml#/components/responses/403"
        404:
          $ref: "../responses/SOL005_resp.yaml#/components/responses/404"
        405:
          $ref: "../responses/SOL005_resp.yaml#/components/responses/405"
        406:
          $ref: "../responses/SOL005_resp.yaml#/components/responses/406"
        409:
          #  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"
        412:
          $ref: "../responses/SOL005_resp.yaml#/components/responses/412"
        500:
          $ref: "../responses/SOL005_resp.yaml#/components/responses/500"
        503:
          $ref: "../responses/SOL005_resp.yaml#/components/responses/503"
        504:
          $ref: "../responses/SOL005_resp.yaml#/components/responses/504"

    delete:
      summary: Delete an individual NS descriptor resource.
      description: |
        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.
      responses:
        204:
          $ref: '#/components/responses/IndividualNSDescriptor.Delete.204'
        400:
          $ref: "../responses/SOL005_resp.yaml#/components/responses/400"
        401:
          $ref: "../responses/SOL005_resp.yaml#/components/responses/401"
        403:
          $ref: "../responses/SOL005_resp.yaml#/components/responses/403"
        404:
          $ref: "../responses/SOL005_resp.yaml#/components/responses/404"
        405:
          $ref: "../responses/SOL005_resp.yaml#/components/responses/405"
        406:
          $ref: "../responses/SOL005_resp.yaml#/components/responses/406"
        409:
          #  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"
        500:
          $ref: "../responses/SOL005_resp.yaml#/components/responses/500"
        503:
          $ref: "../responses/SOL005_resp.yaml#/components/responses/503"
        504:
          $ref: "../responses/SOL005_resp.yaml#/components/responses/504"

  ###############################################################################
  # NSD Archive Content                                                         #
  ###############################################################################
  /ns_descriptors/{nsdInfoId}/nsd_content:
    #ETSI GS NFV-SOL 005 V2.4.1 location: 5.4.4
    parameters:
      - $ref: '#/components/parameters/NsdInfoId'
      - $ref: ../components/SOL005_params.yaml#/components/parameters/Authorization
      - $ref: ../components/SOL005_params.yaml#/components/parameters/Version

    get:
      summary: Fetch the content of a NSD.
      description: |
        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:
        - $ref: '#/components/parameters/AcceptTextOrZip'
        - $ref: ../components/SOL005_params.yaml#/components/parameters/Range
      responses:
        200:
          $ref: '#/components/responses/NsdArchiveContent.Get.200'
        206:
          #  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"
        400:
          $ref: "../responses/SOL005_resp.yaml#/components/responses/400"
        401:
          $ref: "../responses/SOL005_resp.yaml#/components/responses/401"
        403:
          $ref: "../responses/SOL005_resp.yaml#/components/responses/403"
        404:
          $ref: "../responses/SOL005_resp.yaml#/components/responses/404"
        405:
          $ref: "../responses/SOL005_resp.yaml#/components/responses/405"
        406:
          #  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"
        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#/components/responses/409"
        416:
          #  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"
        500:
          $ref: "../responses/SOL005_resp.yaml#/components/responses/500"
        503:
          $ref: "../responses/SOL005_resp.yaml#/components/responses/503"
        504:
          $ref: "../responses/SOL005_resp.yaml#/components/responses/504"

    put:
      summary: Upload the content of a NSD.
      description: |
        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:
        - $ref: '#/components/parameters/ContentTypeZip'
      responses:
        202:
          $ref: '#/components/responses/NsdArchiveContent.Put.202'
        204:
          $ref: '#/components/responses/NsdArchiveContent.Put.204'
        400:
          $ref: "../responses/SOL005_resp.yaml#/components/responses/400"
        401:
          $ref: "../responses/SOL005_resp.yaml#/components/responses/401"
        403:
          $ref: "../responses/SOL005_resp.yaml#/components/responses/403"
        404:
          $ref: "../responses/SOL005_resp.yaml#/components/responses/404"
        405:
          $ref: "../responses/SOL005_resp.yaml#/components/responses/405"
        406:
          $ref: "../responses/SOL005_resp.yaml#/components/responses/406"
        409:
          #          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"
        500:
          $ref: "../responses/SOL005_resp.yaml#/components/responses/500"
        503:
          $ref: "../responses/SOL005_resp.yaml#/components/responses/503"
        504:
          $ref: "../responses/SOL005_resp.yaml#/components/responses/504"

  ###############################################################################
  # NSD                                                                         #
  ###############################################################################
  /ns_descriptors/{nsdInfoId}/nsd:
    #ETSI GS NFV-SOL 005 V2.4.1 location: 5.4.4a
    parameters:
      - $ref: '#/components/parameters/NsdInfoId'
      - $ref: ../components/SOL005_params.yaml#/components/parameters/Authorization
      - $ref: ../components/SOL005_params.yaml#/components/parameters/Version

    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:
        - $ref: ../components/SOL005_params.yaml#/components/parameters/include_signatures
        - $ref: '#/components/parameters/AcceptTextOrZip'
      responses:
        200:
          $ref: '#/components/responses/NSD.Get.200'
        400:
          $ref: "../responses/SOL005_resp.yaml#/components/responses/400"
        401:
          $ref: "../responses/SOL005_resp.yaml#/components/responses/401"
        403:
          $ref: "../responses/SOL005_resp.yaml#/components/responses/403"
        404:
          $ref: "../responses/SOL005_resp.yaml#/components/responses/404"
        405:
          $ref: "../responses/SOL005_resp.yaml#/components/responses/405"
        406:
          $ref: "../responses/SOL005_resp.yaml#/components/responses/406"
        409:
          $ref: "../responses/SOL005_resp.yaml#/components/responses/409"
        500:
          $ref: "../responses/SOL005_resp.yaml#/components/responses/500"
        503:
          $ref: "../responses/SOL005_resp.yaml#/components/responses/503"
        504:
          $ref: "../responses/SOL005_resp.yaml#/components/responses/504"

  ###############################################################################
  # NSD Archive Manifest                                                        #
  ###############################################################################
  /ns_descriptors/{nsdInfoId}/manifest:
    #ETSI GS NFV-SOL 005 V2.4.1 location: 5.4.4b
    parameters:
      - $ref: '#/components/parameters/NsdInfoId'
      - $ref: ../components/SOL005_params.yaml#/components/parameters/Authorization
      - $ref: ../components/SOL005_params.yaml#/components/parameters/Version

    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:
        - $ref: '#/components/parameters/AcceptTextOrZip'
        - $ref: ../components/SOL005_params.yaml#/components/parameters/include_signatures
      responses:
        200:
          $ref: '#/components/responses/NsdArchiveManifest.Get.200'
        400:
          $ref: "../responses/SOL005_resp.yaml#/components/responses/400"
        401:
          $ref: "../responses/SOL005_resp.yaml#/components/responses/401"
        403:
          $ref: "../responses/SOL005_resp.yaml#/components/responses/403"
        404:
          $ref: "../responses/SOL005_resp.yaml#/components/responses/404"
        405:
          $ref: "../responses/SOL005_resp.yaml#/components/responses/405"
        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#/components/responses/409"
        500:
          $ref: "../responses/SOL005_resp.yaml#/components/responses/500"
        503:
          $ref: "../responses/SOL005_resp.yaml#/components/responses/503"
        504:
          $ref: "../responses/SOL005_resp.yaml#/components/responses/504"

  ###############################################################################
  # Individual NSD Archive Artifact                                             #
  ###############################################################################
  /ns_descriptors/{nsdInfoId}/artifacts/{artifactPath}:
    #ETSI GS NFV-SOL 005 V3.3.1 location: 5.4.4c
    parameters:
      - $ref: '#/components/parameters/NsdInfoId'
      - $ref: '#/components/parameters/ArtifactPathInNSD'
      - $ref: ../components/SOL005_params.yaml#/components/parameters/Authorization
      - $ref: ../components/SOL005_params.yaml#/components/parameters/Version
    get:
      description: |
        The GET method fetches the content of an individual artifact within 
        a NSD archive.

        This method shall follow the provisions specified in the Tables 5.4.4c.3.2-1 
        and 5.4.4c.3.2-2 for URI query parameters, request and response data structures, 
        and response codes.
      parameters:
        - $ref: ../components/SOL005_params.yaml#/components/parameters/Range
        - $ref: ../components/SOL005_params.yaml#/components/parameters/include_signatures
      responses:
        200:
          $ref: '#/components/responses/IndividualNsdArchiveArtifact.Get.200'
        206:
          $ref: '#/components/responses/IndividualNsdArchiveArtifact.Get.206'
        400:
          $ref: "../responses/SOL005_resp.yaml#/components/responses/400"
        401:
          $ref: "../responses/SOL005_resp.yaml#/components/responses/401"
        403:
          $ref: "../responses/SOL005_resp.yaml#/components/responses/403"
        404:
          $ref: "../responses/SOL005_resp.yaml#/components/responses/404"
        406:
          # description: |
          #   If the related request contained an "Accept" header not compatible with the Content type
          #   "application/zip" but the "include_signatures" flag was provided, 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/405"
        405:
          $ref: "../responses/SOL005_resp.yaml#/components/responses/406"
        409:
          # description: |
          #   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 "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"
        416:
          # description: |
          #   The byte range passed in the "Range" header did not match any available byte range in the 
          #   artifact file (e.g. "access after end of file").

          #   The response body may contain a ProblemDetails structure.
          $ref: "../responses/SOL005_resp.yaml#/components/responses/416"
        500:
          $ref: "../responses/SOL005_resp.yaml#/components/responses/500"
        503:
          $ref: "../responses/SOL005_resp.yaml#/components/responses/503"
        504:
          $ref: "../responses/SOL005_resp.yaml#/components/responses/504"
  
  ###############################################################################
  # PNF Descriptors                                                             #
  ###############################################################################
  /pnf_descriptors:
    #ETSI GS NFV-SOL 005 V2.4.1 location: 5.4.5
    parameters:
      - $ref: ../components/SOL005_params.yaml#/components/parameters/Authorization
      - $ref: ../components/SOL005_params.yaml#/components/parameters/Version

    post:
      summary: Create a new PNF descriptor resource.
      description: |
        The POST method is used to create a new PNF descriptor resource
      parameters:
        - $ref: ../components/SOL005_params.yaml#/components/parameters/Accept
        - $ref: ../components/SOL005_params.yaml#/components/parameters/ContentType
      requestBody:
        $ref: '#/components/requestBodies/CreatePnfdInfoRequest'
      responses:
        201:
          $ref: '#/components/responses/PNFDescriptors.Post.201'
        400:
          $ref: "../responses/SOL005_resp.yaml#/components/responses/400"
        401:
          $ref: "../responses/SOL005_resp.yaml#/components/responses/401"
        403:
          $ref: "../responses/SOL005_resp.yaml#/components/responses/403"
        404:
          $ref: "../responses/SOL005_resp.yaml#/components/responses/404"
        405:
          $ref: "../responses/SOL005_resp.yaml#/components/responses/405"
        406:
          $ref: "../responses/SOL005_resp.yaml#/components/responses/406"
        500:
          $ref: "../responses/SOL005_resp.yaml#/components/responses/500"
        503:
          $ref: "../responses/SOL005_resp.yaml#/components/responses/503"
        504:
          $ref: "../responses/SOL005_resp.yaml#/components/responses/504"

    get:
      summary: Query information about multiple PNF descriptor resources.
      description: |
        "The GET method queries information about multiple PNF descriptor
        resources."
      parameters:
        - $ref: ../components/SOL005_params.yaml#/components/parameters/filter
        - $ref: ../components/SOL005_params.yaml#/components/parameters/all_fields
        - $ref: ../components/SOL005_params.yaml#/components/parameters/fields
        - $ref: ../components/SOL005_params.yaml#/components/parameters/exclude_fields
        - $ref: ../components/SOL005_params.yaml#/components/parameters/exclude_default
        - $ref: ../components/SOL005_params.yaml#/components/parameters/nextpage_opaque_marker
      responses:
        200:
          $ref: '#/components/responses/PNFDescriptors.Get.200'
        400:
          $ref: "../responses/SOL005_resp.yaml#/components/responses/400"
        401:
          $ref: "../responses/SOL005_resp.yaml#/components/responses/401"
        403:
          $ref: "../responses/SOL005_resp.yaml#/components/responses/403"
        404:
          $ref: "../responses/SOL005_resp.yaml#/components/responses/404"
        405:
          $ref: "../responses/SOL005_resp.yaml#/components/responses/405"
        406:
          $ref: "../responses/SOL005_resp.yaml#/components/responses/406"
        500:
          $ref: "../responses/SOL005_resp.yaml#/components/responses/500"
        503:
          $ref: "../responses/SOL005_resp.yaml#/components/responses/503"
        504:
          $ref: "../responses/SOL005_resp.yaml#/components/responses/504"

  ###############################################################################
  # Individual PNF Descriptor                                                   #
  ###############################################################################
  /pnf_descriptors/{pnfdInfoId}:
    #ETSI GS NFV-SOL 005 V2.4.1 location: 5.4.6
    parameters:
      - $ref: '#/components/parameters/PnfdInfoId'

    get:
      summary: Read an individual PNFD resource.
      description: |
        The GET method reads information about an individual PNF descriptor.
      parameters:
        - $ref: ../components/SOL005_params.yaml#/components/parameters/Accept
        - $ref: ../components/SOL005_params.yaml#/components/parameters/Authorization
        - $ref: ../components/SOL005_params.yaml#/components/parameters/Version
      responses:
        200:
          $ref: '#/components/responses/IndividualPnfDescriptor.Get.200'
        400:
          $ref: "../responses/SOL005_resp.yaml#/components/responses/400"
        401:
          $ref: "../responses/SOL005_resp.yaml#/components/responses/401"
        403:
          $ref: "../responses/SOL005_resp.yaml#/components/responses/403"
        404:
          $ref: "../responses/SOL005_resp.yaml#/components/responses/404"
        405:
          $ref: "../responses/SOL005_resp.yaml#/components/responses/405"
        406:
          $ref: "../responses/SOL005_resp.yaml#/components/responses/406"
        500:
          $ref: "../responses/SOL005_resp.yaml#/components/responses/500"
        503:
          $ref: "../responses/SOL005_resp.yaml#/components/responses/503"
        504:
          $ref: "../responses/SOL005_resp.yaml#/components/responses/504"

    patch:
      summary: Modify the user defined data of an individual PNF descriptor resource.
      description: |
        The PATCH method modifies the user defined data of an individual PNF descriptor resource.
      parameters:
        - $ref: ../components/SOL005_params.yaml#/components/parameters/Accept
        - $ref: ../components/SOL005_params.yaml#/components/parameters/ContentType
      requestBody:
        $ref: '#/components/requestBodies/PnfdInfoModifications'
      responses:
        200:
          $ref: '#/components/responses/IndividualPnfDescriptor.Patch.200'
        400:
          $ref: "../responses/SOL005_resp.yaml#/components/responses/400"
        401:
          $ref: "../responses/SOL005_resp.yaml#/components/responses/401"
        403:
          $ref: "../responses/SOL005_resp.yaml#/components/responses/403"
        404:
          $ref: "../responses/SOL005_resp.yaml#/components/responses/404"
        405:
          $ref: "../responses/SOL005_resp.yaml#/components/responses/405"
        406:
          $ref: "../responses/SOL005_resp.yaml#/components/responses/406"
        412:
          $ref: "../responses/SOL005_resp.yaml#/components/responses/412"
        500:
          $ref: "../responses/SOL005_resp.yaml#/components/responses/500"
        503:
          $ref: "../responses/SOL005_resp.yaml#/components/responses/503"
        504:
          $ref: "../responses/SOL005_resp.yaml#/components/responses/504"

    delete:
      summary: Delete an individual 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:
          $ref: '#/components/responses/IndividualPnfDescriptor.Delete.200'
        400:
          $ref: "../responses/SOL005_resp.yaml#/components/responses/400"
        401:
          $ref: "../responses/SOL005_resp.yaml#/components/responses/401"
        403:
          $ref: "../responses/SOL005_resp.yaml#/components/responses/403"
        404:
          $ref: "../responses/SOL005_resp.yaml#/components/responses/404"
        405:
          $ref: "../responses/SOL005_resp.yaml#/components/responses/405"
        406:
          $ref: "../responses/SOL005_resp.yaml#/components/responses/406"
        500:
          $ref: "../responses/SOL005_resp.yaml#/components/responses/500"
        503:
          $ref: "../responses/SOL005_resp.yaml#/components/responses/503"
        504:
          $ref: "../responses/SOL005_resp.yaml#/components/responses/504"

  ###############################################################################
  # PNFD Archive Content                                                        #
  ###############################################################################
  /pnf_descriptors/{pnfdInfoId}/pnfd_content:
    #ETSI GS NFV-SOL 005 V2.4.1 location: 5.4.7
    parameters:
      - $ref: '#/components/parameters/PnfdInfoId'
      - $ref: ../components/SOL005_params.yaml#/components/parameters/Authorization
      - $ref: ../components/SOL005_params.yaml#/components/parameters/Version

    get:
      summary: Fetch the content of a PNFD.
      description: |
        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.
      parameters:
        - $ref: '#/components/parameters/AcceptText'
        - $ref: ../components/SOL005_params.yaml#/components/parameters/Range
      responses:
        200:
          $ref: '#/components/responses/PnfdArchiveContent.Get.200'
        206:
          $ref: '#/components/responses/PnfdArchiveContent.Get.206'
        400:
          $ref: "../responses/SOL005_resp.yaml#/components/responses/400"
        401:
          $ref: "../responses/SOL005_resp.yaml#/components/responses/401"
        403:
          $ref: "../responses/SOL005_resp.yaml#/components/responses/403"
        404:
          $ref: "../responses/SOL005_resp.yaml#/components/responses/404"
        405:
          $ref: "../responses/SOL005_resp.yaml#/components/responses/405"
        406:
          $ref: "../responses/SOL005_resp.yaml#/components/responses/406"
        409:
          #  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#/components/responses/409"
        416:
          $ref: "../responses/SOL005_resp.yaml#/components/responses/416"
        500:
          $ref: "../responses/SOL005_resp.yaml#/components/responses/500"
        503:
          $ref: "../responses/SOL005_resp.yaml#/components/responses/503"
        504:
          $ref: "../responses/SOL005_resp.yaml#/components/responses/504"

    put:
      summary: Upload the content of a PNFD.
      description: |
        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:
        - $ref: '#/components/parameters/AcceptText'
        - $ref: '#/components/parameters/ContentTypeZip'
      responses:
        202:
          $ref: '#/components/responses/PnfdArchiveContent.Put.200'
        204:
          $ref: '#/components/responses/PnfdArchiveContent.Put.204'
        400:
          $ref: "../responses/SOL005_resp.yaml#/components/responses/400"
        401:
          $ref: "../responses/SOL005_resp.yaml#/components/responses/401"
        403:
          $ref: "../responses/SOL005_resp.yaml#/components/responses/403"
        404:
          $ref: "../responses/SOL005_resp.yaml#/components/responses/404"
        405:
          $ref: "../responses/SOL005_resp.yaml#/components/responses/405"
        406:
          $ref: "../responses/SOL005_resp.yaml#/components/responses/406"
        409:
          #  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#/components/responses/409"
        500:
          $ref: "../responses/SOL005_resp.yaml#/components/responses/500"
        503:
          $ref: "../responses/SOL005_resp.yaml#/components/responses/503"

  ###############################################################################
  # PNFD                                                                        #
  ###############################################################################
  /pnf_descriptors/{pnfdInfoId}/pnfd:
    #ETSI GS NFV-SOL 005 V2.4.1 location: 5.4.7a
    parameters:
      - $ref: '#/components/parameters/PnfdInfoId'
      - $ref: ../components/SOL005_params.yaml#/components/parameters/Authorization
      - $ref: ../components/SOL005_params.yaml#/components/parameters/Version

    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:
        - $ref: '#/components/parameters/AcceptText'
        - $ref: ../components/SOL005_params.yaml#/components/parameters/Range
        - $ref: ../components/SOL005_params.yaml#/components/parameters/include_signatures
      responses:
        200:
          $ref: '#/components/responses/PNFD.Get.200'
        400:
          $ref: "../responses/SOL005_resp.yaml#/components/responses/400"
        401:
          $ref: "../responses/SOL005_resp.yaml#/components/responses/401"
        403:
          $ref: "../responses/SOL005_resp.yaml#/components/responses/403"
        404:
          $ref: "../responses/SOL005_resp.yaml#/components/responses/404"
        405:
          $ref: "../responses/SOL005_resp.yaml#/components/responses/405"
        406:
          $ref: "../responses/SOL005_resp.yaml#/components/responses/406"
        409:
          $ref: "../responses/SOL005_resp.yaml#/components/responses/409"
        500:
          $ref: "../responses/SOL005_resp.yaml#/components/responses/500"
        503:
          $ref: "../responses/SOL005_resp.yaml#/components/responses/503"
        504:
          $ref: "../responses/SOL005_resp.yaml#/components/responses/504"

  ###############################################################################
  # PNFD Archive Manifest                                                       #
  ###############################################################################
  /pnf_descriptors/{pnfdInfoId}/manifest:
    #ETSI GS NFV-SOL 005 V2.4.1 location: 5.4.7b
    parameters:
      - $ref: '#/components/parameters/PnfdInfoId'
      - $ref: ../components/SOL005_params.yaml#/components/parameters/Authorization
      - $ref: ../components/SOL005_params.yaml#/components/parameters/Version

    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:
        - $ref: '#/components/parameters/AcceptTextOrZip'
        - $ref: ../components/SOL005_params.yaml#/components/parameters/include_signatures
      responses:
        200:
          $ref: '#/components/responses/PnfdArchiveManifest.Get.200'
        400:
          $ref: "../responses/SOL005_resp.yaml#/components/responses/400"
        401:
          $ref: "../responses/SOL005_resp.yaml#/components/responses/401"
        403:
          $ref: "../responses/SOL005_resp.yaml#/components/responses/403"
        404:
          $ref: "../responses/SOL005_resp.yaml#/components/responses/404"
        405:
          $ref: "../responses/SOL005_resp.yaml#/components/responses/405"
        406:
          $ref: "../responses/SOL005_resp.yaml#/components/responses/406"
        409:
          $ref: "../responses/SOL005_resp.yaml#/components/responses/409"
        500:
          $ref: "../responses/SOL005_resp.yaml#/components/responses/500"
        503:
          $ref: "../responses/SOL005_resp.yaml#/components/responses/503"
        504:
          $ref: "../responses/SOL005_resp.yaml#/components/responses/504"

  ###############################################################################
  # Individual PNFD Archive Artifact                                            #
  ###############################################################################
  /pnf_descriptors/{pnfdInfoId}/artifacts/{artifactPath}:
    #ETSI GS NFV-SOL 005 V3.3.1 location: 5.4.7c
    parameters:
      - $ref: '#/components/parameters/PnfdInfoId'
      - $ref: '#/components/parameters/ArtifactPathInPNFD'
      - $ref: ../components/SOL005_params.yaml#/components/parameters/Authorization
      - $ref: ../components/SOL005_params.yaml#/components/parameters/Version
    
    get:
      description: |
        The GET method fetches the content of an individual artifact within a PNFD archive.

        This method shall follow the provisions specified in the Tables 5.4.7c.3.2-1 and 
        5.4.7c.3.2-2 for URI query parameters, request and response data structures, and 
        response codes.
      parameters:
        - $ref: ../components/SOL005_params.yaml#/components/parameters/Range
        - $ref: ../components/SOL005_params.yaml#/components/parameters/include_signatures
      responses:
        200:
          $ref: '#/components/responses/IndividualPnfdArchiveArtifact.Get.200'
        206:
          $ref: '#/components/responses/IndividualPnfdArchiveArtifact.Get.206'
        400:
          $ref: "../responses/SOL005_resp.yaml#/components/responses/400"
        401:
          $ref: "../responses/SOL005_resp.yaml#/components/responses/401"
        403:
          $ref: "../responses/SOL005_resp.yaml#/components/responses/403"
        404:
          $ref: "../responses/SOL005_resp.yaml#/components/responses/404"
        406:
          # description: |
          #   If the related request contained an "Accept" header not compatible with the Content type
          #   "application/zip" but the "include_signatures" flag was provided, 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/405"
        405:
          $ref: "../responses/SOL005_resp.yaml#/components/responses/406"
        409:
          # description: |
          #   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 "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#/components/responses/409"
        416:
          # description: |
          #   The byte range passed in the "Range" header did not match any available byte range in the 
          #   artifact file (e.g. "access after end of file").

          #   The response body may contain a ProblemDetails structure.
          $ref: "../responses/SOL005_resp.yaml#/components/responses/416"
        500:
          $ref: "../responses/SOL005_resp.yaml#/components/responses/500"
        503:
          $ref: "../responses/SOL005_resp.yaml#/components/responses/503"
        504:
          $ref: "../responses/SOL005_resp.yaml#/components/responses/504"
    
  ###############################################################################
  # Subscriptions                                                               #
  ###############################################################################
  /subscriptions:
    #ETSI GS NFV-SOL 005 V2.4.1 location: 5.4.8
    parameters:
      - $ref: ../components/SOL005_params.yaml#/components/parameters/Authorization
      - $ref: ../components/SOL005_params.yaml#/components/parameters/Version

    post:
      summary: Subscribe to NSD and PNFD change notifications.
      description: |
        The POST method creates a new subscription.
        This method shall support the URI query parameters, request and
        response data structures, and response codes, as specified in
        the Tables 5.4.8.3.1-1 and 5.4.8.3.1-2.
        Creation of two subscription resources with the same callback URI
        and the same filter can result in performance degradation and will
        provide duplicates of notifications to the OSS, and might make
        sense only in very rare use cases. Consequently, the NFVO may
        either allow creating a subscription resource if another subscription
        resource with the same filter and callback URI already exists (in which
        case it shall return the "201 Created" response code), or may decide to
        not create a duplicate subscription resource (in which case it shall
        return a "303 See Other" response code referencing the existing
        subscription resource with the same filter and callbackUricallback URI).
      parameters:
        - $ref: ../components/SOL005_params.yaml#/components/parameters/Accept
        - $ref: ../components/SOL005_params.yaml#/components/parameters/ContentType
      requestBody:
        $ref: '#/components/requestBodies/NsdmSubscriptionRequest'
      responses:
        201:
          $ref: '#/components/responses/Subscriptions.Post.201'
        303:
          #  description: |
          #    303 SEE OTHER

          #    Shall be returned when a subscription with the
          #    same callbackURI and the same filter already
          #    exits and the policy of the NFVO is to not create
          #    redundant subscriptions.
          #    The HTTP response shall include a "Location"
          #    HTTP header that contains the resource URI of
          #    the existing subscription resource.
          #    The response body shall be empty.
          $ref: "../responses/SOL005_resp.yaml#/components/responses/303"
        400:
          $ref: "../responses/SOL005_resp.yaml#/components/responses/400"
        401:
          $ref: "../responses/SOL005_resp.yaml#/components/responses/401"
        403:
          $ref: "../responses/SOL005_resp.yaml#/components/responses/403"
        404:
          $ref: "../responses/SOL005_resp.yaml#/components/responses/404"
        405:
          $ref: "../responses/SOL005_resp.yaml#/components/responses/405"
        406:
          $ref: "../responses/SOL005_resp.yaml#/components/responses/406"
        422:
          $ref: "../responses/SOL005_resp.yaml#/components/responses/422"
        500:
          $ref: "../responses/SOL005_resp.yaml#/components/responses/500"
        503:
          $ref: "../responses/SOL005_resp.yaml#/components/responses/503"
        504:
          $ref: "../responses/SOL005_resp.yaml#/components/responses/504"

    get:
      summary: Query multiple subscriptions.
      description: |
        TThe GET method queries the list of active subscriptions of the
        functional block that invokes the method. It can be used e.g.
        for resynchronization after error situations.
        This method shall support the URI query parameters, request and
        response data structures, and response codes, as specified in
        the Tables 5.4.8.3.2-1 and 5.4.8.3.2-2.
      parameters:
        - $ref: ../components/SOL005_params.yaml#/components/parameters/filter
        - $ref: ../components/SOL005_params.yaml#/components/parameters/nextpage_opaque_marker
        - $ref: ../components/SOL005_params.yaml#/components/parameters/Accept
      responses:
        200:
          $ref: '#/components/responses/Subscriptions.Get.200'
        400:
          $ref: "../responses/SOL005_resp.yaml#/components/responses/400"
        401:
          $ref: "../responses/SOL005_resp.yaml#/components/responses/401"
        403:
          $ref: "../responses/SOL005_resp.yaml#/components/responses/403"
        404:
          $ref: "../responses/SOL005_resp.yaml#/components/responses/404"
        405:
          $ref: "../responses/SOL005_resp.yaml#/components/responses/405"
        406:
          $ref: "../responses/SOL005_resp.yaml#/components/responses/406"
        500:
          $ref: "../responses/SOL005_resp.yaml#/components/responses/500"
        503:
          $ref: "../responses/SOL005_resp.yaml#/components/responses/503"
        504:
          $ref: "../responses/SOL005_resp.yaml#/components/responses/504"

  ###############################################################################
  # Individual Subscription                                                     #
  ###############################################################################
  /subscriptions/{subscriptionId}:
    #ETSI GS NFV-SOL 005 V2.4.1 location: 5.4.9    
    parameters:
      - $ref: '#/components/parameters/SubscriptionId'
      - $ref: ../components/SOL005_params.yaml#/components/parameters/Authorization
      - $ref: ../components/SOL005_params.yaml#/components/parameters/Version

    get:
      summary: Read an individual subscription resource.
      description: |
        This resource represents an individual subscription. 
        It can be used by the client to read and to terminate a subscription to
        notifications related to NSD management.

        The GET method retrieves information about a subscription by reading
        an individual subscription resource. 
        This resource represents an individual subscription. 
        It can be used by the client to read and to terminate a subscription to
        notifications related to NSD management.
      parameters:
        - $ref: ../components/SOL005_params.yaml#/components/parameters/Accept
      responses:
        200:
          $ref: '#/components/responses/IndividualSubscription.Get.200'
        400:
          $ref: "../responses/SOL005_resp.yaml#/components/responses/400"
        401:
          $ref: "../responses/SOL005_resp.yaml#/components/responses/401"
        403:
          $ref: "../responses/SOL005_resp.yaml#/components/responses/403"
        404:
          $ref: "../responses/SOL005_resp.yaml#/components/responses/404"
        405:
          $ref: "../responses/SOL005_resp.yaml#/components/responses/405"
        406:
          $ref: "../responses/SOL005_resp.yaml#/components/responses/406"
        500:
          $ref: "../responses/SOL005_resp.yaml#/components/responses/500"
        503:
          $ref: "../responses/SOL005_resp.yaml#/components/responses/503"
        504:
          $ref: "../responses/SOL005_resp.yaml#/components/responses/504"

    delete:
      summary: Terminate Subscription
      description: |
        This resource represents an individual subscription. 
        It can be used by the client to read and to terminate a subscription to
        notifications related to NSD management.

        The DELETE method terminates an individual subscription.
        This method shall support the URI query parameters, request and 
        response data structures, and response codes, as
        specified in the Table 5.4.9.3.3-2.      
      responses:
        204:
          $ref: '#/components/responses/IndividualSubscription.Delete.204'
        400:
          $ref: "../responses/SOL005_resp.yaml#/components/responses/400"
        401:
          $ref: "../responses/SOL005_resp.yaml#/components/responses/401"
        403:
          $ref: "../responses/SOL005_resp.yaml#/components/responses/403"
        404:
          $ref: "../responses/SOL005_resp.yaml#/components/responses/404"
        405:
          $ref: "../responses/SOL005_resp.yaml#/components/responses/405"
        406:
          $ref: "../responses/SOL005_resp.yaml#/components/responses/406"
        500:
          $ref: "../responses/SOL005_resp.yaml#/components/responses/500"
        503:
          $ref: "../responses/SOL005_resp.yaml#/components/responses/503"
        504:
          $ref: "../responses/SOL005_resp.yaml#/components/responses/504"

components:
  parameters:
    AcceptTextOrZip:
      name: Accept
      description: >
        The request shall contain the appropriate entries in the "Accept" HTTP header.
      in: header
      required: true
      schema:
        type: string
        enum:
          - text/plain
          - application/zip
    AcceptText:
      name: Accept
      description: >
        The request shall contain the appropriate entries in the "Accept" HTTP header.
      in: header
      required: true
      schema:
        type: string
        enum:
          - text/plain
    ContentTypeZip:
      name: Content-Type
      description: |
        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
      schema:
        type: string
        enum:
          - application/zip

    NsdInfoId:
      name: nsdInfoId
      in: path
      description: |
        Identifier of the individual NS descriptor resource.
      required: true
      style: simple
      explode: false
      schema:
        type: string
    
    PnfdInfoId:
      name: pnfdInfoId
      in: path
      description: |
          Identifier of the individual PNF descriptor resource.
      required: true
      style: simple
      explode: false
      schema:
        type: string

    ArtifactPathInNSD:
      name: artifactPath
      in: path
      description: |
        For an artifact contained as a file in the NSD archive, this variable shall 
        contain a sequence of one or path segments representing the path of the 
        artifact within the NSD archive, relative to the root of the package.

        EXAMPLE: foo/bar/m%40ster.sh
        
        For an external artifact represented as a URI in the NSD archive manifest, 
        this variable shall contain the URI as provided in the NS archive.

        This identifier can be retrieved from the "artifactPath" attribute of the 
        applicable "artifacts" entry in the body of the response to a GET request 
        querying the "Individual NSD" resource.
        
        Since multiple path segments are allowed to be contained in this variable, 
        the "/" character that separates these segments is not percent-encoded. 
        Each individual segment is percent-encoded if necessary as defined in 
        clause 4.1 of ETSI GS NFV-SOL 013.
      required: true
      style: simple
      explode: false
      schema:
        type: string

    ArtifactPathInPNFD:
      name: artifactPath
      in: path
      description: |
        For an artifact contained as a file in the PNFD archive, this variable shall contain 
        a sequence of one or path segments representing the path of the artifact within the 
        PNFD archive, relative to the root of the package.

        EXAMPLE: foo/bar/m%40ster.sh

        For an external artifact represented as a URI in the PNFD archive manifest, this variable 
        shall contain the URI as provided in the NS archive.

        This identifier can be retrieved from the "artifactPath" attribute of the applicable 
        "artifacts" entry in the body of the response to a GET request querying the "Individual PNFD" 
        resource. 
        
        Since multiple path segments are allowed to be contained in this variable, the "/" character 
        that separates these segments is not percent-encoded. Each individual segment is percent-encoded 
        if necessary as defined in clause 4.1 of ETSI GS NFV-SOL 013.
      required: true
      style: simple
      explode: false
      schema:
        type: string

    SubscriptionId:
      name: subscriptionId
      in: path
      description: |
          Identifier of this subscription. 
          This identifier can be retrieved from the resource referenced by the "Location" HTTP header in 
          the response to a POST request creating a new subscription resource. It can also be retrieved
          from the "id" attribute in the payload body of that response.
      required: true
      style: simple
      explode: false
      schema:
        type: string
  
  requestBodies:
    CreateNsdInfoRequest:
      description: |
        Parameters of creating an NS descriptor resource, as defined in clause 5.5.2.3.
      content:
        application/json:
          schema:
            $ref: "definitions/SOL005NSDescriptorManagement_def.yaml#/definitions/CreateNsdInfoRequest"
      required: true

    NsdInfoModifications:
      description: |
        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.
      content:
        application/json:
          schema:
            $ref: "definitions/SOL005NSDescriptorManagement_def.yaml#/definitions/NsdInfoModifications"
      required: true

    CreatePnfdInfoRequest:
      description: |
        Parameters of creating a PNF descriptor resource.
      content:
        application/json:
          schema:
            $ref: "definitions/SOL005NSDescriptorManagement_def.yaml#/definitions/CreatePnfdInfoRequest"
      required: true

    PnfdInfoModifications:
      description: |
        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.
      content:
        application/json:
          schema:
            $ref: "definitions/SOL005NSDescriptorManagement_def.yaml#/definitions/PnfdInfoModifications"
      required: true

    NsdmSubscriptionRequest:
      description: |
        Details of the subscription to be created, as defined in clause 5.5.2.7.
      content:
        application/json:
          schema:
            $ref: "definitions/SOL005NSDescriptorManagement_def.yaml#/definitions/NsdmSubscriptionRequest"
      required: true

  responses:
    NSDescriptors.Post.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.
      headers:
        Content-Type:
          description: |
            The MIME type of the body of the request. Reference: IETF RFC 7231
          style: simple
          explode: false
          schema:
            type: string
        WWW-Authenticate:
          description: |
            Challenge if the corresponding HTTP request has not provided authorization, or error details if the
            corresponding HTTP request has provided an invalid authorization token.
          style: simple
          explode: false
          schema:
            type: string
        Version:
          description: |
            Version of the API used in the response.
          style: simple
          explode: false
          schema:
            type: string
      content:
        application/json:
          schema:
            $ref: "definitions/SOL005NSDescriptorManagement_def.yaml#/definitions/NsdInfo"

    NSDescriptors.Get.200:
      description: |
        200 OK

        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 request. Reference: IETF RFC 7231
          style: simple
          explode: false
          schema:
            type: string
        WWW-Authenticate:
          description: |
            Challenge if the corresponding HTTP request has not provided authorization, or error details if the
            corresponding HTTP request has provided an invalid authorization token.
          style: simple
          explode: false
          schema:
            type: string
        Version:
          description: |
            Version of the API used in the response.
          style: simple
          explode: false
          schema:
            type: string
        Link:
          description: |
            Reference to other resources. Used for paging in the present document, see clause 4.7.2.1.
          style: simple
          explode: false
          schema:
            type: string
      content:
        application/json:
          schema:
            type: array
            items:
              $ref: "definitions/SOL005NSDescriptorManagement_def.yaml#/definitions/NsdInfo"

    IndividualNSDescriptor.Get.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.
      headers:
        Content-Type:
          description: |
            The MIME type of the body of the request. Reference: IETF RFC 7231
          style: simple
          explode: false
          schema:
            type: string
        WWW-Authenticate:
          description: |
            Challenge if the corresponding HTTP request has not provided authorization, or error details if the
            corresponding HTTP request has provided an invalid authorization token.
          style: simple
          explode: false
          schema:
            type: string
        Version:
          description: |
            Version of the API used in the response.
          style: simple
          explode: false
          schema:
            type: string
      content:
        application/json:
          schema:
            $ref: "definitions/SOL005NSDescriptorManagement_def.yaml#/definitions/NsdInfo"

    IndividualNSDescriptor.Patch.200:
      description: |
        200 OK

        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 request. Reference: IETF RFC 7231
          style: simple
          explode: false
          schema:
            type: string
        WWW-Authenticate:
          description: |
            Challenge if the corresponding HTTP request has not provided authorization, or error details if the
            corresponding HTTP request has provided an invalid authorization token.
          style: simple
          explode: false
          schema:
            type: string
        Version:
          description: |
            Version of the API used in the response.
          style: simple
          explode: false
          schema:
            type: string
      content:
        application/json:
          schema:
            $ref: "definitions/SOL005NSDescriptorManagement_def.yaml#/definitions/NsdInfoModifications"

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

        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.
          style: simple
          explode: false
          schema:
            type: string
        Version:
          description: |
            Version of the API used in the response.
          style: simple
          explode: false
          schema:
            type: string

    NsdArchiveContent.Get.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 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 request. Reference: IETF RFC 7231
          style: simple
          explode: false
          schema:
            type: string
        WWW-Authenticate:
          description: |
            Challenge if the corresponding HTTP request has not provided authorization, or error details if the
            corresponding HTTP request has provided an invalid authorization token.
          style: simple
          explode: false
          schema:
            type: string
        Version:
          description: |
            Version of the API used in the response.
          style: simple
          explode: false
          schema:
            type: string

    NsdArchiveContent.Put.202:
      description: |
        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
        resource using the GET method.
      headers:
        Content-Type:
          description: |
            The MIME type of the body of the request. Reference: IETF RFC 7231
          style: simple
          explode: false
          schema:
            type: string
        WWW-Authenticate:
          description: |
            Challenge if the corresponding HTTP request has not provided authorization, or error details if the
            corresponding HTTP request has provided an invalid authorization token.
          style: simple
          explode: false
          schema:
            type: string
        Version:
          description: |
            Version of the API used in the response.
          style: simple
          explode: false
          schema:
            type: string

    NsdArchiveContent.Put.204:
      description: |
        204 NO CONTENT

        The NSD content successfully uploaded and
        validated (synchronous mode).
        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.
          style: simple
          explode: false
          schema:
            type: string
        Version:
          description: |
            Version of the API used in the response.
          style: simple
          explode: false
          schema:
            type: string

    NSD.Get.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 request. Reference: IETF RFC 7231
          style: simple
          explode: false
          schema:
            type: string
        WWW-Authenticate:
          description: |
            Challenge if the corresponding HTTP request has not provided authorization, or error details if the
            corresponding HTTP request has provided an invalid authorization token.
          style: simple
          explode: false
          schema:
            type: string
        Version:
          description: |
            Version of the API used in the response.
          style: simple
          explode: false
          schema:
            type: string

    NsdArchiveManifest.Get.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:
          description: |
            The MIME type of the body of the request. Reference: IETF RFC 7231
          style: simple
          explode: false
          schema:
            type: string
        WWW-Authenticate:
          description: |
            Challenge if the corresponding HTTP request has not provided authorization, or error details if the
            corresponding HTTP request has provided an invalid authorization token.
          style: simple
          explode: false
          schema:
            type: string
        Version:
          description: |
            Version of the API used in the response.
          style: simple
          explode: false
          schema:
            type: string

    IndividualNsdArchiveArtifact.Get.200:
      description: |
        200 OK

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

        If the "include_signatures" request URI parameter was not provided in the related request, 
        the payload body shall contain a copy of the artifact file from the NSD archive, as defined 
        by ETSI GS NFV-SOL 007, and the "Content-Type" HTTP header shall be set according to the 
        content type of the artifact file. If the artifact is encrypted, the header shall be set to
        the value "application/cms" (IETF RFC 7193). 
        
        If the content type cannot be determined, the header shall be set to the value 
        "application/octet-stream". If the "include_signatures" request URI parameter was provided 
        in the related request, the "Content-Type" HTTP header shall be set to "application/zip"
        and the payload body shall contain a ZIP archive which includes:
        - a copy of the artifact file from the VNF package, as defined by ETSI GS NFVSOL 007
        - the related security information (individual signature file and optional related individual 
        certificate file).
      headers:
        Content-Type:
          description: |
            The MIME type of the body of the request. Reference: IETF RFC 7231
          style: simple
          explode: false
          schema:
            type: string
        WWW-Authenticate:
          description: |
            Challenge if the corresponding HTTP request has not provided authorization, or error details if the
            corresponding HTTP request has provided an invalid authorization token.
          style: simple
          explode: false
          schema:
            type: string
        Version:
          description: |
            Version of the API used in the response.
          style: simple
          explode: false
          schema:
            type: string

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

        If the NFVO supports range requests and the "include_signatures" request URI parameter was
        not present in the related request, this response shall be returned when a single consecutive 
        byte range from the content of the artifact file has been read successfully according to the 
        request.

        The response body shall contain the requested part of the artifact file from the NSD archive, 
        as defined by ETSI GS NFV-SOL 007. 
        
        The "Content-Type" HTTP header shall be set according to the content type of the artifact file. 
        If the content type cannot be determined, the header shall be set to the value 
        "application/octet-stream".

        The "Content-Range" HTTP header shall be provided according to IETF RFC 7233.
      headers:
        Content-Type:
          description: |
            The MIME type of the body of the request. Reference: IETF RFC 7231
          style: simple
          explode: false
          schema:
            type: string
        WWW-Authenticate:
          description: |
            Challenge if the corresponding HTTP request has not provided authorization, or error details if the
            corresponding HTTP request has provided an invalid authorization token.
          style: simple
          explode: false
          schema:
            type: string
        Version:
          description: |
            Version of the API used in the response.
          style: simple
          explode: false
          schema:
            type: string

    PNFDescriptors.Post.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.
      headers:
        Content-Type:
          description: |
            The MIME type of the body of the request. Reference: IETF RFC 7231
          style: simple
          explode: false
          schema:
            type: string
        WWW-Authenticate:
          description: |
            Challenge if the corresponding HTTP request has not provided authorization, or error details if the
            corresponding HTTP request has provided an invalid authorization token.
          style: simple
          explode: false
          schema:
            type: string
        Version:
          description: |
            Version of the API used in the response.
          style: simple
          explode: false
          schema:
            type: string
      content:
        application/json:
          schema:
            $ref: "definitions/SOL005NSDescriptorManagement_def.yaml#/definitions/PnfdInfo"

    PNFDescriptors.Get.200:
      description: |
        200 OK

        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 request. Reference: IETF RFC 7231
          style: simple
          explode: false
          schema:
            type: string
        WWW-Authenticate:
          description: |
            Challenge if the corresponding HTTP request has not provided authorization, or error details if the
            corresponding HTTP request has provided an invalid authorization token.
          style: simple
          explode: false
          schema:
            type: string
        Version:
          description: |
            Version of the API used in the response.
          style: simple
          explode: false
          schema:
            type: string
        Link:
          description: |
            Reference to other resources. Used for paging in the present document, see clause 4.7.2.1.
          style: simple
          explode: false
          schema:
            type: string
      content:
        application/json:
          schema:
            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.
            type: array
            items:
              $ref: "definitions/SOL005NSDescriptorManagement_def.yaml#/definitions/PnfdInfo"

    IndividualPnfDescriptor.Get.200:
      description: |
        200 OK

        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 request. Reference: IETF RFC 7231
          style: simple
          explode: false
          schema:
            type: string
        WWW-Authenticate:
          description: |
            Challenge if the corresponding HTTP request has not provided authorization, or error details if the
            corresponding HTTP request has provided an invalid authorization token.
          style: simple
          explode: false
          schema:
            type: string
        Version:
          description: |
            Version of the API used in the response.
          style: simple
          explode: false
          schema:
            type: string
      content:
        application/json:
          schema:
            $ref: "definitions/SOL005NSDescriptorManagement_def.yaml#/definitions/PnfdInfo"

    IndividualPnfDescriptor.Patch.200:
      description: |
        200 OK

        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).
      headers:
        Content-Type:
          description: |
            The MIME type of the body of the request. Reference: IETF RFC 7231
          style: simple
          explode: false
          schema:
            type: string
        WWW-Authenticate:
          description: |
            Challenge if the corresponding HTTP request has not provided authorization, or error details if the
            corresponding HTTP request has provided an invalid authorization token.
          style: simple
          explode: false
          schema:
            type: string
        Version:
          description: |
            Version of the API used in the response.
          style: simple
          explode: false
          schema:
            type: string
      content:
        application/json:
          schema:
            $ref: "definitions/SOL005NSDescriptorManagement_def.yaml#/definitions/PnfdInfoModifications"

    IndividualPnfDescriptor.Delete.200:
      description: |
        204 NO CONTENT

        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.
          style: simple
          explode: false
          schema:
            type: string
        Version:
          description: |
            Version of the API used in the response.
          style: simple
          explode: false
          schema:
            type: string

    PnfdArchiveContent.Get.200:
      description: |
        200 OK

        Shall be returned when the content of the PNFD archive has
        been read successfully.
        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 request. Reference: IETF RFC 7231
          style: simple
          explode: false
          schema:
            type: string
        WWW-Authenticate:
          description: |
            Challenge if the corresponding HTTP request has not provided authorization, or error details if the
            corresponding HTTP request has provided an invalid authorization token.
          style: simple
          explode: false
          schema:
            type: string
        Version:
          description: |
            Version of the API used in the response.
          style: simple
          explode: false
          schema:
            type: string

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

        If the NFVO supports range requests, this response shall be returned
        when a single consecutive byte range from the content of the 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 request. Reference: IETF RFC 7231
          style: simple
          explode: false
          schema:
            type: string
        Content-Range:
          description: The Content-Range response HTTP header indicates where in a full body message a partial message belongs.
          style: simple
          explode: false
          schema:
            type: string
        WWW-Authenticate:
          description: |
            Challenge if the corresponding HTTP request has not provided authorization, or error details if the
            corresponding HTTP request has provided an invalid authorization token.
          style: simple
          explode: false
          schema:
            type: string
        Version:
          description: |
            Version of the API used in the response.
          style: simple
          explode: false
          schema:
            type: string

    PnfdArchiveContent.Put.200:
      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:
          description: |
            Challenge if the corresponding HTTP request has not provided authorization, or error details if the
            corresponding HTTP request has provided an invalid authorization token.
          style: simple
          explode: false
          schema:
            type: string
        Version:
          description: |
            Version of the API used in the response.
          style: simple
          explode: false
          schema:
            type: string

    PnfdArchiveContent.Put.204:
      description: |
        204 NO CONTENT

        Shall be returned when the PNFD archive content has been
        uploaded and validated 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.
          style: simple
          explode: false
          schema:
            type: string
        Version:
          description: |
            Version of the API used in the response.
          style: simple
          explode: false
          schema:
            type: string

    PNFD.Get.200:
      description: |
        200 OK

        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:
          description: |
            The MIME type of the body of the request. Reference: IETF RFC 7231
          style: simple
          explode: false
          schema:
            type: string
        WWW-Authenticate:
          description: |
            Challenge if the corresponding HTTP request has not provided authorization, or error details if the
            corresponding HTTP request has provided an invalid authorization token.
          style: simple
          explode: false
          schema:
            type: string
        Version:
          description: |
            Version of the API used in the response.
          style: simple
          explode: false
          schema:
            type: string

    PnfdArchiveManifest.Get.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,
        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 PNFD archive;
        -	a copy of the related individual certificate file.
      headers:
        Content-Type:
          description: |
            The MIME type of the body of the request. Reference: IETF RFC 7231
          style: simple
          explode: false
          schema:
            type: string
            enum:
              - text/plain
              - application/zip
        WWW-Authenticate:
          description: |
            Challenge if the corresponding HTTP request has not provided authorization, or error details if the
            corresponding HTTP request has provided an invalid authorization token.
          style: simple
          explode: false
          schema:
            type: string
        Version:
          description: |
            Version of the API used in the response.
          style: simple
          explode: false
          schema:
            type: string

    IndividualPnfdArchiveArtifact.Get.200:
      description: |
        200 OK

        Shall be returned when the content of the artifact file has been read successfully.
                  
        If the "include_signatures" request URI parameter was not provided in the related request, 
        the payload body shall contain a copy of the artifact file from the PNFD archive, as defined 
        by ETSI GS NFV-SOL 004, and the "Content-Type" HTTP header shall be set according to the 
        content type of the artifact file. If the artifact is encrypted, the header shall be set to 
        the value "application/cms" (IETF RFC 7193). 
        
        If the content type cannot be determined, the header shall be set to the value 
        "application/octetstream". If the "include_signatures" request URI parameter was provided 
        in the related request, the "Content-Type" HTTP header shall be set to "application/zip"
        and the payload body shall contain a ZIP archive which includes:
        - a copy of the artifact file from the VNF package, as defined by ETSI GS NFVSOL 004
        - the related security information (individual signature file and optional related individual 
        certificate file).
      headers:
        Content-Type:
          description: |
            The MIME type of the body of the request. Reference: IETF RFC 7231
          style: simple
          explode: false
          schema:
            type: string
        WWW-Authenticate:
          description: |
            Challenge if the corresponding HTTP request has not provided authorization, or error details if the
            corresponding HTTP request has provided an invalid authorization token.
          style: simple
          explode: false
          schema:
            type: string
        Version:
          description: |
            Version of the API used in the response.
          style: simple
          explode: false
          schema:
            type: string

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

        If the NFVO supports range requests and the "include_signatures" request URI parameter was
        not present in the related request, this response shall be returned when a single consecutive 
        byte range from the content of the artifact file has been read successfully according to the 
        request.

        The response body shall contain the requested part of the artifact file from the PNFD archive, 
        as defined by ETSI GS NFV-SOL 004. 
        
        The "Content-Type" HTTP header shall be set according to the content type of the artifact file. 
        If the content type cannot be determined, the header shall be set to the value 
        "application/octet-stream".
        
        The "Content-Range" HTTP header shall be provided according to IETF RFC 7233.
      headers:
        Content-Type:
          description: |
            The MIME type of the body of the request. Reference: IETF RFC 7231
          style: simple
          explode: false
          schema:
            type: string
        WWW-Authenticate:
          description: |
            Challenge if the corresponding HTTP request has not provided authorization, or error details if the
            corresponding HTTP request has provided an invalid authorization token.
          style: simple
          explode: false
          schema:
            type: string
        Version:
          description: |
            Version of the API used in the response.
          style: simple
          explode: false
          schema:
            type: string

    Subscriptions.Post.201:
      description: |
        201 CREATED

        Shall be returned when the subscription has been created successfully.
        A representation of the created "Individual subscription" resource shall
        be returned in the response body, as defined in clause 5.5.2.8.
        The HTTP response shall include a "Location:" HTTP header that points
        to the created "Individual subscription" resource.
      headers:
        Content-Type:
          description: |
            The MIME type of the body of the request. Reference: IETF RFC 7231
          style: simple
          explode: false
          schema:
            type: string
        WWW-Authenticate:
          description: |
            Challenge if the corresponding HTTP request has not provided authorization, or error details if the
            corresponding HTTP request has provided an invalid authorization token.
          style: simple
          explode: false
          schema:
            type: string
        Version:
          description: |
            Version of the API used in the response.
          style: simple
          explode: false
          schema:
            type: string
      content:
        application/json:
          schema:
            $ref: "definitions/SOL005NSDescriptorManagement_def.yaml#/definitions/NsdmSubscription"

    Subscriptions.Get.200:
      description: |
        200 OK

        Shall be returned when the list of subscriptions has been queried successfully.
        The response body shall contain in an array the representations of all active
        subscriptions of the functional block that invokes the method, i.e. zero or more
        representations of NSD management subscriptions as defined in clause 5.5.2.8.
        If the "filter" URI parameter was supplied in the request, the data in the
        response body shall have been transformed according to the rules specified in
        clause 5.2.2 of ETSI GS NFV-SOL 013.
        If the 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 request. Reference: IETF RFC 7231
          style: simple
          explode: false
          schema:
            type: string
        WWW-Authenticate:
          description: |
            Challenge if the corresponding HTTP request has not provided authorization, or error details if the
            corresponding HTTP request has provided an invalid authorization token.
          style: simple
          explode: false
          schema:
            type: string
        Version:
          description: |
            Version of the API used in the response.
          style: simple
          explode: false
          schema:
            type: string
        Link:
          description: |
            Reference to other resources. Used for paging in the present document, see clause 4.7.2.1.
          style: simple
          explode: false
          schema:
            type: string
      content:
        application/json:
          schema:
            description: |
              The list of subscriptions was queried successfully.
              The response body shall contain in an array the representations of all active subscriptions
              of the functional block that invokes the method, i.e., zero or more representations of NSD management
              subscriptions as defined in clause 5.5.2.8.
              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.
            type: array
            items:
              $ref: "definitions/SOL005NSDescriptorManagement_def.yaml#/definitions/NsdmSubscription"

    IndividualSubscription.Get.200:
      description: |
        200 OK

        Shall be returned when information about an individual subscription has been read successfully.
        The response body shall contain a representation of the subscription resource.
      headers:
        Content-Type:
          description: |
            The MIME type of the body of the request. Reference: IETF RFC 7231
          style: simple
          explode: false
          schema:
            type: string
        WWW-Authenticate:
          description: |
            Challenge if the corresponding HTTP request has not provided authorization, or error details if the
            corresponding HTTP request has provided an invalid authorization token.
          style: simple
          explode: false
          schema:
            type: string
        Version:
          description: |
            Version of the API used in the response.
          style: simple
          explode: false
          schema:
            type: string
      content:
        application/json:
          schema:
            $ref: "definitions/SOL005NSDescriptorManagement_def.yaml#/definitions/NsdmSubscription"

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

        Shall be returned when the "Individual subscription" resource
        has been deleted 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.
          style: simple
          explode: false
          schema:
            type: string
        Version:
          description: |
            Version of the API used in the response.
          style: simple
          explode: false
          schema:
            type: string