VNFIndicatorNotification.yaml 5.02 KB
Newer Older
1 2
swagger: "2.0"

3
info:
4
  version: "1.2.0-impl:etsi.org:ETSI_NFV_OpenAPI:1"
5
  title: SOL002 - VNF Indicator Notification Endpoint interface
6
  description: >
7
    SOL002 - VNF Indicator Notification Endpoint interface
8
    IMPORTANT: Please note that this file might be not aligned to the current
9 10 11 12
    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
13
  license:
14
    name: ETSI Forge copyright notice
15
    url: https://forge.etsi.org/etsi-forge-copyright-notice.txt
16 17
  contact:
    name: NFV-SOL WG
18

19
externalDocs:
20 21
  description: ETSI GS NFV-SOL 002 V2.6.1
  url: https://www.etsi.org/deliver/etsi_gs/NFV-SOL/001_099/002/02.06.01_60/gs_nfv-sol002v020601p.pdf
22

23
schemes:
24 25 26
  - http
  - https

27
consumes:
28 29
  - application/json

30
produces:
31 32 33
  - application/json

paths:
34
  ###############################################################################
35
  # Notification endpoint VnfIndicatorValueChangeNotification                   #
36
  ###############################################################################
37
  '/URI-is-provided-by-the-client-when-creating-the-subscription_VnfIndicatorValueChangeNotification':
38 39 40 41 42 43 44
    parameters:
      - name: Version
        description: >
          Version of the API requested to use when responding to this request.
        in: header
        required: true
        type: string
45 46 47 48 49 50 51
      - name: Authorization
        description: >
          The authorization token for the request.
          Reference: IETF RFC 7235
        in: header
        required: false
        type: string
52 53 54 55 56 57
    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.
58 59 60
        The POST method delivers a notification from API producer to an API consumer. The API 
        consumer shall have previously created an "Individual subscription" resource with a 
        matching filter.
61
      parameters:
62 63
        - name: vnfIndicatorValueChangeNotification
          in: body
64
          description: >
65
            A notification about VNF indicator value changes.
66
          required: true
67
          schema:
68
            $ref: 'definitions/SOL002VNFIndicatorNotification_def.yaml#/definitions/VnfIndicatorValueChangeNotification'
69 70 71
      responses:
        204:
          description: >
72
            204 NO CONTENT
73

74 75
            Shall be returned when the notification has been delivered successfully. 
            The response body shall be empty.
76 77 78 79 80 81
          headers:
            Version:
              description: The used API version.
              type: string
              maximum: 1
              minimum: 1
82 83 84 85 86 87 88 89 90 91 92 93 94 95
        400:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/400"
        401:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/401"
        403:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/403"
        405:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/405"
        406:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/406"
        500:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/500"
        503:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/503"
96 97 98 99
    get:
      summary: Test notification endpoint.
      description: >
        Service Unavailable
100

101 102 103 104 105
        The GET method allows the server to test the notification endpoint that is provided
        by the client, e.g. during subscription.
      responses:
        204:
          description: >
106
            204 NO CONTENT
107

108 109
            Shall be returned when the notification endpoint has been tested successfully. 
            The response body shall be empty.
110
          headers:
111 112 113 114 115 116 117 118
            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
119 120 121 122 123
            Version:
              description: The used API version.
              type: string
              maximum: 1
              minimum: 1
124 125 126 127 128 129 130 131 132 133 134 135 136 137
        400:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/400"
        401:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/401"
        403:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/403"
        405:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/405"
        406:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/406"
        500:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/500"
        503:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/503"