NFVManoFaultManagement.yaml 29.3 KB
Newer Older
1
2
3
4
5
6
7
8
9
10
11
12
13
14
openapi: 3.0.2
info:
  version: 1.0.0-impl:etsi.org:ETSI_NFV_OpenAPI:1
  title: SOL009 - NFV-MANO Fault Management interface
  description: >
    SOL009 - NFV-MANO 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. In case of discrepancies the published ETSI Group Specification takes precedence.

    Please report bugs to https://forge.etsi.org/bugzilla/buglist.cgi?component=Nfv-Openapis&list_id=61&product=NFV&resolution=
  license:
    name: ETSI Forge copyright notice
    url: https://forge.etsi.org/etsi-forge-copyright-notice.txt
externalDocs:
Giacomo Bernini's avatar
Giacomo Bernini committed
15
16
  description: ETSI GS NFV-SOL 009 V3.3.1
  url: https://www.etsi.org/deliver/etsi_gs/NFV-SOL/001_099/009/03.03.01_60/gs_NFV-SOL009v030301p.pdf
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32

servers:
  - url: http://127.0.0.1/nfvmanofm/v1
  - url: https://127.0.0.1/nfvmanofm/v1

paths:
  /api_versions:
    $ref: ../endpoints/SOL009_endpoints.yaml#/endpoints/api_versions
  /alarms:
    get:
      description: >
        Get Alarm List. The client can use this method to retrieve information
        about the alarm list. This method shall follow the provisions specified
        in the tables 7.5.3.3.2-1 and 7.5.3.3.2-2 for URI query parameters,
        request and response data structures, and response codes.
      parameters:
33
34
35
36
37
        - $ref: "../components/SOL009_params.yaml#/components/parameters/Version"
        - $ref: "../components/SOL009_params.yaml#/components/parameters/Accept"
        - $ref: "../components/SOL009_params.yaml#/components/parameters/Authorization"
        - $ref: "../components/SOL009_params.yaml#/components/parameters/filter"
        - $ref: "../components/SOL009_params.yaml#/components/parameters/nextpage_opaque_marker"
38
39
      responses:
        "200":
Giacomo Bernini's avatar
Giacomo Bernini committed
40
          $ref: '#/components/responses/Alarms.get'
41
        "400":
Giacomo Bernini's avatar
Giacomo Bernini committed
42
          $ref: ../components/SOL009_resp.yaml#/components/responses/400
43
        "401":
Giacomo Bernini's avatar
Giacomo Bernini committed
44
          $ref: ../components/SOL009_resp.yaml#/components/responses/401
45
        "403":
Giacomo Bernini's avatar
Giacomo Bernini committed
46
          $ref: ../components/SOL009_resp.yaml#/components/responses/403
47
        "404":
Giacomo Bernini's avatar
Giacomo Bernini committed
48
          $ref: ../components/SOL009_resp.yaml#/components/responses/404
49
        "405":
Giacomo Bernini's avatar
Giacomo Bernini committed
50
          $ref: ../components/SOL009_resp.yaml#/components/responses/405
51
        "406":
Giacomo Bernini's avatar
Giacomo Bernini committed
52
          $ref: ../components/SOL009_resp.yaml#/components/responses/406
53
        "422":
Giacomo Bernini's avatar
Giacomo Bernini committed
54
          $ref: ../components/SOL009_resp.yaml#/components/responses/422
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
        "504":
Giacomo Bernini's avatar
Giacomo Bernini committed
60
          $ref: ../components/SOL009_resp.yaml#/components/responses/504
61
62
  "/alarms/{alarmId}":
    parameters:
63
      - $ref: "#/components/parameters/alarmId"
64
65
66
67
68
69
70
    get:
      description: >
        The client can use this method to read an individual alarm. This method
        shall follow the provisions specified in the tables 7.5.4.3.2-1 and
        7.5.4.3.2-2 for URI query parameters, request and response data
        structures, and response codes.
      parameters:
71
72
73
        - $ref: "../components/SOL009_params.yaml#/components/parameters/Version"
        - $ref: "../components/SOL009_params.yaml#/components/parameters/Accept"
        - $ref: "../components/SOL009_params.yaml#/components/parameters/Authorization"
74
75
      responses:
        "200":
Giacomo Bernini's avatar
Giacomo Bernini committed
76
          $ref: '#/components/responses/Alarm.get'
77
        "400":
Giacomo Bernini's avatar
Giacomo Bernini committed
78
          $ref: ../components/SOL009_resp.yaml#/components/responses/400
79
        "401":
Giacomo Bernini's avatar
Giacomo Bernini committed
80
          $ref: ../components/SOL009_resp.yaml#/components/responses/401
81
        "403":
Giacomo Bernini's avatar
Giacomo Bernini committed
82
          $ref: ../components/SOL009_resp.yaml#/components/responses/403
83
        "404":
Giacomo Bernini's avatar
Giacomo Bernini committed
84
          $ref: ../components/SOL009_resp.yaml#/components/responses/404
85
        "405":
Giacomo Bernini's avatar
Giacomo Bernini committed
86
          $ref: ../components/SOL009_resp.yaml#/components/responses/405
87
        "406":
Giacomo Bernini's avatar
Giacomo Bernini committed
88
          $ref: ../components/SOL009_resp.yaml#/components/responses/406
89
        "422":
Giacomo Bernini's avatar
Giacomo Bernini committed
90
          $ref: ../components/SOL009_resp.yaml#/components/responses/422
91
        "500":
Giacomo Bernini's avatar
Giacomo Bernini committed
92
          $ref: ../components/SOL009_resp.yaml#/components/responses/500
93
        "503":
Giacomo Bernini's avatar
Giacomo Bernini committed
94
          $ref: ../components/SOL009_resp.yaml#/components/responses/503
95
        "504":
Giacomo Bernini's avatar
Giacomo Bernini committed
96
          $ref: ../components/SOL009_resp.yaml#/components/responses/504
97
98
99
100
101
102
103
    patch:
      description: >
        This method modifies an "Individual alarm" resource. This method shall
        follow the provisions specified in the tables 7.5.4.3.4-1 and
        7.5.4.3.4-2 for URI query parameters, request and response data
        structures, and response codes.
      parameters:
104
105
106
107
        - $ref: "../components/SOL009_params.yaml#/components/parameters/Version"
        - $ref: "../components/SOL009_params.yaml#/components/parameters/Accept"
        - $ref: "../components/SOL009_params.yaml#/components/parameters/Authorization"
        - $ref: "../components/SOL009_params.yaml#/components/parameters/ContentType"
108
      requestBody:
Giacomo Bernini's avatar
Giacomo Bernini committed
109
        $ref: "#/components/requestBodies/AlarmModifications"
110
111
      responses:
        "200":
Giacomo Bernini's avatar
Giacomo Bernini committed
112
          $ref: '#/components/responses/Alarm.patch'
113
        "400":
Giacomo Bernini's avatar
Giacomo Bernini committed
114
          $ref: ../components/SOL009_resp.yaml#/components/responses/400
115
        "401":
Giacomo Bernini's avatar
Giacomo Bernini committed
116
          $ref: ../components/SOL009_resp.yaml#/components/responses/401
117
        "403":
Giacomo Bernini's avatar
Giacomo Bernini committed
118
          $ref: ../components/SOL009_resp.yaml#/components/responses/403
119
        "404":
Giacomo Bernini's avatar
Giacomo Bernini committed
120
          $ref: ../components/SOL009_resp.yaml#/components/responses/404
121
        "405":
Giacomo Bernini's avatar
Giacomo Bernini committed
122
          $ref: ../components/SOL009_resp.yaml#/components/responses/405
123
        "406":
Giacomo Bernini's avatar
Giacomo Bernini committed
124
          $ref: ../components/SOL009_resp.yaml#/components/responses/406
125
        "409":
Giacomo Bernini's avatar
Giacomo Bernini committed
126
          $ref: ../components/SOL009_resp.yaml#/components/responses/409
127
        "412":
Giacomo Bernini's avatar
Giacomo Bernini committed
128
          $ref: ../components/SOL009_resp.yaml#/components/responses/412
129
        "422":
Giacomo Bernini's avatar
Giacomo Bernini committed
130
          $ref: ../components/SOL009_resp.yaml#/components/responses/422
131
        "500":
Giacomo Bernini's avatar
Giacomo Bernini committed
132
          $ref: ../components/SOL009_resp.yaml#/components/responses/500
133
        "503":
Giacomo Bernini's avatar
Giacomo Bernini committed
134
          $ref: ../components/SOL009_resp.yaml#/components/responses/503
135
        "504":
Giacomo Bernini's avatar
Giacomo Bernini committed
136
          $ref: ../components/SOL009_resp.yaml#/components/responses/504
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
  /subscriptions:
    post:
      description: >
        Subscribe. The POST method creates a new subscription. This method shall
        follow the provisions specified in the tables 7.5.5.3.1-1 and
        7.5.5.3.1-2 for URI query parameters, request and response data
        structures, and response codes. As the result of successfully executing
        this method, a new "Individual subscription" resource as defined in
        clause 7.5.6 shall have been created. This method shall not trigger any
        notification. Creation of two "Individual subscription" resources with
        the same callbackURI and the same filter can result in performance
        degradation and will provide duplicates of notifications to the API
        consumer, and might make sense only in very rare use cases.
        Consequently, the NFV-MANO functional entity may either allow creating a
        new "Individual subscription" resource if another "Individual
        subscription" resource with the same filter and callbackUri already
        exists (in which case it shall return the "201 Created" response code),
        or may decide to not create a duplicate "Individual subscription"
        resource (in which case it shall return a "303 See Other" response code
        referencing the existing "Individual subscription" resource with the
        same filter and callbackUri).
      parameters:
159
160
161
162
        - $ref: "../components/SOL009_params.yaml#/components/parameters/Version"
        - $ref: "../components/SOL009_params.yaml#/components/parameters/Accept"
        - $ref: "../components/SOL009_params.yaml#/components/parameters/Authorization"
        - $ref: "../components/SOL009_params.yaml#/components/parameters/ContentType"
163
      requestBody:
Giacomo Bernini's avatar
Giacomo Bernini committed
164
        $ref: "#/components/requestBodies/FmSubscriptionRequest"
165
166
      responses:
        "201":
Giacomo Bernini's avatar
Giacomo Bernini committed
167
          $ref: '#/components/responses/Subscriptions.post'
168
        "303":
Giacomo Bernini's avatar
Giacomo Bernini committed
169
          $ref: ../components/SOL009_resp.yaml#/components/responses/303
170
        "400":
Giacomo Bernini's avatar
Giacomo Bernini committed
171
          $ref: ../components/SOL009_resp.yaml#/components/responses/400
172
        "401":
Giacomo Bernini's avatar
Giacomo Bernini committed
173
          $ref: ../components/SOL009_resp.yaml#/components/responses/401
174
        "403":
Giacomo Bernini's avatar
Giacomo Bernini committed
175
          $ref: ../components/SOL009_resp.yaml#/components/responses/403
176
        "404":
Giacomo Bernini's avatar
Giacomo Bernini committed
177
          $ref: ../components/SOL009_resp.yaml#/components/responses/404
178
        "405":
Giacomo Bernini's avatar
Giacomo Bernini committed
179
          $ref: ../components/SOL009_resp.yaml#/components/responses/405
180
        "406":
Giacomo Bernini's avatar
Giacomo Bernini committed
181
          $ref: ../components/SOL009_resp.yaml#/components/responses/406
182
        "422":
Giacomo Bernini's avatar
Giacomo Bernini committed
183
          $ref: ../components/SOL009_resp.yaml#/components/responses/422
184
        "500":
Giacomo Bernini's avatar
Giacomo Bernini committed
185
          $ref: ../components/SOL009_resp.yaml#/components/responses/500
186
        "503":
Giacomo Bernini's avatar
Giacomo Bernini committed
187
          $ref: ../components/SOL009_resp.yaml#/components/responses/503
188
        "504":
Giacomo Bernini's avatar
Giacomo Bernini committed
189
          $ref: ../components/SOL009_resp.yaml#/components/responses/504
190
191
192
193
194
195
196
197
198
    get:
      description: >
        Query Subscription Information

        The client can use this method to retrieve the list of active subscriptions for NFV-MANO functional entity
        alarms subscribed by the client. It can be used e.g. for resynchronization after error situations. This method
        shall follow the provisions specified in the tables 7.5.5.3.2-1 and 7.5.5.3.2-2 for URI query parameters,
        request and response data structures, and response codes.
      parameters:
199
200
201
202
203
        - $ref: "../components/SOL009_params.yaml#/components/parameters/Version"
        - $ref: "../components/SOL009_params.yaml#/components/parameters/Accept"
        - $ref: "../components/SOL009_params.yaml#/components/parameters/Authorization"
        - $ref: "../components/SOL009_params.yaml#/components/parameters/filter"
        - $ref: "../components/SOL009_params.yaml#/components/parameters/nextpage_opaque_marker"
204
205
      responses:
        "200":
Giacomo Bernini's avatar
Giacomo Bernini committed
206
          $ref: '#/components/responses/Subscriptions.get'
207
        "400":
Giacomo Bernini's avatar
Giacomo Bernini committed
208
          $ref: ../components/SOL009_resp.yaml#/components/responses/400
209
        "401":
Giacomo Bernini's avatar
Giacomo Bernini committed
210
          $ref: ../components/SOL009_resp.yaml#/components/responses/401
211
        "403":
Giacomo Bernini's avatar
Giacomo Bernini committed
212
          $ref: ../components/SOL009_resp.yaml#/components/responses/403
213
        "404":
Giacomo Bernini's avatar
Giacomo Bernini committed
214
          $ref: ../components/SOL009_resp.yaml#/components/responses/404
215
        "405":
Giacomo Bernini's avatar
Giacomo Bernini committed
216
          $ref: ../components/SOL009_resp.yaml#/components/responses/405
217
        "406":
Giacomo Bernini's avatar
Giacomo Bernini committed
218
          $ref: ../components/SOL009_resp.yaml#/components/responses/406
219
        "422":
Giacomo Bernini's avatar
Giacomo Bernini committed
220
          $ref: ../components/SOL009_resp.yaml#/components/responses/422
221
        "500":
Giacomo Bernini's avatar
Giacomo Bernini committed
222
          $ref: ../components/SOL009_resp.yaml#/components/responses/500
223
        "503":
Giacomo Bernini's avatar
Giacomo Bernini committed
224
          $ref: ../components/SOL009_resp.yaml#/components/responses/503
225
        "504":
Giacomo Bernini's avatar
Giacomo Bernini committed
226
          $ref: ../components/SOL009_resp.yaml#/components/responses/504
227
228
  "/subscriptions/{subscriptionId}":
    parameters:
229
      - $ref: "#/components/parameters/subscriptionId"
230
231
232
233
234
235
236
237
    get:
      description: >
        Query Subscription Information. The client can use this method for
        reading an individual subscription for NFV-MANO functional entity alarms
        subscribed by the client. This method shall follow the provisions
        specified in the tables 7.5.6.3.2-1 and 7.5.6.3.2-2 for URI query
        parameters, request and response data structures, and response codes.
      parameters:
238
239
240
        - $ref: "../components/SOL009_params.yaml#/components/parameters/Version"
        - $ref: "../components/SOL009_params.yaml#/components/parameters/Accept"
        - $ref: "../components/SOL009_params.yaml#/components/parameters/Authorization"
241
242
      responses:
        "200":
Giacomo Bernini's avatar
Giacomo Bernini committed
243
          $ref: '#/components/responses/Subscription.get'
244
        "400":
Giacomo Bernini's avatar
Giacomo Bernini committed
245
          $ref: ../components/SOL009_resp.yaml#/components/responses/400
246
        "401":
Giacomo Bernini's avatar
Giacomo Bernini committed
247
          $ref: ../components/SOL009_resp.yaml#/components/responses/401
248
        "403":
Giacomo Bernini's avatar
Giacomo Bernini committed
249
          $ref: ../components/SOL009_resp.yaml#/components/responses/403
250
        "404":
Giacomo Bernini's avatar
Giacomo Bernini committed
251
          $ref: ../components/SOL009_resp.yaml#/components/responses/404
252
        "405":
Giacomo Bernini's avatar
Giacomo Bernini committed
253
          $ref: ../components/SOL009_resp.yaml#/components/responses/405
254
        "406":
Giacomo Bernini's avatar
Giacomo Bernini committed
255
          $ref: ../components/SOL009_resp.yaml#/components/responses/406
256
        "422":
Giacomo Bernini's avatar
Giacomo Bernini committed
257
          $ref: ../components/SOL009_resp.yaml#/components/responses/422
258
        "500":
Giacomo Bernini's avatar
Giacomo Bernini committed
259
          $ref: ../components/SOL009_resp.yaml#/components/responses/500
260
        "503":
Giacomo Bernini's avatar
Giacomo Bernini committed
261
          $ref: ../components/SOL009_resp.yaml#/components/responses/503
262
        "504":
Giacomo Bernini's avatar
Giacomo Bernini committed
263
          $ref: ../components/SOL009_resp.yaml#/components/responses/504
264
265
266
267
268
269
270
271
272
273
274
275
276
    delete:
      description: >
        Terminate Subscription. This method terminates an individual
        subscription. This method shall follow the provisions specified in the
        tables 7.5.6.3.5-1 and 7.5.6.3.5-2 for URI query parameters, request and
        response data structures, and response codes. 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.
      parameters:
277
278
        - $ref: "../components/SOL009_params.yaml#/components/parameters/Version"
        - $ref: "../components/SOL009_params.yaml#/components/parameters/Authorization"
279
280
      responses:
        "204":
Giacomo Bernini's avatar
Giacomo Bernini committed
281
          $ref: '#/components/responses/Subscription.delete'
282
        "400":
Giacomo Bernini's avatar
Giacomo Bernini committed
283
          $ref: ../components/SOL009_resp.yaml#/components/responses/400
284
        "401":
Giacomo Bernini's avatar
Giacomo Bernini committed
285
          $ref: ../components/SOL009_resp.yaml#/components/responses/401
286
        "403":
Giacomo Bernini's avatar
Giacomo Bernini committed
287
          $ref: ../components/SOL009_resp.yaml#/components/responses/403
288
        "404":
Giacomo Bernini's avatar
Giacomo Bernini committed
289
          $ref: ../components/SOL009_resp.yaml#/components/responses/404
290
        "405":
Giacomo Bernini's avatar
Giacomo Bernini committed
291
          $ref: ../components/SOL009_resp.yaml#/components/responses/405
292
        "406":
Giacomo Bernini's avatar
Giacomo Bernini committed
293
          $ref: ../components/SOL009_resp.yaml#/components/responses/406
294
        "422":
Giacomo Bernini's avatar
Giacomo Bernini committed
295
          $ref: ../components/SOL009_resp.yaml#/components/responses/422
296
        "500":
Giacomo Bernini's avatar
Giacomo Bernini committed
297
          $ref: ../components/SOL009_resp.yaml#/components/responses/500
298
        "503":
Giacomo Bernini's avatar
Giacomo Bernini committed
299
          $ref: ../components/SOL009_resp.yaml#/components/responses/503
300
        "504":
Giacomo Bernini's avatar
Giacomo Bernini committed
301
          $ref: ../components/SOL009_resp.yaml#/components/responses/504
302

303
304
305
306
307
308
309
310
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
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
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
components:
  parameters:
    alarmId:
      name: alarmId
      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.
      in: path
      required: true
      schema:
        type: string
    subscriptionId:
      name: subscriptionId
      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 "Individual subscription" resource.
        It can also be retrieved from the "id" attribute in the payload body
        of that response.
      in: path
      required: true
      schema:
        type: string
  schemas:
    FmSubscriptionRequest:
      description: >
        This type represents a subscription request related to notifications
        about NFV-MANO faults.
      type: object
      required:
        - callbackUri
      properties:
        filter:
          description: >
            Filter settings for this subscription, to define the subset of all
            notifications this subscription relates to. A particular
            notification is sent to the subscriber if the filter matches, or if
            there is no filter.
          $ref: "#/components/schemas/FmNotificationsFilter"
        callbackUri:
          description: >
            The URI of the endpoint to send the notification to.
          $ref: "../components/SOL009_schemas.yaml#/components/schemas/Uri"
        authentication:
          description: >
            Authentication parameters to configure the use of Authorization when sending notifications
            corresponding to this subscription, as defined in clause 8.3.4 of ETSI GS NFV-SOL 013.
            This attribute shall only be present if the subscriber requires authorization of notifications.
          $ref: "../components/SOL009_schemas.yaml#/components/schemas/SubscriptionAuthentication"

    FmSubscription:
      description: >
        This type represents a subscription related to notifications about VNF
        faults.
      type: object
      required:
        - id
        - callbackUri
        - _links
      properties:
        id:
          description: >
            Identifier of this "Individual subscription" resource.
          $ref: "../components/SOL009_schemas.yaml#/components/schemas/Identifier"
        filter:
          description: >
            Filter settings for this subscription, to define the subset of all
            notifications this subscription relates to. A particular
            notification is sent to the subscriber if the filter matches, or if
            there is no filter.
          $ref: "#/components/schemas/FmNotificationsFilter"
        callbackUri:
          description: >
            The URI of the endpoint to send the notification to.
          $ref: "../components/SOL009_schemas.yaml#/components/schemas/Uri"
        _links:
          description: >
            Links for this resource.
          type: object
          required:
            - self
          properties:
            self:
              description: >
                URI of this resource.
              $ref: "../components/SOL009_schemas.yaml#/components/schemas/Link"

    AlarmModifications:
      description: >
        This type represents attribute modifications for an "Individual alarm"
        resource, i.e. modifications to a resource representation based on the
        "Alarm" data type. The attributes of "Alarm" that can be modified
        are included in the "AlarmModifications" data type.
      type: object
      required:
        - ackState
      properties:
        ackState:
          description: >
            New value of the "ackState" attribute in "Alarm".
            Permitted values:
            * ACKNOWLEDGED
          type: string
          enum:
            - ACKNOWLEDGED

    FmNotificationsFilter:
      description: >
        This type represents a subscription filter related to notifications about NFV-MANO functional entity faults.
        It shall comply with the provisions defined in table 7.6.3.2-1. At a particular nesting level in the filter
        structure, the following applies: All attributes shall match in order for the filter to match (logical "and"
        between different filter attributes). If an attribute is an array, the attribute shall match if at least one
        of the values in the array matches (logical "or" between the values of one filter attribute).

      type: object
      properties:
        notificationTypes:
          description: >
            Match particular notification types.
            Permitted values:
            * AlarmNotification
            * AlarmClearedNotification
            * AlarmListRebuiltNotification
            The permitted values of the "notificationTypes" attribute are
            spelled exactly as the names of the notification types to
            facilitate automated code generation systems.
          type: array
          items:
            type: string
            enum:
              - AlarmNotification
              - AlarmClearedNotification
              - AlarmListRebuiltNotification
        perceivedSeverities:
          description: >
            Match VNF alarms with a perceived severity listed in this attribute.
          type: array
          items:
Giacomo Bernini's avatar
fix    
Giacomo Bernini committed
444
            $ref: "../components/SOL009_schemas.yaml#/components/schemas/PerceivedSeverityType"
445
446
447
448
449
        eventTypes:
          description: >
            Match VNF alarms with an event type listed in this attribute.
          type: array
          items:
Giacomo Bernini's avatar
fix    
Giacomo Bernini committed
450
            $ref: "../components/SOL009_schemas.yaml#/components/schemas/EventType"
451
452
453
454
455
456
        probableCauses:
          description: >
            Match VNF alarms with a probable cause listed in this attribute.
          type: array
          items:
            type: string
Giacomo Bernini's avatar
Giacomo Bernini committed
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
500
501
502
503
504
505
506
507
508
509
510
511
512
513
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
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
  requestBodies:
    AlarmModifications:
      description: >
        The parameter for the alarm modification, as defined in clause
        7.6.2.8. The Content-Type header shall be set to
        "application/merge-patch+json" according to IETF RFC 7396.
      content:
        application/json:
          schema:
            $ref: "#/components/schemas/AlarmModifications"
      required: true

    FmSubscriptionRequest:
      description: >
        Details of the subscription to be created, as defined in clause
        7.6.2.2.
      content:
        application/json:
          schema:
            $ref: "#/components/schemas/FmSubscriptionRequest"
      required: true

  responses:
    Alarms.get:
      description: >
        200 OK

        Shall be returned when information about zero or more alarms has been queried successfully.
        The response body shall contain in an array the representations of zero or more alarms as defined
        in clause 7.6.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 NFV-MANO functional entity 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:
        Content-Type:
          description: >
            The MIME type of the body of the request. Reference: IETF RFC
            7231
          schema:
            type: string
            minimum: 1
            maximum: 1
        Version:
          description: |
            Version of the API used in the response.
          schema:
            type: string
            minimum: 1
            maximum: 1
        Link:
          description: >
            Reference to other resources. Used for paging in the present
            document.
          schema:
            type: string
            minimum: 0
            maximum: 1
      content:
        application/json:
          schema:
            type: array
            items:
              $ref: "../components/SOL009_schemas.yaml#/components/schemas/Alarm"

    Alarm.get:
      description: >
        200 OK

        Shall be returned when information about an individual alarm has been read successfully. The response body
        shall contain a representation of the individual alarm
      headers:
        Content-Type:
          description: >
            The MIME type of the body of the request. Reference: IETF RFC
            7231
          schema:
            type: string
            minimum: 1
            maximum: 1
      content:
        application/json:
          schema:
            $ref: "../components/SOL009_schemas.yaml#/components/schemas/Alarm"

    Alarm.patch:
      description: >
        200 OK

        Shall be returned when the request has been accepted and completed. ì The response body shall contain
        attribute modifications for an "Individual alarm" resource (see clause 7.6.2.4).
      headers:
        Content-Type:
          description: >
            The MIME type of the body of the request. Reference: IETF RFC
            7231
          schema:
            type: string
            minimum: 1
            maximum: 1
        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
      content:
        application/json:
          schema:
            $ref: "#/components/schemas/AlarmModifications"

    Subscriptions.post:
      description: >
        201 CREATED

        Shall be returned when the subscription has been created successfully. The response body shall contain a
        representation of the created "Individual subscription" resource. The HTTP response shall include a
        "Location:"" HTTP header that points to the created "Individual subscription" resource.
      headers:
        Content-Type:
          description: >
            The MIME type of the body of the request. Reference: IETF RFC
            7231
          schema:
            type: string
            minimum: 1
            maximum: 1
        Location:
          description: |
            The resource URI of the created subscription resource.
          schema:
            type: string
            format: url
            minimum: 1
            maximum: 1
        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
      content:
        application/json:
          schema:
            $ref: "#/components/schemas/FmSubscription"

    Subscriptions.get:
      description: >
        200 OK

        Shall be returned when the list of subscriptions has been queried successfully. The response body shall
        contain in an array the representations of all active subscriptions of the functional block that invokes
        the method, i.e. zero or more representations of FM subscriptions as defined in clause 7.6.2.3. 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 NFV-MANO
        functional entity 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:
        Content-Type:
          description: >
            The MIME type of the body of the request. Reference: IETF RFC
            7231
          schema:
            type: string
            minimum: 1
            maximum: 1
        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
        Link:
          description: >
            Reference to other resources. Used for paging in the present
            document, see clause 4.7.2.1.
          schema:
            type: string
            minimum: 0
            maximum: 1
      content:
        application/json:
          schema:
            type: array
            items:
              $ref: "#/components/schemas/FmSubscription"

    Subscription.get:
      description: >
        200 OK

        The operation has completed successfully. The response body shall contain a representation of the
        subscription resource.
      headers:
        Content-Type:
          description: >
            The MIME type of the body of the request. Reference: IETF RFC
            7231
          schema:
            type: string
            minimum: 1
            maximum: 1
        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
      content:
        application/json:
          schema:
            $ref: "#/components/schemas/FmSubscription"

    Subscription.delete:
      description: >
        204 NO CONTENT

        Shall be returned when the "Individual subscription" resource has been deleted 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