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. In case of
    discrepancies the published ETSI Group Specification takes precedence.

    Please report bugs to https://forge.etsi.org/rep/nfv/SOL005/issues

  contact:
    name: NFV-SOL WG
  license:
    name: ETSI Forge copyright notice
    url: https://forge.etsi.org/etsi-forge-copyright-notice.txt
  version: 2.2.1-impl:etsi.org:ETSI_NFV_OpenAPI:1

externalDocs:
  description: ETSI GS NFV-SOL 005 V3.6.1
  url: https://www.etsi.org/deliver/etsi_gs/NFV-SOL/001_099/005/03.05.01_60/gs_nfv-sol005v030501p.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:
      description: |
        The POST method is used to create a new NS descriptor resource. See clause 5.4.2.3.1.
      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:
      description: |
        The GET method queries information about multiple NS descriptor resources. See clause 5.4.2.3.2.
      parameters:      
        - in: query
          name: filter
          description: >
            Attribute-based filtering expression according to clause 5.2 of ETSI GS NFV SOL 013.
            The NFVO shall support receiving this filtering parameter as part of the URI query string. 
            The OSS/BSS may supply this parameter.
            All attribute names that appear in the NsdInfo and in data types referenced from it shall 
            be supported by the NFVO in the filter expression.
          schema:
            type: string
        - $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
        - in: query
          name: exclude_default
          description: >
            Indicates to exclude the following complex attributes from the response. See clause 5.3 of ETSI GS 
            NFV-SOL 013 for details. The NFVO shall support this parameter.
            The following attributes shall be excluded from the NsdInfo structure in the response body if this 
            parameter is provided, or none of the parameters "all_fields", "fields", "exclude_fields", 
            "exclude_default" are provided:
            -	userDefinedData
            -	onboardingFailureDetails
          schema:
            type: string
        - $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:
      description: |
        The GET method reads information about an individual NS descriptor. See clause 5.4.3.3.2.
      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:
      description: |
        The PATCH method modifies the operational state and/or user defined data of an individual NS descriptor resource.
        See clause 5.4.3.3.4.
      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:
          $ref: '#/components/responses/IndividualNSDescriptor.Patch.409'
        412:
          $ref: '#/components/responses/IndividualNSDescriptor.Patch.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:
      description: |
        The DELETE method deletes an individual NS descriptor resource. See clause 5.4.3.3.5.
      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:
          $ref: '#/components/responses/IndividualNSDescriptor.Delete.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:
      description: |
        The GET method fetches the content of the NSD archive. See clause 5.4.4.3.2.
      parameters:
        - $ref: '#/components/parameters/AcceptTextOrZip'
        - $ref: ../components/SOL005_params.yaml#/components/parameters/Range
      responses:
        200:
          $ref: '#/components/responses/NsdArchiveContent.Get.200'
        206:
          $ref: '#/components/responses/NsdArchiveContent.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"
        409:
          $ref: '#/components/responses/NsdArchiveContent.Get.409'
        416:
          $ref: '#/components/responses/NsdArchiveContent.Get.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:
      description: |
        The PUT method is used to upload the content of an NSD archive. See clause 5.4.4.3.3.
      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:
          $ref: '#/components/responses/NsdArchiveContent.Put.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. See clause 5.4.4a.3.2.
      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: '#/components/responses/NSD.Get.406'
        409:
          $ref: '#/components/responses/NSD.Get.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:
      description: |
        The GET method reads the content of the manifest file within an NSD archive. See clasue 5.4.4b.3.2.
      parameters:
        - $ref: '#/components/parameters/AcceptTextOrZip'
        - in: query
          name: include_signatures
          description: >
            If this parameter is provided, the NFVO shall return the manifest and related security information 
            (signature and certificate) either in a single text file if the signature and certificate are included 
            in the manifest file, or in a zip file containing the manifest and the certificate file, if this is 
            provided as a separate file in the NSD archive.
            If this parameter is not given, the NFVO shall provide only a copy of the manifest file, as onboarded. 
            If the security information is included in the onboarded manifest, it shall also be included in the 
            returned copy.
            This URI query parameter is a flag, i.e. it shall have no value. The NFVO shall support this parameter.
          schema:
            type: string
      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:
          $ref: '#/components/responses/NsdArchiveManifest.Get.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.5.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 an NSD archive. See clause 5.4.4c.3.2.
      parameters:
        - $ref: ../components/SOL005_params.yaml#/components/parameters/Range
        - in: query
          name: include_signatures
          description: >
            If this parameter is provided, the NFVO shall return the artifact and related security information 
            (such as signature and optional certificate) in a ZIP archive.
            If this parameter is not given, the NFVO shall provide only a copy of the artifact file.
            This URI query parameter is a flag, i.e. it shall have no value. The NFVO shall support this parameter.
          schema:
            type: string
      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:
          $ref: '#/components/responses/IndividualNsdArchiveArtifact.Get.406'
        405:
          $ref: "../responses/SOL005_resp.yaml#/components/responses/406"
        409:
          $ref: '#/components/responses/IndividualNsdArchiveArtifact.Get.409'
        416:
          $ref: '#/components/responses/IndividualNsdArchiveArtifact.Get.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:
      description: |
        The POST method is used to create a new PNF descriptor resource. See clause 5.4.5.3.1.
      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:
      description: |
        The GET method queries information about multiple PNF descriptor resources. See clause 5.4.5.3.2.
      parameters:
        - in: query
          name: filter
          description: >
            Attribute-based filtering expression according to clause 5.2 of ETSI GS NFV-SOL 013.
            The NFVO shall support receiving this filtering parameter as part of the URI query string. 
            The OSS/BSS may supply this parameter.
            All attribute names that appear in the PnfdInfo and in data types referenced from it shall 
            be supported by the NFVO in the filter expression. 
          schema:
            type: string
        - $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
        - in: query
          name: exclude_default
          description: >
            Indicates to exclude the following complex attributes from the response. See clause 5.3 of ETSI GS 
            NFV-SOL 013for details. The NFVO shall support this parameter.
            The following attributes shall be excluded from the PnfdInfo structure in the response body if this 
            parameter is provided, or none of the parameters "all_fields", "fields", "exclude_fields", 
            "exclude_default" are provided:
            -	userDefinedData
            -	onboardingFailureDetails
          schema:
            type: string
        - $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:
      description: |
        The GET method reads information about an individual PNF descriptor. See clause 5.4.6.3.2.
      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:
      description: |
        The PATCH method modifies the user defined data of an individual PNF descriptor resource. See clause 5.4.6.3.4.
      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: '#/components/responses/IndividualPnfDescriptor.Patch.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:
      description: |
        The DELETE method deletes an individual PNF descriptor resource. See clause 5.4.6.3.5.
      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:
      description: |
        The GET method fetches the content of the PNFD archive. See clause 5.4.7.3.2.
      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:
          $ref: '#/components/responses/PnfdArchiveContent.Get.409'
        416:
          $ref: '#/components/responses/PnfdArchiveContent.Get.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:
      description: |
        The PUT method is used to upload the content of a PNFD archive. See clause 5.4.7.3.3.
      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:
          $ref: '#/components/responses/PnfdArchiveContent.Put.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. See clause 5.4.7a.3.2.
      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: '#/components/responses/PNFD.Get.406'
        409:
          $ref: '#/components/responses/PNFD.Get.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. See clause 5.4.7b.3.2.
      parameters:
        - $ref: '#/components/parameters/AcceptTextOrZip'
        - in: query
          name: include_signatures
          description: >
            If this parameter is provided, the NFVO shall return the manifest and related security information 
            (signature and certificate) either in a single text file if the signature and certificate are included 
            in the manifest file, or in a zip file containing the manifest and the certificate file, if this is 
            provided as a separate file in the PNFD archive.
            If this parameter is not given, the NFVO shall provide only a copy of the manifest file, as onboarded. 
            If the security information is included in the onboarded manifest, it shall also be included in the 
            returned copy. This URI query parameter is a flag, i.e. it shall have no value.
            The NFVO shall support this parameter.
          schema:
            type: string
      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: '#/components/responses/PnfdArchiveManifest.Get.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.5.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. See clause 5.4.7c.3.2.
      parameters:
        - $ref: ../components/SOL005_params.yaml#/components/parameters/Range
        - in: query
          name: include_signatures
          description: >
            If this parameter is provided, the NFVO shall return the artifact and related security information 
            (such as signature and optional certificate) in a ZIP archive.
            If this parameter is not given, the NFVO shall provide only a copy of the artifact file.
            This URI query parameter is a flag, i.e. it shall have no value. The NFVO shall support this parameter.
          schema:
            type: string
      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:
          $ref: '#/components/responses/IndividualPnfdArchiveArtifact.Get.406'
        409:
          $ref: '#/components/responses/IndividualPnfdArchiveArtifact.Get.409'
        416:
          $ref: '#/components/responses/IndividualPnfdArchiveArtifact.Get.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:
      description: |
        The POST method creates a new subscription. See clause 5.4.8.3.1.
      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:
          $ref: '#/components/responses/Subscriptions.Post.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: '#/components/responses/Subscriptions.Post.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:
      description: |
        The GET method queries the list of active subscriptions of the functional block that invokes the method.
        It can be used e.g. for resynchronization after error situations. See clause 5.4.8.3.2.
      parameters:
        - in: query
          name: filter
          description: >
            Attribute filtering expression according to clause 5.2 of ETSI GS NFV SOL 013.
            The NFVO shall support receiving this parameter as part of the URI query string. 
            The OSS/BSS may supply this parameter.
            All attribute names that appear in the NsdmSubscription and in data types referenced 
            from it shall be supported by the NFVO in the filter expression.
          schema:
            type: string
        - $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:
      description: |
        The GET method retrieves information about a subscription by reading an individual subscription resource.
        See clause 5.4.9.3.2.
      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:
      description: |
        The DELETE method terminates an individual subscription. See clause 5.4.9.3.5.
      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:
    filter:
      name: filter
      description: >
        Attribute-based filtering expression according to clause 5.2 of ETSI GS NFV SOL 013.
        The NFVO shall support receiving this filtering parameter as part of the URI query string.
        The OSS/BSS may supply this parameter. 
        All attribute names that appear in the NsdInfo and in data types referenced from it shall 
        be supported by the NFVO in the filter expression.
      in: query
      required: false
      schema:
        type: string

    exclude_default:
      name: exclude_default
      in: query
      description: >-
        Indicates to exclude the following complex attributes from the response. 
        See clause 5.3 of ETSI GS NFV-SOL 013 for details. The NFVO shall support this parameter.
        The following attributes shall be excluded from the NsdInfo structure in the response body 
        if this parameter is provided, or none of the parameters "all_fields", "fields", "exclude_fields", 
        "exclude_default" are provided:
        -	userDefinedData
        -	onboardingFailureDetails
      required: false
      schema:
        type: string

    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.1).
      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.Patch.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 "Individual NS descriptor" 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.
      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/SOL005_def.yaml#/definitions/ProblemDetails"

    IndividualNSDescriptor.Patch.412:
      description: |
        412 PRECONDITION FAILED

        Shall be returned upon the following error: A precondition given in an HTTP request header is not fulfilled.
        Typically, this is due to an ETag mismatch, indicating that the resource was modified by another entity.
        The response body should contain a ProblemDetails structure, in which the "detail" attribute should convey
        more information about the error.
      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

    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

    IndividualNSDescriptor.Delete.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 the NS descriptor resource is in the enabled operational state
        (i.e. nsdOperationalState = ENABLED) or there are running NS instances using the concerned individual
        NS descriptor resource (i.e. nsdUsageState = IN_USE).
        The response body shall contain a ProblemDetails structure, in which the "detail" attribute shall
        convey more information about the error.
      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/SOL005_def.yaml#/definitions/ProblemDetails"

    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.Get.206:
      description: |
        206 PARTIAL CONTENT

        If NFVO supports range requests, this response
        shall be returned when a single consecutive byte range from the content of the NSD file has been read
        successfully according to the request.
        The response body shall contain the requested part of the NSD archive.
        The "Content-Range" HTTP header shall be provided according to IETF RFC 7233 [10].
        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
        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-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

    NsdArchiveContent.Get.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.
      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/SOL005_def.yaml#/definitions/ProblemDetails"

    NsdArchiveContent.Get.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.
      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-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

    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

    NsdArchiveContent.Put.409:
      description: |
        409 CONFLICT

        Shall be returned upon the following error: The operation cannot be executed currently, due to a conflict
        with the state of the resource.
        Typically, this is due to the fact that the "nsdOnboardingState" attribute has a value other than "CREATED" or "ERROR".
        The response body shall contain a ProblemDetails structure, in which the "detail" attribute shall convey
        more information about the error.
      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
        Content-Type:
          description: |
            The MIME type of the body of the request. Reference: IETF RFC 7231
          style: simple
          explode: false
          schema:
            type: string
      content:
        application/json:
          schema:
            $ref: "../definitions/SOL005_def.yaml#/definitions/ProblemDetails"

    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

    NSD.Get.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.
      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.409:
      description: |
        409 CONFLICT

        Shall be returned upon the following error: The operation cannot be executed currently, due to a
        conflict with the state of the resource.
        Typically, this is due to the fact that "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.
      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
        Content-Type:
          description: |
            The MIME type of the body of the request. Reference: IETF RFC 7231
          style: simple
          explode: false
          schema:
            type: string
      content:
        application/json:
          schema:
            $ref: "../definitions/SOL005_def.yaml#/definitions/ProblemDetails"

    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

    NsdArchiveManifest.Get.409:
      description: |
       409 CONFLICT

        Shall be returned upon the following error: The operation cannot be executed currently, due to a
        conflict with the state of the resource.
        Typically, this is due to the fact that "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.
      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/SOL005_def.yaml#/definitions/ProblemDetails"

    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

    IndividualNsdArchiveArtifact.Get.409:
      description: |
        409 CONFLICT

        Shall be returned upon the following error: The operation cannot be executed currently, due to a conflict
        with the state of the resource.
        Typically, this is due to the fact that "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.
      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/SOL005_def.yaml#/definitions/ProblemDetails"

    IndividualNsdArchiveArtifact.Get.406:
      description: |
        406 NOT ACCEPTABLE

        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.

      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.416:
      description: |
        416 Range Not Satisfiable

        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.

      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

    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.Patch.412:
      description: |
        412 Precondition failed

        Shall be returned upon the following error: A precondition given in an HTTP request header is not fulfilled.
        Typically, this is due to an ETag mismatch, indicating that the resource was modified by another entity.
        The response body should contain a ProblemDetails structure, in which the "detail" attribute should
        convey more information about the error.
      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

    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.Get.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.
      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/SOL005_def.yaml#/definitions/ProblemDetails"

    PnfdArchiveContent.Get.416:
      description: |
        416 Range not Satisfiable

        Shall be returned upon the following error: The byte range passed in the "Range" header did not
        match any available byte range in the PNFD archive (e.g. "access after end of file").
        The response body may contain a ProblemDetails structure.
      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.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

    PnfdArchiveContent.Put.409:
      description: |
        409 CONFLICT

        Shall be returned upon the following error: The operation cannot be executed currently, due to a conflict
        with the state of the resource.
        Typically, this is due to the fact that the "pnfdOnboardingState" attribute has a value other than "CREATED" or "ERROR".
        The response body shall contain a ProblemDetails structure, in which the "detail" attribute shall convey
        more information about the error
      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
        Content-Type:
          description: |
            The MIME type of the body of the request. Reference: IETF RFC 7231
          style: simple
          explode: false
          schema:
            type: string
      content:
        application/json:
          schema:
            $ref: "../definitions/SOL005_def.yaml#/definitions/ProblemDetails"

    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

    PNFD.Get.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 PNFD, the NFVO shall respond with this response code.
        The "ProblemDetails" structure may be included with the "detail" attribute providing more information
        about the error.
      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.409:
      description: |
        409 CONFLICT

        Shall be returned upon the following error: The operation cannot be executed currently, due to
        a conflict with the state of the resource.
        Typically, this is due to the fact that "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.
      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/SOL005_def.yaml#/definitions/ProblemDetails"

    PnfdArchiveManifest.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 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

    PnfdArchiveManifest.Get.409:
      description: |
        409 CONFLICT

        Shall be returned upon the following error: The operation cannot be executed currently, due to a
        conflict with the state of the resource.
        Typically, this is due to the fact that "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.
      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
      content:
        application/json:
          schema:
            $ref: "../definitions/SOL005_def.yaml#/definitions/ProblemDetails"

    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

    IndividualPnfdArchiveArtifact.Get.406:
      description: |
        406 NOT ACCEPTABLE

        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.
      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.409:
      description: |
        409 CONFLICT

        Shall be returned upon the following error: The operation cannot be executed currently, due to a
        conflict with the state of the resource.
        Typically, this is due to the fact that "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.
      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/SOL005_def.yaml#/definitions/ProblemDetails"

    IndividualPnfdArchiveArtifact.Get.416:
      description: |
        416 Range Not Satisfiable

        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.
      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
        Location:
          description: |
            The resource URI of the created NS instance
          schema:
            type: string
          style: simple
      content:
        application/json:
          schema:
            $ref: "definitions/SOL005NSDescriptorManagement_def.yaml#/definitions/NsdmSubscription"

    Subscriptions.Post.303:
      description: |
        303 See Other

        Shall be returned when a subscription with the same callback URI 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
        "Individual subscription" resource.
        The response body shall be empty.
      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
        Location:
          description: |
            The resource URI of the created NS instance
          schema:
            type: string
          style: simple

    Subscriptions.Post.422:
      description: |
        422 Unprocessable Entity

        Shall be returned upon the following error: The content type of the payload body is supported and the payload
        body of a request contains syntactically correct data but the data cannot be processed.
        The general cause for this error and its handling is specified in clause 6.4 of ETSI GS NFV-SOL 013 [16],
        including rules for the presence of the response body.
        Specifically in case of this resource, the response code 422 shall also be returned if the NFVO has tested
        the Notification endpoint as described in clause 5.4.10.3.2 and the test has failed.
        In this case, the "detail" attribute in the "ProblemDetails" structure shall convey more information about
        the error.
      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/SOL005_def.yaml#/definitions/ProblemDetails"

    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