NSFaultManagement.yaml 35.3 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
16
17
18
19
20
21
22
23
24
25
26
27
28
    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:
29
30
31
32
###############################################################################
# Alarms                                                                      #
###############################################################################
  '/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
45
46
47
48
49
50
51
52
53
54
55
56
57

        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            
58
59
            - perceivedSeverity
            - probableCause
60
61
62
63
64
65
66
67
68
69
70
71
72
73
        - 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
74
75
76
77
78
79
        - name: Version
          description: >
            Version of the API requested to use when responding to this request.
          in: header
          required: true
          type: string
80
81
      responses:
        200:
rameshnaraya's avatar
rameshnaraya committed
82
          description: >
83
            200 OK
rameshnaraya's avatar
rameshnaraya committed
84
            
85
86
            The request has succeeded.
            The response body shall contain the list of related alarms.
rameshnaraya's avatar
rameshnaraya committed
87
88
89
90
91
92
93
          headers:
            Content-Type:
              description: The MIME type of the body of the response.
              type: string
              maximum: 1
              minimum: 1
            WWW-Authenticate:
94
              type: "string"
rameshnaraya's avatar
rameshnaraya committed
95
96
              description: >
                Challenge if the corresponding HTTP request has not provided
97
98
99
                authorization, or error details if the corresponding HTTP request
                has provided an invalid authorization token.
              maximum: 1
100
101
102
103
104
105
106
              minimum: 0
            Version:
              description: >
                Version of the API used in the response.
              type: string
              maximum: 1
              minimum: 1
107
          schema:
rameshnaraya's avatar
rameshnaraya committed
108
109
110
111
112
            type: array
            items:
              properties:
                Alarm:
                  $ref: "definitions/SOL005NSFaultManagement_def.yaml#/definitions/Alarm" 
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
        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}':
132
    #ETSI GS NFV-SOL 005 V2.4.1 location: 8.4.3
133
134
135
    parameters:
      - name: alarmId
        description: >
rameshnaraya's avatar
rameshnaraya committed
136
137
138
139
140
          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.
141
142
143
        in: path
        type: string
        required: true
144
    get:
145
      summary: Read individual alarm.
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
      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
170
171
172
173
174
175
        - 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
176
      responses:            
177
        200:
rameshnaraya's avatar
rameshnaraya committed
178
          description: >
179
            200 OK
rameshnaraya's avatar
rameshnaraya committed
180
            
181
182
183
184
185
            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
186
              description: The MIME type of the body of the response.
187
188
189
              type: string
              maximum: 1
              minimum: 1
rameshnaraya's avatar
rameshnaraya committed
190
            WWW-Authenticate:
191
              type: "string"
rameshnaraya's avatar
rameshnaraya committed
192
193
              description: >
                Challenge if the corresponding HTTP request has not provided
194
195
196
                authorization, or error details if the corresponding HTTP request
                has provided an invalid authorization token.
              maximum: 1
197
198
199
200
201
202
203
              minimum: 0
            Version:
              description: >
                Version of the API used in the response.
              type: string
              maximum: 1
              minimum: 1
204
          schema:
rameshnaraya's avatar
rameshnaraya committed
205
206
207
            properties:
              Alarm:
                $ref: "definitions/SOL005NSFaultManagement_def.yaml#/definitions/Alarm"                  
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
        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:
223
      summary: Acknowledge individual alarm.
224
225
226
227
228
      description: >
        Acknowledge Alarm
  
        This method modifies an individual alarm resource.
      parameters:
rameshnaraya's avatar
rameshnaraya committed
229
230
      - name: "body"
        in: "body"
231
232
        required: true
        schema:
rameshnaraya's avatar
rameshnaraya committed
233
234
235
236
237
238
239
240
          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.
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
      - 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"]
264
265
266
267
268
269
      - name: Version
        description: >
          Version of the API requested to use when responding to this request.
        in: header
        required: true
        type: string
270
271
      responses:
        200:
rameshnaraya's avatar
rameshnaraya committed
272
          description: >
273
            200 OK
rameshnaraya's avatar
rameshnaraya committed
274
            
275
276
277
278
279
            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
280
              description: The MIME type of the body of the response.
281
282
283
284
              type: string
              maximum: 1
              minimum: 1
            WWW-Authenticate:
285
              type: "string"
286
287
              description: >
                Challenge if the corresponding HTTP request has not provided
288
289
                authorization, or error details if the corresponding HTTP request
                has provided an invalid authorization token.
290
              maximum: 1
291
292
293
294
295
296
297
              minimum: 0
            Version:
              description: >
                Version of the API used in the response.
              type: string
              maximum: 1
              minimum: 1
298
          schema:
rameshnaraya's avatar
rameshnaraya committed
299
300
301
            properties:
              AlarmModifications:
                $ref: "definitions/SOL005NSFaultManagement_def.yaml#/definitions/AlarmModifications"
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
        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':
324
    #ETSI GS NFV-SOL 005 V2.4.1 location: 8.4.4
325
    post:
326
      summary: Subscribe to alarms related to NSs.
rameshnaraya's avatar
rameshnaraya committed
327
      description: > 
328
329
330
331
332
333
334
335
        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
336
337
        the existing subscription resource with the same filter and callbackUri).
      parameters:         
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
        - 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
358
359
360
361
362
363
364
          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
365
366
367
368
369
370
371
372
373
374
375
376
377
        - 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.
              
378
379
      responses:
        201:
380
381
382
383
384
385
386
387
          description: >
            201 Created
            
            The subscription was created successfully.
            The response body shall contain a representation of the
            created subscription resource.
            The HTTP response shall include a "Location:" HTTP
            header that points to the created subscription resource.              
rameshnaraya's avatar
rameshnaraya committed
388
389
390
391
392
          schema:
            type: "object"
            properties:
              FmSubscription:
                $ref: "definitions/SOL005NSFaultManagement_def.yaml#/definitions/FmSubscription"
393
          headers:
rameshnaraya's avatar
rameshnaraya committed
394
395
396
397
398
399
            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.
400
            WWW-Authenticate:
rameshnaraya's avatar
rameshnaraya committed
401
              type: "string"
402
403
              description: >
                Challenge if the corresponding HTTP request has not provided
rameshnaraya's avatar
rameshnaraya committed
404
                authorization, or error details if the corresponding HTTP request
405
406
                has provided an invalid authorization token.
              maximum: 1
407
408
409
410
411
412
413
              minimum: 0
            Version:
              description: >
                Version of the API used in the response.
              type: string
              maximum: 1
              minimum: 1
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
        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:
431
      summary: Query multiple subscriptions.
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
      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
449
            Attribute-based filtering parameters according to clause 4.3.2.
450
451
452
            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
453
            referenced from it shall be supported in attribute-based filtering parameters.       
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
        - 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
475
476
477
478
479
480
        - name: Version
          description: >
            Version of the API requested to use when responding to this request.
          in: header
          required: true
          type: string
481
482
      responses:
        200:
rameshnaraya's avatar
rameshnaraya committed
483
          description: >
484
            200 OK
485
486
487
488
489
490
491
            
            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
492
              description: The MIME type of the body of the response.
493
494
495
496
              type: string
              maximum: 1
              minimum: 1
            WWW-Authenticate:
497
              type: "string"
498
499
              description: >
                Challenge if the corresponding HTTP request has not provided
500
501
502
                authorization, or error details if the corresponding HTTP request
                has provided an invalid authorization token.
              maximum: 1
503
504
505
506
507
508
509
              minimum: 0
            Version:
              description: >
                Version of the API used in the response.
              type: string
              maximum: 1
              minimum: 1
510
511
512
          schema:
            type: array
            items:
rameshnaraya's avatar
rameshnaraya committed
513
514
515
              properties:
                FmSubscription:
                  $ref: "definitions/SOL005NSFaultManagement_def.yaml#/definitions/FmSubscription"  
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
        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
532
          
533
534
535
536
###############################################################################
# Individual subscription                                                     #
###############################################################################
  '/subscriptions/{subscriptionId}':
537
    #ETSI GS NFV-SOL 005 V2.4.1 location: 8.4.5
538
539
540
541
542
543
544
545
546
547
548
549
    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:
550
      summary: Read an individual subscription.
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
      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
579
580
581
582
583
584
        - name: Version
          description: >
            Version of the API requested to use when responding to this request.
          in: header
          required: true
          type: string
585
586
      responses:
        200:
587
588
589
          description: >
            200 OK
            
590
591
592
593
594
595
596
597
598
599
600
601
            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:
602
              type: "string"
603
604
              description: >
                Challenge if the corresponding HTTP request has not provided
605
606
                authorization, or error details if the corresponding HTTP request
                has provided an invalid authorization token.
607
608
              maximum: 1
              minimum: 0
609
610
611
612
613
614
            Version:
              description: >
                Version of the API used in the response.
              type: string
              maximum: 1
              minimum: 1
615
          schema:
616
617
618
            properties:
              FmSubscription:
                $ref: "definitions/SOL005NSFaultManagement_def.yaml#/definitions/FmSubscription"
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
        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:
634
      summary: Terminate a subscription.
635
636
637
638
639
640
641
642
643
644
645
646
      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
647
648
649
650
651
652
        - name: Version
          description: >
            Version of the API requested to use when responding to this request.
          in: header
          required: true
          type: string
653
654
655
      responses:
        204:
          description: > 
656
            204 - No Content
657
658
659
660
661
 
            The subscription resource was deleted successfully.
            The response body shall be empty.
          headers:
            WWW-Authenticate:
662
              type: "string"
663
664
              description: >
                Challenge if the corresponding HTTP request has not provided
665
666
                authorization, or error details if the corresponding HTTP request
                has provided an invalid authorization token.
667
668
              maximum: 1
              minimum: 0
669
670
671
672
673
674
            Version:
              description: >
                Version of the API used in the response.
              type: string
              maximum: 1
              minimum: 1
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
        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"
          
690
691
692
693
694
695
696
##################################################################################
# Notification endpoint                                                          #
# Dummy URI is used for testing.                                                 #
# In real, resource URI is provided by the client when creating the subscription.#
##################################################################################
  '/URI_is_provided_by_the_client_when_creating_the_subscription-AlarmNotification':
    #ETSI GS NFV-SOL 005 V2.4.1 location: 8.4.6
697
    post:
698
      summary: Notify about NS alarms
699
700
      description: >
        The POST method notifies an alarm related to a NS or that the alarm list has been rebuilt.
701

702
703
704
705
706
707
708
      parameters:
        - name: alarmNotification
          description: >
            Information of a NS alarm.
          in: body
          required: true
          schema:
rameshnaraya's avatar
rameshnaraya committed
709
710
            properties:
              AlarmNotification:
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
                $ref: "definitions/SOL005NSFaultManagement_def.yaml#/definitions/AlarmNotification"           
        - 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
733
734
735
736
737
738
        - name: Version
          description: >
            Version of the API requested to use when responding to this request.
          in: header
          required: true
          type: string
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
      responses:
        204:
          description: >
            204 No Content
            
            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
754
755
756
757
758
759
760
              minimum: 0
            Version:
              description: >
                Version of the API used in the response.
              type: string
              maximum: 1
              minimum: 1
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
        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" 
          
  '/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:
              AlarmClearedNotification:        
                $ref: "definitions/SOL005NSFaultManagement_def.yaml#/definitions/AlarmClearedNotification"          
        - 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
809
810
811
812
813
814
        - name: Version
          description: >
            Version of the API requested to use when responding to this request.
          in: header
          required: true
          type: string
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
      responses:
        204:
          description: >
            204 No Content
            
            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
830
831
832
833
834
835
836
              minimum: 0
            Version:
              description: >
                Version of the API used in the response.
              type: string
              maximum: 1
              minimum: 1
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
        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" 

  '/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:
              AlarmListRebuiltNotification:   
                $ref: "definitions/SOL005NSFaultManagement_def.yaml#/definitions/AlarmListRebuiltNotification"             
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
        - 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
885
886
887
888
889
890
        - name: Version
          description: >
            Version of the API requested to use when responding to this request.
          in: header
          required: true
          type: string
891
892
893
      responses:
        204:
          description: >
894
895
            204 No Content
            
896
            The notification was delivered successfully.
897
898
899
900
901
902
903
904
905
            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
906
907
908
909
910
911
912
              minimum: 0
            Version:
              description: >
                Version of the API used in the response.
              type: string
              maximum: 1
              minimum: 1
913
914
915
916
917
918
919
920
921
922
        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" 
923
          
924
    get:
925
      summary: Test the notification endpoint
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
      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
944
945
946
947
948
949
        - name: Version
          description: >
            Version of the API requested to use when responding to this request.
          in: header
          required: true
          type: string
950
951
952
      responses:
        204:
          description: >
953
954
            204 No Content
            
955
956
            The notification endpoint was tested successfully.
            The response body shall be empty. 
957
958
959
960
961
962
963
964
965
          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
              minimum: 0            
966
967
968
969
970
971
972
973
974
975
        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"