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

info:
4
  version: "1.2.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

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

14

15
16
17
18
19
20
    In clause 4.3.2 of ETSI GS NFV-SOL 003 v2.4.1, an attribute-based
    filtering mechanism is defined. This mechanism is currently not
    included in the corresponding OpenAPI design for this GS version. Changes
    to the attribute-based filtering mechanism are being considered in v2.5.1
    of this GS for inclusion in the corresponding future ETSI NFV OpenAPI
    design.
21

22
    Please report bugs to https://forge.etsi.org/bugzilla/buglist.cgi?component=Nfv-Openapis&list_id=61&product=NFV&resolution=
23
24
25
  license:
    name: "ETSI Forge copyright notice"
    url: https://forge.etsi.org/etsi-forge-copyright-notice.txt
26
27

externalDocs:
28
29
  description: ETSI GS NFV-SOL 003 V2.6.1
  url: https://www.etsi.org/deliver/etsi_gs/NFV-SOL/001_099/003/02.06.01_60/gs_NFV-SOL003v020601p.pdf
30
31
32
33
34
35
36
37
38
39
40
41

basePath: "/callback/v1"

schemes:
  - https

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

paths:
42
43
44
  ###############################################################################
  # Notification endpoint AlarmNotification                                     #
  ###############################################################################
45
46
47
48
  '/URI-is-provided-by-the-client-when-creating-the-subscription-AlarmNotification':
    #SOL003 location: 7.4.6
    post:
      description: >
49
50
51
52
53
        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.
54
55
56
57
58
59
60
61
      parameters:
        - name: AlarmNotification
          description: >
            Information of a VNF alarm.
          in: body
          required: true
          schema:
            $ref: "../definitions/SOL003_def.yaml#/definitions/AlarmNotification"
Gergely Csatari's avatar
Gergely Csatari committed
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
        - 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
77
78
79
80
81
82
        - name: Version
          description: >
            Version of the API requested to use when responding to this request.
          in: header
          required: true
          type: string
83
84
      responses:
        204:
85
          description: >
86
            204 NO CONTENT
Gergely Csatari's avatar
Gergely Csatari committed
87

88
            Shall be returned when the notification has been delivered successfully.
89
            The response body shall be empty.
Gergely Csatari's avatar
Gergely Csatari committed
90
91
92
93
94
95
96
97
98
          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
99
100
101
102
103
104
            Version:
              description: >
                Version of the API used in the response.
              type: string
              maximum: 1
              minimum: 1
105
106
107
108
109
110
111
112
113
114
115
116
117
118
        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"
119

120
121
    get:
      description: >
122
123
124
125
        The GET method allows the server to test the notification endpoint that is provided by the client,
        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
126
127
128
129
130
131
132
133
      parameters:
        - name: Authorization
          description: >
            The authorization token for the request.
            Reference: IETF RFC 7235
          in: header
          required: false
          type: string
134
135
136
137
138
139
        - name: Version
          description: >
            Version of the API requested to use when responding to this request.
          in: header
          required: true
          type: string
140
141
      responses:
        204:
142
          description: >
143
            204 NO CONTENT
Gergely Csatari's avatar
Gergely Csatari committed
144

145
            Shall be returned to indicate that the notification endpoint has been tested successfully.
146
            The response body shall be empty.
Gergely Csatari's avatar
Gergely Csatari committed
147
148
149
150
151
152
153
154
155
          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
156
157
158
159
160
161
            Version:
              description: >
                Version of the API used in the response.
              type: string
              maximum: 1
              minimum: 1
162
163
164
165
166
167
168
169
170
171
172
173
174
175
        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"
176

177
178
179
  ###############################################################################
  # Notification endpoint AlarmClearedNotification                              #
  ###############################################################################
180
181
182
183
  '/URI-is-provided-by-the-client-when-creating-the-subscription-AlarmClearedNotification':
    #SOL003 location: 7.4.6
    post:
      description: >
184
185
186
187
188
        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.
189
190
191
192
193
194
195
196
      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
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
        - 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
212
213
214
215
216
217
        - name: Version
          description: >
            Version of the API requested to use when responding to this request.
          in: header
          required: true
          type: string
218
219
      responses:
        204:
220
          description: >
221
            204 NO CONTENT
Gergely Csatari's avatar
Gergely Csatari committed
222

223
            Shall be returned when the notification has been delivered successfully.
224
            The response body shall be empty.
Gergely Csatari's avatar
Gergely Csatari committed
225
226
227
228
229
230
231
232
233
          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
234
235
236
237
238
239
            Version:
              description: >
                Version of the API used in the response.
              type: string
              maximum: 1
              minimum: 1
240
241
242
243
244
245
246
247
248
249
250
251
252
253
        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"
254

255
256
    get:
      description: >
257
258
259
260
        The GET method allows the server to test the notification endpoint that is provided by the client,
        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
261
262
263
264
265
266
267
268
      parameters:
        - name: Authorization
          description: >
            The authorization token for the request.
            Reference: IETF RFC 7235
          in: header
          required: false
          type: string
269
270
271
272
273
274
        - name: Version
          description: >
            Version of the API requested to use when responding to this request.
          in: header
          required: true
          type: string
275
276
      responses:
        204:
277
          description: >
278
            204 NO CONTENT
Gergely Csatari's avatar
Gergely Csatari committed
279

280
            Shall be returned to indicate that the notification endpoint has been tested successfully.
281
            The response body shall be empty.
Gergely Csatari's avatar
Gergely Csatari committed
282
283
284
285
286
287
288
289
290
          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
291
292
293
294
295
296
            Version:
              description: >
                Version of the API used in the response.
              type: string
              maximum: 1
              minimum: 1
297
298
299
300
301
302
303
304
305
306
307
308
309
310
        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"
311

312
313
314
  ###############################################################################
  # Notification endpoint AlarmListRebuiltNotification                          #
  ###############################################################################
315
316
317
318
  '/URI-is-provided-by-the-client-when-creating-the-subscription-AlarmListRebuiltNotification':
    #SOL003 location: 7.4.6
    post:
      description: >
319
320
321
322
323
        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.
324
325
326
327
328
329
330
331
      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
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
        - 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
347
348
349
350
351
352
        - name: Version
          description: >
            Version of the API requested to use when responding to this request.
          in: header
          required: true
          type: string
353
354
      responses:
        204:
355
          description: >
356
            204 NO CONTENT
Gergely Csatari's avatar
Gergely Csatari committed
357

358
            Shall be returned when the notification has been delivered successfully.
359
            The response body shall be empty.
Gergely Csatari's avatar
Gergely Csatari committed
360
361
362
363
364
365
366
367
368
          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
369
370
371
372
373
374
            Version:
              description: >
                Version of the API used in the response.
              type: string
              maximum: 1
              minimum: 1
375
376
377
378
379
380
381
382
383
384
385
386
387
388
        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"
389

390
391
    get:
      description: >
392
393
394
395
        The GET method allows the server to test the notification endpoint that is provided by the client,
        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
396
397
398
399
400
401
402
403
      parameters:
        - name: Authorization
          description: >
            The authorization token for the request.
            Reference: IETF RFC 7235
          in: header
          required: false
          type: string
404
405
406
407
408
409
        - name: Version
          description: >
            Version of the API requested to use when responding to this request.
          in: header
          required: true
          type: string
410
411
      responses:
        204:
412
          description: >
413
            204 NO CONTENT
Gergely Csatari's avatar
Gergely Csatari committed
414

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