Skip to content
VNFIndicatorNotification.yaml 3.54 KiB
Newer Older
swagger: "2.0"

info: 
  version: "2.3.1"
  title: "VNF Indicator Notification Endpoint interface"
  description: "VNF Indicator Notification Endpoint interface of ETSI NFV SOL002"
  termsOfService: "http://etsi.org"
  contact: 
    name: "NFV-SOL WG"
  license:
    name: "ETSI Forge copyright notice"
    url: https://forge.etsi.org/etsi-forge-copyright-notice.txt


basePath: /callback/v1

schemes: 
  - http
  - https

consumes: 
  - application/json

produces: 
  - application/json


paths:



    /notificationendpoint:
      post:
        summary: Notification endpoint
        description: >
          The API producer can use this resource to send notifications related to VNF indicator
          value changes to a subscribed API consumer, which has provided the URI of this resource
          during the subscription process.
          The POST method delivers a notification from the server to the client.
        parameters:
         - name: vnfIndicatorValueChangeNotification
           in: body
           description: >
             A notification about VNF indicator value changes.
           required: true
           schema: 
             $ref: 'definitions/VnfIndicatorValueChangeNotification_def.yaml#/definitions/VnfIndicatorValueChangeNotification'                  
        responses:
          204:
            description: >
              The notification was delivered successfully. The response body shall be empty.
          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' }
          409: { $ref: 'responses/VNFIndicatorNotification_resp.yaml#/responses/409' }
          416: { $ref: '../../responses/SOL002SOL003_resp.yaml#/responses/416' }
          422: { $ref: '../../responses/SOL002SOL003_resp.yaml#/responses/422' }
          500: { $ref: '../../responses/SOL002SOL003_resp.yaml#/responses/500' }
          503: { $ref: '../../responses/SOL002SOL003_resp.yaml#/responses/503' }
      get:
        summary: Test notification endpoint.
        description: >
          The GET method allows the server to test the notification endpoint that is provided
          by the client, e.g. during subscription.
        responses:
          204:
            description: >
              The notification endpoint was tested successfully. The response body shall be empty.
          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' }
          409: { $ref: 'responses/VNFIndicatorNotification_resp.yaml#/responses/409' }
          416: { $ref: '../../responses/SOL002SOL003_resp.yaml#/responses/416' }
          422: { $ref: '../../responses/SOL002SOL003_resp.yaml#/responses/422' }
          500: { $ref: '../../responses/SOL002SOL003_resp.yaml#/responses/500' }
          503: { $ref: '../../responses/SOL002SOL003_resp.yaml#/responses/503' }