VNFFaultManagementNotification.yaml 16.6 KB
Newer Older
1
2
3
swagger: "2.0"

info:
4
  version: "1.3.0-impl:etsi.org:ETSI_NFV_OpenAPI:1"
5
  title: SOL003 - VNF Fault Management Notification interface
6
  description: >
7
8
    SOL003 - VNF Fault Management Notification interface

9
    IMPORTANT: Please note that this file might be not aligned to the current
10
11
12
    version of the ETSI Group Specification it refers to. In case of
    discrepancies the published ETSI Group Specification takes precedence.

13
    Please report bugs to https://forge.etsi.org/rep/nfv/SOL002-SOL003/issues
14
15
16
  license:
    name: "ETSI Forge copyright notice"
    url: https://forge.etsi.org/etsi-forge-copyright-notice.txt
17
18

externalDocs:
19
20
  description: ETSI GS NFV-SOL 003 V2.8.1
  url: https://www.etsi.org/deliver/etsi_gs/NFV-SOL/001_099/003/02.08.01_60/gs_NFV-SOL003v020801p.pdf
21
22
23
24
25
26
27
28
29
30
31
32

basePath: "/callback/v1"

schemes:
  - https

consumes:
  - "application/json"
produces:
  - "application/json"

paths:
33
34
35
  ###############################################################################
  # Notification endpoint AlarmNotification                                     #
  ###############################################################################
36
  '/URI_is_provided_by_the_client_when_creating_the_subscription-AlarmNotification':
37
38
39
    #SOL003 location: 7.4.6
    post:
      description: >
40
41
42
43
44
        Notify.
        The POST method notifies a VNF alarm or that the alarm list has been rebuilt.
        The API consumer shall have previously created an "Individual subscription resource" with a matching filter.
        This method shall follow the provisions specified in the tables 7.4.6.3.1-1 and 7.4.6.3.1-2
        for URI query parameters, request and response data structures, and response codes.
45
46
47
48
49
50
51
      parameters:
        - name: AlarmNotification
          description: >
            Information of a VNF alarm.
          in: body
          required: true
          schema:
moscatelli's avatar
moscatelli committed
52
            $ref: "../../definitions/SOL002SOL003VNFFaultManagement_def.yaml#/definitions/AlarmNotification"
Gergely Csatari's avatar
Gergely Csatari committed
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
        - name: Authorization
          description: >
            The authorization token for the request.
            Reference: IETF RFC 7235
          in: header
          required: false
          type: string
        - name: Content-Type
          description: >
            The Content-Type header shall be set to
            "application/merge-patch+json" according to
            IETF RFC 7396.
          in: header
          required: true
          type: string
68
69
70
71
72
73
        - name: Version
          description: >
            Version of the API requested to use when responding to this request.
          in: header
          required: true
          type: string
74
75
      responses:
        204:
76
          description: >
77
            204 NO CONTENT
Gergely Csatari's avatar
Gergely Csatari committed
78

79
            Shall be returned when the notification has been delivered successfully.
80
            The response body shall be empty.
Gergely Csatari's avatar
Gergely Csatari committed
81
82
83
84
85
86
87
88
89
          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.
              type: string
              maximum: 1
              minimum: 0
90
91
92
93
94
95
            Version:
              description: >
                Version of the API used in the response.
              type: string
              maximum: 1
              minimum: 1
96
97
98
99
100
101
102
103
104
105
106
107
108
109
        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"
110

111
112
    get:
      description: >
113
        The GET method allows the API producer to test the notification endpoint that is provided by the API consumer,
114
115
116
        e.g. during subscription.
        This method shall follow the provisions specified in the tables 7.4.6.3.2-1 and 7.4.6.3.2-2
        for URI query parameters, request and response data structures, and response codes.
Gergely Csatari's avatar
Gergely Csatari committed
117
118
119
120
121
122
123
124
      parameters:
        - name: Authorization
          description: >
            The authorization token for the request.
            Reference: IETF RFC 7235
          in: header
          required: false
          type: string
125
126
127
128
129
130
        - name: Version
          description: >
            Version of the API requested to use when responding to this request.
          in: header
          required: true
          type: string
131
132
      responses:
        204:
133
          description: >
134
            204 NO CONTENT
Gergely Csatari's avatar
Gergely Csatari committed
135

136
            Shall be returned to indicate that the notification endpoint has been tested successfully.
137
            The response body shall be empty.
Gergely Csatari's avatar
Gergely Csatari committed
138
139
140
141
142
143
144
145
146
          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.
              type: string
              maximum: 1
              minimum: 0
147
148
149
150
151
152
            Version:
              description: >
                Version of the API used in the response.
              type: string
              maximum: 1
              minimum: 1
153
154
155
156
157
158
159
160
161
162
163
164
165
166
        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"
167

168
169
170
  ###############################################################################
  # Notification endpoint AlarmClearedNotification                              #
  ###############################################################################
171
  '/URI_is_provided_by_the_client_when_creating_the_subscription-AlarmClearedNotification':
172
173
174
    #SOL003 location: 7.4.6
    post:
      description: >
175
176
177
178
179
        Notify.
        The POST method notifies a VNF alarm or that the alarm list has been rebuilt.
        The API consumer shall have previously created an "Individual subscription resource" with a matching filter.
        This method shall follow the provisions specified in the tables 7.4.6.3.1-1 and 7.4.6.3.1-2
        for URI query parameters, request and response data structures, and response codes.
180
181
182
183
184
185
186
187
      parameters:
        - name: AlarmClearedNotification
          description: >
            Information of the clearance of a VNF alarm
          in: body
          required: true
          schema:
            $ref: "../../definitions/SOL002SOL003VNFFaultManagement_def.yaml#/definitions/AlarmClearedNotification"
Gergely Csatari's avatar
Gergely Csatari committed
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
        - name: Authorization
          description: >
            The authorization token for the request.
            Reference: IETF RFC 7235
          in: header
          required: false
          type: string
        - name: Content-Type
          description: >
            The Content-Type header shall be set to
            "application/merge-patch+json" according to
            IETF RFC 7396.
          in: header
          required: true
          type: string
203
204
205
206
207
208
        - name: Version
          description: >
            Version of the API requested to use when responding to this request.
          in: header
          required: true
          type: string
209
210
      responses:
        204:
211
          description: >
212
            204 NO CONTENT
Gergely Csatari's avatar
Gergely Csatari committed
213

214
            Shall be returned when the notification has been delivered successfully.
215
            The response body shall be empty.
Gergely Csatari's avatar
Gergely Csatari committed
216
217
218
219
220
221
222
223
224
          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.
              type: string
              maximum: 1
              minimum: 0
225
226
227
228
229
230
            Version:
              description: >
                Version of the API used in the response.
              type: string
              maximum: 1
              minimum: 1
231
232
233
234
235
236
237
238
239
240
241
242
243
244
        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"
245

246
247
    get:
      description: >
248
        The GET method allows the API producer to test the notification endpoint that is provided by the API consumer,
249
250
251
        e.g. during subscription.
        This method shall follow the provisions specified in the tables 7.4.6.3.2-1 and 7.4.6.3.2-2
        for URI query parameters, request and response data structures, and response codes.
Gergely Csatari's avatar
Gergely Csatari committed
252
253
254
255
256
257
258
259
      parameters:
        - name: Authorization
          description: >
            The authorization token for the request.
            Reference: IETF RFC 7235
          in: header
          required: false
          type: string
260
261
262
263
264
265
        - name: Version
          description: >
            Version of the API requested to use when responding to this request.
          in: header
          required: true
          type: string
266
267
      responses:
        204:
268
          description: >
269
            204 NO CONTENT
Gergely Csatari's avatar
Gergely Csatari committed
270

271
            Shall be returned to indicate that the notification endpoint has been tested successfully.
272
            The response body shall be empty.
Gergely Csatari's avatar
Gergely Csatari committed
273
274
275
276
277
278
279
280
281
          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.
              type: string
              maximum: 1
              minimum: 0
282
283
284
285
286
287
            Version:
              description: >
                Version of the API used in the response.
              type: string
              maximum: 1
              minimum: 1
288
289
290
291
292
293
294
295
296
297
298
299
300
301
        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"
302

303
304
305
  ###############################################################################
  # Notification endpoint AlarmListRebuiltNotification                          #
  ###############################################################################
306
  '/URI_is_provided_by_the_client_when_creating_the_subscription-AlarmListRebuiltNotification':
307
308
309
    #SOL003 location: 7.4.6
    post:
      description: >
310
311
312
313
314
        Notify.
        The POST method notifies a VNF alarm or that the alarm list has been rebuilt.
        The API consumer shall have previously created an "Individual subscription resource" with a matching filter.
        This method shall follow the provisions specified in the tables 7.4.6.3.1-1 and 7.4.6.3.1-2
        for URI query parameters, request and response data structures, and response codes.
315
316
317
318
319
320
321
322
      parameters:
        - name: AlarmListRebuiltNotification
          description: >
            Information that the alarm list has been rebuilt by the VNFM
          in: body
          required: true
          schema:
            $ref: "../../definitions/SOL002SOL003VNFFaultManagement_def.yaml#/definitions/AlarmListRebuiltNotification"
Gergely Csatari's avatar
Gergely Csatari committed
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
        - name: Authorization
          description: >
            The authorization token for the request.
            Reference: IETF RFC 7235
          in: header
          required: false
          type: string
        - name: Content-Type
          description: >
            The Content-Type header shall be set to
            "application/merge-patch+json" according to
            IETF RFC 7396.
          in: header
          required: true
          type: string
338
339
340
341
342
343
        - name: Version
          description: >
            Version of the API requested to use when responding to this request.
          in: header
          required: true
          type: string
344
345
      responses:
        204:
346
          description: >
347
            204 NO CONTENT
Gergely Csatari's avatar
Gergely Csatari committed
348

349
            Shall be returned when the notification has been delivered successfully.
350
            The response body shall be empty.
Gergely Csatari's avatar
Gergely Csatari committed
351
352
353
354
355
356
357
358
359
          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.
              type: string
              maximum: 1
              minimum: 0
360
361
362
363
364
365
            Version:
              description: >
                Version of the API used in the response.
              type: string
              maximum: 1
              minimum: 1
366
367
368
369
370
371
372
373
374
375
376
377
378
379
        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"
380

381
382
    get:
      description: >
383
        The GET method allows the API producer to test the notification endpoint that is provided by the API consumer,
384
385
386
        e.g. during subscription.
        This method shall follow the provisions specified in the tables 7.4.6.3.2-1 and 7.4.6.3.2-2
        for URI query parameters, request and response data structures, and response codes.
Gergely Csatari's avatar
Gergely Csatari committed
387
388
389
390
391
392
393
394
      parameters:
        - name: Authorization
          description: >
            The authorization token for the request.
            Reference: IETF RFC 7235
          in: header
          required: false
          type: string
395
396
397
398
399
400
        - name: Version
          description: >
            Version of the API requested to use when responding to this request.
          in: header
          required: true
          type: string
401
402
      responses:
        204:
403
          description: >
404
            204 NO CONTENT
Gergely Csatari's avatar
Gergely Csatari committed
405

406
            Shall be returned to indicate that the notification endpoint has been tested successfully.
407
            The response body shall be empty.
Gergely Csatari's avatar
Gergely Csatari committed
408
409
410
411
412
413
414
415
416
          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.
              type: string
              maximum: 1
              minimum: 0
417
418
419
420
421
422
            Version:
              description: >
                Version of the API used in the response.
              type: string
              maximum: 1
              minimum: 1
423
424
425
426
427
428
429
430
431
432
433
434
435
        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:
436
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/503"