VNFIndicatorNotification.yaml

openapi: 3.0.2

info:
  title: SOL003 - VNF Indicator Notification interface
  description: |
    SOL003 - VNF Indicator Notification 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
  license:
    name: ETSI Forge copyright notice
    url: https://forge.etsi.org/etsi-forge-copyright-notice.txt
  version: "1.3.1-impl:etsi.org:ETSI_NFV_OpenAPI:1"

externalDocs:
  description: ETSI GS NFV-SOL 003 V3.5.1
  url: https://www.etsi.org/deliver/etsi_gs/NFV-SOL/001_099/003/03.05.01_60/gs_NFV-SOL003v030501p.pdf

servers:
  - url: http://127.0.0.1/callback/v1
  - url: https://127.0.0.1/callback/v1

paths:
  ###############################################################################
  # Notification endpoint VnfIndicatorValueChangeNotification                   #
  ###############################################################################
  /URI_is_provided_by_the_client_when_creating_the_subscription-VnfIndicatorValueChangeNotification:
    #SOL003 location: 8.4.7
    post:
      description: |
        The POST method delivers a notification from the API producer to an API consumer. The API consumer shall
        have previously created an "Individual subscription" resource with a matching filter. See clause 8.4.7.3.1.
      parameters:
        - $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/Authorization
        - $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/Version
      requestBody:
        $ref: '#/components/requestBodies/AlarmListRebuiltNotification'
      responses:
        204:
          $ref: '#/components/responses/VNFINDNotification.Post.204'
        400:
          $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/400
        401:
          $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/401
        403:
          $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/403
        405:
          $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/405
        406:
          $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/406
        500:
          $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/500
        503:
          $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/503

    get:
      description: |
        The GET method allows the API producer to test the notification endpoint that is provided by the API consumer,
        e.g. during subscription. See clause 8.4.7.3.2.
      parameters:
        - $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/Authorization
        - $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/Version
      responses:
        204:
          $ref: '#/components/responses/VNFINDNotification.Get.204'
        400:
          $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/400
        401:
          $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/401
        403:
          $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/403
        405:
          $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/405
        406:
          $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/406
        500:
          $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/500
        503:
          $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/503

components:

  requestBodies:
    AlarmListRebuiltNotification: 
      description: Information that the alarm list has been rebuilt by the VNFM.
      content:
        application/json:
          schema:
            oneOf:
              - $ref: ../../definitions/SOL002SOL003VNFIndicator_def.yaml#/definitions/VnfIndicatorValueChangeNotification
              - $ref: ../../definitions/SOL002SOL003VNFIndicator_def.yaml#/definitions/SupportedIndicatorsChangeNotification
      required: true
  
  responses:
    VNFINDNotification.Post.204:
      description: |
        204 NO CONTENT

        Shall be returned when the notification has been delivered 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

    VNFINDNotification.Get.204:
      description: |
        204 NO CONTENT
        Shall be returned to indicate that the notification endpoint has been tested 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