NFVManoFaultManagementNotification.yaml 13.8 KB
Newer Older
1
openapi: 3.0.2
2

3
info:
4
5
6
7
8
9
10
  title: SOL009 - NFV-MANO Fault Management Notification Interface
  description: |
    SOL009 - NFV-MANO Fault Management Notification Interface

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

12
    Please report bugs to https://forge.etsi.org/rep/nfv/SOL009/issues
13

14
15
  contact:
    name: NFV-SOL WG
16
17
18
  license:
    name: ETSI Forge copyright notice
    url: https://forge.etsi.org/etsi-forge-copyright-notice.txt
19
20
  version: 1.0.1-impl:etsi.org:ETSI_NFV_OpenAPI:1

21
externalDocs:
22
23
  description: ETSI GS NFV-SOL 009 V4.3.1
  url: https://www.etsi.org/deliver/etsi_gs/NFV-SOL/001_099/009/04.03.01_60/gs_NFV-SOL009v040301p.pdf
24
25

servers:
Giacomo Bernini's avatar
Giacomo Bernini committed
26
27
  - url: http://127.0.0.1/callback/v1
  - url: https://127.0.0.1/callback/v1
28

29
paths:
30
  /URI_is_provided_by_the_client_when_creating_the_subscription-AlarmNotification:
31
32
33
34
    post:
      description: >
        The POST method notifies an NFV-MANO functional entity alarm or that the
        alarm list has been rebuilt. The API consumer shall have previously
35
        created an "Individual subscription" resource with a matching filter. See clause 7.5.7.3.1.
36
      parameters:
37
38
39
        - $ref: "../components/SOL009_params.yaml#/components/parameters/Version"
        - $ref: "../components/SOL009_params.yaml#/components/parameters/ContentType"
        - $ref: "../components/SOL009_params.yaml#/components/parameters/Authorization"
40
      requestBody:
Giacomo Bernini's avatar
Giacomo Bernini committed
41
        $ref: "#/components/requestBodies/AlarmNotification"
42
43
      responses:
        "204":
44
          $ref: "#/components/responses/AlarmNotification.Post.204"
45
        "400":
Giacomo Bernini's avatar
Giacomo Bernini committed
46
          $ref: ../components/SOL009_resp.yaml#/components/responses/400
47
        "401":
Giacomo Bernini's avatar
Giacomo Bernini committed
48
          $ref: ../components/SOL009_resp.yaml#/components/responses/401
49
        "403":
Giacomo Bernini's avatar
Giacomo Bernini committed
50
          $ref: ../components/SOL009_resp.yaml#/components/responses/403
51
        "405":
Giacomo Bernini's avatar
Giacomo Bernini committed
52
          $ref: ../components/SOL009_resp.yaml#/components/responses/405
53
        "406":
Giacomo Bernini's avatar
Giacomo Bernini committed
54
          $ref: ../components/SOL009_resp.yaml#/components/responses/406
55
        "500":
Giacomo Bernini's avatar
Giacomo Bernini committed
56
          $ref: ../components/SOL009_resp.yaml#/components/responses/500
57
        "503":
Giacomo Bernini's avatar
Giacomo Bernini committed
58
          $ref: ../components/SOL009_resp.yaml#/components/responses/503
59
60
61
    get:
      description: >
        The GET method allows the server to test the notification endpoint that
62
        is provided by the client, e.g. during subscription. See clause 7.5.7.3.2.
63
      parameters:
64
65
        - $ref: "../components/SOL009_params.yaml#/components/parameters/Version"
        - $ref: "../components/SOL009_params.yaml#/components/parameters/Authorization"
66
67
      responses:
        "204":
68
          $ref: "#/components/responses/AlarmNotification.Get.204"
69
        "400":
Giacomo Bernini's avatar
Giacomo Bernini committed
70
          $ref: ../components/SOL009_resp.yaml#/components/responses/400
71
        "401":
Giacomo Bernini's avatar
Giacomo Bernini committed
72
          $ref: ../components/SOL009_resp.yaml#/components/responses/401
73
        "403":
Giacomo Bernini's avatar
Giacomo Bernini committed
74
          $ref: ../components/SOL009_resp.yaml#/components/responses/403
75
        "405":
Giacomo Bernini's avatar
Giacomo Bernini committed
76
          $ref: ../components/SOL009_resp.yaml#/components/responses/405
77
        "406":
Giacomo Bernini's avatar
Giacomo Bernini committed
78
          $ref: ../components/SOL009_resp.yaml#/components/responses/406
79
        "500":
Giacomo Bernini's avatar
Giacomo Bernini committed
80
          $ref: ../components/SOL009_resp.yaml#/components/responses/500
81
        "503":
Giacomo Bernini's avatar
Giacomo Bernini committed
82
          $ref: ../components/SOL009_resp.yaml#/components/responses/503
83
  /URI_is_provided_by_the_client_when_creating_the_subscription-AlarmClearedNotification:
84
85
86
87
    post:
      description: >
        The POST method notifies an NFV-MANO functional entity alarm or that the
        alarm list has been rebuilt. The API consumer shall have previously
88
        created an "Individual subscription" resource with a matching filter. See clause 7.5.7.3.1.
89
      parameters:
90
91
92
        - $ref: "../components/SOL009_params.yaml#/components/parameters/Version"
        - $ref: "../components/SOL009_params.yaml#/components/parameters/ContentType"
        - $ref: "../components/SOL009_params.yaml#/components/parameters/Authorization"
93
      requestBody:
Giacomo Bernini's avatar
Giacomo Bernini committed
94
        $ref: "#/components/requestBodies/AlarmClearedNotification"
95
96
      responses:
        "204":
97
          $ref: "#/components/responses/AlarmClearedNotification.Post.204"
98
        "400":
Giacomo Bernini's avatar
Giacomo Bernini committed
99
          $ref: ../components/SOL009_resp.yaml#/components/responses/400
100
        "401":
Giacomo Bernini's avatar
Giacomo Bernini committed
101
          $ref: ../components/SOL009_resp.yaml#/components/responses/401
102
        "403":
Giacomo Bernini's avatar
Giacomo Bernini committed
103
          $ref: ../components/SOL009_resp.yaml#/components/responses/403
104
        "405":
Giacomo Bernini's avatar
Giacomo Bernini committed
105
          $ref: ../components/SOL009_resp.yaml#/components/responses/405
106
        "406":
Giacomo Bernini's avatar
Giacomo Bernini committed
107
          $ref: ../components/SOL009_resp.yaml#/components/responses/406
108
        "500":
Giacomo Bernini's avatar
Giacomo Bernini committed
109
          $ref: ../components/SOL009_resp.yaml#/components/responses/500
110
        "503":
Giacomo Bernini's avatar
Giacomo Bernini committed
111
          $ref: ../components/SOL009_resp.yaml#/components/responses/503
112
113
114
    get:
      description: >
        The GET method allows the server to test the notification endpoint that
115
        is provided by the client, e.g. during subscription. See clause 7.5.7.3.2.
116
      parameters:
117
118
        - $ref: "../components/SOL009_params.yaml#/components/parameters/Version"
        - $ref: "../components/SOL009_params.yaml#/components/parameters/Authorization"
119
120
      responses:
        "204":
121
          $ref: "#/components/responses/AlarmClearedNotification.Get.204"
122
        "400":
Giacomo Bernini's avatar
Giacomo Bernini committed
123
          $ref: ../components/SOL009_resp.yaml#/components/responses/400
124
        "401":
Giacomo Bernini's avatar
Giacomo Bernini committed
125
          $ref: ../components/SOL009_resp.yaml#/components/responses/401
126
        "403":
Giacomo Bernini's avatar
Giacomo Bernini committed
127
          $ref: ../components/SOL009_resp.yaml#/components/responses/403
128
        "405":
Giacomo Bernini's avatar
Giacomo Bernini committed
129
          $ref: ../components/SOL009_resp.yaml#/components/responses/405
130
        "406":
Giacomo Bernini's avatar
Giacomo Bernini committed
131
          $ref: ../components/SOL009_resp.yaml#/components/responses/406
132
        "500":
Giacomo Bernini's avatar
Giacomo Bernini committed
133
          $ref: ../components/SOL009_resp.yaml#/components/responses/500
134
        "503":
Giacomo Bernini's avatar
Giacomo Bernini committed
135
          $ref: ../components/SOL009_resp.yaml#/components/responses/503
136
  /URI_is_provided_by_the_client_when_creating_the_subscription-AlarmListRebuiltNotification:
137
138
139
140
    post:
      description: >
        The POST method notifies an NFV-MANO functional entity alarm or that the
        alarm list has been rebuilt. The API consumer shall have previously
141
        created an "Individual subscription" resource with a matching filter. See clause 7.5.7.3.1.
142
      parameters:
143
144
145
        - $ref: "../components/SOL009_params.yaml#/components/parameters/Version"
        - $ref: "../components/SOL009_params.yaml#/components/parameters/ContentType"
        - $ref: "../components/SOL009_params.yaml#/components/parameters/Authorization"
146
      requestBody:
Giacomo Bernini's avatar
Giacomo Bernini committed
147
        $ref: "#/components/requestBodies/AlarmListRebuiltNotification"
148
149
      responses:
        "204":
150
          $ref: "#/components/responses/AlarmListRebuiltNotification.Post.204"
151
        "400":
Giacomo Bernini's avatar
Giacomo Bernini committed
152
          $ref: ../components/SOL009_resp.yaml#/components/responses/400
153
        "401":
Giacomo Bernini's avatar
Giacomo Bernini committed
154
          $ref: ../components/SOL009_resp.yaml#/components/responses/401
155
        "403":
Giacomo Bernini's avatar
Giacomo Bernini committed
156
          $ref: ../components/SOL009_resp.yaml#/components/responses/403
157
        "405":
Giacomo Bernini's avatar
Giacomo Bernini committed
158
          $ref: ../components/SOL009_resp.yaml#/components/responses/405
159
        "406":
Giacomo Bernini's avatar
Giacomo Bernini committed
160
          $ref: ../components/SOL009_resp.yaml#/components/responses/406
161
        "500":
Giacomo Bernini's avatar
Giacomo Bernini committed
162
          $ref: ../components/SOL009_resp.yaml#/components/responses/500
163
        "503":
Giacomo Bernini's avatar
Giacomo Bernini committed
164
          $ref: ../components/SOL009_resp.yaml#/components/responses/503
165
166
167
    get:
      description: >
        The GET method allows the server to test the notification endpoint that
168
        is provided by the client, e.g. during subscription. See clause 7.5.7.3.2.
169
      parameters:
170
171
        - $ref: "../components/SOL009_params.yaml#/components/parameters/Version"
        - $ref: "../components/SOL009_params.yaml#/components/parameters/Authorization"
172
173
      responses:
        "204":
174
          $ref: "#/components/responses/AlarmListRebuiltNotification.Get.204"
175
        "400":
Giacomo Bernini's avatar
Giacomo Bernini committed
176
          $ref: ../components/SOL009_resp.yaml#/components/responses/400
177
        "401":
Giacomo Bernini's avatar
Giacomo Bernini committed
178
          $ref: ../components/SOL009_resp.yaml#/components/responses/401
179
        "403":
Giacomo Bernini's avatar
Giacomo Bernini committed
180
          $ref: ../components/SOL009_resp.yaml#/components/responses/403
181
        "405":
Giacomo Bernini's avatar
Giacomo Bernini committed
182
          $ref: ../components/SOL009_resp.yaml#/components/responses/405
183
        "406":
Giacomo Bernini's avatar
Giacomo Bernini committed
184
          $ref: ../components/SOL009_resp.yaml#/components/responses/406
185
        "500":
Giacomo Bernini's avatar
Giacomo Bernini committed
186
          $ref: ../components/SOL009_resp.yaml#/components/responses/500
187
        "503":
Giacomo Bernini's avatar
Giacomo Bernini committed
188
          $ref: ../components/SOL009_resp.yaml#/components/responses/503
189

190
components:
Giacomo Bernini's avatar
Giacomo Bernini committed
191
192
193
194
195
196
197
  requestBodies:
    AlarmNotification:
      description: >
        Information of a NFV-MANO functional entity alarm.
      content:
        application/json:
          schema:
Giacomo Bernini's avatar
Giacomo Bernini committed
198
            $ref: "./components/NFVManoFaultManagementNotification_def.yaml#/components/schemas/AlarmNotification"
Giacomo Bernini's avatar
Giacomo Bernini committed
199
200
201
202
203
204
205
206
      required: true

    AlarmClearedNotification:
      description: |
        Information of the clearance of an NFV-MANO functional entity alarm.
      content:
        application/json:
          schema:
Giacomo Bernini's avatar
Giacomo Bernini committed
207
            $ref: "./components/NFVManoFaultManagementNotification_def.yaml#/components/schemas/AlarmClearedNotification"
Giacomo Bernini's avatar
Giacomo Bernini committed
208
209
210
211
212
213
214
215
216
      required: true

    AlarmListRebuiltNotification:
      description: >
        Information that the alarm list has been rebuilt by the NFV-MANO
        functional entity.
      content:
        application/json:
          schema:
Giacomo Bernini's avatar
Giacomo Bernini committed
217
            $ref: "./components/NFVManoFaultManagementNotification_def.yaml#/components/schemas/AlarmListRebuiltNotification"
Giacomo Bernini's avatar
Giacomo Bernini committed
218
219
220
      required: true

  responses:
221
    AlarmNotification.Post.204:
Giacomo Bernini's avatar
Giacomo Bernini committed
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
      description: >
        204 NO CONTENT

        Shall be returned when the notification has been delivered successfully. The response body shall be empty.
      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.
          schema:
            type: string
            minimum: 0
            maximum: 1
        Version:
          description: |
            Version of the API used in the response.
          schema:
            type: string
            minimum: 1
            maximum: 1

244
    AlarmNotification.Get.204:
Giacomo Bernini's avatar
Giacomo Bernini committed
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
      description: >
        204 NO CONTENT

        Shall be returned to indicate that the notification endpoint has been tested successfully.
        The response body shall be empty.
      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.
          schema:
            type: string
            minimum: 0
            maximum: 1
        Version:
          description: |
            Version of the API used in the response.
          schema:
            type: string
            minimum: 1
            maximum: 1

268
    AlarmClearedNotification.Post.204:
Giacomo Bernini's avatar
Giacomo Bernini committed
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
      description: >
        204 NO CONTENT

        Shall be returned when the notification has been delivered successfully. The response body shall be empty.
      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.
          schema:
            type: string
            minimum: 0
            maximum: 1
        Version:
          description: |
            Version of the API used in the response.
          schema:
            type: string
            minimum: 1
            maximum: 1

291
    AlarmClearedNotification.Get.204:
Giacomo Bernini's avatar
Giacomo Bernini committed
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
      description: >
        204 NO CONTENT

        Shall be returned to indicate that the notification endpoint has been tested successfully.
        The response body shall be empty.
      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.
          schema:
            type: string
            minimum: 0
            maximum: 1
        Version:
          description: |
            Version of the API used in the response.
          schema:
            type: string
            minimum: 1
            maximum: 1

315
    AlarmListRebuiltNotification.Post.204:
Giacomo Bernini's avatar
Giacomo Bernini committed
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
      description: >
        204 NO CONTENT

        Shall be returned when the notification has been delivered successfully. The response body shall be empty.
      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.
          schema:
            type: string
            minimum: 0
            maximum: 1
        Version:
          description: |
            Version of the API used in the response.
          schema:
            type: string
            minimum: 1
            maximum: 1

338
    AlarmListRebuiltNotification.Get.204:
Giacomo Bernini's avatar
Giacomo Bernini committed
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
      description: >
        204 NO CONTENT

        Shall be returned to indicate that the notification endpoint has been tested successfully. The response body shall be empty.
      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.
          schema:
            type: string
            minimum: 0
            maximum: 1
        Version:
          description: >-
            Version of the API used in the response.
          schema:
            type: string
            minimum: 1
            maximum: 1