VNFIndicatorNotification.yaml 4.62 KB
Newer Older
  version: "1.2.0"
moscatelli's avatar
moscatelli committed
  title: SOL002 - VNF Indicator Notification Endpoint interface
moscatelli's avatar
moscatelli committed
    SOL002 - VNF Indicator Notification Endpoint interface
    IMPORTANT: Please note that this file might be not aligned to the current
moscatelli's avatar
moscatelli committed
    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
moscatelli's avatar
moscatelli committed
    name: ETSI Forge copyright notice
    url: https://forge.etsi.org/etsi-forge-copyright-notice.txt
moscatelli's avatar
moscatelli committed
  contact:
    name: NFV-SOL WG
  description: ETSI GS NFV-SOL 002 V2.5.1
  url: https://www.etsi.org/deliver/etsi_gs/NFV-SOL/001_099/002/02.05.01_60/gs_nfv-sol002v020501p.pdf
  - http
  - https

consumes: 
  - application/json

produces: 
  - application/json

paths:
    /notificationendpoint:
      parameters:
        - name: Version
          description: >
            Version of the API requested to use when responding to this request.
          in: header
          required: true
          type: string
      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: >
              No Content

              The notification was delivered 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' }
          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: >
          Service Unavailable

          The GET method allows the server to test the notification endpoint that is provided
          by the client, e.g. during subscription.
        responses:
          204:
            description: >
              No Content

              The notification endpoint was tested 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' }
          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' }
moscatelli's avatar
moscatelli committed
          503: { $ref: '../../responses/SOL002SOL003_resp.yaml#/responses/503' }