NSFaultManagement.yaml 26.9 KB
Newer Older
1
2
3
swagger: "2.0"
info:
  version: "2.4.1"
rameshnaraya's avatar
rameshnaraya committed
4
  title: SOL005 - NS Fault Management Interface
5
  description: >
rameshnaraya's avatar
rameshnaraya committed
6
    SOL005 - NS Fault Management Interface
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
    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
  contact: 
    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:
31
32
33
34
35
36
37
###############################################################################
# Alarms                                                                      #
###############################################################################
  '/alarms':
    #SOL005 location: 8.2-1
    get:
      summary: >
rameshnaraya's avatar
rameshnaraya committed
38
        Query alarms related to NS instances.
39
      description: >
rameshnaraya's avatar
rameshnaraya committed
40
        Get Alarm List.
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

        The client can use this method to retrieve information about the alarm list.
      parameters:
        - name: "filter"
          in: "query"
          required: false
          type: "string"
          description: >  
            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            
            - perceivedSeverity     
        - 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
      responses:
        200:
rameshnaraya's avatar
rameshnaraya committed
78
79
80
          description: >
            200 OK.
            
81
82
            The request has succeeded.
            The response body shall contain the list of related alarms.
rameshnaraya's avatar
rameshnaraya committed
83
84
85
86
87
88
89
90
91
92
93
94
          headers:
            Content-Type:
              description: The MIME type of the body of the response.
              type: string
              maximum: 1
              minimum: 1
            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.  
95
          schema:
rameshnaraya's avatar
rameshnaraya committed
96
97
98
99
100
            type: array
            items:
              properties:
                Alarm:
                  $ref: "definitions/SOL005NSFaultManagement_def.yaml#/definitions/Alarm" 
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
        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"            
          
###############################################################################
# Individual alarm                                                            #
###############################################################################
  '/alarms/{alarmId}':
    #SOL005 location: 8.2-1
    parameters:
      - name: alarmId
        description: >
rameshnaraya's avatar
rameshnaraya committed
124
125
126
127
128
          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.
129
130
131
        in: path
        type: string
        required: true
132
    get:
133
      summary: >
rameshnaraya's avatar
rameshnaraya committed
134
        Read individual alarm.
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
      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
rameshnaraya's avatar
rameshnaraya committed
159
      responses:            
160
        200:
rameshnaraya's avatar
rameshnaraya committed
161
162
163
          description: >
            200 OK.
            
164
165
166
167
168
            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
169
              description: The MIME type of the body of the response.
170
171
172
              type: string
              maximum: 1
              minimum: 1
rameshnaraya's avatar
rameshnaraya committed
173
174
175
176
177
178
            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.  
179
          schema:
rameshnaraya's avatar
rameshnaraya committed
180
181
182
            properties:
              Alarm:
                $ref: "definitions/SOL005NSFaultManagement_def.yaml#/definitions/Alarm"                  
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
        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"
    patch:
      summary: >
rameshnaraya's avatar
rameshnaraya committed
199
        Acknowledge individual alarm.
200
201
202
203
204
      description: >
        Acknowledge Alarm
  
        This method modifies an individual alarm resource.
      parameters:
rameshnaraya's avatar
rameshnaraya committed
205
206
      - name: "body"
        in: "body"
207
208
        required: true
        schema:
rameshnaraya's avatar
rameshnaraya committed
209
210
211
212
213
214
215
216
          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.
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
      - 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"]
      responses:
        200:
rameshnaraya's avatar
rameshnaraya committed
242
243
244
          description: >
            200 OK.
            
245
246
247
248
249
            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
250
              description: The MIME type of the body of the response.
251
252
253
254
              type: string
              maximum: 1
              minimum: 1
            WWW-Authenticate:
rameshnaraya's avatar
rameshnaraya committed
255
              type: string            
256
257
258
              description: >
                Challenge if the corresponding HTTP request has not provided
                authorization, or error details if the corresponding HTTP
rameshnaraya's avatar
rameshnaraya committed
259
                request has provided an invalid authorization token. 
260
              maximum: 1
rameshnaraya's avatar
rameshnaraya committed
261
              minimum: 0                
262
          schema:
rameshnaraya's avatar
rameshnaraya committed
263
264
265
            properties:
              AlarmModifications:
                $ref: "definitions/SOL005NSFaultManagement_def.yaml#/definitions/AlarmModifications"
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
        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"
##############################################################################
#Subscriptions                                                               #
##############################################################################
  '/subscriptions':
    #SOL005 location: 8.2-1
    post:
      summary: >
rameshnaraya's avatar
rameshnaraya committed
291
292
        Subscribe to alarms related to NSs.
      description: > 
293
294
295
296
297
298
299
300
        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
301
302
        the existing subscription resource with the same filter and callbackUri).
      parameters:         
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
        - 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
rameshnaraya's avatar
rameshnaraya committed
323
324
325
326
327
328
329
330
331
332
333
334
335
336
          type: string            
        - name: "body"
          in: "body"
          required: true
          schema:
            type: "object"
            required:
            - "FmSubscriptionRequest"
            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.
              
337
338
      responses:
        201:
rameshnaraya's avatar
rameshnaraya committed
339
340
341
342
343
344
345
346
347
348
349
350
          description: 201 Created
          schema:
            type: "object"
            description: >            
              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.
            properties:
              FmSubscription:
                $ref: "definitions/SOL005NSFaultManagement_def.yaml#/definitions/FmSubscription"
351
352
          headers:
            Location:
rameshnaraya's avatar
rameshnaraya committed
353
              type: "string"
354
              description: >
rameshnaraya's avatar
rameshnaraya committed
355
356
357
358
359
360
361
362
                The HTTP response shall include a Location HTTP header
                that contains the resource URI of the new NS descriptor resource.
            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.
363
            WWW-Authenticate:
rameshnaraya's avatar
rameshnaraya committed
364
              type: "string"
365
366
              description: >
                Challenge if the corresponding HTTP request has not provided
rameshnaraya's avatar
rameshnaraya committed
367
368
                authorization, or error details if the corresponding HTTP request
                has provided an invalid authorization token.               
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
        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:
      summary: >
rameshnaraya's avatar
rameshnaraya committed
387
        Query multiple subscriptions.
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
      description: >
        Query Subscription Information
  
        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.
        
        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"
          description: >  
rameshnaraya's avatar
rameshnaraya committed
405
            Attribute-based filtering parameters according to clause 4.3.2.
406
407
408
            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
409
            referenced from it shall be supported in attribute-based filtering parameters.       
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
        - 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
      responses:
        200:
rameshnaraya's avatar
rameshnaraya committed
433
434
          description: >
            200 OK.
435
436
437
438
439
440
441
            
            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
442
              description: The MIME type of the body of the response.
443
444
445
446
              type: string
              maximum: 1
              minimum: 1
            WWW-Authenticate:
rameshnaraya's avatar
rameshnaraya committed
447
              type: string            
448
449
450
              description: >
                Challenge if the corresponding HTTP request has not provided
                authorization, or error details if the corresponding HTTP
rameshnaraya's avatar
rameshnaraya committed
451
                request has provided an invalid authorization token.  
452
453
454
          schema:
            type: array
            items:
rameshnaraya's avatar
rameshnaraya committed
455
456
457
              properties:
                FmSubscription:
                  $ref: "definitions/SOL005NSFaultManagement_def.yaml#/definitions/FmSubscription"  
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
        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"
rameshnaraya's avatar
rameshnaraya committed
474
          
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
###############################################################################
# Individual subscription                                                     #
###############################################################################
  '/subscriptions/{subscriptionId}':
    #SOL005 location: 8.2-1
    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:
      summary: >
rameshnaraya's avatar
rameshnaraya committed
493
        Read an individual subscription.
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
      description: >
        Query Subscription Information
  
        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
      responses:
        200:
          description: >            
            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:
              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.
              type: string
              maximum: 1
              minimum: 0
          schema:
            $ref: "definitions/SOL005NSFaultManagement_def.yaml#/definitions/FmSubscription"
        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:
      summary: >
rameshnaraya's avatar
rameshnaraya committed
562
        Terminate a subscription.
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
      description: >
        Terminate Subscription
          
        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
      responses:
        204:
          description: > 
rameshnaraya's avatar
rameshnaraya committed
578
            204 - No Content.
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
 
            The subscription resource was 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.
              type: string
              maximum: 1
              minimum: 0
        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"
          
###############################################################################
# Notification endpoint                                                       #
# "/notification_endpoint" is the                                             #
# is the dummy URI used for testing, in real case endpoint URI has to         #
# provided by client.                                                         #
###############################################################################
  '/notification_endpoint':
    #SOL005 location: 8.2-1
    post:
      summary: >
rameshnaraya's avatar
rameshnaraya committed
616
        Notify about NS alarms.
617
618
      description: >
        The POST method notifies an alarm related to a NS or that the alarm list has been rebuilt.
rameshnaraya's avatar
rameshnaraya committed
619
620
      # Don't know how to pass multiple body parameters. 
      # Jenkin build is failing if enable more than one body parameters, So commented body parameters.
621
622
623
624
625
626
627
      parameters:
        - name: alarmNotification
          description: >
            Information of a NS alarm.
          in: body
          required: true
          schema:
rameshnaraya's avatar
rameshnaraya committed
628
629
630
            properties:
              AlarmNotification:
                $ref: "definitions/SOL005NSFaultManagement_def.yaml#/definitions/AlarmNotification"
631
632
633
634
635
636
        #- name: alarmClearedNotification
        #  description: >
        #    Information of the clearance of a NS alarm.
        #  in: body
        #  required: true
        #  schema:
rameshnaraya's avatar
rameshnaraya committed
637
638
639
        #      properties:
        #        AlarmClearedNotification:        
        #         $ref: "definitions/SOL005NSFaultManagement_def.yaml#/definitions/AlarmClearedNotification"
640
641
642
643
644
645
        #- name: alarmListRebuiltNotification
        #  description: >
        #    Information that the alarm list has been rebuilt by the NFVO.
        #  in: body
        #  required: true
        #  schema:
rameshnaraya's avatar
rameshnaraya committed
646
647
        #      properties:
        #        AlarmListRebuiltNotification:   
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
        #    $ref: "definitions/SOL005NSFaultManagement_def.yaml#/definitions/AlarmListRebuiltNotification"            
        - 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
      responses:
        204:
          description: >
            The notification was delivered successfully.
            The response body shall be empty.          
        400:
          $ref: "responses/SOL005_resp.yaml#/responses/400"
        401:
          $ref: "responses/SOL005_resp.yaml#/responses/401"
        403:
          $ref: "responses/SOL005_resp.yaml#/responses/403"                        
        500:
          $ref: "responses/SOL005_resp.yaml#/responses/500"
        503:
          $ref: "responses/SOL005_resp.yaml#/responses/503" 
    get:
rameshnaraya's avatar
rameshnaraya committed
686
      summary: Test the notification endpoint.
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
      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
      responses:
        204:
          description: >
            The notification endpoint was tested successfully.
            The response body shall be empty. 
        400:
          $ref: "responses/SOL005_resp.yaml#/responses/400"
        401:
          $ref: "responses/SOL005_resp.yaml#/responses/401"
        403:
          $ref: "responses/SOL005_resp.yaml#/responses/403"                        
        500:
          $ref: "responses/SOL005_resp.yaml#/responses/500"
        503:
          $ref: "responses/SOL005_resp.yaml#/responses/503"