VNFFaultManagement.yaml 32.4 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
            Attribute-based filtering expression according to clause 5.2 of ETSI GS NFV-SOL 013.
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
            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
119
120
            (paging) according to clause 5.4.2.1 5.2 of ETSI GS NFV-SOL 013 
            for this resource.
121
122
          in: query
          required: false
123
124
125
          type: string
      responses:
        200:
126
          description: >
127
            200 OK
Gergely Csatari's avatar
Gergely Csatari committed
128

129
            Shall be returned when information about zero or more alarms was queried successfully.
130
131
            The response body shall contain in an array the representations of zero or more alarms
            as defined in clause 7.5.2.4.
132
133
134
135
136
137
            If the "filter" URI parameter was supplied in the request, the data in the response body 
            shall have been transformed according to the rules specified in clause 5.2.2 of 
            ETSI GS NFV-SOL 013.
            If the VNFM supports alternative 2 (paging) according to clause 5.4.2.1 of 
            ETSI GS NFV-SOL 013for this resource, inclusion of the Link HTTP header in this response 
            shall follow the provisions in clause 5.4.2.3 of ETSI GS NFV-SOL 013.
138
139
          headers:
            Content-Type:
140
141
142
143
144
145
              description: The MIME type of the body of the response.
              type: string
              maximum: 1
              minimum: 1
            Version:
              description: The used API version.
146
147
148
149
150
151
152
153
154
155
156
              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
157
158
159
160
161
162
            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
163
          schema:
164
            $ref: "./definitions/SOL002VNFFaultManagement_def.yaml#/definitions/Alarm"
165
        400:
166
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/400"
167
168
169
170
        401:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/401"
        403:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/403"
171
172
        404:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/404"
173
174
175
176
        405:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/405"
        406:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/406"
177
178
179
180
181
182
        416:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/416"
        422:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/422"
        429:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/429"
183
184
185
186
        500:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/500"
        503:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/503"
187
188
189
190
191
192
        504:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/504"

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

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

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

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

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

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

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

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

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

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

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