NFVManoFaultManagement.yaml 29.4 KB
Newer Older
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
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:
  description: ETSI GS NFV-SOL 009 V0.8.0
  url: https://docbox.etsi.org/ISG/NFV/Open/Drafts/SOL009ed331_MANO_mgmt_stage_3/NFV-SOL009ed331v080.zip

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
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
      responses:
        "200":
          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:
79
                  $ref: "../components/SOL009_schemas.yaml#/components/schemas/Alarm"
80
        "400":
Giacomo Bernini's avatar
Giacomo Bernini committed
81
          $ref: ../components/SOL009_resp.yaml#/components/responses/400
82
        "401":
Giacomo Bernini's avatar
Giacomo Bernini committed
83
          $ref: ../components/SOL009_resp.yaml#/components/responses/401
84
        "403":
Giacomo Bernini's avatar
Giacomo Bernini committed
85
          $ref: ../components/SOL009_resp.yaml#/components/responses/403
86
        "404":
Giacomo Bernini's avatar
Giacomo Bernini committed
87
          $ref: ../components/SOL009_resp.yaml#/components/responses/404
88
        "405":
Giacomo Bernini's avatar
Giacomo Bernini committed
89
          $ref: ../components/SOL009_resp.yaml#/components/responses/405
90
        "406":
Giacomo Bernini's avatar
Giacomo Bernini committed
91
          $ref: ../components/SOL009_resp.yaml#/components/responses/406
92
        "422":
Giacomo Bernini's avatar
Giacomo Bernini committed
93
          $ref: ../components/SOL009_resp.yaml#/components/responses/422
94
        "500":
Giacomo Bernini's avatar
Giacomo Bernini committed
95
          $ref: ../components/SOL009_resp.yaml#/components/responses/500
96
        "503":
Giacomo Bernini's avatar
Giacomo Bernini committed
97
          $ref: ../components/SOL009_resp.yaml#/components/responses/503
98
        "504":
Giacomo Bernini's avatar
Giacomo Bernini committed
99
          $ref: ../components/SOL009_resp.yaml#/components/responses/504
100
101
  "/alarms/{alarmId}":
    parameters:
102
      - $ref: "#/components/parameters/alarmId"
103
104
105
106
107
108
109
    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:
110
111
112
        - $ref: "../components/SOL009_params.yaml#/components/parameters/Version"
        - $ref: "../components/SOL009_params.yaml#/components/parameters/Accept"
        - $ref: "../components/SOL009_params.yaml#/components/parameters/Authorization"
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
      responses:
        "200":
          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:
132
                $ref: "../components/SOL009_schemas.yaml#/components/schemas/Alarm"
133
        "400":
Giacomo Bernini's avatar
Giacomo Bernini committed
134
          $ref: ../components/SOL009_resp.yaml#/components/responses/400
135
        "401":
Giacomo Bernini's avatar
Giacomo Bernini committed
136
          $ref: ../components/SOL009_resp.yaml#/components/responses/401
137
        "403":
Giacomo Bernini's avatar
Giacomo Bernini committed
138
          $ref: ../components/SOL009_resp.yaml#/components/responses/403
139
        "404":
Giacomo Bernini's avatar
Giacomo Bernini committed
140
          $ref: ../components/SOL009_resp.yaml#/components/responses/404
141
        "405":
Giacomo Bernini's avatar
Giacomo Bernini committed
142
          $ref: ../components/SOL009_resp.yaml#/components/responses/405
143
        "406":
Giacomo Bernini's avatar
Giacomo Bernini committed
144
          $ref: ../components/SOL009_resp.yaml#/components/responses/406
145
        "422":
Giacomo Bernini's avatar
Giacomo Bernini committed
146
          $ref: ../components/SOL009_resp.yaml#/components/responses/422
147
        "500":
Giacomo Bernini's avatar
Giacomo Bernini committed
148
          $ref: ../components/SOL009_resp.yaml#/components/responses/500
149
        "503":
Giacomo Bernini's avatar
Giacomo Bernini committed
150
          $ref: ../components/SOL009_resp.yaml#/components/responses/503
151
        "504":
Giacomo Bernini's avatar
Giacomo Bernini committed
152
          $ref: ../components/SOL009_resp.yaml#/components/responses/504
153
154
155
156
157
158
159
    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:
160
161
162
163
        - $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"
164
165
166
167
      requestBody:
        content:
          application/json:
            schema:
168
              $ref: "#/components/schemas/AlarmModifications"
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
        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.
        required: true
      responses:
        "200":
          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:
202
                $ref: "#/components/schemas/AlarmModifications"
203
        "400":
Giacomo Bernini's avatar
Giacomo Bernini committed
204
          $ref: ../components/SOL009_resp.yaml#/components/responses/400
205
        "401":
Giacomo Bernini's avatar
Giacomo Bernini committed
206
          $ref: ../components/SOL009_resp.yaml#/components/responses/401
207
        "403":
Giacomo Bernini's avatar
Giacomo Bernini committed
208
          $ref: ../components/SOL009_resp.yaml#/components/responses/403
209
        "404":
Giacomo Bernini's avatar
Giacomo Bernini committed
210
          $ref: ../components/SOL009_resp.yaml#/components/responses/404
211
        "405":
Giacomo Bernini's avatar
Giacomo Bernini committed
212
          $ref: ../components/SOL009_resp.yaml#/components/responses/405
213
        "406":
Giacomo Bernini's avatar
Giacomo Bernini committed
214
          $ref: ../components/SOL009_resp.yaml#/components/responses/406
215
        "409":
Giacomo Bernini's avatar
Giacomo Bernini committed
216
          $ref: ../components/SOL009_resp.yaml#/components/responses/409
217
        "412":
Giacomo Bernini's avatar
Giacomo Bernini committed
218
          $ref: ../components/SOL009_resp.yaml#/components/responses/412
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
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
  /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:
249
250
251
252
        - $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"
253
254
255
256
      requestBody:
        content:
          application/json:
            schema:
257
              $ref: "#/components/schemas/FmSubscriptionRequest"
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
        description: >
          Details of the subscription to be created, as defined in clause
          7.6.2.2.
        required: true
      responses:
        "201":
          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:
299
                $ref: "#/components/schemas/FmSubscription"
300
        "303":
Giacomo Bernini's avatar
Giacomo Bernini committed
301
          $ref: ../components/SOL009_resp.yaml#/components/responses/303
302
        "400":
Giacomo Bernini's avatar
Giacomo Bernini committed
303
          $ref: ../components/SOL009_resp.yaml#/components/responses/400
304
        "401":
Giacomo Bernini's avatar
Giacomo Bernini committed
305
          $ref: ../components/SOL009_resp.yaml#/components/responses/401
306
        "403":
Giacomo Bernini's avatar
Giacomo Bernini committed
307
          $ref: ../components/SOL009_resp.yaml#/components/responses/403
308
        "404":
Giacomo Bernini's avatar
Giacomo Bernini committed
309
          $ref: ../components/SOL009_resp.yaml#/components/responses/404
310
        "405":
Giacomo Bernini's avatar
Giacomo Bernini committed
311
          $ref: ../components/SOL009_resp.yaml#/components/responses/405
312
        "406":
Giacomo Bernini's avatar
Giacomo Bernini committed
313
          $ref: ../components/SOL009_resp.yaml#/components/responses/406
314
        "422":
Giacomo Bernini's avatar
Giacomo Bernini committed
315
          $ref: ../components/SOL009_resp.yaml#/components/responses/422
316
        "500":
Giacomo Bernini's avatar
Giacomo Bernini committed
317
          $ref: ../components/SOL009_resp.yaml#/components/responses/500
318
        "503":
Giacomo Bernini's avatar
Giacomo Bernini committed
319
          $ref: ../components/SOL009_resp.yaml#/components/responses/503
320
        "504":
Giacomo Bernini's avatar
Giacomo Bernini committed
321
          $ref: ../components/SOL009_resp.yaml#/components/responses/504
322
323
324
325
326
327
328
329
330
    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:
331
332
333
334
335
        - $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"
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
      responses:
        "200":
          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:
385
                $ref: "#/components/schemas/FmSubscription"
386
        "400":
Giacomo Bernini's avatar
Giacomo Bernini committed
387
          $ref: ../components/SOL009_resp.yaml#/components/responses/400
388
        "401":
Giacomo Bernini's avatar
Giacomo Bernini committed
389
          $ref: ../components/SOL009_resp.yaml#/components/responses/401
390
        "403":
Giacomo Bernini's avatar
Giacomo Bernini committed
391
          $ref: ../components/SOL009_resp.yaml#/components/responses/403
392
        "404":
Giacomo Bernini's avatar
Giacomo Bernini committed
393
          $ref: ../components/SOL009_resp.yaml#/components/responses/404
394
        "405":
Giacomo Bernini's avatar
Giacomo Bernini committed
395
          $ref: ../components/SOL009_resp.yaml#/components/responses/405
396
        "406":
Giacomo Bernini's avatar
Giacomo Bernini committed
397
          $ref: ../components/SOL009_resp.yaml#/components/responses/406
398
        "422":
Giacomo Bernini's avatar
Giacomo Bernini committed
399
          $ref: ../components/SOL009_resp.yaml#/components/responses/422
400
        "500":
Giacomo Bernini's avatar
Giacomo Bernini committed
401
          $ref: ../components/SOL009_resp.yaml#/components/responses/500
402
        "503":
Giacomo Bernini's avatar
Giacomo Bernini committed
403
          $ref: ../components/SOL009_resp.yaml#/components/responses/503
404
        "504":
Giacomo Bernini's avatar
Giacomo Bernini committed
405
          $ref: ../components/SOL009_resp.yaml#/components/responses/504
406
407
  "/subscriptions/{subscriptionId}":
    parameters:
408
      - $ref: "#/components/parameters/subscriptionId"
409
410
411
412
413
414
415
416
    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:
417
418
419
        - $ref: "../components/SOL009_params.yaml#/components/parameters/Version"
        - $ref: "../components/SOL009_params.yaml#/components/parameters/Accept"
        - $ref: "../components/SOL009_params.yaml#/components/parameters/Authorization"
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
      responses:
        "200":
          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:
455
                $ref: "#/components/schemas/FmSubscription"
456
        "400":
Giacomo Bernini's avatar
Giacomo Bernini committed
457
          $ref: ../components/SOL009_resp.yaml#/components/responses/400
458
        "401":
Giacomo Bernini's avatar
Giacomo Bernini committed
459
          $ref: ../components/SOL009_resp.yaml#/components/responses/401
460
        "403":
Giacomo Bernini's avatar
Giacomo Bernini committed
461
          $ref: ../components/SOL009_resp.yaml#/components/responses/403
462
        "404":
Giacomo Bernini's avatar
Giacomo Bernini committed
463
          $ref: ../components/SOL009_resp.yaml#/components/responses/404
464
        "405":
Giacomo Bernini's avatar
Giacomo Bernini committed
465
          $ref: ../components/SOL009_resp.yaml#/components/responses/405
466
        "406":
Giacomo Bernini's avatar
Giacomo Bernini committed
467
          $ref: ../components/SOL009_resp.yaml#/components/responses/406
468
        "422":
Giacomo Bernini's avatar
Giacomo Bernini committed
469
          $ref: ../components/SOL009_resp.yaml#/components/responses/422
470
        "500":
Giacomo Bernini's avatar
Giacomo Bernini committed
471
          $ref: ../components/SOL009_resp.yaml#/components/responses/500
472
        "503":
Giacomo Bernini's avatar
Giacomo Bernini committed
473
          $ref: ../components/SOL009_resp.yaml#/components/responses/503
474
        "504":
Giacomo Bernini's avatar
Giacomo Bernini committed
475
          $ref: ../components/SOL009_resp.yaml#/components/responses/504
476
477
478
479
480
481
482
483
484
485
486
487
488
    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:
489
490
        - $ref: "../components/SOL009_params.yaml#/components/parameters/Version"
        - $ref: "../components/SOL009_params.yaml#/components/parameters/Authorization"
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
      responses:
        "204":
          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
        "400":
Giacomo Bernini's avatar
Giacomo Bernini committed
516
          $ref: ../components/SOL009_resp.yaml#/components/responses/400
517
        "401":
Giacomo Bernini's avatar
Giacomo Bernini committed
518
          $ref: ../components/SOL009_resp.yaml#/components/responses/401
519
        "403":
Giacomo Bernini's avatar
Giacomo Bernini committed
520
          $ref: ../components/SOL009_resp.yaml#/components/responses/403
521
        "404":
Giacomo Bernini's avatar
Giacomo Bernini committed
522
          $ref: ../components/SOL009_resp.yaml#/components/responses/404
523
        "405":
Giacomo Bernini's avatar
Giacomo Bernini committed
524
          $ref: ../components/SOL009_resp.yaml#/components/responses/405
525
        "406":
Giacomo Bernini's avatar
Giacomo Bernini committed
526
          $ref: ../components/SOL009_resp.yaml#/components/responses/406
527
        "422":
Giacomo Bernini's avatar
Giacomo Bernini committed
528
          $ref: ../components/SOL009_resp.yaml#/components/responses/422
529
        "500":
Giacomo Bernini's avatar
Giacomo Bernini committed
530
          $ref: ../components/SOL009_resp.yaml#/components/responses/500
531
        "503":
Giacomo Bernini's avatar
Giacomo Bernini committed
532
          $ref: ../components/SOL009_resp.yaml#/components/responses/503
533
        "504":
Giacomo Bernini's avatar
Giacomo Bernini committed
534
          $ref: ../components/SOL009_resp.yaml#/components/responses/504
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
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
677
            $ref: "../components/SOL009_schemas.yaml#/components/schemas/PerceivedSeverityType"
678
679
680
681
682
        eventTypes:
          description: >
            Match VNF alarms with an event type listed in this attribute.
          type: array
          items:
Giacomo Bernini's avatar
fix    
Giacomo Bernini committed
683
            $ref: ""../components/SOL009_schemas.yaml#/components/schemas/EventType"
684
685
686
687
688
689
        probableCauses:
          description: >
            Match VNF alarms with a probable cause listed in this attribute.
          type: array
          items:
            type: string