NSFaultManagement.yaml 39.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
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
  # API Versions                                                                #
  ###############################################################################
  '/api-versions':
    get:
      summary: Retrieve API version information
      description: >
        The GET method reads API version information. This method shall follow the provisions specified in
        table 4.6.3.3.3.2-1 for request and response data structures, and response codes. URI query parameters are not
        supported.
      parameters:
        - name: Version
          description: >
            Version of the API requested to use when responding to this request.
          in: header
          required: false
          type: string
      responses:
        200:
          description: >
            200 OK
            
            API version information was read successfully.
            The response body shall contain API version information, as defined in clause 4.4.1.7.
          schema:
            $ref: '../definitions/SOL005_def.yaml#/definitions/ApiVersionInformation'
          headers:
            Content-Type:
              description: The MIME type of the body of the response.
              type: string
              maximum: 1
              minimum: 1
            Version:
              description: The used API version.
              type: string
              maximum: 1
              minimum: 1
        400: { $ref: '../responses/SOL005_resp.yaml#/responses/400' }
        401: { $ref: '../responses/SOL005_resp.yaml#/responses/401' }
        403: { $ref: '../responses/SOL005_resp.yaml#/responses/403' }
        404: { $ref: '../responses/SOL005_resp.yaml#/responses/404' }
        405: { $ref: '../responses/SOL005_resp.yaml#/responses/405' }
        406: { $ref: '../responses/SOL005_resp.yaml#/responses/406' }
        413: { $ref: '../responses/SOL005_resp.yaml#/responses/413' }
        414: { $ref: '../responses/SOL005_resp.yaml#/responses/414' }
        416: { $ref: '../responses/SOL005_resp.yaml#/responses/416' }
        422: { $ref: '../responses/SOL005_resp.yaml#/responses/422' }
        429: { $ref: '../responses/SOL005_resp.yaml#/responses/429' }
        500: { $ref: '../responses/SOL005_resp.yaml#/responses/500' }
        503: { $ref: '../responses/SOL005_resp.yaml#/responses/503' }
        504: { $ref: '../responses/SOL005_resp.yaml#/responses/504' }
  ###############################################################################
81
82
  # Alarms                                                                      #
  ###############################################################################
83
  '/alarms':
84
    #ETSI GS NFV-SOL 005 V2.4.1 location: 8.4.2
85
    get:
86
      summary: Query alarms related to NS instances.
87
      description: >
rameshnaraya's avatar
rameshnaraya committed
88
        Get Alarm List.
89
90
91

        The client can use this method to retrieve information about the alarm list.
      parameters:
92
93
        - name: filter
          in: query
94
          required: false
95
          type: string
96
          description: >
97
98
99
100
101
            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: 
102
103
104
105
106
107
108
            - id            
            - nsInstanceId            
            - rootCauseFaultyComponent.faultyNestedNsInstanceId            
            - rootCauseFaultyComponent.faultyNsVirtualLinkInstanceId            
            - rootCauseFaultyComponent.faultyVnfInstanceId           
            - rootCauseFaultyResource.faultyResourceType            
            - eventType            
109
110
            - perceivedSeverity
            - probableCause
111
112
113
114
115
116
117
        - 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
118
119
120
121
122
123
124
125
126
127
128
129
130
131
        - 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
132
133
134
135
136
137
        - name: Version
          description: >
            Version of the API requested to use when responding to this request.
          in: header
          required: true
          type: string
138
139
      responses:
        200:
rameshnaraya's avatar
rameshnaraya committed
140
          description: >
141
            200 OK
142

143
            Information about zero or more alarms was queried successfully.
144
            The response body shall contain the list of related alarms.
145
146
147
            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
148
149
150
151
152
153
154
          headers:
            Content-Type:
              description: The MIME type of the body of the response.
              type: string
              maximum: 1
              minimum: 1
            WWW-Authenticate:
155
              type: "string"
rameshnaraya's avatar
rameshnaraya committed
156
157
              description: >
                Challenge if the corresponding HTTP request has not provided
158
159
160
                authorization, or error details if the corresponding HTTP request
                has provided an invalid authorization token.
              maximum: 1
161
162
163
164
165
166
167
              minimum: 0
            Version:
              description: >
                Version of the API used in the response.
              type: string
              maximum: 1
              minimum: 1
168
169
170
171
172
173
            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
174
          schema:
rameshnaraya's avatar
rameshnaraya committed
175
176
177
178
            type: array
            items:
              properties:
                Alarm:
179
                  $ref: "definitions/SOL005NSFaultManagement_def.yaml#/definitions/Alarm"
180
181
182
183
184
185
186
187
188
189
190
191
192
        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:
193
194
195
196
197
          $ref: "responses/SOL005_resp.yaml#/responses/503"

  ###############################################################################
  # Individual alarm                                                            #
  ###############################################################################
198
  '/alarms/{alarmId}':
199
    #ETSI GS NFV-SOL 005 V2.4.1 location: 8.4.3
200
201
202
    parameters:
      - name: alarmId
        description: >
rameshnaraya's avatar
rameshnaraya committed
203
204
205
206
207
          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.
208
209
210
        in: path
        type: string
        required: true
211
    get:
212
      summary: Read individual alarm.
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
      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
237
238
239
240
241
242
        - name: Version
          description: >
            Version of the API requested to use when responding to this request.
          in: header
          required: true
          type: string
243
      responses:
244
        200:
rameshnaraya's avatar
rameshnaraya committed
245
          description: >
246
            200 OK
247

248
249
250
251
252
            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
253
              description: The MIME type of the body of the response.
254
255
256
              type: string
              maximum: 1
              minimum: 1
rameshnaraya's avatar
rameshnaraya committed
257
            WWW-Authenticate:
258
              type: "string"
rameshnaraya's avatar
rameshnaraya committed
259
260
              description: >
                Challenge if the corresponding HTTP request has not provided
261
262
263
                authorization, or error details if the corresponding HTTP request
                has provided an invalid authorization token.
              maximum: 1
264
265
266
267
268
269
270
              minimum: 0
            Version:
              description: >
                Version of the API used in the response.
              type: string
              maximum: 1
              minimum: 1
271
          schema:
rameshnaraya's avatar
rameshnaraya committed
272
273
            properties:
              Alarm:
274
                $ref: "definitions/SOL005NSFaultManagement_def.yaml#/definitions/Alarm"
275
276
277
278
279
        400:
          $ref: "responses/SOL005_resp.yaml#/responses/400"
        401:
          $ref: "responses/SOL005_resp.yaml#/responses/401"
        403:
280
          $ref: "responses/SOL005_resp.yaml#/responses/403"
281
282
283
284
285
286
287
        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:
288
          $ref: "responses/SOL005_resp.yaml#/responses/503"
289
    patch:
290
      summary: Acknowledge individual alarm.
291
292
      description: >
        Acknowledge Alarm
293

294
295
        This method modifies an individual alarm resource.
      parameters:
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
        - 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
337
338
      responses:
        200:
rameshnaraya's avatar
rameshnaraya committed
339
          description: >
340
            200 OK
341

342
343
344
345
346
            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
347
              description: The MIME type of the body of the response.
348
349
350
351
              type: string
              maximum: 1
              minimum: 1
            WWW-Authenticate:
352
              type: "string"
353
354
              description: >
                Challenge if the corresponding HTTP request has not provided
355
356
                authorization, or error details if the corresponding HTTP request
                has provided an invalid authorization token.
357
              maximum: 1
358
359
360
361
362
363
364
              minimum: 0
            Version:
              description: >
                Version of the API used in the response.
              type: string
              maximum: 1
              minimum: 1
365
          schema:
rameshnaraya's avatar
rameshnaraya committed
366
367
368
            properties:
              AlarmModifications:
                $ref: "definitions/SOL005NSFaultManagement_def.yaml#/definitions/AlarmModifications"
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
        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"
387
388
389
  ##############################################################################
  #Subscriptions                                                               #
  ##############################################################################
390
  '/subscriptions':
391
    #ETSI GS NFV-SOL 005 V2.4.1 location: 8.4.4
392
    post:
393
      summary: Subscribe to alarms related to NSs.
394
      description: >
395
396
397
398
399
400
401
402
        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
403
        the existing subscription resource with the same filter and callbackUri).
404
      parameters:
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
        - 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
425
426
427
428
429
430
431
          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
432
433
434
435
436
437
        - name: "body"
          in: "body"
          required: true
          schema:
            type: "object"
            required:
438
              - "FmSubscriptionRequest"
rameshnaraya's avatar
rameshnaraya committed
439
440
441
442
443
            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.
444

445
446
      responses:
        201:
447
448
          description: >
            201 Created
449

450
451
452
453
454
            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
455
456
457
458
459
          schema:
            type: "object"
            properties:
              FmSubscription:
                $ref: "definitions/SOL005NSFaultManagement_def.yaml#/definitions/FmSubscription"
460
          headers:
rameshnaraya's avatar
rameshnaraya committed
461
462
463
464
465
466
            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.
467
            WWW-Authenticate:
rameshnaraya's avatar
rameshnaraya committed
468
              type: "string"
469
470
              description: >
                Challenge if the corresponding HTTP request has not provided
rameshnaraya's avatar
rameshnaraya committed
471
                authorization, or error details if the corresponding HTTP request
472
473
                has provided an invalid authorization token.
              maximum: 1
474
475
476
477
478
479
480
              minimum: 0
            Version:
              description: >
                Version of the API used in the response.
              type: string
              maximum: 1
              minimum: 1
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
        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:
498
      summary: Query multiple subscriptions.
499
500
      description: >
        Query Subscription Information
501

502
503
504
        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.
505

506
507
508
509
510
        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:
511
512
        - name: filter
          in: query
513
          required: false
514
          type: string
515
          description: >
516
517
518
            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.
519
            All attribute names that appear in the FmSubscription and in data types
520
            referenced from it shall be supported by the NFVO in the filter expression.       
521
522
523
524
525
526
527
        - 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
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
        - 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
549
550
551
552
553
554
        - name: Version
          description: >
            Version of the API requested to use when responding to this request.
          in: header
          required: true
          type: string
555
556
      responses:
        200:
rameshnaraya's avatar
rameshnaraya committed
557
          description: >
558
            200 OK
559

560
            The list of subscriptions was queried successfully.
561
562
563
564
565
566
567
            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.
568
569
          headers:
            Content-Type:
rameshnaraya's avatar
rameshnaraya committed
570
              description: The MIME type of the body of the response.
571
572
573
574
              type: string
              maximum: 1
              minimum: 1
            WWW-Authenticate:
575
              type: "string"
576
577
              description: >
                Challenge if the corresponding HTTP request has not provided
578
579
580
                authorization, or error details if the corresponding HTTP request
                has provided an invalid authorization token.
              maximum: 1
581
582
583
584
585
586
587
              minimum: 0
            Version:
              description: >
                Version of the API used in the response.
              type: string
              maximum: 1
              minimum: 1
588
589
590
591
592
593
            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
594
595
596
          schema:
            type: array
            items:
rameshnaraya's avatar
rameshnaraya committed
597
598
              properties:
                FmSubscription:
599
                  $ref: "definitions/SOL005NSFaultManagement_def.yaml#/definitions/FmSubscription"
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
        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"
616
617
618
619

  ###############################################################################
  # Individual subscription                                                     #
  ###############################################################################
620
  '/subscriptions/{subscriptionId}':
621
    #ETSI GS NFV-SOL 005 V2.4.1 location: 8.4.5
622
623
624
625
626
627
628
629
630
631
632
633
    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:
634
      summary: Read an individual subscription.
635
636
      description: >
        Query Subscription Information
637

638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
        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
663
664
665
666
667
668
        - name: Version
          description: >
            Version of the API requested to use when responding to this request.
          in: header
          required: true
          type: string
669
670
      responses:
        200:
671
672
          description: >
            200 OK
673

674
675
676
677
678
679
680
681
682
683
684
685
            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:
686
              type: "string"
687
688
              description: >
                Challenge if the corresponding HTTP request has not provided
689
690
                authorization, or error details if the corresponding HTTP request
                has provided an invalid authorization token.
691
692
              maximum: 1
              minimum: 0
693
694
695
696
697
698
            Version:
              description: >
                Version of the API used in the response.
              type: string
              maximum: 1
              minimum: 1
699
          schema:
700
701
702
            properties:
              FmSubscription:
                $ref: "definitions/SOL005NSFaultManagement_def.yaml#/definitions/FmSubscription"
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
        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:
718
      summary: Terminate a subscription.
719
720
      description: >
        Terminate Subscription
721

722
723
724
725
726
727
728
729
730
        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
731
732
733
734
735
736
        - name: Version
          description: >
            Version of the API requested to use when responding to this request.
          in: header
          required: true
          type: string
737
738
      responses:
        204:
739
          description: >
740
            204 - No Content
741

742
743
744
745
            The subscription resource was deleted successfully.
            The response body shall be empty.
          headers:
            WWW-Authenticate:
746
              type: "string"
747
748
              description: >
                Challenge if the corresponding HTTP request has not provided
749
750
                authorization, or error details if the corresponding HTTP request
                has provided an invalid authorization token.
751
752
              maximum: 1
              minimum: 0
753
754
755
756
757
758
            Version:
              description: >
                Version of the API used in the response.
              type: string
              maximum: 1
              minimum: 1
759
760
761
762
763
764
765
766
767
768
769
770
771
772
        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"
773
774
775
776
777
778

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

786
787
788
789
790
791
792
      parameters:
        - name: alarmNotification
          description: >
            Information of a NS alarm.
          in: body
          required: true
          schema:
rameshnaraya's avatar
rameshnaraya committed
793
794
            properties:
              AlarmNotification:
795
                $ref: "definitions/SOL005NSFaultManagement_def.yaml#/definitions/AlarmNotification"
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
        - 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
817
818
819
820
821
822
        - name: Version
          description: >
            Version of the API requested to use when responding to this request.
          in: header
          required: true
          type: string
823
824
825
826
      responses:
        204:
          description: >
            204 No Content
827

828
829
830
831
832
833
834
835
836
837
            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
838
839
840
841
842
843
844
              minimum: 0
            Version:
              description: >
                Version of the API used in the response.
              type: string
              maximum: 1
              minimum: 1
845
846
847
848
849
        400:
          $ref: "responses/SOL005_resp.yaml#/responses/400"
        401:
          $ref: "responses/SOL005_resp.yaml#/responses/401"
        403:
850
          $ref: "responses/SOL005_resp.yaml#/responses/403"
851
852
853
        500:
          $ref: "responses/SOL005_resp.yaml#/responses/500"
        503:
854
855
          $ref: "responses/SOL005_resp.yaml#/responses/503"

856
857
858
859
860
861
862
863
864
865
866
867
868
869
  '/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:
870
871
              AlarmClearedNotification:
                $ref: "definitions/SOL005NSFaultManagement_def.yaml#/definitions/AlarmClearedNotification"
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
        - 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
893
894
895
896
897
898
        - name: Version
          description: >
            Version of the API requested to use when responding to this request.
          in: header
          required: true
          type: string
899
900
901
902
      responses:
        204:
          description: >
            204 No Content
903

904
905
906
907
908
909
910
911
912
913
            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
914
915
916
917
918
919
920
              minimum: 0
            Version:
              description: >
                Version of the API used in the response.
              type: string
              maximum: 1
              minimum: 1
921
922
923
924
925
        400:
          $ref: "responses/SOL005_resp.yaml#/responses/400"
        401:
          $ref: "responses/SOL005_resp.yaml#/responses/401"
        403:
926
          $ref: "responses/SOL005_resp.yaml#/responses/403"
927
928
929
        500:
          $ref: "responses/SOL005_resp.yaml#/responses/500"
        503:
930
          $ref: "responses/SOL005_resp.yaml#/responses/503"
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945

  '/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:
946
947
              AlarmListRebuiltNotification:
                $ref: "definitions/SOL005NSFaultManagement_def.yaml#/definitions/AlarmListRebuiltNotification"
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
        - 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
969
970
971
972
973
974
        - name: Version
          description: >
            Version of the API requested to use when responding to this request.
          in: header
          required: true
          type: string
975
976
977
      responses:
        204:
          description: >
978
            204 No Content
979

980
            The notification was delivered successfully.
981
982
983
984
985
986
987
988
989
            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
990
991
992
993
994
995
996
              minimum: 0
            Version:
              description: >
                Version of the API used in the response.
              type: string
              maximum: 1
              minimum: 1
997
998
999
1000
1001
        400:
          $ref: "responses/SOL005_resp.yaml#/responses/400"
        401:
          $ref: "responses/SOL005_resp.yaml#/responses/401"
        403:
1002
          $ref: "responses/SOL005_resp.yaml#/responses/403"
1003
1004
1005
        500:
          $ref: "responses/SOL005_resp.yaml#/responses/500"
        503:
1006
1007
          $ref: "responses/SOL005_resp.yaml#/responses/503"

1008
    get:
1009
      summary: Test the notification endpoint
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
      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
1028
1029
1030
1031
1032
1033
        - name: Version
          description: >
            Version of the API requested to use when responding to this request.
          in: header
          required: true
          type: string
1034
1035
1036
      responses:
        204:
          description: >
1037
            204 No Content
1038

1039
1040
            The notification endpoint was tested successfully.
            The response body shall be empty. 
1041
1042
1043
1044
1045
1046
1047
1048
          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
1049
              minimum: 0
1050
1051
1052
1053
1054
        400:
          $ref: "responses/SOL005_resp.yaml#/responses/400"
        401:
          $ref: "responses/SOL005_resp.yaml#/responses/401"
        403:
1055
          $ref: "responses/SOL005_resp.yaml#/responses/403"
1056
1057
1058
1059
        500:
          $ref: "responses/SOL005_resp.yaml#/responses/500"
        503:
          $ref: "responses/SOL005_resp.yaml#/responses/503"