VNFFaultManagement.yaml 32 KB
Newer Older
1
2
3
swagger: "2.0"

info: 
4
  version: "1.2.0"
5
  title: SOL002 - VNF Fault Management interface
6
  description: >
7
    VNF Fault Management interface of ETSI NFV SOL002
8

9
    IMPORTANT: Please note that this file might be not aligned to the current
10
11
12
    version of the ETSI Group Specification it refers to. In case of
    discrepancies the published ETSI Group Specification takes precedence.

13
14
15
16
17
    Please report bugs to https://forge.etsi.org/bugzilla/buglist.cgi?component=Nfv-Openapis&list_id=61&product=NFV&resolution=---
  license:
    name: "ETSI Forge copyright notice"
    url: https://forge.etsi.org/etsi-forge-copyright-notice.txt

18
externalDocs:
19
20
  description: ETSI GS NFV-SOL 002 V2.5.1
  url: https://www.etsi.org/deliver/etsi_gs/NFV-SOL/001_099/002/02.05.01_60/gs_nfv-sol002v020501p.pdf
21

22
basePath: /vnffm/v1
23
24
25
26
27
28
29
30
31
32
33
34

schemes: 
  - http
  - https

consumes: 
  - application/json

produces: 
  - application/json

paths:
35
36
37
  ###############################################################################
  # API Versions                                                                #
  ###############################################################################
38
  '/api-versions':
39
    $ref: '../../endpoints/SOL002SOL003_endpoints.yaml#/endpoints/api-versions'
40

41
42
43
  ###############################################################################
  # Alarms                                                                      #
  ###############################################################################
44
45
  '/alarms':
  #SOL003 location: 7.4.2
46
47
48
49
50
    parameters:
      - name: Version
        description: >
          Version of the API requested to use when responding to this request.
        in: header
51
        required: true
52
        type: string
53
54
55
56
57
58
59
      - name: Authorization
        description: >
          The authorization token for the request.
          Reference: IETF RFC 7235
        in: header
        required: false
        type: string
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
    get:
      description: >
        The client can use this method to retrieve information about the alarm
        list.
      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
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
        - name: filter
          description: >
            Attribute-based filtering expression according to clause 4.3.2.
            The VNFM shall support receiving this parameter as part of the URI query string.
            The EM may supply this parameter. The VNF may supply its instance Id as an attribute filter.
            The following attribute names shall be supported in the filter expression: id, managedObjectId,
            vnfcInstanceIds, rootCauseFaultyResource.faultyResourceType, eventType, perceivedSeverity, probableCause.
            If the vnfcInstanceIds parameter is provided, exactly one value for the managedObjectId attribute
            shall be provided.

            EXAMPLE
            objects
            obj1: {"id":123, "weight":100, "parts":[{"id":1, "color":"red"}, {"id":2, "color":"green"}]}
            obj2: {"id":456, "weight":500, "parts":[{"id":3, "color":"green"}, {"id":4, "color":"blue"}]}

            Request 1:
            GET …/container

            Response 1:
            [
                {"id":123, "weight":100, "parts":[{"id":1, "color":"red"}, {"id":2, "color":"green"}]},
                {"id":456, "weight":500, "parts":[{"id":3, "color":"green"}, {"id":4, "color":"blue"}]}
            ]

            Request 2:
            GET …/container?filter=(eq.weight,100)

            Response 2:
            [
                {"id":123, "weight":100, "parts":[{"id":1, "color":"red"}, {"id":2, "color":"green"}]}
            ]
          #Request 2 in EXAMPLE from clause 4.3.2 probably wrong, since "," should be used after opOne (eq), "." is used
          in: query
          required: false
          type: string
        - name: nextpage_opaque_marker
          description: >
            Marker to obtain the next page of a paged response.
            Shall be supported by the VNFM if the VNFM supports alternative 2
            (paging) according to clause 4.7.2.1 for this resource.
          in: query
          required: false
          type: string
122
123
124
      responses:
        200:
          description: > 
125
            200 OK
Gergely Csatari's avatar
Gergely Csatari committed
126

127
128
129
130
131
            Information about zero or more alarms was queried successfully.
            The response body shall contain in an array the representations of zero or more alarms
            as defined in clause 7.5.2.4.
            If the VNFM 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.
132
133
          headers:
            Content-Type:
134
135
136
137
138
139
              description: The MIME type of the body of the response.
              type: string
              maximum: 1
              minimum: 1
            Version:
              description: The used API version.
140
141
142
143
144
145
146
147
148
149
150
              type: string
              maximum: 1
              minimum: 1
            WWW-Authenticate:
              description: >
                Challenge if the corresponding HTTP request has not provided
                authorization, or error details if the corresponding HTTP
                request has provided an invalid authorization token.
              type: string
              maximum: 1
              minimum: 0
151
152
153
154
155
156
            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
157
          schema:
158
            $ref: "./definitions/VNFFaultManagement_def.yaml#/definitions/Alarm"
159
        400:
160
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/400"
161
162
163
164
        401:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/401"
        403:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/403"
165
166
        404:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/404"
167
        405:
168
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/404"
169
170
        406:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/406"
171
172
173
174
175
176
        416:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/416"
        422:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/422"
        429:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/429"
177
178
179
180
        500:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/500"
        503:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/503"
181
182
183
184
185
186
        504:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/504"

  ###############################################################################
  # Individual alarm                                                            #
  ###############################################################################
187
188
189
190
191
192
193
194
195
196
197
198
199
200
  '/alarms/{alarmId}':
  #SOL003 location: 7.4.3
    parameters:
      - name: alarmId
        description: >
          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.
        in: path
        type: string
        required: true
201
202
203
204
      - name: Version
        description: >
          Version of the API requested to use when responding to this request.
        in: header
205
        required: true
206
        type: string
207
208
209
210
211
212
213
      - name: Authorization
        description: >
          The authorization token for the request.
          Reference: IETF RFC 7235
        in: header
        required: false
        type: string
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
    get:
      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
      responses:
        200:
          description: > 
235
            200 OK
Gergely Csatari's avatar
Gergely Csatari committed
236

237
238
239
240
241
            Information about an individual alarm was read successfully.
            The response body shall contain a representation of the individual
            alarm.
          headers:
            Content-Type:
242
243
244
245
246
247
              description: The MIME type of the body of the response.
              type: string
              maximum: 1
              minimum: 1
            Version:
              description: The used API version.
248
249
250
251
252
253
254
255
256
257
258
259
              type: string
              maximum: 1
              minimum: 1
            WWW-Authenticate:
              description: >
                Challenge if the corresponding HTTP request has not provided
                authorization, or error details if the corresponding HTTP
                request has provided an invalid authorization token.
              type: string
              maximum: 1
              minimum: 0
          schema:
260
            $ref: "./definitions/VNFFaultManagement_def.yaml#/definitions/Alarm"
261
262
263
264
265
266
        400:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/400"
        401:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/401"
        403:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/403"
267
268
        404:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/404"
269
        405:
270
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/404"
271
272
        406:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/406"
273
274
275
276
277
278
        416:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/416"
        422:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/422"
        429:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/429"
279
280
281
282
        500:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/500"
        503:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/503"
283
284
        504:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/504"
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
    patch:
      description: >
        This method modifies an individual alarm resource.
      parameters:
        - name: AlarmModifications
          description: The VNF creation parameters
          in: body
          required: true
          schema:
            $ref: "../../definitions/SOL002SOL003VNFFaultManagement_def.yaml#/definitions/AlarmModifications"
        - 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
      responses:
        200:
          description: > 
312
            200 OK
Gergely Csatari's avatar
Gergely Csatari committed
313

314
315
316
317
318
            The request was accepted and completed. The response body shall
            contain attribute modifications for an ‘Individual alarm’
            resource.
          headers:
            Content-Type:
319
320
321
322
323
324
              description: The MIME type of the body of the response.
              type: string
              maximum: 1
              minimum: 1
            Version:
              description: The used API version.
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
              type: string
              maximum: 1
              minimum: 1
            WWW-Authenticate:
              description: >
                Challenge if the corresponding HTTP request has not provided
                authorization, or error details if the corresponding HTTP
                request has provided an invalid authorization token.
              type: string
              maximum: 1
              minimum: 0
          schema:
            $ref: "../../definitions/SOL002SOL003VNFFaultManagement_def.yaml#/definitions/AlarmModifications"
        400:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/400"
        401:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/401"
        403:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/403"
344
345
        404:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/404"
346
        405:
347
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/404"
348
349
350
        406:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/406"
        409:
351
352
353
354
355
356
357
358
359
360
          description: >
            409 CONFLICT

            Error: The operation cannot be executed currently, due to a conflict with the state of
            the "Individual alarm" resource.
            Typically, this is due to the fact that the alarm is already in the state that is requested
            to be set (such as trying to acknowledge an already-acknowledged alarm).
            The response body shall contain a ProblemDetails structure, in which the "detail" attribute shall
            convey more information about the error.
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/409"
361
362
        412:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/412"
363
364
365
366
367
368
        416:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/416"
        422:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/422"
        429:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/429"
369
370
371
372
        500:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/500"
        503:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/503"
373
374
375
        504:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/504"

376
  ###############################################################################
377
  # Escalate Perceived Severity task                                            #
378
379
380
  ###############################################################################
  '/alarms/{alarmId}/escalate':
    #SOL002 location: 7.4.4
381
382
383
384
385
    parameters:
      - name: Version
        description: >
          Version of the API requested to use when responding to this request.
        in: header
386
        required: true
387
        type: string
388
389
390
391
392
393
394
      - name: Authorization
        description: >
          The authorization token for the request.
          Reference: IETF RFC 7235
        in: header
        required: false
        type: string
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
    post:
      description: >
        The POST method enables the consumer to escalate the perceived severity
        of an alarm that is represented by an ndividual alarm resource.
      parameters:
        - name: alarmId
          description: >
            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.
          in: path
          type: string
          required: true
        - name: PerceivedSeverityRequest
          description: The proposed "escalated perceived severity" value
          in: body
          schema:
            $ref: "./definitions/VNFFaultManagement_def.yaml#/definitions/PerceivedSeverityRequest"
      responses:
        200:
          description: >
419
            200 OK
420
421
422

            The VNFM has received the proposed "escalated perceived severity" value
            successfully. The response body shall be empty.
423
424
425
426
427
428
          headers:
            Version:
              description: The used API version.
              type: string
              maximum: 1
              minimum: 1
429
430
431
432
433
434
        400:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/400"
        401:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/401"
        403:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/403"
435
436
        404:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/404"
437
        405:
438
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/404"
439
440
        406:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/406"
441
442
443
444
445
446
        416:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/416"
        422:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/422"
        429:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/429"
447
448
449
450
        500:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/500"
        503:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/503"
451
452
        504:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/504"
453
454

  ###############################################################################
455
456
  # Subscriptions                                                               #
  ###############################################################################
457
  '/subscriptions':
458
  #SOL003 location: 7.4.4
459
460
461
462
463
    parameters:
      - name: Version
        description: >
          Version of the API requested to use when responding to this request.
        in: header
464
        required: true
465
        type: string
466
467
468
469
470
471
472
      - name: Authorization
        description: >
          The authorization token for the request.
          Reference: IETF RFC 7235
        in: header
        required: false
        type: string
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
    post:
      description: >
        The POST method creates a new subscription.
      parameters:
        - name: FmSubscriptionRequest
          description: The VNF creation parameters
          in: body
          required: true
          schema:
            $ref: "../../definitions/SOL002SOL003VNFFaultManagement_def.yaml#/definitions/FmSubscriptionRequest"
        - 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
      responses:
        201:
          description: > 
500
            201 CREATED
Gergely Csatari's avatar
Gergely Csatari committed
501

502
503
504
505
506
507
            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.
          headers:
            Content-Type:
508
509
510
511
512
513
              description: The MIME type of the body of the response.
              type: string
              maximum: 1
              minimum: 1
            Version:
              description: The used API version.
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
              type: string
              maximum: 1
              minimum: 1
            Location:
              description: >
                The resource URI of the created subscription resource.
              type: string
              format: url
            WWW-Authenticate:
              description: >
                Challenge if the corresponding HTTP request has not provided
                authorization, or error details if the corresponding HTTP
                request has provided an invalid authorization token.
              type: string
              maximum: 1
              minimum: 0
          schema:
            $ref: "../../definitions/SOL002SOL003VNFFaultManagement_def.yaml#/definitions/FmSubscription"
532
533
534
535
536
537
538
539
540
541
        303:
          description: >
            303 SEE OTHER

            A subscription with the same callbackURI and the same filter already exists and the policy of
            the VNFM is to not create redundant subscriptions.
            The HTTP response shall include a "Location" HTTP header that contains the resource URI of the
            existing subscription resource.
            The response body shall be empty.
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/303"
542
543
544
545
546
547
        400:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/400"
        401:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/401"
        403:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/403"
548
549
        404:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/404"
550
        405:
551
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/404"
552
553
        406:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/406"
554
555
556
557
558
559
        416:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/416"
        422:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/422"
        429:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/429"
560
561
562
563
        500:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/500"
        503:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/503"
564
565
        504:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/504"
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
    get:
      description: >
        The client can use this method to retrieve the list of active
        subscriptions for VNF alarms subscribed by the client. It can be used
        e.g. for resynchronization after error situations.
      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
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
        - name: filter
          description: >
            Attribute-based filtering expression according to clause 4.3.2.
            The VNFM shall support receiving this parameter as part of the URI query string.
            The EM may supply this parameter. The VNF may supply its instance Id as an attribute filter.
            All attribute names that appear in the FmSubscription and in data types referenced from it
            shall be supported by the VNFM in the filter expression.

            EXAMPLE
            objects
            obj1: {"id":123, "weight":100, "parts":[{"id":1, "color":"red"}, {"id":2, "color":"green"}]}
            obj2: {"id":456, "weight":500, "parts":[{"id":3, "color":"green"}, {"id":4, "color":"blue"}]}

            Request 1:
            GET …/container

            Response 1:
            [
                {"id":123, "weight":100, "parts":[{"id":1, "color":"red"}, {"id":2, "color":"green"}]},
                {"id":456, "weight":500, "parts":[{"id":3, "color":"green"}, {"id":4, "color":"blue"}]}
            ]

            Request 2:
            GET …/container?filter=(eq.weight,100)

            Response 2:
            [
                {"id":123, "weight":100, "parts":[{"id":1, "color":"red"}, {"id":2, "color":"green"}]}
            ]
          #Request 2 in EXAMPLE from clause 4.3.2 probably wrong, since "," should be used after opOne (eq), "." is used
          in: query
          required: false
          type: string
        - name: nextpage_opaque_marker
          description: >
            Marker to obtain the next page of a paged response.
            Shall be supported by the VNFM if the VNFM supports alternative 2
            (paging) according to clause 4.7.2.1 for this resource.
          in: query
          required: false
          type: string
627
628
629
      responses:
        200:
          description: > 
630
            200 OK
Gergely Csatari's avatar
Gergely Csatari committed
631

632
633
634
            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.
635
636
637
            If the VNFM 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.
638
639
          headers:
            Content-Type:
640
641
642
643
644
645
              description: The MIME type of the body of the response.
              type: string
              maximum: 1
              minimum: 1
            Version:
              description: The used API version.
646
647
648
649
650
651
652
653
654
655
656
              type: string
              maximum: 1
              minimum: 1
            WWW-Authenticate:
              description: >
                Challenge if the corresponding HTTP request has not provided
                authorization, or error details if the corresponding HTTP
                request has provided an invalid authorization token.
              type: string
              maximum: 1
              minimum: 0
657
658
659
660
661
662
            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
663
664
665
          schema:
            $ref: "../../definitions/SOL002SOL003VNFFaultManagement_def.yaml#/definitions/FmSubscription"
        400:
666
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/400"
667
668
669
670
        401:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/401"
        403:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/403"
671
672
        404:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/404"
673
        405:
674
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/404"
675
676
        406:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/406"
677
678
679
680
681
682
        416:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/416"
        422:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/422"
        429:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/429"
683
684
685
686
        500:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/500"
        503:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/503"
687
688
689
690
691
692
        504:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/504"

  ###############################################################################
  # Individual subscription                                                     #
  ###############################################################################
693
694
695
696
  '/subscriptions/{subscriptionId}':
  #SOL003 location: 7.4.5
    parameters:
      - name: subscriptionId
697
        description: >
698
699
700
701
702
703
704
705
          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
706
707
708
709
      - name: Version
        description: >
          Version of the API requested to use when responding to this request.
        in: header
710
        required: true
711
        type: string
712
713
714
715
716
717
718
      - name: Authorization
        description: >
          The authorization token for the request.
          Reference: IETF RFC 7235
        in: header
        required: false
        type: string
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
    get:
      description: >
        The client can use this method for reading an individual subscription
        for VNF alarms subscribed by the client.
      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
      responses:
        200:
          description: > 
741
            200 OK
Gergely Csatari's avatar
Gergely Csatari committed
742

743
744
745
746
747
            The operation has completed successfully.
            The response body shall contain a representation of the
            subscription resource.
          headers:
            Content-Type:
748
749
750
751
752
753
              description: The MIME type of the body of the response.
              type: string
              maximum: 1
              minimum: 1
            Version:
              description: The used API version.
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
              type: string
              maximum: 1
              minimum: 1
            WWW-Authenticate:
              description: >
                Challenge if the corresponding HTTP request has not provided
                authorization, or error details if the corresponding HTTP
                request has provided an invalid authorization token.
              type: string
              maximum: 1
              minimum: 0
          schema:
            $ref: "../../definitions/SOL002SOL003VNFFaultManagement_def.yaml#/definitions/FmSubscription"
        400:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/400"
        401:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/401"
        403:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/403"
773
774
        404:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/404"
775
        405:
776
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/404"
777
778
        406:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/406"
779
780
781
782
783
784
        416:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/416"
        422:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/422"
        429:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/429"
785
786
787
788
        500:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/500"
        503:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/503"
789
790
        504:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/504"
791
792
793
794
795
796
    delete:
      description: >
        This method terminates an individual subscription.
      responses:
        204:
          description: > 
797
            204 NO CONTENT
Gergely Csatari's avatar
Gergely Csatari committed
798

799
800
801
            The subscription resource was deleted successfully.
            The response body shall be empty.
          headers:
802
803
            Version:
              description: The used API version.
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
              type: string
              maximum: 1
              minimum: 1
            WWW-Authenticate:
              description: >
                Challenge if the corresponding HTTP request has not provided
                authorization, or error details if the corresponding HTTP
                request has provided an invalid authorization token.
              type: string
              maximum: 1
              minimum: 0
        400:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/400"
        401:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/401"
        403:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/403"
821
822
        404:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/404"
823
        405:
824
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/404"
825
826
        406:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/406"
827
828
829
830
831
832
        416:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/416"
        422:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/422"
        429:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/429"
833
834
835
        500:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/500"
        503:
836
837
838
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/503"
        504:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/504"