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

3
info:
4
  version: "1.2.0-impl:etsi.org:ETSI_NFV_OpenAPI:1"
5
  title: SOL002 - VNF Fault Management interface
6
  description: >
moscatelli's avatar
moscatelli committed
7
    SOL002 - VNF Fault Management interface
8
    IMPORTANT: Please note that this file might be not aligned to the current
moscatelli's avatar
moscatelli committed
9
10
11
12
    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
13
  license:
moscatelli's avatar
moscatelli committed
14
    name: ETSI Forge copyright notice
15
    url: https://forge.etsi.org/etsi-forge-copyright-notice.txt
moscatelli's avatar
moscatelli committed
16
17
  contact:
    name: NFV-SOL WG
18

19
externalDocs:
20
21
  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
22

23
basePath: /vnffm/v1
24

25
schemes:
26
27
28
  - http
  - https

29
consumes:
30
31
  - application/json

32
produces:
33
34
35
  - application/json

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

42
43
44
  ###############################################################################
  # Alarms                                                                      #
  ###############################################################################
45
  '/alarms':
46
    #SOL003 location: 7.4.2
47
48
49
50
51
    parameters:
      - name: Version
        description: >
          Version of the API requested to use when responding to this request.
        in: header
52
        required: true
53
        type: string
54
55
56
57
58
59
60
      - name: Authorization
        description: >
          The authorization token for the request.
          Reference: IETF RFC 7235
        in: header
        required: false
        type: string
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
    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
80
        - name: filter
81
          description: >
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
            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
122
123
124
          type: string
      responses:
        200:
125
          description: >
126
            200 OK
Gergely Csatari's avatar
Gergely Csatari committed
127

128
129
130
131
132
            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.
133
134
          headers:
            Content-Type:
135
136
137
138
139
140
              description: The MIME type of the body of the response.
              type: string
              maximum: 1
              minimum: 1
            Version:
              description: The used API version.
141
142
143
144
145
146
147
148
149
150
151
              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
152
153
154
155
156
157
            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
158
          schema:
159
            $ref: "./definitions/SOL002VNFFaultManagement_def.yaml#/definitions/Alarm"
160
        400:
161
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/400"
162
163
164
165
        401:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/401"
        403:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/403"
166
167
        404:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/404"
168
169
170
171
        405:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/405"
        406:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/406"
172
173
174
175
176
177
        416:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/416"
        422:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/422"
        429:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/429"
178
179
180
181
        500:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/500"
        503:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/503"
182
183
184
185
186
187
        504:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/504"

  ###############################################################################
  # Individual alarm                                                            #
  ###############################################################################
188
  '/alarms/{alarmId}':
189
    #SOL003 location: 7.4.3
190
191
192
193
194
195
196
197
198
199
200
201
    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
202
203
204
205
      - name: Version
        description: >
          Version of the API requested to use when responding to this request.
        in: header
206
        required: true
207
        type: string
208
209
210
211
212
213
214
      - name: Authorization
        description: >
          The authorization token for the request.
          Reference: IETF RFC 7235
        in: header
        required: false
        type: string
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:
235
          description: >
236
            200 OK
Gergely Csatari's avatar
Gergely Csatari committed
237

238
239
240
241
242
            Information about an individual alarm was read successfully.
            The response body shall contain a representation of the individual
            alarm.
          headers:
            Content-Type:
243
244
245
246
247
248
              description: The MIME type of the body of the response.
              type: string
              maximum: 1
              minimum: 1
            Version:
              description: The used API version.
249
250
251
252
253
254
255
256
257
258
259
260
              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:
261
            $ref: "definitions/SOL002VNFFaultManagement_def.yaml#/definitions/Alarm"
262
263
264
265
266
267
        400:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/400"
        401:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/401"
        403:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/403"
268
269
        404:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/404"
270
271
272
273
        405:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/405"
        406:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/406"
274
275
276
277
278
279
        416:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/416"
        422:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/422"
        429:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/429"
280
281
282
283
        500:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/500"
        503:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/503"
284
285
        504:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/504"
286
287
288
289
290
    patch:
      description: >
        This method modifies an individual alarm resource.
      parameters:
        - name: AlarmModifications
291
          description: The parameter for the alarm modification
292
293
294
295
296
297
298
299
300
301
302
303
304
          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: >
305
306
            The Content-Type header shall be set to "application/mergepatch+json"
            Reference: IETF RFC 7396
307
308
309
310
311
          in: header
          required: true
          type: string
      responses:
        200:
312
          description: >
313
            200 OK
Gergely Csatari's avatar
Gergely Csatari committed
314

315
316
317
318
319
            The request was accepted and completed. The response body shall
            contain attribute modifications for an ‘Individual alarm’
            resource.
          headers:
            Content-Type:
320
321
322
323
324
325
              description: The MIME type of the body of the response.
              type: string
              maximum: 1
              minimum: 1
            Version:
              description: The used API version.
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
              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"
345
346
        404:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/404"
347
348
349
350
351
        405:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/405"
        406:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/406"
        409:
352
353
354
355
356
357
358
359
360
361
          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"
362
363
        412:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/412"
364
365
366
367
368
369
        416:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/416"
        422:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/422"
        429:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/429"
370
371
372
373
        500:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/500"
        503:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/503"
374
375
376
        504:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/504"

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

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

  ###############################################################################
456
457
  # Subscriptions                                                               #
  ###############################################################################
458
  '/subscriptions':
459
    #SOL003 location: 7.4.4
460
461
462
463
464
    parameters:
      - name: Version
        description: >
          Version of the API requested to use when responding to this request.
        in: header
465
        required: true
466
        type: string
467
468
469
470
471
472
473
      - name: Authorization
        description: >
          The authorization token for the request.
          Reference: IETF RFC 7235
        in: header
        required: false
        type: string
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
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:
500
          description: >
501
            201 CREATED
Gergely Csatari's avatar
Gergely Csatari committed
502

503
504
505
506
507
508
            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:
509
510
511
512
513
514
              description: The MIME type of the body of the response.
              type: string
              maximum: 1
              minimum: 1
            Version:
              description: The used API version.
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
              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"
533
        303:
534
535
536
537
538
539
540
541
          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.
542
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/303"
543
544
545
546
547
548
        400:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/400"
        401:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/401"
        403:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/403"
549
550
        404:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/404"
551
552
553
554
        405:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/405"
        406:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/406"
555
556
557
558
559
560
        416:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/416"
        422:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/422"
        429:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/429"
561
562
563
564
        500:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/500"
        503:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/503"
565
566
        504:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/504"
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
    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
587
        - name: filter
588
          description: >
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
            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
627
628
629
          type: string
      responses:
        200:
630
          description: >
631
            200 OK
Gergely Csatari's avatar
Gergely Csatari committed
632

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

  ###############################################################################
  # Individual subscription                                                     #
  ###############################################################################
694
  '/subscriptions/{subscriptionId}':
695
    #SOL003 location: 7.4.5
696
697
    parameters:
      - name: subscriptionId
698
        description: >
699
700
701
702
703
704
705
706
          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
707
708
709
710
      - name: Version
        description: >
          Version of the API requested to use when responding to this request.
        in: header
711
        required: true
712
        type: string
713
714
715
716
717
718
719
      - name: Authorization
        description: >
          The authorization token for the request.
          Reference: IETF RFC 7235
        in: header
        required: false
        type: string
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:
741
          description: >
742
            200 OK
Gergely Csatari's avatar
Gergely Csatari committed
743

744
745
746
747
748
            The operation has completed successfully.
            The response body shall contain a representation of the
            subscription resource.
          headers:
            Content-Type:
749
750
751
752
753
754
              description: The MIME type of the body of the response.
              type: string
              maximum: 1
              minimum: 1
            Version:
              description: The used API version.
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
              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"
774
775
        404:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/404"
776
777
778
779
        405:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/405"
        406:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/406"
780
781
782
783
784
785
        416:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/416"
        422:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/422"
        429:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/429"
786
787
788
789
        500:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/500"
        503:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/503"
790
791
        504:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/504"
792
793
794
795
796
    delete:
      description: >
        This method terminates an individual subscription.
      responses:
        204:
797
          description: >
798
            204 NO CONTENT
Gergely Csatari's avatar
Gergely Csatari committed
799

800
801
802
            The subscription resource was deleted successfully.
            The response body shall be empty.
          headers:
803
804
            Version:
              description: The used API version.
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
              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"
822
823
        404:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/404"
824
825
826
827
        405:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/405"
        406:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/406"
828
829
830
831
832
833
        416:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/416"
        422:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/422"
        429:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/429"
834
835
836
        500:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/500"
        503:
837
838
839
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/503"
        504:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/504"