VNFIndicator.yaml

swagger: "2.0"

info:
  version: "1.2.1-impl:etsi.org:ETSI_NFV_OpenAPI:1"
  title: SOL002 - VNF Indicator interface
  description: >
    SOL002 - VNF Indicator interface
    IMPORTANT: Please note that this file might be not aligned to the current
    version of the ETSI Group Specification it refers to and has not been
    approved by the ETSI NFV ISG. In case of discrepancies the published ETSI
    Group Specification takes precedence.
    Please report bugs to https://forge.etsi.org/bugzilla/buglist.cgi?component=Nfv-Openapis
  license:
    name: ETSI Forge copyright notice
    url: https://forge.etsi.org/etsi-forge-copyright-notice.txt
  contact:
    name: NFV-SOL WG

externalDocs:
  description: ETSI GS NFV-SOL 002 V2.8.1
  url: https://www.etsi.org/deliver/etsi_gs/NFV-SOL/001_099/002/02.08.01_60/gs_NFV-SOL002v020801p.pdf

basePath: /vnfind/v1

schemes:
  - http
  - https

consumes:
  - application/json

produces:
  - application/json

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

  ###############################################################################
  # VNF Indicators                                                              #
  ###############################################################################
  /indicators:
    parameters:
      - name: Version
        description: >
          Version of the API requested to use when responding to this request.
        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
    get:
      summary: Query multiple indicators
      description: Get a list of indicators. Support of attribute based filtering via query parameters.
      parameters:
        - name: filter
          description: >
            Attribute-based filtering expression according to clause 5.2 of ETSI GS NFV-SOL 013.
            The VNFM shall support receiving this parameter as part of the URI query string.
            The EM/VNF may supply this parameter. The VNF may supply its instance Id as an attribute filter.
            All attribute names that appear in the VnfIndicator data type and in data types referenced from
            it shall be supported by the VNFM in the filter expression. If receiving, this parameter is not
            supported a 400 Bad Request response shall be returned (See table 8.4.2.3.2-2).

            EXAMPLE
            objects
            obj1: {"id":123, "weight":100, "parts":[{"id":1, "color":"red"}, {"id":2, "color":"green"}]}
            obj2: {"id":456, "weight":500, "parts":[{"id":3, "color":"green"}, {"id":4, "color":"blue"}]}

            Request 1:
            GET …/container

            Response 1:
            [
                {"id":123, "weight":100, "parts":[{"id":1, "color":"red"}, {"id":2, "color":"green"}]},
                {"id":456, "weight":500, "parts":[{"id":3, "color":"green"}, {"id":4, "color":"blue"}]}
            ]

            Request 2:
            GET …/container?filter=(eq.weight,100)

            Response 2:
            [
                {"id":123, "weight":100, "parts":[{"id":1, "color":"red"}, {"id":2, "color":"green"}]}
            ]
          #Request 2 in EXAMPLE from clause 4.3.2 probably wrong, since "," should be used after opOne (eq), "." is used
          in: query
          required: false
          type: string
        - name: nextpage_opaque_marker
          description: >
            Marker to obtain the next page of a paged response. Shall be supported by the EM/VNF
            if the EM/VNF supports alternative 2 (paging) according to clause 5.4.2.1 of 
            ETSI GS NFV-SOL 013for this resource.
          in: query
          required: false
          type: string
      responses:
        200:
          description: >
            200 OK

            Shall be returned when information about zero or more VNF indicators was 
            queried successfully. The response body shall contain in an array the 
            representations of all VNF indicators that match the attribute
            filter, i.e. zero or more representations of VNF indicators
            as defined in clause 8.5.2.2.
            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 EM/VNF supports alternative 2 (paging) according to clause 5.4.2.1 
            of ETSI GS NFV-SOL 013for 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
            Version:
              description: The used API version.
              type: string
              maximum: 1
              minimum: 1
            Link:
              description: >
                Reference to other resources. Used for paging in the present document, see clause 4.7.2.1.
              type: string
              maximum: 1
              minimum: 0
          schema:
            type: array
            items:
              $ref: '../../definitions/SOL002SOL003VNFIndicator_def.yaml#/definitions/VnfIndicator'
        400:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/400"
        401:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/401"
        403:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/403"
        404:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/404"
        405:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/405"
        406:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/406"
        416:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/416"
        422:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/422"
        429:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/429"
        500:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/500"
        503:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/503"
        504:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/504"
  ###############################################################################
  # VNF indicators related to a VNF instance                                    #
  ###############################################################################
  /indicators/{vnfInstanceId}:
    parameters:
      - name: vnfInstanceId
        in: path
        description: >
          Service Unavailable

          Identifier of the VNF instance to which the VNF indicators applies.
          NOTE: This identifier can be retrieved from the resource referenced by the "Location" HTTP header in the response to a
          POST request creating a new VNF instance resource. It can also be retrieved from the "id" attribute in the payload body
          of that response.
        type: string
        required: true
      - name: Version
        description: >
          Version of the API requested to use when responding to this request.
        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
    get:
      summary: Query multiple indicators related to a VNF instance.
      description: >
        Get a list of indicators related to a specific VNF instance. Support of attribute based filtering via query parameters.
      parameters:
        - name: filter
          description: >
            Attribute-based filtering expression according to clause 5.2 of ETSI GS NFV-SOL 013.
            The VNFM shall support receiving this parameter as part of the URI query string.
            The EM/VNF shall support receiving filtering parameters as part of the URI query string.
            The VNFM may supply filtering parameters.
            All attribute names that appear in the VnfIndicator data type and in data types referenced
            from it shall be supported in attribute-based filtering parameters.

            EXAMPLE
            objects
            obj1: {"id":123, "weight":100, "parts":[{"id":1, "color":"red"}, {"id":2, "color":"green"}]}
            obj2: {"id":456, "weight":500, "parts":[{"id":3, "color":"green"}, {"id":4, "color":"blue"}]}

            Request 1:
            GET …/container

            Response 1:
            [
                {"id":123, "weight":100, "parts":[{"id":1, "color":"red"}, {"id":2, "color":"green"}]},
                {"id":456, "weight":500, "parts":[{"id":3, "color":"green"}, {"id":4, "color":"blue"}]}
            ]

            Request 2:
            GET …/container?filter=(eq.weight,100)

            Response 2:
            [
                {"id":123, "weight":100, "parts":[{"id":1, "color":"red"}, {"id":2, "color":"green"}]}
            ]
          #Request 2 in EXAMPLE from clause 4.3.2 probably wrong, since "," should be used after opOne (eq), "." is used
          in: query
          required: false
          type: string
        - name: nextpage_opaque_marker
          description: >
            Marker to obtain the next page of a paged response. Shall be supported 
            by the EM/VNF if the EM/VNF supports alternative 2 (paging) according 
            to clause 5.4.2.1 of ETSI GS NFV-SOL 013 for this resource.
          in: query
          required: false
          type: string
      responses:
        200:
          description: >
            200 OK

            Shall be returned when information about zero or more VNF indicators 
            was queried successfully.
            The response body shall contain in an array the representations of all
            VNF indicators that are related to the particular VNF instance and that
            match the attribute filter., i.e. zero or more representations of VNF
            indicators as defined in clause 8.5.2.2.
            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 EM/VMF 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
            Version:
              description: The used API version.
              type: string
              maximum: 1
              minimum: 1
            Link:
              description: >
                Reference to other resources. Used for paging in the present document, see clause 4.7.2.1.
              type: string
              maximum: 1
              minimum: 0
          schema:
            type: array
            items:
              $ref: '../../definitions/SOL002SOL003VNFIndicator_def.yaml#/definitions/VnfIndicator'
        400:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/400"
        401:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/401"
        403:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/403"
        404:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/404"
        405:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/405"
        406:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/406"
        416:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/416"
        422:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/422"
        429:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/429"
        500:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/500"
        503:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/503"
        504:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/504"
  ###############################################################################
  # Individual VNF indicator                                                    #
  ###############################################################################
  /indicators/{vnfInstanceId}/{indicatorId}:
    parameters:
      - name: vnfInstanceId
        in: path
        description: >
          Service Unavailable

          Identifier of the VNF instance to which the VNF indicators applies.
          NOTE: This identifier can be retrieved from the resource referenced by the "Location" HTTP header in the response to a
          POST request creating a new VNF instance resource. It can also be retrieved from the "id" attribute in the payload body
          of that response.
        type: string
        required: true
      - name: indicatorId
        in: path
        description: >
          Identifier of the VNF indicator.
        # LEH        NOTE from SOL002 is strange
        type: string
        required: true
      - name: Version
        description: >
          Version of the API requested to use when responding to this request.
        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
    get:
      summary: Read an inidividual VNF indicator related to a VNF instance.
      description: >
        Read an individual VNF indicator related to a specific VNF instance.
        NOTE: This identifier can be retrieved from the resource referenced by the "Location" HTTP header in the response to a
        POST request creating a new VNF instance resource. It can also be retrieved from the "id" attribute in the payload body
        of that response.
      responses:
        200:
          description: >
            200 OK

            Shall be returned when the VNF indicator has been read successfully.
            The response body shall contain the representation of the VNF indicator.
          headers:
            Content-Type:
              description: The MIME type of the body of the response.
              type: string
              maximum: 1
              minimum: 1
            Version:
              description: The used API version.
              type: string
              maximum: 1
              minimum: 1
          schema:
            $ref: '../../definitions/SOL002SOL003VNFIndicator_def.yaml#/definitions/VnfIndicator'
        400:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/400"
        401:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/401"
        403:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/403"
        404:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/404"
        405:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/405"
        406:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/406"
        416:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/416"
        422:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/422"
        429:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/429"
        500:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/500"
        503:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/503"
        504:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/504"
  ###############################################################################
  # Subscriptions                                                               #
  ###############################################################################
  /subscriptions:
    post:
      summary: Create a new subscription to VNF indicator change notifications
      description: >
        This method creates a new subscription.
        As the result of successfully executing this method, a new "Individual 
        subscription" resource as defined in clause 8.4.6 shall have been created. 
        This method shall not trigger any notification.
        Creation of two "Individual subscription" resources with the same callbackURI and the same filter can result in
        performance degradation and will provide duplicates of notifications to the VNFM, and might make sense only in very
        rare use cases. Consequently, the API producer may either allow creating a new "Individual subscription" resource if
        another "Individual subscription" resource with the same filter and callbackUri 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 callbackUri).
        This method shall follow the provisions specified in the tables 8.4.5.3.1-1 and 8.4.5.3.1-2 for URI query parameters,
        request and response data structures, and response codes
      parameters:
        - name: vnfIndicatorSubscriptionRequest
          in: body
          description: Details of the subscription to be created.
          required: true
          schema:
            $ref: '../../definitions/SOL002SOL003VNFIndicator_def.yaml#/definitions/VnfIndicatorSubscriptionRequest'
        - 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: 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
      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.
          schema:
            type: array
            items:
              $ref: '../../definitions/SOL002SOL003VNFIndicator_def.yaml#/definitions/VnfIndicatorSubscription'
          headers:
            Location:
              description: >
                Pointer to the created subscription resource.
              type: string
              format: URI
            Content-Type:
              description: The MIME type of the body of the response.
              type: string
              maximum: 1
              minimum: 1
            WWW-Authenticate:
              description: >
                Challenge if the corresponding HTTP request has not provided
                authorization, or error details if the corresponding HTTP
                request has provided an invalid authorization token.
              type: string
              maximum: 1
              minimum: 0
            Version:
              description: The used API version.
              type: string
              maximum: 1
              minimum: 1
        303:
          # description: >
          #   303 SEE OTHER

          #   Shall be returned when a subscription with the same callbackURI and 
          #   the same filter already exists and the policy of the VNFM 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.
          # schema:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/303"
        400:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/400"
        401:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/401"
        403:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/403"
        404:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/404"
        405:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/405"
        406:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/406"
        416:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/416"
        422:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/422"
        429:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/429"
        500:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/500"
        503:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/503"
        504:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/504"
    get:
      summary: Query multiple subscriptions.
      description: >
        Service Unavailable

        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.
      parameters:
        - name: filter
          description: >
            Attribute-based filtering expression according to clause 5.2 of ETSI GS NFV-SOL 013.
            The EM shall and the VNF may support receiving this parameter as part
            of the URI query string. The VNFM may supply this parameter.
            All attribute names that appear in the VnfIndicatorSubscription data
            type and in data types referenced from it shall be supported in the filter expression.
            If receiving, this parameter is not supported, a 400 Bad Request response shall
            be returned (see table 8.4.5.3.2-2).

            EXAMPLE
            objects
            obj1: {"id":123, "weight":100, "parts":[{"id":1, "color":"red"}, {"id":2, "color":"green"}]}
            obj2: {"id":456, "weight":500, "parts":[{"id":3, "color":"green"}, {"id":4, "color":"blue"}]}

            Request 1:
            GET …/container

            Response 1:
            [
                {"id":123, "weight":100, "parts":[{"id":1, "color":"red"}, {"id":2, "color":"green"}]},
                {"id":456, "weight":500, "parts":[{"id":3, "color":"green"}, {"id":4, "color":"blue"}]}
            ]

            Request 2:
            GET …/container?filter=(eq.weight,100)

            Response 2:
            [
                {"id":123, "weight":100, "parts":[{"id":1, "color":"red"}, {"id":2, "color":"green"}]}
            ]
          #Request 2 in EXAMPLE from clause 4.3.2 probably wrong, since "," should be used after opOne (eq), "." is used
          in: query
          required: false
          type: string
        - name: nextpage_opaque_marker
          description: >
            Marker to obtain the next page of a paged response. Shall be supported 
            by the EM if the EM supports alternative 2 (paging) according to 
            clause 5.4.2.1 of ETSI GS NFV-SOL 013 for this resource.
          in: query
          required: false
          type: string
      responses:
        200:
          description: >
            200 OK

            Shall be returned when 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 which 
            match the attribute filter, i.e. zero or more representations of VNF 
            indicators subscriptions as defined in clause 8.5.2.4.
            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 EM 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
            Version:
              description: The used API version.
              type: string
              maximum: 1
              minimum: 1
            Link:
              description: >
                Reference to other resources. Used for paging in the present document, see clause 4.7.2.1.
              type: string
              maximum: 1
              minimum: 0
          schema:
            type: array
            items:
              $ref: '../../definitions/SOL002SOL003VNFIndicator_def.yaml#/definitions/VnfIndicatorSubscription'
        400:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/400"
        401:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/401"
        403:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/403"
        404:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/404"
        405:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/405"
        406:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/406"
        416:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/416"
        422:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/422"
        429:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/429"
        500:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/500"
        503:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/503"
        504:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/504"
  ###############################################################################
  # Individual Subscription                                                     #
  ###############################################################################
  /subscriptions/{subscriptionId}:
    parameters:
      - name: Version
        description: >
          Version of the API requested to use when responding to this request.
        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
    get:
      summary: Read an individual subscription.
      description: >
        Service Unavailable

        This resource represents an individual subscription. The client can use this resource to
        read and to terminate a subscription to notifications related to VNF indicator value changes.
      parameters:
        - name: subscriptionId
          description: >
            Identifier of this subscription.
            NOTE:
             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.
          in: path
          type: string
          required: true
      responses:
        200:
          description: >
            200 OK

            Shall be returned when information about an individual subscription 
            has been read successfully. 
            The response body shall contain the 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
            Version:
              description: The used API version.
              type: string
              maximum: 1
              minimum: 1
          schema:
            $ref: '../../definitions/SOL002SOL003VNFIndicator_def.yaml#/definitions/VnfIndicatorSubscription'
        400:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/400"
        401:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/401"
        403:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/403"
        404:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/404"
        405:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/405"
        406:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/406"
        416:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/416"
        422:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/422"
        429:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/429"
        500:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/500"
        503:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/503"
        504:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/504"
    delete:
      summary: Delete a subscription
      description: >
        This method terminates an individual subscription.
        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.
      parameters:
        - name: subscriptionId
          description: >
            Service Unavailable

            Identifier of this subscription.
            NOTE:
             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.
          in: path
          type: string
          required: true
      responses:
        204:
          description: >
            204 NO CONTENT

            Shall be returned when the "Individual subscription" has been deleted successfully.
            The response body shall be empty.
          headers:
            Version:
              description: The used API version.
              type: string
              maximum: 1
              minimum: 1
        400:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/400"
        401:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/401"
        403:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/403"
        404:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/404"
        405:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/405"
        406:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/406"
        416:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/416"
        422:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/422"
        429:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/429"
        500:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/500"
        503:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/503"
        504:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/504"