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

3
info:
4
  version: "1.2.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
    name: "NFV-SOL WG"
externalDocs:
19
20
  description: ETSI GS NFV-SOL 005 V2.5.1
  url: https://www.etsi.org/deliver/etsi_gs/NFV-SOL/001_099/005/02.05.01_60/gs_NFV-SOL005v020501p.pdf
21
22
23
24
25
26
27
28
basePath: "/nsfm/v1"
schemes:
  - https
consumes:
  - "application/json"
produces:
  - "application/json"
paths:
29
  ###############################################################################
30
31
32
  # API Versions                                                                #
  ###############################################################################
  '/api-versions':
33
34
    $ref: '../endpoints/SOL005_endpoints.yaml#/endpoints/api-versions'

35
  ###############################################################################
36
37
  # Alarms                                                                      #
  ###############################################################################
38
  '/alarms':
39
    #ETSI GS NFV-SOL 005 V2.4.1 location: 8.4.2
40
    get:
41
      summary: Query alarms related to NS instances.
42
      description: >
rameshnaraya's avatar
rameshnaraya committed
43
        Get Alarm List.
44
45
46

        The client can use this method to retrieve information about the alarm list.
      parameters:
47
48
        - name: filter
          in: query
49
          required: false
50
          type: string
51
          description: >
52
53
54
55
56
            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: 
57
58
59
60
61
62
63
            - id            
            - nsInstanceId            
            - rootCauseFaultyComponent.faultyNestedNsInstanceId            
            - rootCauseFaultyComponent.faultyNsVirtualLinkInstanceId            
            - rootCauseFaultyComponent.faultyVnfInstanceId           
            - rootCauseFaultyResource.faultyResourceType            
            - eventType            
64
65
            - perceivedSeverity
            - probableCause
66
67
68
69
70
71
72
        - 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
73
74
75
76
77
78
79
80
81
82
83
84
85
86
        - 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
87
88
89
90
91
92
        - name: Version
          description: >
            Version of the API requested to use when responding to this request.
          in: header
          required: true
          type: string
93
94
      responses:
        200:
rameshnaraya's avatar
rameshnaraya committed
95
          description: >
96
            200 OK
97

98
            Information about zero or more alarms was queried successfully.
99
            The response body shall contain the list of related alarms.
100
101
102
            If the NFVO supports alternative 2 (paging) according to 
            clause 4.7.2.1 for this resource, inclusion of the Link HTTP header 
            in this response shall follow the provisions in clause 4.7.2.3.
rameshnaraya's avatar
rameshnaraya committed
103
104
105
106
107
108
109
          headers:
            Content-Type:
              description: The MIME type of the body of the response.
              type: string
              maximum: 1
              minimum: 1
            WWW-Authenticate:
110
              type: "string"
rameshnaraya's avatar
rameshnaraya committed
111
112
              description: >
                Challenge if the corresponding HTTP request has not provided
113
114
115
                authorization, or error details if the corresponding HTTP request
                has provided an invalid authorization token.
              maximum: 1
116
117
118
119
120
121
122
              minimum: 0
            Version:
              description: >
                Version of the API used in the response.
              type: string
              maximum: 1
              minimum: 1
123
124
125
126
127
128
            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
129
          schema:
rameshnaraya's avatar
rameshnaraya committed
130
131
132
133
            type: array
            items:
              properties:
                Alarm:
134
                  $ref: "definitions/SOL005NSFaultManagement_def.yaml#/definitions/Alarm"
135
136
137
138
139
140
141
142
143
144
145
146
147
        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:
148
149
150
151
152
          $ref: "responses/SOL005_resp.yaml#/responses/503"

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

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

249
250
        This method modifies an individual alarm resource.
      parameters:
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
283
284
285
286
287
288
289
290
291
        - 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
292
293
      responses:
        200:
rameshnaraya's avatar
rameshnaraya committed
294
          description: >
295
            200 OK
296

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

400
401
      responses:
        201:
402
403
          description: >
            201 Created
404

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

457
458
459
        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.
460

461
462
463
464
465
        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:
466
467
        - name: filter
          in: query
468
          required: false
469
          type: string
470
          description: >
471
472
473
            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.
474
            All attribute names that appear in the FmSubscription and in data types
475
            referenced from it shall be supported by the NFVO in the filter expression.       
476
477
478
479
480
481
482
        - 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
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
        - 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
504
505
506
507
508
509
        - name: Version
          description: >
            Version of the API requested to use when responding to this request.
          in: header
          required: true
          type: string
510
511
      responses:
        200:
rameshnaraya's avatar
rameshnaraya committed
512
          description: >
513
            200 OK
514

515
            The list of subscriptions was queried successfully.
516
517
518
519
520
521
522
            The response body shall contain in an array the representations 
            of all active subscriptions of the functional block that invokes 
            the method, i.e. zero or more representations of FM subscriptions,
            as defined in clause 8.5.2.3.
            If the NFVO supports alternative 2 (paging) according to 
            clause 4.7.2.1 for this resource, inclusion of the Link HTTP header 
            in this response shall follow the provisions in clause 4.7.2.3.
523
524
          headers:
            Content-Type:
rameshnaraya's avatar
rameshnaraya committed
525
              description: The MIME type of the body of the response.
526
527
528
529
              type: string
              maximum: 1
              minimum: 1
            WWW-Authenticate:
530
              type: "string"
531
532
              description: >
                Challenge if the corresponding HTTP request has not provided
533
534
535
                authorization, or error details if the corresponding HTTP request
                has provided an invalid authorization token.
              maximum: 1
536
537
538
539
540
541
542
              minimum: 0
            Version:
              description: >
                Version of the API used in the response.
              type: string
              maximum: 1
              minimum: 1
543
544
545
546
547
548
            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
549
550
551
          schema:
            type: array
            items:
rameshnaraya's avatar
rameshnaraya committed
552
553
              properties:
                FmSubscription:
554
                  $ref: "definitions/SOL005NSFaultManagement_def.yaml#/definitions/FmSubscription"
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
        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"
571
572
573
574

  ###############################################################################
  # Individual subscription                                                     #
  ###############################################################################
575
  '/subscriptions/{subscriptionId}':
576
    #ETSI GS NFV-SOL 005 V2.4.1 location: 8.4.5
577
578
579
580
581
582
583
584
585
586
587
588
    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:
589
      summary: Read an individual subscription.
590
591
      description: >
        Query Subscription Information
592

593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
        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
618
619
620
621
622
623
        - name: Version
          description: >
            Version of the API requested to use when responding to this request.
          in: header
          required: true
          type: string
624
625
      responses:
        200:
626
627
          description: >
            200 OK
628

629
630
631
632
633
634
635
636
637
638
639
640
            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:
641
              type: "string"
642
643
              description: >
                Challenge if the corresponding HTTP request has not provided
644
645
                authorization, or error details if the corresponding HTTP request
                has provided an invalid authorization token.
646
647
              maximum: 1
              minimum: 0
648
649
650
651
652
653
            Version:
              description: >
                Version of the API used in the response.
              type: string
              maximum: 1
              minimum: 1
654
          schema:
655
656
657
            properties:
              FmSubscription:
                $ref: "definitions/SOL005NSFaultManagement_def.yaml#/definitions/FmSubscription"
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
        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:
673
      summary: Terminate a subscription.
674
675
      description: >
        Terminate Subscription
676

677
678
679
680
681
682
683
684
685
        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
686
687
688
689
690
691
        - name: Version
          description: >
            Version of the API requested to use when responding to this request.
          in: header
          required: true
          type: string
692
693
      responses:
        204:
694
          description: >
695
            204 - No Content
696

697
698
699
700
            The subscription resource was deleted successfully.
            The response body shall be empty.
          headers:
            WWW-Authenticate:
701
              type: "string"
702
703
              description: >
                Challenge if the corresponding HTTP request has not provided
704
705
                authorization, or error details if the corresponding HTTP request
                has provided an invalid authorization token.
706
707
              maximum: 1
              minimum: 0
708
709
710
711
712
713
            Version:
              description: >
                Version of the API used in the response.
              type: string
              maximum: 1
              minimum: 1
714
715
716
717
718
719
720
721
722
723
724
725
726
727
        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"
728
729
730
731
732
733

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

741
742
743
744
745
746
747
      parameters:
        - name: alarmNotification
          description: >
            Information of a NS alarm.
          in: body
          required: true
          schema:
rameshnaraya's avatar
rameshnaraya committed
748
749
            properties:
              AlarmNotification:
750
                $ref: "definitions/SOL005NSFaultManagement_def.yaml#/definitions/AlarmNotification"
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
        - 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
772
773
774
775
776
777
        - name: Version
          description: >
            Version of the API requested to use when responding to this request.
          in: header
          required: true
          type: string
778
779
780
781
      responses:
        204:
          description: >
            204 No Content
782

783
784
785
786
787
788
789
790
791
792
            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
793
794
795
796
797
798
799
              minimum: 0
            Version:
              description: >
                Version of the API used in the response.
              type: string
              maximum: 1
              minimum: 1
800
801
802
803
804
        400:
          $ref: "responses/SOL005_resp.yaml#/responses/400"
        401:
          $ref: "responses/SOL005_resp.yaml#/responses/401"
        403:
805
          $ref: "responses/SOL005_resp.yaml#/responses/403"
806
807
808
        500:
          $ref: "responses/SOL005_resp.yaml#/responses/500"
        503:
809
810
          $ref: "responses/SOL005_resp.yaml#/responses/503"

811
812
813
814
815
816
817
818
819
820
821
822
823
824
  '/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:
825
826
              AlarmClearedNotification:
                $ref: "definitions/SOL005NSFaultManagement_def.yaml#/definitions/AlarmClearedNotification"
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
        - 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
848
849
850
851
852
853
        - name: Version
          description: >
            Version of the API requested to use when responding to this request.
          in: header
          required: true
          type: string
854
855
856
857
      responses:
        204:
          description: >
            204 No Content
858

859
860
861
862
863
864
865
866
867
868
            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
869
870
871
872
873
874
875
              minimum: 0
            Version:
              description: >
                Version of the API used in the response.
              type: string
              maximum: 1
              minimum: 1
876
877
878
879
880
        400:
          $ref: "responses/SOL005_resp.yaml#/responses/400"
        401:
          $ref: "responses/SOL005_resp.yaml#/responses/401"
        403:
881
          $ref: "responses/SOL005_resp.yaml#/responses/403"
882
883
884
        500:
          $ref: "responses/SOL005_resp.yaml#/responses/500"
        503:
885
          $ref: "responses/SOL005_resp.yaml#/responses/503"
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900

  '/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:
901
902
              AlarmListRebuiltNotification:
                $ref: "definitions/SOL005NSFaultManagement_def.yaml#/definitions/AlarmListRebuiltNotification"
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
        - 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
924
925
926
927
928
929
        - name: Version
          description: >
            Version of the API requested to use when responding to this request.
          in: header
          required: true
          type: string
930
931
932
      responses:
        204:
          description: >
933
            204 No Content
934

935
            The notification was delivered successfully.
936
937
938
939
940
941
942
943
944
            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
945
946
947
948
949
950
951
              minimum: 0
            Version:
              description: >
                Version of the API used in the response.
              type: string
              maximum: 1
              minimum: 1
952
953
954
955
956
        400:
          $ref: "responses/SOL005_resp.yaml#/responses/400"
        401:
          $ref: "responses/SOL005_resp.yaml#/responses/401"
        403:
957
          $ref: "responses/SOL005_resp.yaml#/responses/403"
958
959
960
        500:
          $ref: "responses/SOL005_resp.yaml#/responses/500"
        503:
961
962
          $ref: "responses/SOL005_resp.yaml#/responses/503"

963
    get:
964
      summary: Test the notification endpoint
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
      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
983
984
985
986
987
988
        - name: Version
          description: >
            Version of the API requested to use when responding to this request.
          in: header
          required: true
          type: string
989
990
991
      responses:
        204:
          description: >
992
            204 No Content
993

994
995
            The notification endpoint was tested successfully.
            The response body shall be empty. 
996
997
998
999
1000
1001
1002
1003
          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
1004
              minimum: 0
1005
1006
1007
1008
1009
        400:
          $ref: "responses/SOL005_resp.yaml#/responses/400"
        401:
          $ref: "responses/SOL005_resp.yaml#/responses/401"
        403:
1010
          $ref: "responses/SOL005_resp.yaml#/responses/403"
1011
1012
1013
1014
        500:
          $ref: "responses/SOL005_resp.yaml#/responses/500"
        503:
          $ref: "responses/SOL005_resp.yaml#/responses/503"