NSFaultManagement.yaml 36.1 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
            Attribute-based filtering expression according to clause 4.3.2.
            The NFVO shall support receiving this parameter as part of the URI query string.
            The OSS/BSS may supply this parameter.
            The following attribute names shall be supported by the NFVO in the filter 
            expression: 
51
52
53
54
55
56
57
            - 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
115
116
117
118
119
            Link:
              description: >
                Reference to other resources. Used for paging in the present document, see clause 4.7.2.1.
              type: string
              maximum: 1
              minimum: 0
120
          schema:
rameshnaraya's avatar
rameshnaraya committed
121
122
123
124
            type: array
            items:
              properties:
                Alarm:
125
                  $ref: "definitions/SOL005NSFaultManagement_def.yaml#/definitions/Alarm"
126
127
128
129
130
131
132
133
134
135
136
137
138
        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:
139
140
141
142
143
          $ref: "responses/SOL005_resp.yaml#/responses/503"

  ###############################################################################
  # Individual alarm                                                            #
  ###############################################################################
144
  '/alarms/{alarmId}':
145
    #ETSI GS NFV-SOL 005 V2.4.1 location: 8.4.3
146
147
148
    parameters:
      - name: alarmId
        description: >
rameshnaraya's avatar
rameshnaraya committed
149
150
151
152
153
          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.
154
155
156
        in: path
        type: string
        required: true
157
    get:
158
      summary: Read individual alarm.
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
      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
183
184
185
186
187
188
        - name: Version
          description: >
            Version of the API requested to use when responding to this request.
          in: header
          required: true
          type: string
189
      responses:
190
        200:
rameshnaraya's avatar
rameshnaraya committed
191
          description: >
192
            200 OK
193

194
195
196
197
198
            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
199
              description: The MIME type of the body of the response.
200
201
202
              type: string
              maximum: 1
              minimum: 1
rameshnaraya's avatar
rameshnaraya committed
203
            WWW-Authenticate:
204
              type: "string"
rameshnaraya's avatar
rameshnaraya committed
205
206
              description: >
                Challenge if the corresponding HTTP request has not provided
207
208
209
                authorization, or error details if the corresponding HTTP request
                has provided an invalid authorization token.
              maximum: 1
210
211
212
213
214
215
216
              minimum: 0
            Version:
              description: >
                Version of the API used in the response.
              type: string
              maximum: 1
              minimum: 1
217
          schema:
rameshnaraya's avatar
rameshnaraya committed
218
219
            properties:
              Alarm:
220
                $ref: "definitions/SOL005NSFaultManagement_def.yaml#/definitions/Alarm"
221
222
223
224
225
        400:
          $ref: "responses/SOL005_resp.yaml#/responses/400"
        401:
          $ref: "responses/SOL005_resp.yaml#/responses/401"
        403:
226
          $ref: "responses/SOL005_resp.yaml#/responses/403"
227
228
229
230
231
232
233
        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:
234
          $ref: "responses/SOL005_resp.yaml#/responses/503"
235
    patch:
236
      summary: Acknowledge individual alarm.
237
238
      description: >
        Acknowledge Alarm
239

240
241
        This method modifies an individual alarm resource.
      parameters:
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
277
278
279
280
281
282
        - 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
283
284
      responses:
        200:
rameshnaraya's avatar
rameshnaraya committed
285
          description: >
286
            200 OK
287

288
289
290
291
292
            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
293
              description: The MIME type of the body of the response.
294
295
296
297
              type: string
              maximum: 1
              minimum: 1
            WWW-Authenticate:
298
              type: "string"
299
300
              description: >
                Challenge if the corresponding HTTP request has not provided
301
302
                authorization, or error details if the corresponding HTTP request
                has provided an invalid authorization token.
303
              maximum: 1
304
305
306
307
308
309
310
              minimum: 0
            Version:
              description: >
                Version of the API used in the response.
              type: string
              maximum: 1
              minimum: 1
311
          schema:
rameshnaraya's avatar
rameshnaraya committed
312
313
314
            properties:
              AlarmModifications:
                $ref: "definitions/SOL005NSFaultManagement_def.yaml#/definitions/AlarmModifications"
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
        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"
333
334
335
  ##############################################################################
  #Subscriptions                                                               #
  ##############################################################################
336
  '/subscriptions':
337
    #ETSI GS NFV-SOL 005 V2.4.1 location: 8.4.4
338
    post:
339
      summary: Subscribe to alarms related to NSs.
340
      description: >
341
342
343
344
345
346
347
348
        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
349
        the existing subscription resource with the same filter and callbackUri).
350
      parameters:
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
        - 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
371
372
373
374
375
376
377
          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
378
379
380
381
382
383
        - name: "body"
          in: "body"
          required: true
          schema:
            type: "object"
            required:
384
              - "FmSubscriptionRequest"
rameshnaraya's avatar
rameshnaraya committed
385
386
387
388
389
            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.
390

391
392
      responses:
        201:
393
394
          description: >
            201 Created
395

396
397
398
399
400
            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
401
402
403
404
405
          schema:
            type: "object"
            properties:
              FmSubscription:
                $ref: "definitions/SOL005NSFaultManagement_def.yaml#/definitions/FmSubscription"
406
          headers:
rameshnaraya's avatar
rameshnaraya committed
407
408
409
410
411
412
            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.
413
            WWW-Authenticate:
rameshnaraya's avatar
rameshnaraya committed
414
              type: "string"
415
416
              description: >
                Challenge if the corresponding HTTP request has not provided
rameshnaraya's avatar
rameshnaraya committed
417
                authorization, or error details if the corresponding HTTP request
418
419
                has provided an invalid authorization token.
              maximum: 1
420
421
422
423
424
425
426
              minimum: 0
            Version:
              description: >
                Version of the API used in the response.
              type: string
              maximum: 1
              minimum: 1
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
        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:
444
      summary: Query multiple subscriptions.
445
446
      description: >
        Query Subscription Information
447

448
449
450
        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.
451

452
453
454
455
456
457
458
459
460
        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"
461
          description: >
462
463
464
            Attribute-based filtering expression according to clause 4.3.2.
            The NFVO shall support receiving this parameter as part of the URI
            query string. The OSS/BSS may supply this parameter.
465
            All attribute names that appear in the FmSubscription and in data types
466
            referenced from it shall be supported by the NFVO in the filter expression.       
467
468
469
470
471
472
473
        - 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
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
        - 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
495
496
497
498
499
500
        - name: Version
          description: >
            Version of the API requested to use when responding to this request.
          in: header
          required: true
          type: string
501
502
      responses:
        200:
rameshnaraya's avatar
rameshnaraya committed
503
          description: >
504
            200 OK
505

506
507
508
509
510
511
            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
512
              description: The MIME type of the body of the response.
513
514
515
516
              type: string
              maximum: 1
              minimum: 1
            WWW-Authenticate:
517
              type: "string"
518
519
              description: >
                Challenge if the corresponding HTTP request has not provided
520
521
522
                authorization, or error details if the corresponding HTTP request
                has provided an invalid authorization token.
              maximum: 1
523
524
525
526
527
528
529
              minimum: 0
            Version:
              description: >
                Version of the API used in the response.
              type: string
              maximum: 1
              minimum: 1
530
531
532
533
534
535
            Link:
              description: >
                Reference to other resources. Used for paging in the present document, see clause 4.7.2.1.
              type: string
              maximum: 1
              minimum: 0
536
537
538
          schema:
            type: array
            items:
rameshnaraya's avatar
rameshnaraya committed
539
540
              properties:
                FmSubscription:
541
                  $ref: "definitions/SOL005NSFaultManagement_def.yaml#/definitions/FmSubscription"
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
        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"
558
559
560
561

  ###############################################################################
  # Individual subscription                                                     #
  ###############################################################################
562
  '/subscriptions/{subscriptionId}':
563
    #ETSI GS NFV-SOL 005 V2.4.1 location: 8.4.5
564
565
566
567
568
569
570
571
572
573
574
575
    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:
576
      summary: Read an individual subscription.
577
578
      description: >
        Query Subscription Information
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
        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
605
606
607
608
609
610
        - name: Version
          description: >
            Version of the API requested to use when responding to this request.
          in: header
          required: true
          type: string
611
612
      responses:
        200:
613
614
          description: >
            200 OK
615

616
617
618
619
620
621
622
623
624
625
626
627
            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:
628
              type: "string"
629
630
              description: >
                Challenge if the corresponding HTTP request has not provided
631
632
                authorization, or error details if the corresponding HTTP request
                has provided an invalid authorization token.
633
634
              maximum: 1
              minimum: 0
635
636
637
638
639
640
            Version:
              description: >
                Version of the API used in the response.
              type: string
              maximum: 1
              minimum: 1
641
          schema:
642
643
644
            properties:
              FmSubscription:
                $ref: "definitions/SOL005NSFaultManagement_def.yaml#/definitions/FmSubscription"
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
        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:
660
      summary: Terminate a subscription.
661
662
      description: >
        Terminate Subscription
663

664
665
666
667
668
669
670
671
672
        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
673
674
675
676
677
678
        - name: Version
          description: >
            Version of the API requested to use when responding to this request.
          in: header
          required: true
          type: string
679
680
      responses:
        204:
681
          description: >
682
            204 - No Content
683

684
685
686
687
            The subscription resource was deleted successfully.
            The response body shall be empty.
          headers:
            WWW-Authenticate:
688
              type: "string"
689
690
              description: >
                Challenge if the corresponding HTTP request has not provided
691
692
                authorization, or error details if the corresponding HTTP request
                has provided an invalid authorization token.
693
694
              maximum: 1
              minimum: 0
695
696
697
698
699
700
            Version:
              description: >
                Version of the API used in the response.
              type: string
              maximum: 1
              minimum: 1
701
702
703
704
705
706
707
708
709
710
711
712
713
714
        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"
715
716
717
718
719
720

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

728
729
730
731
732
733
734
      parameters:
        - name: alarmNotification
          description: >
            Information of a NS alarm.
          in: body
          required: true
          schema:
rameshnaraya's avatar
rameshnaraya committed
735
736
            properties:
              AlarmNotification:
737
                $ref: "definitions/SOL005NSFaultManagement_def.yaml#/definitions/AlarmNotification"
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
        - 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
759
760
761
762
763
764
        - name: Version
          description: >
            Version of the API requested to use when responding to this request.
          in: header
          required: true
          type: string
765
766
767
768
      responses:
        204:
          description: >
            204 No Content
769

770
771
772
773
774
775
776
777
778
779
            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
780
781
782
783
784
785
786
              minimum: 0
            Version:
              description: >
                Version of the API used in the response.
              type: string
              maximum: 1
              minimum: 1
787
788
789
790
791
        400:
          $ref: "responses/SOL005_resp.yaml#/responses/400"
        401:
          $ref: "responses/SOL005_resp.yaml#/responses/401"
        403:
792
          $ref: "responses/SOL005_resp.yaml#/responses/403"
793
794
795
        500:
          $ref: "responses/SOL005_resp.yaml#/responses/500"
        503:
796
797
          $ref: "responses/SOL005_resp.yaml#/responses/503"

798
799
800
801
802
803
804
805
806
807
808
809
810
811
  '/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:
812
813
              AlarmClearedNotification:
                $ref: "definitions/SOL005NSFaultManagement_def.yaml#/definitions/AlarmClearedNotification"
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
        - 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
835
836
837
838
839
840
        - name: Version
          description: >
            Version of the API requested to use when responding to this request.
          in: header
          required: true
          type: string
841
842
843
844
      responses:
        204:
          description: >
            204 No Content
845

846
847
848
849
850
851
852
853
854
855
            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
856
857
858
859
860
861
862
              minimum: 0
            Version:
              description: >
                Version of the API used in the response.
              type: string
              maximum: 1
              minimum: 1
863
864
865
866
867
        400:
          $ref: "responses/SOL005_resp.yaml#/responses/400"
        401:
          $ref: "responses/SOL005_resp.yaml#/responses/401"
        403:
868
          $ref: "responses/SOL005_resp.yaml#/responses/403"
869
870
871
        500:
          $ref: "responses/SOL005_resp.yaml#/responses/500"
        503:
872
          $ref: "responses/SOL005_resp.yaml#/responses/503"
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887

  '/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:
888
889
              AlarmListRebuiltNotification:
                $ref: "definitions/SOL005NSFaultManagement_def.yaml#/definitions/AlarmListRebuiltNotification"
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
        - 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
911
912
913
914
915
916
        - name: Version
          description: >
            Version of the API requested to use when responding to this request.
          in: header
          required: true
          type: string
917
918
919
      responses:
        204:
          description: >
920
            204 No Content
921

922
            The notification was delivered successfully.
923
924
925
926
927
928
929
930
931
            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
932
933
934
935
936
937
938
              minimum: 0
            Version:
              description: >
                Version of the API used in the response.
              type: string
              maximum: 1
              minimum: 1
939
940
941
942
943
        400:
          $ref: "responses/SOL005_resp.yaml#/responses/400"
        401:
          $ref: "responses/SOL005_resp.yaml#/responses/401"
        403:
944
          $ref: "responses/SOL005_resp.yaml#/responses/403"
945
946
947
        500:
          $ref: "responses/SOL005_resp.yaml#/responses/500"
        503:
948
949
          $ref: "responses/SOL005_resp.yaml#/responses/503"

950
    get:
951
      summary: Test the notification endpoint
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
      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
970
971
972
973
974
975
        - name: Version
          description: >
            Version of the API requested to use when responding to this request.
          in: header
          required: true
          type: string
976
977
978
      responses:
        204:
          description: >
979
            204 No Content
980

981
982
            The notification endpoint was tested successfully.
            The response body shall be empty. 
983
984
985
986
987
988
989
990
          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
991
              minimum: 0
992
993
994
995
996
        400:
          $ref: "responses/SOL005_resp.yaml#/responses/400"
        401:
          $ref: "responses/SOL005_resp.yaml#/responses/401"
        403:
997
          $ref: "responses/SOL005_resp.yaml#/responses/403"
998
999
1000
1001
        500:
          $ref: "responses/SOL005_resp.yaml#/responses/500"
        503:
          $ref: "responses/SOL005_resp.yaml#/responses/503"