NSFaultManagementNotification.yaml 13.6 KB
Newer Older
1
openapi: 3.0.2
2

3
info:
Giacomo Bernini's avatar
upd  
Giacomo Bernini committed
4
  title: SOL005 - NS Fault Management Notification Interface
5
  description: |
Giacomo Bernini's avatar
upd  
Giacomo Bernini committed
6
    SOL005 - NS Fault Management Notification Interface
7
8
9
10
11

    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.

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

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

externalDocs:
22
  description: ETSI GS NFV-SOL 005 V3.5.1
23
  url: https://www.etsi.org/deliver/etsi_gs/NFV-SOL/001_099/005/03.05.01_60/gs_nfv-sol005v030501p.pdf
24

25
26
27
servers:
  - url: http://127.0.0.1/callback/v1
  - url: https://127.0.0.1/callback/v1
28
paths:
29
30
31
32
33
34
  /URI_is_provided_by_the_client_when_creating_the_subscription-AlarmNotification:
    parameters:
      - $ref: ../components/SOL005_params.yaml#/components/parameters/Version
      - $ref: ../components/SOL005_params.yaml#/components/parameters/Authorization
    get:
      description: |
35
36
        The GET method allows the API producer to test the notification endpoint that is provided by the API consumer,
        e.g. during subscription. See clause 8.4.6.3.2.
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
      parameters:
        - $ref: ../components/SOL005_params.yaml#/components/parameters/Accept
      responses:
        "204":
          $ref: '#/components/responses/AlarmNotification.Get'
        "400":
          $ref: ../responses/SOL005_resp.yaml#/components/responses/400
        "401":
          $ref: ../responses/SOL005_resp.yaml#/components/responses/401
        "403":
          $ref: ../responses/SOL005_resp.yaml#/components/responses/403
        "405":
          $ref: ../responses/SOL005_resp.yaml#/components/responses/405
        "406":
          $ref: ../responses/SOL005_resp.yaml#/components/responses/406
        "500":
          $ref: ../responses/SOL005_resp.yaml#/components/responses/500
        "503":
          $ref: ../responses/SOL005_resp.yaml#/components/responses/503

57
    post:
58
      description: |
59
60
        The POST method notifies an alarm related to an NS or that the alarm list has been rebuilt. The API consumer
        shall have previously created an "individual subscription resource" with a matching filter. See clause 8.4.6.3.1.
61
      parameters:
62
63
64
65
        - $ref: ../components/SOL005_params.yaml#/components/parameters/Accept
        - $ref: ../components/SOL005_params.yaml#/components/parameters/ContentType
      requestBody:
        $ref: '#/components/requestBodies/AlarmNotificationRequest'
66
      responses:
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
        "204":
          $ref: '#/components/responses/AlarmNotification.Post'
        "400":
          $ref: ../responses/SOL005_resp.yaml#/components/responses/400
        "401":
          $ref: ../responses/SOL005_resp.yaml#/components/responses/401
        "403":
          $ref: ../responses/SOL005_resp.yaml#/components/responses/403
        "405":
          $ref: ../responses/SOL005_resp.yaml#/components/responses/405
        "406":
          $ref: ../responses/SOL005_resp.yaml#/components/responses/406
        "500":
          $ref: ../responses/SOL005_resp.yaml#/components/responses/500
        "503":
          $ref: ../responses/SOL005_resp.yaml#/components/responses/503
83

84
85
86
87
  /URI_is_provided_by_the_client_when_creating_the_subscription-AlarmClearedNotification:
    parameters:
      - $ref: ../components/SOL005_params.yaml#/components/parameters/Version
      - $ref: ../components/SOL005_params.yaml#/components/parameters/Authorization
88
    get:
89
      description: |
90
91
        The GET method allows the API producer to test the notification endpoint that is provided by the API consumer,
        e.g. during subscription. See clause 8.4.6.3.2.
92
      parameters:
93
        - $ref: ../components/SOL005_params.yaml#/components/parameters/Accept
94
      responses:
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
        "204":
          $ref: '#/components/responses/AlarmClearedNotification.Get'
        "400":
          $ref: ../responses/SOL005_resp.yaml#/components/responses/400
        "401":
          $ref: ../responses/SOL005_resp.yaml#/components/responses/401
        "403":
          $ref: ../responses/SOL005_resp.yaml#/components/responses/403
        "405":
          $ref: ../responses/SOL005_resp.yaml#/components/responses/405
        "406":
          $ref: ../responses/SOL005_resp.yaml#/components/responses/406
        "500":
          $ref: ../responses/SOL005_resp.yaml#/components/responses/500
        "503":
          $ref: ../responses/SOL005_resp.yaml#/components/responses/503
111

112
    post:
113
      description: |
114
115
        The POST method notifies an alarm related to an NS or that the alarm list has been rebuilt. The API consumer
        shall have previously created an "individual subscription resource" with a matching filter. See clause 8.4.6.3.1.
116
      parameters:
117
118
119
120
        - $ref: ../components/SOL005_params.yaml#/components/parameters/Accept
        - $ref: ../components/SOL005_params.yaml#/components/parameters/ContentType
      requestBody:
        $ref: '#/components/requestBodies/AlarmClearedNotificationRequest'
121
      responses:
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
        "204":
          $ref: '#/components/responses/AlarmClearedNotification.Post'
        "400":
          $ref: ../responses/SOL005_resp.yaml#/components/responses/400
        "401":
          $ref: ../responses/SOL005_resp.yaml#/components/responses/401
        "403":
          $ref: ../responses/SOL005_resp.yaml#/components/responses/403
        "405":
          $ref: ../responses/SOL005_resp.yaml#/components/responses/405
        "406":
          $ref: ../responses/SOL005_resp.yaml#/components/responses/406
        "500":
          $ref: ../responses/SOL005_resp.yaml#/components/responses/500
        "503":
          $ref: ../responses/SOL005_resp.yaml#/components/responses/503
138

139
140
141
142
  /URI_is_provided_by_the_client_when_creating_the_subscription-AlarmListRebuiltNotification:
    parameters:
      - $ref: ../components/SOL005_params.yaml#/components/parameters/Version
      - $ref: ../components/SOL005_params.yaml#/components/parameters/Authorization
Giacomo Bernini's avatar
Giacomo Bernini committed
143
    get:
144
      description: |
145
146
        The GET method allows the API producer to test the notification endpoint that is provided by the API consumer,
        e.g. during subscription. See clause 8.4.6.3.2.
Giacomo Bernini's avatar
Giacomo Bernini committed
147
      parameters:
148
        - $ref: ../components/SOL005_params.yaml#/components/parameters/Accept
Giacomo Bernini's avatar
Giacomo Bernini committed
149
      responses:
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
        "204":
          $ref: '#/components/responses/AlarmListRebuiltNotification.Get'
        "400":
          $ref: ../responses/SOL005_resp.yaml#/components/responses/400
        "401":
          $ref: ../responses/SOL005_resp.yaml#/components/responses/401
        "403":
          $ref: ../responses/SOL005_resp.yaml#/components/responses/403
        "405":
          $ref: ../responses/SOL005_resp.yaml#/components/responses/405
        "406":
          $ref: ../responses/SOL005_resp.yaml#/components/responses/406
        "500":
          $ref: ../responses/SOL005_resp.yaml#/components/responses/500
        "503":
          $ref: ../responses/SOL005_resp.yaml#/components/responses/503
166
167

    post:
168
      description: |
169
170
        The POST method notifies an alarm related to an NS or that the alarm list has been rebuilt. The API consumer
        shall have previously created an "individual subscription resource" with a matching filter. See clause 8.4.6.3.1.
171
      parameters:
172
173
174
175
        - $ref: ../components/SOL005_params.yaml#/components/parameters/Accept
        - $ref: ../components/SOL005_params.yaml#/components/parameters/ContentType
      requestBody:
        $ref: '#/components/requestBodies/AlarmListRebuiltNotificationRequest'
176
      responses:
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
        "204":
          $ref: '#/components/responses/AlarmListRebuiltNotification.Post'
        "400":
          $ref: ../responses/SOL005_resp.yaml#/components/responses/400
        "401":
          $ref: ../responses/SOL005_resp.yaml#/components/responses/401
        "403":
          $ref: ../responses/SOL005_resp.yaml#/components/responses/403
        "405":
          $ref: ../responses/SOL005_resp.yaml#/components/responses/405
        "406":
          $ref: ../responses/SOL005_resp.yaml#/components/responses/406
        "500":
          $ref: ../responses/SOL005_resp.yaml#/components/responses/500
        "503":
          $ref: ../responses/SOL005_resp.yaml#/components/responses/503
193

194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
components:
  requestBodies:
    AlarmNotificationRequest:
      description: |
        Information of an NS alarm.
      content:
        application/json:
          schema:
            $ref: ./definitions/SOL005NSFaultManagementNotification_def.yaml#/definitions/AlarmNotification
      required: true

    AlarmClearedNotificationRequest:
      description: |
        Information of the clearance of an NS alarm.
      content:
        application/json:
          schema:
            $ref: ./definitions/SOL005NSFaultManagementNotification_def.yaml#/definitions/AlarmClearedNotification
      required: true

    AlarmListRebuiltNotificationRequest:
      description: |
        Information that the alarm list has been rebuilt by the NFVO.
      content:
        application/json:
          schema:
            $ref: ./definitions/SOL005NSFaultManagementNotification_def.yaml#/definitions/AlarmListRebuiltNotification
      required: true

  responses:
    AlarmNotification.Get:
      description: |
        204 No Content
        Shall be returned when the notification endpoint has been tested successfully. The response body shall be empty.
      headers:
        Version:
          description: |
            Version of the API used in the response.
          style: simple
          explode: false
          schema:
            type: string
        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.
          style: simple
          explode: false
          schema:
            type: string
      content: {}

    AlarmNotification.Post:
      description: |
        204 No Content
        Shall be returned when the notification has been delivered successfully. The response body shall be empty.
      headers:
        Version:
          description: |
            Version of the API used in the response.
          style: simple
          explode: false
          schema:
            type: string
        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.
          style: simple
          explode: false
          schema:
            type: string
      content: {}

    AlarmClearedNotification.Get:
      description: |
        204 No Content
        Shall be returned when the notification endpoint has been tested successfully. The response body shall be empty.
      headers:
        Version:
          description: |
            Version of the API used in the response.
          style: simple
          explode: false
          schema:
            type: string
        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.
          style: simple
          explode: false
          schema:
            type: string
      content: {}

    AlarmClearedNotification.Post:
      description: |
        204 No Content
        The notification was delivered successfully. The response body shall be empty.
      headers:
        Version:
          description: |
            Version of the API used in the response.
          style: simple
          explode: false
          schema:
            type: string
        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.
          style: simple
          explode: false
          schema:
            type: string
      content: {}
311

312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
    AlarmListRebuiltNotification.Get:
      description: |
        204 No Content
        Shall be returned when the notification endpoint has been tested successfully. The response body shall be empty.
      headers:
        Version:
          description: |
            Version of the API used in the response.
          style: simple
          explode: false
          schema:
            type: string
        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.
          style: simple
          explode: false
          schema:
            type: string
      content: {}

    AlarmListRebuiltNotification.Post:
      description: |
        204 No Content
        The notification was delivered successfully. The response body shall be empty.
      headers:
        Version:
          description: |
            Version of the API used in the response.
          style: simple
          explode: false
          schema:
            type: string
        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.
          style: simple
          explode: false
          schema:
            type: string
      content: {}