VNFPackageManagement.yaml

          enum:
            - application/zip
        - name: Range
          in: header
          required: false
          type: string
          description: >
            The request may contain a "Range" HTTP header to obtain single
            range of bytes from the VNF package file. This can be used to
            continue an aborted transmission.

            If the NFVO does not support range requests, it should return the
            whole file with a 200 OK response instead.
      responses:
        200:
          description: >
            200 OK

            Shall be returned when the whole content of the VNF package file has been read successfully.
            The response body shall include a copy of the VNF package file.
            The "Content-Type" HTTP header shall be set according to the type of the file, i.e. to
            "application/zip" for a VNF Package as defined in ETSI GS NFV-SOL 004.
          headers:
            Content-Type:
              description: The MIME type of the body of the response.
              type: string
              maximum: 1
              minimum: 1
            WWW-Authenticate:
              type: string
              description: >
                Challenge if the corresponding HTTP request has not provided
                authorization, or error details if the corresponding HTTP request
                has provided an invalid authorization token.
              maximum: 1
              minimum: 0
            Version:
              description: >
                Version of the API used in the response.
              type: string
              maximum: 1
              minimum: 1
        206:
          $ref: "../responses/SOL005_resp.yaml#/responses/206"
        409:
          $ref: "../responses/SOL005_resp.yaml#/responses/409"
        416:
          $ref: "../responses/SOL005_resp.yaml#/responses/416"
        400:
          $ref: "../responses/SOL005_resp.yaml#/responses/400"
        401:
          $ref: "../responses/SOL005_resp.yaml#/responses/401"
        403:
          $ref: "../responses/SOL005_resp.yaml#/responses/403"
        404:
          $ref: "../responses/SOL005_resp.yaml#/responses/404"
        405:
          $ref: "../responses/SOL005_resp.yaml#/responses/405"
        406:
          $ref: "../responses/SOL005_resp.yaml#/responses/406"
        500:
          $ref: "../responses/SOL005_resp.yaml#/responses/500"
        503:
          $ref: "../responses/SOL005_resp.yaml#/responses/503"
    put:
      summary: The PUT method uploads the content of a VNF package.
      description: >
        The PUT method uploads the content of a VNF package.
        This method shall follow the provisions specified in the 
        Tables 9.4.5.3.3-1 and 9.4.5.3.3-2 for URI query parameters,
        request and response data structures, and response codes.
        Upon start of the upload of the package, the NFVO shall set the "onboardingState" attribute in the "VnfPkgInfo"
        structure to "UPLOADING". Upon successful upload of the package, if the package references external artifacts, the
        NFVO shall obtain the external artifacts. Subsequently, upon success, the NFVO shall set that attribute to
        "PROCESSING" and shall process the package, which shall include checking package consistency. Upon successful
        processing, the NFVO shall set the "onboardingState" attribute to "ONBOARDED", the "operationalState" attribute to 
        "ENABLED", and the "usageState" attribute to "NOT_IN_USE". In addition, the NFVO shall set the value of the attributes 
        in the "VnfPkgInfo" that are copied from the VNFD (refer to clause 9.5.2.5). If an error occurs during uploading
        the package, downloading the external artifacts or processing the package, the NFVO shall set the "onboardingState"
        attribute to "ERROR" and shall populate the "onboardingFailureDetails" attribute in "VnfPkgInfo".
      consumes:
        - multipart/form-data
      parameters:
        - name: Accept
          description: >
            Content-Types that are acceptable for the response.
          in: header
          required: true
          type: string
          enum:
            - application/zip
        - in: formData
          name: file
          required: false
          type: file
          description: >
            The payload body contains a ZIP file that represents the VNF package.
            The "Content-Type" HTTP header shall be set according to the type of the file,
            i.e. to "application/zip" for a VNF Package as defined in ETSI GS NFV-SOL 004.
      responses:
        202:
          description: >
            202 Accepted

            Shall be returned when the VNF package has been
            accepted for uploading, but the processing has not
            been completed. It is expected to take some time
            for processing.
            The response body shall be empty. See note.
          headers:
            Version:
              description: >
                Version of the API used in the response.
              type: string
              maximum: 1
              minimum: 1
        409:
          $ref: "../responses/SOL005_resp.yaml#/responses/409"
        400:
          $ref: "../responses/SOL005_resp.yaml#/responses/400"
        401:
          $ref: "../responses/SOL005_resp.yaml#/responses/401"
        403:
          $ref: "../responses/SOL005_resp.yaml#/responses/403"
        404:
          $ref: "../responses/SOL005_resp.yaml#/responses/404"
        405:
          $ref: "../responses/SOL005_resp.yaml#/responses/405"
        406:
          $ref: "../responses/SOL005_resp.yaml#/responses/406"
        500:
          $ref: "../responses/SOL005_resp.yaml#/responses/500"
        503:
          $ref: "../responses/SOL005_resp.yaml#/responses/503"

  ###############################################################################
  # VNF package artifact                                                        #
  ###############################################################################
  '/vnf_packages/{vnfPkgId}/artifacts':
    #ETSI GS NFV-SOL 005 V2.8.1 location: 9.4.5a
    parameters:
      - name: vnfPkgId
        description: >
          Identifier of the on-boarded VNF package.
          The identifier is allocated by the NFVO.
          This identifier can be retrieved from the "vnfPkgId" attribute in the VnfPackageOnboardingNotification or
          VnfPackageChangeNotification.
        in: path
        type: string
        required: true
      - name: Authorization
        description: >
          The authorization token for the request.
          Reference: IETF RFC 7235.
        in: header
        required: false
        type: string
      - name: Version
        description: >
          Version of the API requested to use when responding to this request.
        in: header
        required: true
        type: string
    get:
      summary: Fetch set of VNF package artifacts.
      description: >
        The GET method shall return an archive that contains a set of artifacts according to the provisions for
        inclusion/exclusion defined below, embedded in a directory structure being the same as in the VNF package.
        The criteria for exclusion/inclusion of an artifact in the archive are defined as follows:
        • Artifacts that are software images shall be excluded from the archive.
        • Artifacts that are not software images and that are external to the VNF package shall be excluded from the 
        archive unless the URI query parameter "include_external_artifacts" has been provided. 
        External artifacts shall be included in the archive using the content of the "artifactPath" attribute as the path.
        • All additional artifacts included in the VNF package that are MANO artifacts shall be included in the archive,
        unless the URI query parameter "exclude_all_mano_artifacts" has been provided, in which case such artifacts
        shall be excluded.
        • All additional artifacts included in the VNF package that are non-MANO artifacts shall be included in the
        archive, unless:
        - the URI query parameter "exclude_all_non_mano_artifacts" has been provided, in which case such
        artifacts shall be excluded;
        - the URI query parameter "select_non_mano_artifact_sets" has been provided and is supported by the
        NFVO, in which case only those non-MANO artifacts shall be included whose non-MANO artifact set
        identifier matches one of the values of the query parameter.
        Package metadata such as manifest file or VNFD shall not be included in the archive.
        This method shall follow the provisions specified in the Tables 9.4.5a.3.2-1 and 9.4.5a.3.2-2 for URI query parameters,
        request and response data structures, and response codes.
      parameters:
        - name: Accept
          description: >
            Content-Types that are acceptable for the response.
          in: header
          required: true
          type: string
          enum:
            - application/zip
        - name: Range
          in: header
          required: false
          type: string
          description: >
            The request may contain a "Range" HTTP header to obtain single
            range of bytes from the archive containing the artifacts. This can
            be used to continue an aborted transmission.
            If the "Range" header is present in the request and the NFVO
            does not support responding to range requests with a 206
            response, it shall return a 200 OK response instead as defined
            below.
        - name: include_signatures
          in: query
          required: false
          type: string
          description: >
            If this parameter is provided, the NFVO shall include in the ZIP
            archive the individual signatures and, if provided, related
            certificates for the included artifacts, in the format in which they
            are provided in the VNF package.
            If this parameter is not given, the NFVO shall only provide copies
            of the artifact files.
            This URI query parameter is a flag, i.e. it shall have no value.
            The NFVO shall support this parameter.
        - name: exclude_all_mano_artifacts
          in: query
          required: false
          type: string
          description: >
            Flag (i.e. parameter without value) that instructs the NFVO to
            exclude the set of additional MANO artifacts (i.e. those that are
            not images) from the response payload body.
            The NFVO shall support this parameter. The OSS/BSS may supply
            this parameter.
        - name: exclude_all_non_mano_artifacts
          in: query
          required: false
          type: string
          description: >
            Flag (i.e. parameter without value) that instructs the NFVO to
            exclude the set of non-MANO artifacts from the response payload
            body.
            The NFVO shall support this parameter. The OSS/BSS may supply
            this parameter.        
        - name: include_external_artifacts
          description: >
            Flag (i.e. parameter without value) that instructs the NFVO to include 
            external artifacts in the response payload body. It shall not be treated 
            as an error if this flag is provided but there is no external artifact to
            include in the result. If this parameter is missing, no external artifacts 
            shall be included.
            The NFVO shall support this parameter. The OSS/BSS may supply this parameter.
          in: query
          type: string
        - name: select_non_mano_artifact_sets
          in: query
          required: false
          type: string
          description: >
            Comma-separated list of non-MANO artifact set identifiers for
            which the artifacts are to be included in the response body.
            The NFVO should support this parameter. If the NFVO does not
            support this parameter, it shall ignore it, i.e. provide a response as
            if no parameter was provided. The OSS/BSS may supply this
            parameter.
      responses:
        200:
          description: >
            200 OK
            Shall be returned when the whole content of the
            archive containing the artifact files has been read
            successfully.
            The payload body shall be a ZIP archive containing
            the requested set of artifacts selected according to the
            provisions specified above in this clause, and, if the
            flag "include_signatures" was provided in the related
            request, the applicable signature files and, if available,
            the separate certificate files from the VNF package.
            The "Content-Type" HTTP header shall be set to
            "application/zip".
          headers:
            Content-Type:
              description: The MIME type of the body of the response.
              type: string
              maximum: 1
              minimum: 1
            WWW-Authenticate:
              type: string
              description: >
                Challenge if the corresponding HTTP request has not provided
                authorization, or error details if the corresponding HTTP request
                has provided an invalid authorization token.
              maximum: 1
              minimum: 0
            Version:
              description: >
                Version of the API used in the response.
              type: string
              maximum: 1
              minimum: 1
        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 archive that would have
            been returned in a "200 OK" response has been read
            successfully according to the request.
            The response body shall contain the requested part of
            the archive.
            The "Content-Type" HTTP header shall be set to
            "application/zip".
            The "Content-Range" HTTP header shall be provided
            according to IETF RFC 7233 [10].
          headers:
            Content-Range:
              type: string
              maximum: 1
              minimum: 1
            Content-Type:
              description: The MIME type of the body of the response.
              type: string
              maximum: 1
              minimum: 1
            WWW-Authenticate:
              type: string
              description: >
                Challenge if the corresponding HTTP request has not provided
                authorization, or error details if the corresponding HTTP request
                has provided an invalid authorization token.
              maximum: 1
              minimum: 0
        400:
          $ref: "../responses/SOL005_resp.yaml#/responses/400"
        401:
          $ref: "../responses/SOL005_resp.yaml#/responses/401"
        403:
          $ref: "../responses/SOL005_resp.yaml#/responses/403"
        404:
          $ref: "../responses/SOL005_resp.yaml#/responses/404"
        405:
          $ref: "../responses/SOL005_resp.yaml#/responses/405"
        406:
          $ref: "../responses/SOL005_resp.yaml#/responses/406"
        409:
          $ref: "../responses/SOL005_resp.yaml#/responses/409"
        416:
          $ref: "../responses/SOL005_resp.yaml#/responses/416"
        500:
          $ref: "../responses/SOL005_resp.yaml#/responses/500"
        503:
          $ref: "../responses/SOL005_resp.yaml#/responses/503"

  ###############################################################################
  # Upload VNF package from URI task                                            #
  ###############################################################################
  '/vnf_packages/{vnfPkgId}/package_content/upload_from_uri':
    #ETSI GS NFV-SOL 005 V2.8.1 location: 9.4.6
    post:
      summary: Upload a VNF package by providing the address information of the VNF package.
      description: >
        The POST method provides the information for the NFVO to get the content of a VNF package.
        This method shall follow the provisions specified in the Tables 9.4.6.3.1-1 and 9.4.6.3.1-2 for URI query parameters,
        request and response data structures, and response codes.
        Upon start of obtaining the package, the NFVO shall set the "onboardingState" attribute in the "VnfPkgInfo" structure
        to "UPLOADING". Upon successfully obtaining the package, if the package references external artifacts, the NFVO
        shall obtain the external artifacts. Subsequently, upon success, the NFVO shall set that attribute to "PROCESSING" and
        shall process the package, which shall include checking package consistency. Upon successful processing, the NFVO
        shall set the "onboardingState" attribute to "ONBOARDED", the "operationalState" attribute to "ENABLED", and the 
        "usageState" attribute to "NOT_IN_USE". In addition, the NFVO shall set the value of the attributes in the "VnfPkgInfo" 
        that are copied from the VNFD (refer to clause 9.5.2.5). If an error occurs during obtaining the package,
        downloading the external artifacts or processing the package, the NFVO shall set the "onboardingState" attribute to
        "ERROR" and shall populate the "onboardingFailureDetails" attribute in "VnfPkgInfo".        
      parameters:
        - name: Accept
          description: >
            Content-Types that are acceptable for the response.
            Reference: IETF RFC 7231
          in: header
          required: true
          type: string
        - name: Authorization
          description: >
            The authorization token for the request.
            Reference: IETF RFC 7235
          in: header
          required: false
          type: string
        - name: Version
          description: >
            Version of the API requested to use when responding to this request.
          in: header
          required: true
          type: string
        - name: vnfPkgId
          description: >
            Identifier of the VNF package. The identifier is allocated by the NFVO.
          in: path
          required: true
          type: string
        - name: body
          in: body
          required: true
          schema:
            $ref: "definitions/SOL005VNFPackageManagement_def.yaml#/definitions/UploadVnfPkgFromUriRequest"
          description: >
            The payload body contains the address information based on
            which the NFVO can obtain the content of the VNF package.
      responses:
        202:
          description: >
            202 Accepted

            The information about the VNF package has been received successfully, but the on-boarding
            has not been completed. It is expected to take some time for processing.
            The response body shall be empty.
          headers:
            Version:
              description: >
                Version of the API used in the response.
              type: string
              maximum: 1
              minimum: 1
        409:
          $ref: "../responses/SOL005_resp.yaml#/responses/409"
        400:
          $ref: "../responses/SOL005_resp.yaml#/responses/400"
        401:
          $ref: "../responses/SOL005_resp.yaml#/responses/401"
        403:
          $ref: "../responses/SOL005_resp.yaml#/responses/403"
        404:
          $ref: "../responses/SOL005_resp.yaml#/responses/404"
        405:
          $ref: "../responses/SOL005_resp.yaml#/responses/405"
        406:
          $ref: "../responses/SOL005_resp.yaml#/responses/406"
        500:
          $ref: "../responses/SOL005_resp.yaml#/responses/500"
        503:
          $ref: "../responses/SOL005_resp.yaml#/responses/503"

  ###############################################################################
  # Individual VNF package artifact                                             #
  ###############################################################################
  '/vnf_packages/{vnfPkgId}/artifacts/{artifactPath}':
    #ETSI GS NFV-SOL 005 V2.8.1 location: 9.4.7
    parameters:
      - name: vnfPkgId
        description: >
          Identifier of the on-boarded VNF package.
          The identifier is allocated by the NFVO.
          This identifier can be retrieved from the "vnfPkgId" attribute in the VnfPackageOnboardingNotification or
          VnfPackageChangeNotification.
        in: path
        type: string
        required: true
      - name: artifactPath
        description: >
          For an artifact contained as a file in the VNF package, this variable shall contain a sequence of
          one or more path segments representing the path of the artifact within the VNF package, relative to
          the root of the package. See note 3.
          EXAMPLE: foo/bar/m%40ster.sh
          For an external artifact represented as a URI in the VNF package manifest, this variable shall
          contain a sequence of one or more path segments as synthesized by the NFVO (see
          clause 9.5.3.3), representing this artifact.
          See note 2 and note 3
        in: path
        type: string
        required: true
      - name: Authorization
        description: >
          The authorization token for the request.
          Reference: IETF RFC 7235.
        in: header
        required: false
        type: string
      - name: Version
        description: >
          Version of the API requested to use when responding to this request.
        in: header
        required: true
        type: string
    get:
      summary: Fetch individual VNF package artifact.
      description: >
        The GET method fetches the content of an artifact within a VNF package.
        This method shall follow the provisions specified in the
        Tables 9.4.7.3.2-1 and 9.4.7.3.2-2 for URI query parameters,
        request and response data structures, and response codes.
      parameters:
        - name: Accept
          description: >
            Content-Types that are acceptable for the response.
          in: header
          required: true
          type: string
        - name: Range
          description: >
            The request may contain a "Range" HTTP header to obtain single
            range of bytes from the VNF package file. This can be used to
            continue an aborted transmission.
            If the NFVO does not support range requests, it should return the
            whole file with a 200 OK response instead.
          in: header
          type: string
        - name: include_signatures
          in: query
          required: false
          type: string
          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.
      responses:
        200:
          description: >
            200 OK
            Shall be returned when the whole 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
            VNF package, as defined by ETSI
            GS NFV-SOL 004 [5], 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 [17]). 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 "ContentType" 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 NFV-SOL 004 [5];
            - 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 response.
              type: string
              maximum: 1
              minimum: 1
            WWW-Authenticate:
              type: string
              description: >
                Challenge if the corresponding HTTP request has not provided
                authorization, or error details if the corresponding HTTP request
                has provided an invalid authorization token.
              maximum: 1
              minimum: 0
            Version:
              description: >
                Version of the API used in the response.
              type: string
              maximum: 1
              minimum: 1
        206:
          description: >
            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 VNF package, as defined
            by ETSI GS NFV-SOL 004 [5].
            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 [10].
          headers:
            Content-Range:
              type: string
              maximum: 1
              minimum: 1
            Content-Type:
              description: The MIME type of the body of the response.
              type: string
              maximum: 1
              minimum: 1
            WWW-Authenticate:
              type: string
              description: >
                Challenge if the corresponding HTTP request has not provided
                authorization, or error details if the corresponding HTTP request
                has provided an invalid authorization token.
              maximum: 1
              minimum: 0
        400:
          $ref: "../responses/SOL005_resp.yaml#/responses/400"
        401:
          $ref: "../responses/SOL005_resp.yaml#/responses/401"
        403:
          $ref: "../responses/SOL005_resp.yaml#/responses/403"
        404:
          $ref: "../responses/SOL005_resp.yaml#/responses/404"
        405:
          $ref: "../responses/SOL005_resp.yaml#/responses/405"
        406:
          $ref: "../responses/SOL005_resp.yaml#/responses/406"
        409:
          $ref: "../responses/SOL005_resp.yaml#/responses/409"
        416:
          $ref: "../responses/SOL005_resp.yaml#/responses/416"
        500:
          $ref: "../responses/SOL005_resp.yaml#/responses/500"
        503:
          $ref: "../responses/SOL005_resp.yaml#/responses/503"

  ###############################################################################
  # Subscriptions                                                               #
  ###############################################################################
  '/subscriptions':
    #ETSI GS NFV-SOL 005 V2.8.1 location: 9.4.8
    parameters:
      - name: Authorization
        description: >
          The authorization token for the request.
          Reference: IETF RFC 7235.
        in: header
        required: false
        type: string
      - name: Version
        description: >
          Version of the API requested to use when responding to this request.
        in: header
        required: true
        type: string
    post:
      summary: Subscribe to notifications related to on-boarding and/or changes of VNF packages.
      description: >
        The POST method creates a new subscription.
        This method shall follow the provisions specified in the Tables 9.4.8.3.1-1 and 9.4.8.3.1-2 for URI
        query parameters, request and response data structures, and response codes.
        As the result of successfully executing this method, a new "Individual subscription" resource as defined 
        in clause 9.4.9 shall have been created. This method shall not trigger any notification.
        Creation of two "Individual subscription" resources with the same callback URI and the same filter can 
        result in performance degradation and will provide duplicates of notifications to the OSS/BSS, and might 
        make sense only in very rare use cases. Consequently, the NFVO may either allow creating a new "Individual 
        subscription" resource if another "Individual subscription" resource with the same filter and callback URI 
        already exists (in which case it shall return the "201 Created" response code), or may decide to not create 
        a duplicate "Individual subscription" resource (in which case it shall return a "303 See Other" response 
        code referencing the existing "Individual subscription" resource with the same filter and callback URI).
      parameters:
        - name: Accept
          description: >
            Content-Types that are acceptable for the response.
            Reference: IETF RFC 7231
          in: header
          required: true
          type: string
        - name: Content-Type
          description: >
            The MIME type of the body of the request.
            Reference: IETF RFC 7231
          in: header
          required: true
          type: string
        - name: body
          in: body
          required: true
          schema:
            $ref: "definitions/SOL005VNFPackageManagement_def.yaml#/definitions/PkgmSubscriptionRequest"
          description: >
            Details of the subscription to be created.
      responses:
        201:
          description: >
            201 Created

            Shall be returned when the subscription has been
            created successfully.
            The response body shall contain a representation
            of the created "Individual subscription" resource.
            The HTTP response shall include a "Location"
            HTTP header that points to the created resource.
          headers:
            Content-Type:
              description: The MIME type of the body of the response.
              type: string
              maximum: 1
              minimum: 1
            WWW-Authenticate:
              type: string
              description: >
                Challenge if the corresponding HTTP request has not provided
                authorization, or error details if the corresponding HTTP request
                has provided an invalid authorization token.
              maximum: 1
              minimum: 0
            Version:
              description: >
                Version of the API used in the response.
              type: string
              maximum: 1
              minimum: 1
          schema:
            $ref: "definitions/SOL005VNFPackageManagement_def.yaml#/definitions/PkgmSubscription"
        303:
          $ref: "../responses/SOL005_resp.yaml#/responses/303"
        400:
          $ref: "../responses/SOL005_resp.yaml#/responses/400"
        401:
          $ref: "../responses/SOL005_resp.yaml#/responses/401"
        403:
          $ref: "../responses/SOL005_resp.yaml#/responses/403"
        404:
          $ref: "../responses/SOL005_resp.yaml#/responses/404"
        405:
          $ref: "../responses/SOL005_resp.yaml#/responses/405"
        406:
          $ref: "../responses/SOL005_resp.yaml#/responses/406"
        416:
          $ref: "../responses/SOL005_resp.yaml#/responses/416"
        422:
          $ref: "../responses/SOL005_resp.yaml#/responses/422"
        500:
          $ref: "../responses/SOL005_resp.yaml#/responses/500"
        503:
          $ref: "../responses/SOL005_resp.yaml#/responses/503"
    get:
      summary: Query multiple subscriptions.
      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.
        This method shall follow the provisions specified in the Tables 9.4.8.3.2-1 and 9.4.8.3.2-2 for URI query parameters,
        request and response data structures, and response codes.
      parameters:
        - name: filter
          in: query
          required: false
          type: string
          description: >
            Attribute-based filter 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 PkgmSubscription and in data types referenced from it
            shall be supported by the NFVO in the filter expression
        - name: nextpage_opaque_marker
          in: query
          required: false
          type: string
          description: >
            Marker to obtain the next page of a paged response. Shall be supported by the NFVO if the NFVO
            supports alternative 2 (paging) according to clause 5.4.2.1 of ETSI GS NFV-SOL 013 for this resource.
        - name: Accept
          description: >
            Content-Types that are acceptable for the response.
            Reference: IETF RFC 7231
          in: header
          required: true
          type: string
      responses:
        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 VNF package management
            subscriptions, as defined in clause 9.5.2.7.
            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 response.
              type: string
              maximum: 1
              minimum: 1
            WWW-Authenticate:
              type: string
              description: >
                Challenge if the corresponding HTTP request has not provided
                authorization, or error details if the corresponding HTTP request
                has provided an invalid authorization token.
              maximum: 1
              minimum: 0
            Version:
              description: >
                Version of the API used in the response.
              type: string
              maximum: 1
              minimum: 1
          schema:
            type: array
            items:
              $ref: "definitions/SOL005VNFPackageManagement_def.yaml#/definitions/PkgmSubscription"
        400:
          $ref: "../responses/SOL005_resp.yaml#/responses/400"
        401:
          $ref: "../responses/SOL005_resp.yaml#/responses/401"
        403:
          $ref: "../responses/SOL005_resp.yaml#/responses/403"
        404:
          $ref: "../responses/SOL005_resp.yaml#/responses/404"
        405:
          $ref: "../responses/SOL005_resp.yaml#/responses/405"
        406:
          $ref: "../responses/SOL005_resp.yaml#/responses/406"
        416:
          $ref: "../responses/SOL005_resp.yaml#/responses/416"
        500:
          $ref: "../responses/SOL005_resp.yaml#/responses/500"
        503:
          $ref: "../responses/SOL005_resp.yaml#/responses/503"

  ###############################################################################
  # Individual subscription                                                     #
  ###############################################################################
  '/subscriptions/{subscriptionId}':
    #ETSI GS NFV-SOL 005 V2.8.1 location: 9.4.9
    parameters:
      - name: subscriptionId
        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 "Individual subscription" resource. It can also be retrieved from
          the "id" attribute in the payload body of that response.
        in: path
        type: string
        required: true
      - name: Authorization
        description: >
          The authorization token for the request.
          Reference: IETF RFC 7235.
        in: header
        required: false
        type: string
      - name: Version
        description: >
          Version of the API requested to use when responding to this request.
        in: header
        required: true
        type: string
    get:
      summary: Read an individual subscription resource.
      description: >
        Query Subscription Information
        The GET method reads an individual subscription.
      parameters:
        - name: Accept
          description: >
            Content-Types that are acceptable for the response.
            Reference: IETF RFC 7231
          in: header
          required: true
          type: string
      responses:
        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 "Individual subscription" resource.
          headers:
            Content-Type:
              description: The MIME type of the body of the response.
              type: string
              maximum: 1
              minimum: 1
            WWW-Authenticate:
              type: string
              description: >
                Challenge if the corresponding HTTP request has not provided
                authorization, or error details if the corresponding HTTP request
                has provided an invalid authorization token.
              maximum: 1
              minimum: 0
            Version:
              description: >
                Version of the API used in the response.
              type: string
              maximum: 1
              minimum: 1
          schema:
            $ref: "definitions/SOL005VNFPackageManagement_def.yaml#/definitions/PkgmSubscription"
        400:
          $ref: "../responses/SOL005_resp.yaml#/responses/400"
        401:
          $ref: "../responses/SOL005_resp.yaml#/responses/401"
        403:
          $ref: "../responses/SOL005_resp.yaml#/responses/403"
        404:
          $ref: "../responses/SOL005_resp.yaml#/responses/404"
        405:
          $ref: "../responses/SOL005_resp.yaml#/responses/405"
        406:
          $ref: "../responses/SOL005_resp.yaml#/responses/406"
        416:
          $ref: "../responses/SOL005_resp.yaml#/responses/416"
        500:
          $ref: "../responses/SOL005_resp.yaml#/responses/500"
        503:
          $ref: "../responses/SOL005_resp.yaml#/responses/503"
    delete:
      summary: Terminate a subscription.
      description: >
        The DELETE method terminates an individual subscription.
        This method shall follow the provisions specified in the Tables 9.4.9.3.5-1 and 9.4.9.3.5-2 for
        URI query parameters, request and response data structures, and response codes.
        As the result of successfully executing this method, the "Individual subscription" resource shall
        not exist any longer. This means that no notifications for that subscription shall be sent to the formerly-subscribed API consumer.
        NOTE: Due to race conditions, some notifications might still be received by the formerly-subscribed API consumer for a certain time period after the deletion.
      responses:
        204:
          description: >
            No Content

            Shall be returned when information about an
            individual subscription has been read successfully.
            The response body shall contain a representation of
            the "Individual subscription" resource.
          headers:
            WWW-Authenticate:
              type: string
              description: >
                Challenge if the corresponding HTTP request has not provided
                authorization, or error details if the corresponding HTTP request
                has provided an invalid authorization token.
              maximum: 1
              minimum: 0
            Version:
              description: >
                Version of the API used in the response.
              type: string
              maximum: 1
              minimum: 1
        400:
          $ref: "../responses/SOL005_resp.yaml#/responses/400"
        401:
          $ref: "../responses/SOL005_resp.yaml#/responses/401"
        403:
          $ref: "../responses/SOL005_resp.yaml#/responses/403"
        404:
          $ref: "../responses/SOL005_resp.yaml#/responses/404"
        405:
          $ref: "../responses/SOL005_resp.yaml#/responses/405"
        406:
          $ref: "../responses/SOL005_resp.yaml#/responses/406"
        416:
          $ref: "../responses/SOL005_resp.yaml#/responses/416"
        500:
          $ref: "../responses/SOL005_resp.yaml#/responses/500"
        503:
          $ref: "../responses/SOL005_resp.yaml#/responses/503"