NSFaultManagement.yaml 35.7 KB
Newer Older
1
swagger: "2.0"
2

3
info:
4
  version: "1.0.0"
rameshnaraya's avatar
rameshnaraya committed
5
  title: SOL005 - NS Fault Management Interface
6
  description: >
rameshnaraya's avatar
rameshnaraya committed
7
    SOL005 - NS Fault Management Interface
8
9
10
11
12
13
14
15
    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.
    Please report bugs to https://forge.etsi.org/bugzilla/buglist.cgi?component=Nfv-Openapis
  license:
    name: "ETSI Forge copyright notice"
    url: https://forge.etsi.org/etsi-forge-copyright-notice.txt
16
  contact:
17
18
19
20
21
22
23
24
25
26
27
28
    name: "NFV-SOL WG"
externalDocs:
  description: ETSI GS NFV-SOL 005 V2.4.1
  url: http://www.etsi.org/deliver/etsi_gs/NFV-SOL/001_099/005/02.04.01_60/gs_NFV-SOL005v020401p.pdf
basePath: "/nsfm/v1"
schemes:
  - https
consumes:
  - "application/json"
produces:
  - "application/json"
paths:
29
30
31
  ###############################################################################
  # Alarms                                                                      #
  ###############################################################################
32
  '/alarms':
33
    #ETSI GS NFV-SOL 005 V2.4.1 location: 8.4.2
34
    get:
35
      summary: Query alarms related to NS instances.
36
      description: >
rameshnaraya's avatar
rameshnaraya committed
37
        Get Alarm List.
38
39
40
41
42
43
44

        The client can use this method to retrieve information about the alarm list.
      parameters:
        - name: "filter"
          in: "query"
          required: false
          type: "string"
45
          description: >
46
47
48
49
50
51
52
53
54
55
56
57
            Attribute-based filtering parameters according to clause 4.3.2.
            The NFVO shall support receiving filtering parameters as part of the URI query string.
            The OSS/BSS may supply filtering parameters.
            The following attribute names shall be supported in attribute-based 
            filtering parameters:
            - id            
            - nsInstanceId            
            - rootCauseFaultyComponent.faultyNestedNsInstanceId            
            - rootCauseFaultyComponent.faultyNsVirtualLinkInstanceId            
            - rootCauseFaultyComponent.faultyVnfInstanceId           
            - rootCauseFaultyResource.faultyResourceType            
            - eventType            
58
59
            - perceivedSeverity
            - probableCause
60
61
62
63
64
65
66
        - name: nextpage_opaque_marker
          in: query
          description: >
            Marker to obtain the next page of a paged response. Shall be supported by the NFVO
            if the NFVO supports alternative 2 (paging) according to clause 4.7.2.1 for this resource.
          required: false
          type: string
67
68
69
70
71
72
73
74
75
76
77
78
79
80
        - name: Accept
          description: >
            Content-Types that are acceptable for the response.
            Reference: IETF RFC 7231
          in: header
          required: true
          type: string
        - name: Authorization
          description: >
            The authorization token for the request.
            Reference: IETF RFC 7235
          in: header
          required: false
          type: string
81
82
83
84
85
86
        - name: Version
          description: >
            Version of the API requested to use when responding to this request.
          in: header
          required: true
          type: string
87
88
      responses:
        200:
rameshnaraya's avatar
rameshnaraya committed
89
          description: >
90
            200 OK
91

92
93
            The request has succeeded.
            The response body shall contain the list of related alarms.
rameshnaraya's avatar
rameshnaraya committed
94
95
96
97
98
99
100
          headers:
            Content-Type:
              description: The MIME type of the body of the response.
              type: string
              maximum: 1
              minimum: 1
            WWW-Authenticate:
101
              type: "string"
rameshnaraya's avatar
rameshnaraya committed
102
103
              description: >
                Challenge if the corresponding HTTP request has not provided
104
105
106
                authorization, or error details if the corresponding HTTP request
                has provided an invalid authorization token.
              maximum: 1
107
108
109
110
111
112
113
              minimum: 0
            Version:
              description: >
                Version of the API used in the response.
              type: string
              maximum: 1
              minimum: 1
114
          schema:
rameshnaraya's avatar
rameshnaraya committed
115
116
117
118
            type: array
            items:
              properties:
                Alarm:
119
                  $ref: "definitions/SOL005NSFaultManagement_def.yaml#/definitions/Alarm"
120
121
122
123
124
125
126
127
128
129
130
131
132
        400:
          $ref: "responses/SOL005_resp.yaml#/responses/400"
        401:
          $ref: "responses/SOL005_resp.yaml#/responses/401"
        403:
          $ref: "responses/SOL005_resp.yaml#/responses/403"
        405:
          $ref: "responses/SOL005_resp.yaml#/responses/405"
        406:
          $ref: "responses/SOL005_resp.yaml#/responses/406"
        500:
          $ref: "responses/SOL005_resp.yaml#/responses/500"
        503:
133
134
135
136
137
          $ref: "responses/SOL005_resp.yaml#/responses/503"

  ###############################################################################
  # Individual alarm                                                            #
  ###############################################################################
138
  '/alarms/{alarmId}':
139
    #ETSI GS NFV-SOL 005 V2.4.1 location: 8.4.3
140
141
142
    parameters:
      - name: alarmId
        description: >
rameshnaraya's avatar
rameshnaraya committed
143
144
145
146
147
          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.
148
149
150
        in: path
        type: string
        required: true
151
    get:
152
      summary: Read individual alarm.
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
      description: >
        The client can use this method to read an individual alarm.
      parameters:
        - name: Accept
          description: >
            Content-Types that are acceptable for the response.
            Reference: IETF RFC 7231
          in: header
          required: true
          type: string
        - name: Content-Type
          description: >
            The MIME type of the body of the request.
            Reference: IETF RFC 7231
          in: header
          required: true
          type: string
        - name: Authorization
          description: >
            The authorization token for the request.
            Reference: IETF RFC 7235
          in: header
          required: false
          type: string
177
178
179
180
181
182
        - name: Version
          description: >
            Version of the API requested to use when responding to this request.
          in: header
          required: true
          type: string
183
      responses:
184
        200:
rameshnaraya's avatar
rameshnaraya committed
185
          description: >
186
            200 OK
187

188
189
190
191
192
            Information about an individual alarm was read successfully.
            The response body shall contain a representation of the
            individual alarm.
          headers:
            Content-Type:
rameshnaraya's avatar
rameshnaraya committed
193
              description: The MIME type of the body of the response.
194
195
196
              type: string
              maximum: 1
              minimum: 1
rameshnaraya's avatar
rameshnaraya committed
197
            WWW-Authenticate:
198
              type: "string"
rameshnaraya's avatar
rameshnaraya committed
199
200
              description: >
                Challenge if the corresponding HTTP request has not provided
201
202
203
                authorization, or error details if the corresponding HTTP request
                has provided an invalid authorization token.
              maximum: 1
204
205
206
207
208
209
210
              minimum: 0
            Version:
              description: >
                Version of the API used in the response.
              type: string
              maximum: 1
              minimum: 1
211
          schema:
rameshnaraya's avatar
rameshnaraya committed
212
213
            properties:
              Alarm:
214
                $ref: "definitions/SOL005NSFaultManagement_def.yaml#/definitions/Alarm"
215
216
217
218
219
        400:
          $ref: "responses/SOL005_resp.yaml#/responses/400"
        401:
          $ref: "responses/SOL005_resp.yaml#/responses/401"
        403:
220
          $ref: "responses/SOL005_resp.yaml#/responses/403"
221
222
223
224
225
226
227
        405:
          $ref: "responses/SOL005_resp.yaml#/responses/405"
        406:
          $ref: "responses/SOL005_resp.yaml#/responses/406"
        500:
          $ref: "responses/SOL005_resp.yaml#/responses/500"
        503:
228
          $ref: "responses/SOL005_resp.yaml#/responses/503"
229
    patch:
230
      summary: Acknowledge individual alarm.
231
232
      description: >
        Acknowledge Alarm
233

234
235
        This method modifies an individual alarm resource.
      parameters:
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
        - name: "body"
          in: "body"
          required: true
          schema:
            type: "object"
            required:
              - "AlarmModifications"
            properties:
              AlarmModifications:
                $ref: "definitions/SOL005NSFaultManagement_def.yaml#/definitions/AlarmModifications"
            description: >
              The parameter for the alarm modification, as defined in clause 8.5.2.8.
        - name: Accept
          description: >
            Content-Types that are acceptable for the response.
            Reference: IETF RFC 7231
          in: header
          required: true
          type: string
        - name: Authorization
          description: >
            The authorization token for the request.
            Reference: IETF RFC 7235
          in: header
          required: false
          type: string
        - name: Content-Type
          description: >
            The Content-Type header shall be set to
            "application/merge-patch+json" according to
            IETF RFC 7396.
          in: header
          required: true
          type: string
          enum: ["application/merge-patch+json"]
        - name: Version
          description: >
            Version of the API requested to use when responding to this request.
          in: header
          required: true
          type: string
277
278
      responses:
        200:
rameshnaraya's avatar
rameshnaraya committed
279
          description: >
280
            200 OK
281

282
283
284
285
286
            The request was accepted and completed.
            The response body shall contain attribute modifications
            for an 'Individual alarm' resource (see clause 8.5.2.4).
          headers:
            Content-Type:
rameshnaraya's avatar
rameshnaraya committed
287
              description: The MIME type of the body of the response.
288
289
290
291
              type: string
              maximum: 1
              minimum: 1
            WWW-Authenticate:
292
              type: "string"
293
294
              description: >
                Challenge if the corresponding HTTP request has not provided
295
296
                authorization, or error details if the corresponding HTTP request
                has provided an invalid authorization token.
297
              maximum: 1
298
299
300
301
302
303
304
              minimum: 0
            Version:
              description: >
                Version of the API used in the response.
              type: string
              maximum: 1
              minimum: 1
305
          schema:
rameshnaraya's avatar
rameshnaraya committed
306
307
308
            properties:
              AlarmModifications:
                $ref: "definitions/SOL005NSFaultManagement_def.yaml#/definitions/AlarmModifications"
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
        400:
          $ref: "responses/SOL005_resp.yaml#/responses/400"
        401:
          $ref: "responses/SOL005_resp.yaml#/responses/401"
        403:
          $ref: "responses/SOL005_resp.yaml#/responses/403"
        405:
          $ref: "responses/SOL005_resp.yaml#/responses/405"
        406:
          $ref: "responses/SOL005_resp.yaml#/responses/406"
        409:
          $ref: "responses/NSFManagement_resp.yaml#/responses/409-alarm-state-conflict"
        412:
          $ref: "responses/SOL005_resp.yaml#/responses/412"
        500:
          $ref: "responses/SOL005_resp.yaml#/responses/500"
        503:
          $ref: "responses/SOL005_resp.yaml#/responses/503"
327
328
329
  ##############################################################################
  #Subscriptions                                                               #
  ##############################################################################
330
  '/subscriptions':
331
    #ETSI GS NFV-SOL 005 V2.4.1 location: 8.4.4
332
    post:
333
      summary: Subscribe to alarms related to NSs.
334
      description: >
335
336
337
338
339
340
341
342
        The POST method creates a new subscription.
        This method shall follow the provisions specified in the Tables 8.4.4.3.1-1 and 8.4.4.3.1-2 for URI query parameters,
        request and response data structures, and response codes.
        Creation of two subscription resources with the same callbackURI and the same filter can result in performance
        degradation and will provide duplicates of notifications to the OSS, and might make sense only in very rare use cases.
        Consequently, the NFVO may either allow creating a subscription resource if another 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 subscription resource (in which case it shall return a "303 See Other" response code referencing
rameshnaraya's avatar
rameshnaraya committed
343
        the existing subscription resource with the same filter and callbackUri).
344
      parameters:
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
        - name: Accept
          description: >
            Content-Types that are acceptable for the response.
            Reference: IETF RFC 7231
          in: header
          required: true
          type: string
        - name: Authorization
          description: >
            The authorization token for the request.
            Reference: IETF RFC 7235
          in: header
          required: false
          type: string
        - name: Content-Type
          description: >
            The MIME type of the body of the request.
            Reference: IETF RFC 7231
          in: header
          required: true
365
366
367
368
369
370
371
          type: string
        - name: Version
          description: >
            Version of the API requested to use when responding to this request.
          in: header
          required: true
          type: string
rameshnaraya's avatar
rameshnaraya committed
372
373
374
375
376
377
        - name: "body"
          in: "body"
          required: true
          schema:
            type: "object"
            required:
378
              - "FmSubscriptionRequest"
rameshnaraya's avatar
rameshnaraya committed
379
380
381
382
383
            properties:
              FmSubscriptionRequest:
                $ref: "definitions/SOL005NSFaultManagement_def.yaml#/definitions/FmSubscriptionRequest"
            description: >
              Details of the subscription to be created, as defined in clause 8.5.2.2.
384

385
386
      responses:
        201:
387
388
          description: >
            201 Created
389

390
391
392
393
394
            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.              
rameshnaraya's avatar
rameshnaraya committed
395
396
397
398
399
          schema:
            type: "object"
            properties:
              FmSubscription:
                $ref: "definitions/SOL005NSFaultManagement_def.yaml#/definitions/FmSubscription"
400
          headers:
rameshnaraya's avatar
rameshnaraya committed
401
402
403
404
405
406
            Content-Type:
              type: "string"
              description: >
                The MIME type of the body of the response.This header
                field shall be present if the response has a non-empty message
                body.
407
            WWW-Authenticate:
rameshnaraya's avatar
rameshnaraya committed
408
              type: "string"
409
410
              description: >
                Challenge if the corresponding HTTP request has not provided
rameshnaraya's avatar
rameshnaraya committed
411
                authorization, or error details if the corresponding HTTP request
412
413
                has provided an invalid authorization token.
              maximum: 1
414
415
416
417
418
419
420
              minimum: 0
            Version:
              description: >
                Version of the API used in the response.
              type: string
              maximum: 1
              minimum: 1
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
        303:
          $ref: "responses/SOL005_resp.yaml#/responses/303"
        400:
          $ref: "responses/SOL005_resp.yaml#/responses/400"
        401:
          $ref: "responses/SOL005_resp.yaml#/responses/401"
        403:
          $ref: "responses/SOL005_resp.yaml#/responses/403"
        405:
          $ref: "responses/SOL005_resp.yaml#/responses/405"
        406:
          $ref: "responses/SOL005_resp.yaml#/responses/406"
        500:
          $ref: "responses/SOL005_resp.yaml#/responses/500"
        503:
          $ref: "responses/SOL005_resp.yaml#/responses/503"
    get:
438
      summary: Query multiple subscriptions.
439
440
      description: >
        Query Subscription Information
441

442
443
444
        The client can use this method to retrieve the list of active subscriptions 
        for alarms related to a NS subscribed by the client. 
        It can be used e.g. for resynchronization after error situations.
445

446
447
448
449
450
451
452
453
454
        This method shall follow the provisions specified in the Tables 8.4.4.3.2-1 and 8.4.4.3.2-2 for URI query parameters,
        request and response data structures, and response codes.
        Table 8.4.4.3.2-1: URI query parameters supported.

      parameters:
        - name: "filter"
          in: "query"
          required: false
          type: "string"
455
          description: >
rameshnaraya's avatar
rameshnaraya committed
456
            Attribute-based filtering parameters according to clause 4.3.2.
457
458
459
            The NFVO shall support receiving filtering parameters as part of the URI
            query string. The OSS/BSS may supply filtering parameters.
            All attribute names that appear in the FmSubscription and in data types
rameshnaraya's avatar
rameshnaraya committed
460
            referenced from it shall be supported in attribute-based filtering parameters.       
461
462
463
464
465
466
467
        - name: nextpage_opaque_marker
          in: query
          description: >
            Marker to obtain the next page of a paged response. Shall be supported by the NFVO
            if the NFVO supports alternative 2 (paging) according to clause 4.7.2.1 for this resource.
          required: false
          type: string
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
        - name: Accept
          description: >
            Content-Types that are acceptable for the response.
            Reference: IETF RFC 7231
          in: header
          required: true
          type: string
        - name: Authorization
          description: >
            The authorization token for the request.
            Reference: IETF RFC 7235
          in: header
          required: false
          type: string
        - name: Content-Type
          description: >
            The MIME type of the body of the request.
            Reference: IETF RFC 7231
          in: header
          required: true
          type: string
489
490
491
492
493
494
        - name: Version
          description: >
            Version of the API requested to use when responding to this request.
          in: header
          required: true
          type: string
495
496
      responses:
        200:
rameshnaraya's avatar
rameshnaraya committed
497
          description: >
498
            200 OK
499

500
501
502
503
504
505
            The list of subscriptions was queried successfully.
            The response body shall contain the representations of
            all active subscriptions of the functional block that
            invokes the method.
          headers:
            Content-Type:
rameshnaraya's avatar
rameshnaraya committed
506
              description: The MIME type of the body of the response.
507
508
509
510
              type: string
              maximum: 1
              minimum: 1
            WWW-Authenticate:
511
              type: "string"
512
513
              description: >
                Challenge if the corresponding HTTP request has not provided
514
515
516
                authorization, or error details if the corresponding HTTP request
                has provided an invalid authorization token.
              maximum: 1
517
518
519
520
521
522
523
              minimum: 0
            Version:
              description: >
                Version of the API used in the response.
              type: string
              maximum: 1
              minimum: 1
524
525
526
          schema:
            type: array
            items:
rameshnaraya's avatar
rameshnaraya committed
527
528
              properties:
                FmSubscription:
529
                  $ref: "definitions/SOL005NSFaultManagement_def.yaml#/definitions/FmSubscription"
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
        400:
          $ref: "responses/SOL005_resp.yaml#/responses/400-attr-based-filtering-error"
        401:
          $ref: "responses/SOL005_resp.yaml#/responses/401"
        403:
          $ref: "responses/SOL005_resp.yaml#/responses/403"
        405:
          $ref: "responses/SOL005_resp.yaml#/responses/405"
        406:
          $ref: "responses/SOL005_resp.yaml#/responses/406"
        412:
          $ref: "responses/SOL005_resp.yaml#/responses/412"
        500:
          $ref: "responses/SOL005_resp.yaml#/responses/500"
        503:
          $ref: "responses/SOL005_resp.yaml#/responses/503"
546
547
548
549

  ###############################################################################
  # Individual subscription                                                     #
  ###############################################################################
550
  '/subscriptions/{subscriptionId}':
551
    #ETSI GS NFV-SOL 005 V2.4.1 location: 8.4.5
552
553
554
555
556
557
558
559
560
561
562
563
    parameters:
      - 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 subscription resource. It can also be retrieved from the "id"
          attribute in the payload body of that response.
        in: path
        type: string
        required: true
    get:
564
      summary: Read an individual subscription.
565
566
      description: >
        Query Subscription Information
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
        The client can use this method for reading an individual subscription for alarms related to NSs subscribed by the client.
        This method shall follow the provisions specified in the Tables 8.4.5.3.2-1 and 8.4.5.3.2-2 for URI query parameters,
        request and response data structures, and response codes
      parameters:
        - name: Accept
          description: >
            Content-Types that are acceptable for the response.
            Reference: IETF RFC 7231
          in: header
          required: true
          type: string
        - name: Authorization
          description: >
            The authorization token for the request.
            Reference: IETF RFC 7235
          in: header
          required: false
          type: string
        - name: Content-Type
          description: >
            The MIME type of the body of the request.
            Reference: IETF RFC 7231
          in: header
          required: true
          type: string
593
594
595
596
597
598
        - name: Version
          description: >
            Version of the API requested to use when responding to this request.
          in: header
          required: true
          type: string
599
600
      responses:
        200:
601
602
          description: >
            200 OK
603

604
605
606
607
608
609
610
611
612
613
614
615
            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
              type: string
              maximum: 1
              minimum: 1
            WWW-Authenticate:
616
              type: "string"
617
618
              description: >
                Challenge if the corresponding HTTP request has not provided
619
620
                authorization, or error details if the corresponding HTTP request
                has provided an invalid authorization token.
621
622
              maximum: 1
              minimum: 0
623
624
625
626
627
628
            Version:
              description: >
                Version of the API used in the response.
              type: string
              maximum: 1
              minimum: 1
629
          schema:
630
631
632
            properties:
              FmSubscription:
                $ref: "definitions/SOL005NSFaultManagement_def.yaml#/definitions/FmSubscription"
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
        400:
          $ref: "responses/SOL005_resp.yaml#/responses/400"
        401:
          $ref: "responses/SOL005_resp.yaml#/responses/401"
        403:
          $ref: "responses/SOL005_resp.yaml#/responses/403"
        405:
          $ref: "responses/SOL005_resp.yaml#/responses/405"
        406:
          $ref: "responses/SOL005_resp.yaml#/responses/406"
        500:
          $ref: "responses/SOL005_resp.yaml#/responses/500"
        503:
          $ref: "responses/SOL005_resp.yaml#/responses/503"
    delete:
648
      summary: Terminate a subscription.
649
650
      description: >
        Terminate Subscription
651

652
653
654
655
656
657
658
659
660
        This method terminates an individual subscription.
      parameters:
        - name: Authorization
          description: >
            The authorization token for the request.
            Reference: IETF RFC 7235
          in: header
          required: false
          type: string
661
662
663
664
665
666
        - name: Version
          description: >
            Version of the API requested to use when responding to this request.
          in: header
          required: true
          type: string
667
668
      responses:
        204:
669
          description: >
670
            204 - No Content
671

672
673
674
675
            The subscription resource was deleted successfully.
            The response body shall be empty.
          headers:
            WWW-Authenticate:
676
              type: "string"
677
678
              description: >
                Challenge if the corresponding HTTP request has not provided
679
680
                authorization, or error details if the corresponding HTTP request
                has provided an invalid authorization token.
681
682
              maximum: 1
              minimum: 0
683
684
685
686
687
688
            Version:
              description: >
                Version of the API used in the response.
              type: string
              maximum: 1
              minimum: 1
689
690
691
692
693
694
695
696
697
698
699
700
701
702
        400:
          $ref: "responses/SOL005_resp.yaml#/responses/400"
        401:
          $ref: "responses/SOL005_resp.yaml#/responses/401"
        403:
          $ref: "responses/SOL005_resp.yaml#/responses/403"
        405:
          $ref: "responses/SOL005_resp.yaml#/responses/405"
        406:
          $ref: "responses/SOL005_resp.yaml#/responses/406"
        500:
          $ref: "responses/SOL005_resp.yaml#/responses/500"
        503:
          $ref: "responses/SOL005_resp.yaml#/responses/503"
703
704
705
706
707
708

  ##################################################################################
  # Notification endpoint                                                          #
  # Dummy URI is used for testing.                                                 #
  # In real, resource URI is provided by the client when creating the subscription.#
  ##################################################################################
709
710
  '/URI_is_provided_by_the_client_when_creating_the_subscription-AlarmNotification':
    #ETSI GS NFV-SOL 005 V2.4.1 location: 8.4.6
711
    post:
712
      summary: Notify about NS alarms
713
714
      description: >
        The POST method notifies an alarm related to a NS or that the alarm list has been rebuilt.
715

716
717
718
719
720
721
722
      parameters:
        - name: alarmNotification
          description: >
            Information of a NS alarm.
          in: body
          required: true
          schema:
rameshnaraya's avatar
rameshnaraya committed
723
724
            properties:
              AlarmNotification:
725
                $ref: "definitions/SOL005NSFaultManagement_def.yaml#/definitions/AlarmNotification"
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
        - name: Accept
          description: >
            Content-Types that are acceptable for the response.
            Reference: IETF RFC 7231
          in: header
          required: true
          type: string
        - name: Authorization
          description: >
            The authorization token for the request.
            Reference: IETF RFC 7235
          in: header
          required: false
          type: string
        - name: Content-Type
          description: >
            The MIME type of the body of the request.
            Reference: IETF RFC 7231
          in: header
          required: true
          type: string
747
748
749
750
751
752
        - name: Version
          description: >
            Version of the API requested to use when responding to this request.
          in: header
          required: true
          type: string
753
754
755
756
      responses:
        204:
          description: >
            204 No Content
757

758
759
760
761
762
763
764
765
766
767
            The notification was delivered successfully.
            The response body shall be empty.        
          headers:
            WWW-Authenticate:
              type: "string"
              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.
              maximum: 1
768
769
770
771
772
773
774
              minimum: 0
            Version:
              description: >
                Version of the API used in the response.
              type: string
              maximum: 1
              minimum: 1
775
776
777
778
779
        400:
          $ref: "responses/SOL005_resp.yaml#/responses/400"
        401:
          $ref: "responses/SOL005_resp.yaml#/responses/401"
        403:
780
          $ref: "responses/SOL005_resp.yaml#/responses/403"
781
782
783
        500:
          $ref: "responses/SOL005_resp.yaml#/responses/500"
        503:
784
785
          $ref: "responses/SOL005_resp.yaml#/responses/503"

786
787
788
789
790
791
792
793
794
795
796
797
798
799
  '/URI_is_provided_by_the_client_when_creating_the_subscription-AlarmClearedNotification':
    #ETSI GS NFV-SOL 005 V2.4.1 location: 8.4.6
    post:
      summary: Notify about NS alarms
      description: >
        The POST method notifies an alarm related to a NS or that the alarm list has been rebuilt.
      parameters:
        - name: alarmClearedNotification
          description: >
            Information of the clearance of a NS alarm.
          in: body
          required: true
          schema:
            properties:
800
801
              AlarmClearedNotification:
                $ref: "definitions/SOL005NSFaultManagement_def.yaml#/definitions/AlarmClearedNotification"
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
        - name: Accept
          description: >
            Content-Types that are acceptable for the response.
            Reference: IETF RFC 7231
          in: header
          required: true
          type: string
        - name: Authorization
          description: >
            The authorization token for the request.
            Reference: IETF RFC 7235
          in: header
          required: false
          type: string
        - name: Content-Type
          description: >
            The MIME type of the body of the request.
            Reference: IETF RFC 7231
          in: header
          required: true
          type: string
823
824
825
826
827
828
        - name: Version
          description: >
            Version of the API requested to use when responding to this request.
          in: header
          required: true
          type: string
829
830
831
832
      responses:
        204:
          description: >
            204 No Content
833

834
835
836
837
838
839
840
841
842
843
            The notification was delivered successfully.
            The response body shall be empty.
          headers:
            WWW-Authenticate:
              type: "string"
              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.
              maximum: 1
844
845
846
847
848
849
850
              minimum: 0
            Version:
              description: >
                Version of the API used in the response.
              type: string
              maximum: 1
              minimum: 1
851
852
853
854
855
        400:
          $ref: "responses/SOL005_resp.yaml#/responses/400"
        401:
          $ref: "responses/SOL005_resp.yaml#/responses/401"
        403:
856
          $ref: "responses/SOL005_resp.yaml#/responses/403"
857
858
859
        500:
          $ref: "responses/SOL005_resp.yaml#/responses/500"
        503:
860
          $ref: "responses/SOL005_resp.yaml#/responses/503"
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875

  '/URI_is_provided_by_the_client_when_creating_the_subscription-AlarmListRebuiltNotification':
    #ETSI GS NFV-SOL 005 V2.4.1 location: 8.4.6
    post:
      summary: Notify about NS alarms
      description: >
        The POST method notifies an alarm related to a NS or that the alarm list has been rebuilt.
      parameters:
        - name: AlarmListRebuiltNotification
          description: >
            Information that the alarm list has been rebuilt by the NFVO.
          in: body
          required: true
          schema:
            properties:
876
877
              AlarmListRebuiltNotification:
                $ref: "definitions/SOL005NSFaultManagement_def.yaml#/definitions/AlarmListRebuiltNotification"
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
        - name: Accept
          description: >
            Content-Types that are acceptable for the response.
            Reference: IETF RFC 7231
          in: header
          required: true
          type: string
        - name: Authorization
          description: >
            The authorization token for the request.
            Reference: IETF RFC 7235
          in: header
          required: false
          type: string
        - name: Content-Type
          description: >
            The MIME type of the body of the request.
            Reference: IETF RFC 7231
          in: header
          required: true
          type: string
899
900
901
902
903
904
        - name: Version
          description: >
            Version of the API requested to use when responding to this request.
          in: header
          required: true
          type: string
905
906
907
      responses:
        204:
          description: >
908
            204 No Content
909

910
            The notification was delivered successfully.
911
912
913
914
915
916
917
918
919
            The response body shall be empty. 
          headers:
            WWW-Authenticate:
              type: "string"
              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.
              maximum: 1
920
921
922
923
924
925
926
              minimum: 0
            Version:
              description: >
                Version of the API used in the response.
              type: string
              maximum: 1
              minimum: 1
927
928
929
930
931
        400:
          $ref: "responses/SOL005_resp.yaml#/responses/400"
        401:
          $ref: "responses/SOL005_resp.yaml#/responses/401"
        403:
932
          $ref: "responses/SOL005_resp.yaml#/responses/403"
933
934
935
        500:
          $ref: "responses/SOL005_resp.yaml#/responses/500"
        503:
936
937
          $ref: "responses/SOL005_resp.yaml#/responses/503"

938
    get:
939
      summary: Test the notification endpoint
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
      description: >
        The GET method allows the server to test the notification endpoint that is provided by the client, e.g. during
        subscription.
      parameters:
        - name: Accept
          description: >
            Content-Types that are acceptable for the response.
            Reference: IETF RFC 7231
          in: header
          required: true
          type: string
        - name: Authorization
          description: >
            The authorization token for the request.
            Reference: IETF RFC 7235
          in: header
          required: false
          type: string
958
959
960
961
962
963
        - name: Version
          description: >
            Version of the API requested to use when responding to this request.
          in: header
          required: true
          type: string
964
965
966
      responses:
        204:
          description: >
967
            204 No Content
968

969
970
            The notification endpoint was tested successfully.
            The response body shall be empty. 
971
972
973
974
975
976
977
978
          headers:
            WWW-Authenticate:
              type: "string"
              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.
              maximum: 1
979
              minimum: 0
980
981
982
983
984
        400:
          $ref: "responses/SOL005_resp.yaml#/responses/400"
        401:
          $ref: "responses/SOL005_resp.yaml#/responses/401"
        403:
985
          $ref: "responses/SOL005_resp.yaml#/responses/403"
986
987
988
989
        500:
          $ref: "responses/SOL005_resp.yaml#/responses/500"
        503:
          $ref: "responses/SOL005_resp.yaml#/responses/503"