VNFFaultManagement.yaml 26.8 KB
Newer Older
1
openapi: 3.0.2
2

3
info:
4
  title: SOL002 - VNF Fault Management interface
5 6 7 8
  description: |
    SOL002 - VNF Fault Management interface IMPORTANT: Please note that this file might be not aligned to the current
    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.
9
    Please report bugs to https://forge.etsi.org/bugzilla/buglist.cgi?component=Nfv-Openapis
10 11
  contact:
    name: NFV-SOL WG
12
  license:
13
    name: ETSI Forge copyright notice
14
    url: https://forge.etsi.org/etsi-forge-copyright-notice.txt
15
  version: 1.3.0-impl:etsi.org:ETSI_NFV_OpenAPI:1
16

17
externalDocs:
18
  description: ETSI GS NFV-SOL 002 V3.3.1
19
  url: https://www.etsi.org/deliver/etsi_gs/NFV-SOL/001_099/002/02.07.01_60/gs_nfv-sol002v020701p.pdf
20

21 22 23
servers:
  - url: http://127.0.0.1/vnffm/v1
  - url: https://127.0.0.1/vnffm/v1
24 25

paths:
26
  /api_versions:
27
    $ref: '../../endpoints/SOL002SOL003_endpoints.yaml#/endpoints/api-versions'
28

29
  /alarms:
30
    parameters:
31 32
      - $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/Version
      - $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/Authorization
33
    get:
34 35
      description: |
        The client can use this method to retrieve information about the alarm list.
36
      parameters:
37 38 39 40
        - $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/Accept
        - $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/ContentType
        - $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/filter
        - $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/nextpage_opaque_marker
41
      responses:
42 43 44
        "200":
          $ref: '#/components/responses/Alarms.Get'
        "400":
f.moscatelli's avatar
f.moscatelli committed
45
          $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/400
46
        "401":
f.moscatelli's avatar
f.moscatelli committed
47
          $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/401
48
        "403":
f.moscatelli's avatar
f.moscatelli committed
49
          $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/403
50
        "404":
f.moscatelli's avatar
f.moscatelli committed
51
          $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/404
52
        "405":
f.moscatelli's avatar
f.moscatelli committed
53
          $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/405
54
        "406":
f.moscatelli's avatar
f.moscatelli committed
55
          $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/406
56
        "416":
f.moscatelli's avatar
f.moscatelli committed
57
          $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/416
58
        "422":
f.moscatelli's avatar
f.moscatelli committed
59
          $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/422
60
        "429":
f.moscatelli's avatar
f.moscatelli committed
61
          $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/429
62
        "500":
f.moscatelli's avatar
f.moscatelli committed
63
          $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/500
64
        "503":
f.moscatelli's avatar
f.moscatelli committed
65
          $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/503
66
        "504":
f.moscatelli's avatar
f.moscatelli committed
67
          $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/504
68

69
  /alarms/{alarmId}:
70
    parameters:
71 72 73
      - $ref: '#/components/parameters/AlarmId'
      - $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/Version
      - $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/Authorization
74
    get:
75
      description: |
76 77
        The client can use this method to read an individual alarm.
      parameters:
78 79
        - $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/Accept
        - $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/ContentType
80
      responses:
81 82 83
        "200":
          $ref: '#/components/responses/IndividualAlarm.Get'
        "400":
f.moscatelli's avatar
f.moscatelli committed
84
          $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/400
85
        "401":
f.moscatelli's avatar
f.moscatelli committed
86
          $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/401
87
        "403":
f.moscatelli's avatar
f.moscatelli committed
88
          $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/403
89
        "404":
f.moscatelli's avatar
f.moscatelli committed
90
          $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/404
91
        "405":
f.moscatelli's avatar
f.moscatelli committed
92
          $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/405
93
        "406":
f.moscatelli's avatar
f.moscatelli committed
94
          $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/406
95
        "416":
f.moscatelli's avatar
f.moscatelli committed
96
          $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/416
97
        "422":
f.moscatelli's avatar
f.moscatelli committed
98
          $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/422
99
        "429":
f.moscatelli's avatar
f.moscatelli committed
100
          $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/429
101
        "500":
f.moscatelli's avatar
f.moscatelli committed
102
          $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/500
103
        "503":
f.moscatelli's avatar
f.moscatelli committed
104
          $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/503
105
        "504":
f.moscatelli's avatar
f.moscatelli committed
106
          $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/504
107

108
    patch:
109
      description: |
110 111
        This method modifies an individual alarm resource.
      parameters:
112 113 114 115
        - $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/Accept
        - $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/ContentType
      requestBody:
        $ref: '#/components/requestBodies/IndividualAlarmRequest'
116
      responses:
117 118 119
        "200":
          $ref: '#/components/responses/IndividualAlarm.Patch'
        "400":
f.moscatelli's avatar
f.moscatelli committed
120
          $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/400
121
        "401":
f.moscatelli's avatar
f.moscatelli committed
122
          $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/401
123
        "403":
f.moscatelli's avatar
f.moscatelli committed
124
          $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/403
125
        "404":
f.moscatelli's avatar
f.moscatelli committed
126
          $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/404
127
        "405":
f.moscatelli's avatar
f.moscatelli committed
128
          $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/405
129
        "406":
f.moscatelli's avatar
f.moscatelli committed
130
          $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/406
131
        "409":
f.moscatelli's avatar
f.moscatelli committed
132
          $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/409
133
        "412":
f.moscatelli's avatar
f.moscatelli committed
134
          $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/412
135
        "416":
f.moscatelli's avatar
f.moscatelli committed
136
          $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/416
137
        "422":
f.moscatelli's avatar
f.moscatelli committed
138
          $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/422
139
        "429":
f.moscatelli's avatar
f.moscatelli committed
140
          $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/429
141
        "500":
f.moscatelli's avatar
f.moscatelli committed
142
          $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/500
143
        "503":
f.moscatelli's avatar
f.moscatelli committed
144
          $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/503
145
        "504":
f.moscatelli's avatar
f.moscatelli committed
146
          $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/504
147

148
  /alarms/{alarmId}/escalate:
149
    parameters:
150 151 152
      - $ref: '#/components/parameters/AlarmId'
      - $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/Version
      - $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/Authorization
153
    post:
154 155 156 157 158 159
      description: |
        The POST method enables the consumer to escalate the perceived severity of an alarm that is represented by an
        individual alarm resource. As the result of successfully executing this method, a new "Individual  subscription"
        resource as defined in clause 7.4.5 shall have been created.  This method shall not trigger any notification.
      requestBody:
        $ref: '#/components/requestBodies/IndividualAlarmEscalateRequest'
160
      responses:
161 162 163
        "200":
          $ref: '#/components/responses/IndividualAlarmEscalate.Post'
        "400":
f.moscatelli's avatar
f.moscatelli committed
164
          $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/400
165
        "401":
f.moscatelli's avatar
f.moscatelli committed
166
          $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/401
167
        "403":
f.moscatelli's avatar
f.moscatelli committed
168
          $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/403
169
        "404":
f.moscatelli's avatar
f.moscatelli committed
170
          $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/404
171
        "405":
f.moscatelli's avatar
f.moscatelli committed
172
          $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/405
173
        "406":
f.moscatelli's avatar
f.moscatelli committed
174
          $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/406
175
        "416":
f.moscatelli's avatar
f.moscatelli committed
176
          $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/416
177
        "422":
f.moscatelli's avatar
f.moscatelli committed
178
          $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/422
179
        "429":
f.moscatelli's avatar
f.moscatelli committed
180
          $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/429
181
        "500":
f.moscatelli's avatar
f.moscatelli committed
182
          $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/500
183
        "503":
f.moscatelli's avatar
f.moscatelli committed
184
          $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/503
185
        "504":
f.moscatelli's avatar
f.moscatelli committed
186
          $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/504
187

188
  /subscriptions:
189
    parameters:
190 191 192 193 194 195 196 197 198 199 200 201 202 203 204
      - $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/Version
      - $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/Authorization
    get:
      description: |
        The client can use this method to retrieve the list of active subscriptions for VNF alarms subscribed by the
        client. It can be used e.g. for resynchronization after error situations.
      parameters:
        - $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/Accept
        - $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/ContentType
        - $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/filter
        - $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/nextpage_opaque_marker
      responses:
        "200":
          $ref: '#/components/responses/Subscriptions.Get'
        "400":
f.moscatelli's avatar
f.moscatelli committed
205
          $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/400
206
        "401":
f.moscatelli's avatar
f.moscatelli committed
207
          $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/401
208
        "403":
f.moscatelli's avatar
f.moscatelli committed
209
          $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/403
210
        "404":
f.moscatelli's avatar
f.moscatelli committed
211
          $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/404
212
        "405":
f.moscatelli's avatar
f.moscatelli committed
213
          $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/405
214
        "406":
f.moscatelli's avatar
f.moscatelli committed
215
          $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/406
216
        "416":
f.moscatelli's avatar
f.moscatelli committed
217
          $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/416
218
        "422":
f.moscatelli's avatar
f.moscatelli committed
219
          $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/422
220
        "429":
f.moscatelli's avatar
f.moscatelli committed
221
          $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/429
222
        "500":
f.moscatelli's avatar
f.moscatelli committed
223
          $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/500
224
        "503":
f.moscatelli's avatar
f.moscatelli committed
225
          $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/503
226
        "504":
f.moscatelli's avatar
f.moscatelli committed
227
          $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/504
228

229
    post:
230
      description: |
231 232
        The POST method creates a new subscription.
      parameters:
233 234 235 236
        - $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/Accept
        - $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/ContentType
      requestBody:
        $ref: '#/components/requestBodies/FmSubscriptionRequest'
237
      responses:
238 239 240
        "201":
          $ref: '#/components/responses/Subscriptions.Post'
        "303":
f.moscatelli's avatar
f.moscatelli committed
241
          $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/303
242
        "400":
f.moscatelli's avatar
f.moscatelli committed
243
          $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/400
244
        "401":
f.moscatelli's avatar
f.moscatelli committed
245
          $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/401
246
        "403":
f.moscatelli's avatar
f.moscatelli committed
247
          $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/403
248
        "404":
f.moscatelli's avatar
f.moscatelli committed
249
          $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/404
250
        "405":
f.moscatelli's avatar
f.moscatelli committed
251
          $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/405
252
        "406":
f.moscatelli's avatar
f.moscatelli committed
253
          $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/406
254
        "416":
f.moscatelli's avatar
f.moscatelli committed
255
          $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/416
256
        "422":
f.moscatelli's avatar
f.moscatelli committed
257
          $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/422
258
        "429":
f.moscatelli's avatar
f.moscatelli committed
259
          $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/429
260
        "500":
f.moscatelli's avatar
f.moscatelli committed
261
          $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/500
262
        "503":
f.moscatelli's avatar
f.moscatelli committed
263
          $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/503
264
        "504":
f.moscatelli's avatar
f.moscatelli committed
265
          $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/504
266

267 268 269 270 271
  /subscriptions/{subscriptionId}:
    parameters:
      - $ref: '#/components/parameters/SubscriptionId'
      - $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/Version
      - $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/Authorization
272
    get:
273 274
      description: |
        The client can use this method for reading an individual subscription for VNF alarms subscribed by the client.
275
      parameters:
276 277 278 279 280 281
        - $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/Accept
        - $ref: ../../components/SOL002SOL003_params.yaml#/components/parameters/ContentType
      responses:
        "200":
          $ref: '#/components/responses/IndividualSubscription.Get'
        "400":
f.moscatelli's avatar
f.moscatelli committed
282
          $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/400
283
        "401":
f.moscatelli's avatar
f.moscatelli committed
284
          $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/401
285
        "403":
f.moscatelli's avatar
f.moscatelli committed
286
          $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/403
287
        "404":
f.moscatelli's avatar
f.moscatelli committed
288
          $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/404
289
        "405":
f.moscatelli's avatar
f.moscatelli committed
290
          $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/405
291
        "406":
f.moscatelli's avatar
f.moscatelli committed
292
          $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/406
293
        "416":
f.moscatelli's avatar
f.moscatelli committed
294
          $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/416
295
        "422":
f.moscatelli's avatar
f.moscatelli committed
296
          $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/422
297
        "429":
f.moscatelli's avatar
f.moscatelli committed
298
          $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/429
299
        "500":
f.moscatelli's avatar
f.moscatelli committed
300
          $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/500
301
        "503":
f.moscatelli's avatar
f.moscatelli committed
302
          $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/503
303
        "504":
f.moscatelli's avatar
f.moscatelli committed
304
          $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/504
305

306 307 308 309 310 311 312 313 314 315 316 317 318
    delete:
      description: |
        This method terminates an individual subscription. As the result
        of successfully executing this method, the "Individual  subscription"
        resource shall not exist any longer. This means that no  notifications for
        that subscription shall be sent to the  formerly-subscribed API consumer.
        NOTE: Due to race conditions, some notifications might still be  received
        by the formerly-subscribed API consumer for a certain time  period after
        the deletion.
      responses:
        "204":
          $ref: '#/components/responses/IndividualSubscription.Delete'
        "400":
f.moscatelli's avatar
f.moscatelli committed
319
          $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/400
320
        "401":
f.moscatelli's avatar
f.moscatelli committed
321
          $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/401
322
        "403":
f.moscatelli's avatar
f.moscatelli committed
323
          $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/403
324
        "404":
f.moscatelli's avatar
f.moscatelli committed
325
          $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/404
326
        "405":
f.moscatelli's avatar
f.moscatelli committed
327
          $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/405
328
        "406":
f.moscatelli's avatar
f.moscatelli committed
329
          $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/406
330
        "416":
f.moscatelli's avatar
f.moscatelli committed
331
          $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/416
332
        "422":
f.moscatelli's avatar
f.moscatelli committed
333
          $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/422
334
        "429":
f.moscatelli's avatar
f.moscatelli committed
335
          $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/429
336
        "500":
f.moscatelli's avatar
f.moscatelli committed
337
          $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/500
338
        "503":
f.moscatelli's avatar
f.moscatelli committed
339
          $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/503
340
        "504":
f.moscatelli's avatar
f.moscatelli committed
341
          $ref: ../../responses/SOL002SOL003_resp.yaml#/components/responses/504
342

343 344 345 346 347 348 349 350 351 352 353 354 355 356
components:
  parameters:
    AlarmId:
      name: alarmId
      in: path
      description: |
        Identifier of the alarm. This identifier can be retrieved from the "id" attribute of the "alarm" attribute
        in the AlarmNotification or AlarmClearedNotification. It can also be retrieved from the "id" attribute of
        the applicable array element in the payload body of the response to a GET request to the "Alarms" resource.
      required: true
      style: simple
      explode: false
      schema:
        type: string
357

358 359 360 361 362 363 364 365 366 367 368 369
    SubscriptionId:
      name: subscriptionId
      in: path
      description: |
        Identifier of this subscription. This identifier can be retrieved from the resource referenced by the "Location"
        HTTP header in the response to a POST request creating a new subscription resource. It can also be retrieved
        from the "id" attribute in the payload body of that response.
      required: true
      style: simple
      explode: false
      schema:
        type: string
370

371 372 373 374 375 376 377 378
  requestBodies:
    IndividualAlarmRequest:
      description: The parameter for the alarm modification
      content:
        application/json:
          schema:
            $ref: ../../definitions/SOL002SOL003VNFFaultManagement_def.yaml#/definitions/AlarmModifications
      required: true
379

380 381 382 383 384 385 386
    IndividualAlarmEscalateRequest:
      description: The proposed "escalated perceived severity" value
      content:
        application/json:
          schema:
            $ref: ./definitions/SOL002VNFFaultManagement_def.yaml#/definitions/PerceivedSeverityRequest
      required: false
387

388 389 390 391 392 393 394
    FmSubscriptionRequest:
      description: The VNF creation parameters
      content:
        application/json:
          schema:
            $ref: ../../definitions/SOL002SOL003VNFFaultManagement_def.yaml#/definitions/FmSubscriptionRequest
      required: true
395

396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499
  responses:
    Alarms.Get:
      description: |
        200 OK
        Shall be returned when information about zero or more alarms was queried successfully. The response body shall
        contain in an array the representations of zero or more alarms as defined in clause 7.5.2.4. If the "filter"
        URI parameter was supplied in the request, the data in the response body  shall have been transformed according
        to the rules specified in clause 5.2.2 of  ETSI GS NFV-SOL 013. If the VNFM supports alternative 2 (paging)
        according to clause 5.4.2.1 of  ETSI GS NFV-SOL 013for this resource, inclusion of the Link HTTP header in this
        response  shall follow the provisions in clause 5.4.2.3 of ETSI GS NFV-SOL 013.
      headers:
        Version:
          description: The used API version.
          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
        Link:
          description: |
            Reference to other resources. Used for paging in the present document, see clause 4.7.2.1.
          style: simple
          explode: false
          schema:
            type: string
        Content-Type:
          description: The MIME type of the body of the response.
          style: simple
          explode: false
          schema:
            type: string
      content:
        application/json:
          schema:
            $ref: ./definitions/SOL002VNFFaultManagement_def.yaml#/definitions/Alarm

    IndividualAlarm.Get:
      description: |
        200 OK
        Shall be returned when information about an individual alarm read  successfully. The response body shall contain
        a representation of the individual alarm.
      headers:
        Version:
          description: The used API version.
          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-Type:
          description: The MIME type of the body of the response.
          style: simple
          explode: false
          schema:
            type: string
      content:
        application/json:
          schema:
            $ref: ./definitions/SOL002VNFFaultManagement_def.yaml#/definitions/Alarm

    IndividualAlarm.Patch:
      description: |
        200 OK
        Shall be returned when the request was accepted and completed.  The response body shall contain attribute
        modifications for  an "Individual alarm" resource.
      headers:
        Version:
          description: The used API version.
          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-Type:
          description: The MIME type of the body of the response.
          style: simple
          explode: false
          schema:
            type: string
      content:
        application/json:
          schema:
            $ref: ../../definitions/SOL002SOL003VNFFaultManagement_def.yaml#/definitions/AlarmModifications
500

501 502 503 504 505 506 507 508 509 510 511 512
    IndividualAlarmEscalate.Post:
      description: |
        204 No Content
        Shall be returned when the VNFM has received the proposed "escalated  perceived severity" value successfully.
        The response body shall be empty.
      headers:
        Version:
          description: The used API version.
          style: simple
          explode: false
          schema:
            type: string
513
      content: {}
514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646

    Subscriptions.Get:
      description: |
        200 OK
        The list of subscriptions has been queried successfully. The response body shall contain the representations of
        all active subscriptions of the functional block that invokes the method. If the "filter" URI parameter was
        supplied in the request, the data  in the response body shall have been transformed according to the  rules
        specified in clause 5.2.2 of ETSI GS NFV-SOL 013. If the VNFM supports alternative 2 (paging) according to
        clause 5.4.2.1 of ETSI GS NFV-SOL 013 for this resource, inclusion of the  Link HTTP header in this response
        shall follow the provisions in  clause 5.4.2.3 of ETSI GS NFV-SOL 013.
      headers:
        Version:
          description: The used API version.
          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
        Link:
          description: |
            Reference to other resources. Used for paging in the present document, see clause 4.7.2.1.
          style: simple
          explode: false
          schema:
            type: string
        Content-Type:
          description: The MIME type of the body of the response.
          style: simple
          explode: false
          schema:
            type: string
      content:
        application/json:
          schema:
            $ref: ../../definitions/SOL002SOL003VNFFaultManagement_def.yaml#/definitions/FmSubscription

    Subscriptions.Post:
      description: |
        201 CREATED
        The subscription was created successfully. The response body shall contain a representation of the created
        subscription resource. The HTTP response shall include a "Location:" HTTP header that points to the created
        subscription resource.
      headers:
        Version:
          description: The used API version.
          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-Type:
          description: The MIME type of the body of the response.
          style: simple
          explode: false
          schema:
            type: string
        Location:
          description: |
            The resource URI of the created subscription resource.
          style: simple
          explode: false
          schema:
            type: string
            format: url
      content:
        application/json:
          schema:
            $ref: ../../definitions/SOL002SOL003VNFFaultManagement_def.yaml#/definitions/FmSubscription

    IndividualSubscription.Get:
      description: |
        200 OK
        Shall be returned when information about an individual subscription  has been read successfully. The response body shall contain a representation of the "Individual  subscription" resource.
      headers:
        Version:
          description: The used API version.
          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-Type:
          description: The MIME type of the body of the response.
          style: simple
          explode: false
          schema:
            type: string
      content:
        application/json:
          schema:
            $ref: ../../definitions/SOL002SOL003VNFFaultManagement_def.yaml#/definitions/FmSubscription

    IndividualSubscription.Delete:
      description: |
        204 NO CONTENT
        Shall be returned when the "Individual subscription" resource has  been deleted successfully.
        The response body shall be empty.
      headers:
        Version:
          description: The used API version.
          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: {}