VNFIndicator.yaml 28 KB
Newer Older
openapi: 3.0.2
Gergely Csatari's avatar
Gergely Csatari committed

info:
  title: SOL003 - VNF Indicator interface
  description: |
    SOL003 - 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. In case of
    discrepancies the published ETSI Group Specification takes precedence.
    Please report bugs to https://forge.etsi.org/rep/nfv/SOL002-SOL003/issues
  contact:
    name: NFV-SOL WG
Gergely Csatari's avatar
Gergely Csatari committed
  license:
    name: ETSI Forge copyright notice
Gergely Csatari's avatar
Gergely Csatari committed
    url: https://forge.etsi.org/etsi-forge-copyright-notice.txt
  version: "1.3.0-impl:etsi.org:ETSI_NFV_OpenAPI:1"
  description: ETSI GS NFV-SOL 003 V3.3.1
  url: https://www.etsi.org/deliver/etsi_gs/NFV-SOL/001_099/003/02.07.01_60/gs_NFV-SOL003v020701p.pdf
servers:
  - url: http://127.0.0.1/vnfind/v1
  - url: https://127.0.0.1/vnfind/v1
  ###############################################################################
  # API Versions                                                                #
  ###############################################################################
  /api_versions:
    $ref: ../../endpoints/SOL002SOL003_endpoints.yaml#/endpoints/api-versions
  ###############################################################################
  # VNF indicators                                                              #
  ###############################################################################
  /indicators:
    #SOL003 location: 8.4.2
Gergely Csatari's avatar
Gergely Csatari committed
    get:
      description: |
Gergely Csatari's avatar
Gergely Csatari committed
        The GET method queries multiple VNF indicators.
        This method shall follow the provisions specified in the tables 8.4.2.3.2-1 and 8.4.2.3.2-2
        for URI query parameters, request and response data structures, and response codes.
Gergely Csatari's avatar
Gergely Csatari committed
      parameters:
        - $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/Accept
        - $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/Authorization
        - $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/filter
        - $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/nextpage_opaque_marker
        - $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/Version
Gergely Csatari's avatar
Gergely Csatari committed
      responses:
        200:
          $ref: '#/components/responses/Indicators.Get.200'
Gergely Csatari's avatar
Gergely Csatari committed
        400:
          $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/400
Gergely Csatari's avatar
Gergely Csatari committed
        401:
          $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/401
Gergely Csatari's avatar
Gergely Csatari committed
        403:
          $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/403
          $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/404
Gergely Csatari's avatar
Gergely Csatari committed
        405:
          $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/405
Gergely Csatari's avatar
Gergely Csatari committed
        406:
          $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/406
          $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/422
Gergely Csatari's avatar
Gergely Csatari committed
        500:
          $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/500
Gergely Csatari's avatar
Gergely Csatari committed
        503:
          $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/503
          $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/504
  ###############################################################################
  # VNF indicators related to a VNF instance                                    #
  ###############################################################################
  /indicators/{vnfInstanceId}:
    #SOL003 location: 8.4.3
Gergely Csatari's avatar
Gergely Csatari committed
    parameters:
      - $ref: '#/components/parameters/VnfInstanceId'
Gergely Csatari's avatar
Gergely Csatari committed
    get:
      description: |
        Get Indicator Value.
        The GET method queries multiple VNF indicators related to a VNF instance.
        This method shall follow the provisions specified in the tables 8.4.3.3.2-1 and 8.4.3.3.2-2
        for URI query parameters, request and response data structures, and response codes.
Gergely Csatari's avatar
Gergely Csatari committed
      parameters:
        - $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/Accept
        - $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/ContentType
        - $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/Authorization
        - $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/filter
        - $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/nextpage_opaque_marker
        - $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/Version
Gergely Csatari's avatar
Gergely Csatari committed
      responses:
        200:
          $ref: '#/components/responses/VnfInstanceIndicators.Get.200'
Gergely Csatari's avatar
Gergely Csatari committed
        400:
          $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/400
Gergely Csatari's avatar
Gergely Csatari committed
        401:
          $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/401
Gergely Csatari's avatar
Gergely Csatari committed
        403:
          $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/403
          $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/404
Gergely Csatari's avatar
Gergely Csatari committed
        405:
          $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/405
Gergely Csatari's avatar
Gergely Csatari committed
        406:
          $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/406
          $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/422
Gergely Csatari's avatar
Gergely Csatari committed
        500:
          $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/500
Gergely Csatari's avatar
Gergely Csatari committed
        503:
          $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/503
          $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/504
  ###############################################################################
  # Individual VNF indicator                                                    #
  ###############################################################################
  /indicators/{vnfInstanceId}/{indicatorId}:
    #SOL003 location: 8.4.4
Gergely Csatari's avatar
Gergely Csatari committed
    parameters:
      - $ref: '#/components/parameters/IndicatorId'
      - $ref: '#/components/parameters/VnfInstanceId'
Gergely Csatari's avatar
Gergely Csatari committed
    get:
      description: |
Gergely Csatari's avatar
Gergely Csatari committed
        The GET method reads a VNF indicator.
        This method shall follow the provisions specified in the tables 8.4.4.3.2-1 and 8.4.4.3.2-2
        for URI query parameters, request and response data structures, and response codes.
Gergely Csatari's avatar
Gergely Csatari committed
      parameters:
        - $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/Accept
        - $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/ContentType
        - $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/Authorization
        - $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/Version
Gergely Csatari's avatar
Gergely Csatari committed
      responses:
        200:
          $ref: '#/components/responses/VnfInstanceIndividualIndicator.Get.200'
Gergely Csatari's avatar
Gergely Csatari committed
        400:
          $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/400
Gergely Csatari's avatar
Gergely Csatari committed
        401:
          $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/401
Gergely Csatari's avatar
Gergely Csatari committed
        403:
          $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/403
          $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/404
Gergely Csatari's avatar
Gergely Csatari committed
        405:
          $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/405
Gergely Csatari's avatar
Gergely Csatari committed
        406:
          $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/406
          $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/422
Gergely Csatari's avatar
Gergely Csatari committed
        500:
          $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/500
Gergely Csatari's avatar
Gergely Csatari committed
        503:
          $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/503
          $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/504
  ###############################################################################
  # Subscriptions                                                              #
  ###############################################################################
  /subscriptions:
    parameters:
      - $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/Accept
      - $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/ContentType
      - $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/Authorization
      - $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/Version
Gergely Csatari's avatar
Gergely Csatari committed
    post:
      description: |
Gergely Csatari's avatar
Gergely Csatari committed
        The POST 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 callback URI and the same filter
        can result in performance degradation and will provide duplicates of notifications to the NFVO,
        and might make sense only in very rare use cases. Consequently, the VNFM 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).
        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.
      requestBody:
        $ref: '#/components/requestBodies/VnfIndicatorSubscriptionRequest'
Gergely Csatari's avatar
Gergely Csatari committed
      responses:
        201:
          $ref: '#/components/responses/Subscriptions.Post.201'
          #          description: |
          #            303 SEE OTHER
          #
          #            Shall be returned when a subscription with the
          #            same callback URI 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.
          $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/303
Gergely Csatari's avatar
Gergely Csatari committed
        400:
          $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/400
Gergely Csatari's avatar
Gergely Csatari committed
        401:
          $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/401
Gergely Csatari's avatar
Gergely Csatari committed
        403:
          $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/403
          $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/404
Gergely Csatari's avatar
Gergely Csatari committed
        405:
          $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/405
Gergely Csatari's avatar
Gergely Csatari committed
        406:
          $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/406
          $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/422
Gergely Csatari's avatar
Gergely Csatari committed
        500:
          $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/500
Gergely Csatari's avatar
Gergely Csatari committed
        503:
          $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/503
          $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/504
Gergely Csatari's avatar
Gergely Csatari committed
    get:
      description: |
        Query Subscription Information.
        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 8.4.5.3.2-1 and 8.4.5.3.2-2
        for URI query parameters, request and response data structures, and response codes.
Gergely Csatari's avatar
Gergely Csatari committed
      parameters:
        - $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/filter
        - $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/nextpage_opaque_marker
Gergely Csatari's avatar
Gergely Csatari committed
      responses:
        200:
          $ref: '#/components/responses/Subscriptions.Get.200'
Gergely Csatari's avatar
Gergely Csatari committed
        400:
          $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/400
Gergely Csatari's avatar
Gergely Csatari committed
        401:
          $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/401
Gergely Csatari's avatar
Gergely Csatari committed
        403:
          $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/403
          $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/404
Gergely Csatari's avatar
Gergely Csatari committed
        405:
          $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/405
Gergely Csatari's avatar
Gergely Csatari committed
        406:
          $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/406
          $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/422
Gergely Csatari's avatar
Gergely Csatari committed
        500:
          $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/500
Gergely Csatari's avatar
Gergely Csatari committed
        503:
          $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/503
          $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/504
  ###############################################################################
  # Individual subscription                                                     #
  ###############################################################################
  /indicators/subscriptions/{subscriptionId}:
    #SOL003 location: 8.4.6
Gergely Csatari's avatar
Gergely Csatari committed
    parameters:
      - $ref: '#/components/parameters/SubscriptionId'
      - $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/ContentType
      - $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/Authorization
      - $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/Version
Gergely Csatari's avatar
Gergely Csatari committed
    get:
      description: |
Gergely Csatari's avatar
Gergely Csatari committed
        The GET method reads an individual subscription.
        This method shall follow the provisions specified in the tables 8.4.6.3.2-1 and 8.4.6.3.2-2
        for URI query parameters, request and response data structures, and response codes.
Gergely Csatari's avatar
Gergely Csatari committed
      parameters:
        - $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/Accept
Gergely Csatari's avatar
Gergely Csatari committed
      responses:
        200:
          $ref: '#/components/responses/IndividualSubscription.Get.200'
Gergely Csatari's avatar
Gergely Csatari committed
        400:
          $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/400
Gergely Csatari's avatar
Gergely Csatari committed
        401:
          $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/401
Gergely Csatari's avatar
Gergely Csatari committed
        403:
          $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/403
          $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/404
Gergely Csatari's avatar
Gergely Csatari committed
        405:
          $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/405
Gergely Csatari's avatar
Gergely Csatari committed
        406:
          $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/406
          $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/422
Gergely Csatari's avatar
Gergely Csatari committed
        500:
          $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/500
Gergely Csatari's avatar
Gergely Csatari committed
        503:
          $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/503
          $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/504
Gergely Csatari's avatar
Gergely Csatari committed
    delete:
      description: |
Gergely Csatari's avatar
Gergely Csatari committed
        The DELETE method terminates an individual subscription.
        This method shall follow the provisions specified in the tables 8.4.6.3.5-1 and 8.4.6.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.
Gergely Csatari's avatar
Gergely Csatari committed
      responses:
        204:
          $ref: '#/components/responses/IndividualSubscription.Delete.204'
Gergely Csatari's avatar
Gergely Csatari committed
        400:
          $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/400
Gergely Csatari's avatar
Gergely Csatari committed
        401:
          $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/401
Gergely Csatari's avatar
Gergely Csatari committed
        403:
          $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/403
          $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/404
Gergely Csatari's avatar
Gergely Csatari committed
        405:
          $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/405
Gergely Csatari's avatar
Gergely Csatari committed
        406:
          $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/406
          $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/422
Gergely Csatari's avatar
Gergely Csatari committed
        500:
          $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/500
Gergely Csatari's avatar
Gergely Csatari committed
        503:
          $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/503
          $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/504

components:
  parameters:
    VnfInstanceId:
      name: vnfInstanceId
      in: path
      description: |
        Identifier of the VNF instance to which the VNF indicator applies.
        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 VNF instance" 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

    IndicatorId:
      name: indicatorId
      in: path
      description: |
        Identifier of the VNF indicator.
        This identifier can be retrieved from the resource referenced by the
        payload body in the response to a POST request creating a new "Individual VNF
        instance" resource.
      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 "Individual 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:
    VnfIndicatorSubscriptionRequest:
      description: Details of the subscription to be created.
      content:
        application/json:
          schema:
            $ref: ../../definitions/SOL002SOL003VNFIndicator_def.yaml#/definitions/VnfIndicatorSubscriptionRequest
      required: true

  responses:
    Indicators.Get.200:
      description: |
        200 OK

        Shall be returned when information about zero or more VNF indicators has been 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 VNFM 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:
        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: The used API version.
          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/SOL002SOL003VNFIndicator_def.yaml#/definitions/VnfIndicator
    
    VnfInstanceIndicators.Get.200:
      description: |
        200 OK

        Shall be returned when information about zero or more VNF indicators has been 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 VNFM 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:
        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: The used API version.
          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/SOL002SOL003VNFIndicator_def.yaml#/definitions/VnfIndicator
    
    VnfInstanceIndividualIndicator.Get.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:
        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: The used API version.
          style: simple
          explode: false
          schema:
            type: string
      content:
        application/json:
          schema:
            $ref: ../../definitions/SOL002SOL003VNFIndicator_def.yaml#/definitions/VnfIndicator
    
    Subscriptions.Post.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:
        Location:
          description: |
            The resource URI of the created subscription resource.
          style: simple
          explode: false
          schema:
            type: string
            format: url
        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: The used API version.
          style: simple
          explode: false
          schema:
            type: string
      content:
        application/json:
          schema:
            type: array
            items:
              $ref: ../../definitions/SOL002SOL003VNFIndicator_def.yaml#/definitions/VnfIndicatorSubscription
    
    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 which match the attribute filter,
        i.e. zero or more representations of VNF indicator 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 VNFM 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:
        Location:
          description: |
            The resource URI of the created subscription resource.
          style: simple
          explode: false
          schema:
            type: string
            format: url
        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: The used API version.
          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/SOL002SOL003VNFIndicator_def.yaml#/definitions/VnfIndicatorSubscription
    
    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 "Individual subscription" resource.
      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: The used API version.
          style: simple
          explode: false
          schema:
            type: string
      content:
        application/json:
          schema:
            $ref: ../../definitions/SOL002SOL003VNFIndicator_def.yaml#/definitions/VnfIndicatorSubscription
    
    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: The used API version.
          style: simple
          explode: false
          schema:
            type: string