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

3
info:
Giacomo Bernini's avatar
Giacomo Bernini committed
4
  version: "1.1.0-impl:etsi.org:ETSI_NFV_OpenAPI:2"
5
  title: "SOL005 - NS Fault Management Interface"
6
  description: >
rameshnaraya's avatar
rameshnaraya committed
7
    SOL005 - NS Fault Management Interface
8
9
10
11
12
13
14
15
    IMPORTANT: Please note that this file might be not aligned to the current
    version of the ETSI Group Specification it refers to and has not been
    approved by the ETSI NFV ISG. In case of discrepancies the published ETSI
    Group Specification takes precedence.
    Please report bugs to https://forge.etsi.org/bugzilla/buglist.cgi?component=Nfv-Openapis
  license:
    name: "ETSI Forge copyright notice"
    url: https://forge.etsi.org/etsi-forge-copyright-notice.txt
16
  contact:
17
18
    name: "NFV-SOL WG"
externalDocs:
Giacomo Bernini's avatar
upd  
Giacomo Bernini committed
19
20
  description: ETSI GS NFV-SOL 005 V2.6.1
  url: https://www.etsi.org/deliver/etsi_gs/NFV-SOL/001_099/005/02.06.01_60/gs_NFV-SOL005v020601p.pdf
21
basePath: /nsfm/v1
22
schemes:
23
  - http
24
25
  - https
consumes:
26
  - application/json
27
produces:
28
  - application/json
29
paths:
30
  ###############################################################################
31
32
  # API Versions                                                                #
  ###############################################################################
Giacomo Bernini's avatar
Giacomo Bernini committed
33
  '/api_versions':
34
35
    $ref: '../endpoints/SOL005_endpoints.yaml#/endpoints/api-versions'

36
  ###############################################################################
37
38
  # Alarms                                                                      #
  ###############################################################################
39
  '/alarms':
Giacomo Bernini's avatar
upd  
Giacomo Bernini committed
40
    #ETSI GS NFV-SOL 005 V2.6.1 location: 8.4.2
41
42
43
44
45
46
47
48
49
50
51
52
53
54
    parameters:
      - name: Authorization
        description: >
          The authorization token for the request.
          Reference: IETF RFC 7235.
        in: header
        required: false
        type: string
      - name: Version
        description: >
          Version of the API requested to use when responding to this request.
        in: header
        required: true
        type: string
55
    get:
56
      summary: Query alarms related to NS instances.
57
      description: >
rameshnaraya's avatar
rameshnaraya committed
58
        Get Alarm List.
59
60
61

        The client can use this method to retrieve information about the alarm list.
      parameters:
62
63
        - name: filter
          in: query
64
          required: false
65
          type: string
66
          description: >
Giacomo Bernini's avatar
Giacomo Bernini committed
67
            Attribute-based filtering expression according to clause 5.2 of ETSI GS NFV SOL 013.
68
69
70
71
            The NFVO shall support receiving this parameter as part of the URI query string.
            The OSS/BSS may supply this parameter.
            The following attribute names shall be supported by the NFVO in the filter 
            expression: 
72
73
74
75
76
77
78
            - id            
            - nsInstanceId            
            - rootCauseFaultyComponent.faultyNestedNsInstanceId            
            - rootCauseFaultyComponent.faultyNsVirtualLinkInstanceId            
            - rootCauseFaultyComponent.faultyVnfInstanceId           
            - rootCauseFaultyResource.faultyResourceType            
            - eventType            
79
80
            - perceivedSeverity
            - probableCause
81
82
83
84
        - name: nextpage_opaque_marker
          in: query
          description: >
            Marker to obtain the next page of a paged response. Shall be supported by the NFVO
Giacomo Bernini's avatar
Giacomo Bernini committed
85
            if the NFVO supports alternative 2 (paging) according to clause 5.4.2.1 of ETSI GS NFV SOL 013.
86
87
          required: false
          type: string
88
89
90
91
92
93
94
95
96
        - name: Accept
          description: >
            Content-Types that are acceptable for the response.
            Reference: IETF RFC 7231
          in: header
          required: true
          type: string
      responses:
        200:
rameshnaraya's avatar
rameshnaraya committed
97
          description: >
98
            200 OK
99

Giacomo Bernini's avatar
Giacomo Bernini committed
100
            Shall be returned when information about zero or more alarms has been queried successfully.
101
            The response body shall contain the list of related alarms.
Giacomo Bernini's avatar
Giacomo Bernini committed
102
103
104
105
106
            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 clauses 5.2.2 of ETSI GS NFV-SOL 013.
            If the NFVO supports alternative 2 (paging) according to clause 5.4.2.1 of ETSI GS NFV-SOL 013
            for 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.
rameshnaraya's avatar
rameshnaraya committed
107
108
109
110
111
112
113
          headers:
            Content-Type:
              description: The MIME type of the body of the response.
              type: string
              maximum: 1
              minimum: 1
            WWW-Authenticate:
114
              type: string
rameshnaraya's avatar
rameshnaraya committed
115
116
              description: >
                Challenge if the corresponding HTTP request has not provided
117
118
119
                authorization, or error details if the corresponding HTTP request
                has provided an invalid authorization token.
              maximum: 1
120
121
122
123
124
125
126
              minimum: 0
            Version:
              description: >
                Version of the API used in the response.
              type: string
              maximum: 1
              minimum: 1
127
128
129
130
131
132
            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
133
          schema:
rameshnaraya's avatar
rameshnaraya committed
134
135
136
137
            type: array
            items:
              properties:
                Alarm:
138
                  $ref: "definitions/SOL005NSFaultManagement_def.yaml#/definitions/Alarm"
139
        400:
140
          $ref: "../responses/SOL005_resp.yaml#/responses/400"
141
        401:
142
          $ref: "../responses/SOL005_resp.yaml#/responses/401"
143
        403:
144
          $ref: "../responses/SOL005_resp.yaml#/responses/403"
145
        405:
146
          $ref: "../responses/SOL005_resp.yaml#/responses/405"
147
        406:
148
          $ref: "../responses/SOL005_resp.yaml#/responses/406"
149
        500:
150
          $ref: "../responses/SOL005_resp.yaml#/responses/500"
151
        503:
152
          $ref: "../responses/SOL005_resp.yaml#/responses/503"
153
154
155
156

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

Giacomo Bernini's avatar
Giacomo Bernini committed
207
208
            Shall be returned when information about an individual alarm has been read successfully.
            The response body shall contain a representation of the individual alarm.
209
210
          headers:
            Content-Type:
rameshnaraya's avatar
rameshnaraya committed
211
              description: The MIME type of the body of the response.
212
213
214
              type: string
              maximum: 1
              minimum: 1
rameshnaraya's avatar
rameshnaraya committed
215
            WWW-Authenticate:
216
              type: string
rameshnaraya's avatar
rameshnaraya committed
217
218
              description: >
                Challenge if the corresponding HTTP request has not provided
219
220
221
                authorization, or error details if the corresponding HTTP request
                has provided an invalid authorization token.
              maximum: 1
222
223
224
225
226
227
228
              minimum: 0
            Version:
              description: >
                Version of the API used in the response.
              type: string
              maximum: 1
              minimum: 1
229
          schema:
rameshnaraya's avatar
rameshnaraya committed
230
231
            properties:
              Alarm:
232
                $ref: "definitions/SOL005NSFaultManagement_def.yaml#/definitions/Alarm"
233
        400:
234
          $ref: "../responses/SOL005_resp.yaml#/responses/400"
235
        401:
236
          $ref: "../responses/SOL005_resp.yaml#/responses/401"
237
        403:
238
          $ref: "../responses/SOL005_resp.yaml#/responses/403"
239
        405:
240
          $ref: "../responses/SOL005_resp.yaml#/responses/405"
241
        406:
242
          $ref: "../responses/SOL005_resp.yaml#/responses/406"
243
        500:
244
          $ref: "../responses/SOL005_resp.yaml#/responses/500"
245
        503:
246
          $ref: "../responses/SOL005_resp.yaml#/responses/503"
247
    patch:
248
      summary: Acknowledge individual alarm.
249
250
      description: >
        Acknowledge Alarm
251

252
253
        This method modifies an individual alarm resource.
      parameters:
254
255
        - name: body
          in: body
256
257
          required: true
          schema:
258
259
260
            $ref: "definitions/SOL005NSFaultManagement_def.yaml#/definitions/AlarmModifications"
          description: >
            The parameter for the alarm modification, as defined in clause 8.5.2.8.
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
        - 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 Content-Type header shall be set to
            "application/merge-patch+json" according to
            IETF RFC 7396.
          in: header
          required: true
          type: string
276
277
          enum:
            - application/merge-patch+json
278
279
      responses:
        200:
rameshnaraya's avatar
rameshnaraya committed
280
          description: >
281
            200 OK
282

Giacomo Bernini's avatar
Giacomo Bernini committed
283
284
285
            Shall be returned when the request has been accepted and completed.
            The response body shall contain attribute modifications for an 'Individual alarm'
            resource (see clause 8.5.2.4).
286
287
          headers:
            Content-Type:
rameshnaraya's avatar
rameshnaraya committed
288
              description: The MIME type of the body of the response.
289
290
291
292
              type: string
              maximum: 1
              minimum: 1
            WWW-Authenticate:
293
              type: string
294
295
              description: >
                Challenge if the corresponding HTTP request has not provided
296
297
                authorization, or error details if the corresponding HTTP request
                has provided an invalid authorization token.
298
              maximum: 1
299
300
301
302
303
304
305
              minimum: 0
            Version:
              description: >
                Version of the API used in the response.
              type: string
              maximum: 1
              minimum: 1
306
          schema:
rameshnaraya's avatar
rameshnaraya committed
307
308
309
            properties:
              AlarmModifications:
                $ref: "definitions/SOL005NSFaultManagement_def.yaml#/definitions/AlarmModifications"
310
        400:
311
          $ref: "../responses/SOL005_resp.yaml#/responses/400"
312
        401:
313
          $ref: "../responses/SOL005_resp.yaml#/responses/401"
314
        403:
315
          $ref: "../responses/SOL005_resp.yaml#/responses/403"
316
        405:
317
          $ref: "../responses/SOL005_resp.yaml#/responses/405"
318
        406:
319
          $ref: "../responses/SOL005_resp.yaml#/responses/406"
320
        409:
321
          $ref: "../responses/SOL005_resp.yaml#/responses/409"
322
        412:
323
          $ref: "../responses/SOL005_resp.yaml#/responses/412"
324
        500:
325
          $ref: "../responses/SOL005_resp.yaml#/responses/500"
326
        503:
327
328
          $ref: "../responses/SOL005_resp.yaml#/responses/503"

329
330
331
  ##############################################################################
  #Subscriptions                                                               #
  ##############################################################################
332
  '/subscriptions':
Giacomo Bernini's avatar
upd  
Giacomo Bernini committed
333
    #ETSI GS NFV-SOL 005 V2.6.1 location: 8.4.4
334
335
336
337
338
339
340
341
342
343
344
345
346
347
    parameters:
      - name: Authorization
        description: >
          The authorization token for the request.
          Reference: IETF RFC 7235.
        in: header
        required: false
        type: string
      - name: Version
        description: >
          Version of the API requested to use when responding to this request.
        in: header
        required: true
        type: string
348
    post:
349
      summary: Subscribe to alarms related to NSs.
350
      description: >
351
        The POST method creates a new subscription.
352
353
        This method shall follow the provisions specified in the Tables 8.4.4.3.1-1 and 8.4.4.3.1-2 for URI query
        parameters, request and response data structures, and response codes.
Giacomo Bernini's avatar
Giacomo Bernini committed
354
355
        As the result of successfully executing this method, a new "Individual subscription" resource shall exist
        as defined in clause 8.4.5. This method shall not trigger any notification.
356
        Creation of two subscription resources with the same callbackURI and the same filter can result in performance
357
358
359
360
361
        degradation and will provide duplicates of notifications to the OSS, and might make sense only in very rare
        use cases. Consequently, the NFVO may either allow creating a subscription resource if another subscription
        resource with the same filter and callbackUri already exists (in which case it shall return the "201 Created"
        response code), or may decide to not create a duplicate subscription resource (in which case it shall return
        a "303 See Other" response code referencing the existing subscription resource with the same filter and callbackUri).
362
      parameters:
363
364
365
366
367
368
369
370
371
372
373
374
375
        - 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
376
          type: string
377
378
        - name: body
          in: body
rameshnaraya's avatar
rameshnaraya committed
379
380
          required: true
          schema:
381
382
383
            $ref: "definitions/SOL005NSFaultManagement_def.yaml#/definitions/FmSubscriptionRequest"
          description: >
            Details of the subscription to be created, as defined in clause 8.5.2.2.
384
385
      responses:
        201:
386
387
          description: >
            201 Created
388

Giacomo Bernini's avatar
Giacomo Bernini committed
389
390
391
            Shall be returned when the subscription has been created successfully.
            The response body shall contain a representation of the created subscription resource.
            The HTTP response shall include a "Location:" HTTP header that points to the created subscription resource.
rameshnaraya's avatar
rameshnaraya committed
392
          schema:
393
            $ref: "definitions/SOL005NSFaultManagement_def.yaml#/definitions/FmSubscription"
394
          headers:
rameshnaraya's avatar
rameshnaraya committed
395
            Content-Type:
396
              type: string
rameshnaraya's avatar
rameshnaraya committed
397
398
399
400
              description: >
                The MIME type of the body of the response.This header
                field shall be present if the response has a non-empty message
                body.
401
            WWW-Authenticate:
402
              type: string
403
404
              description: >
                Challenge if the corresponding HTTP request has not provided
rameshnaraya's avatar
rameshnaraya committed
405
                authorization, or error details if the corresponding HTTP request
406
407
                has provided an invalid authorization token.
              maximum: 1
408
409
410
411
412
413
414
              minimum: 0
            Version:
              description: >
                Version of the API used in the response.
              type: string
              maximum: 1
              minimum: 1
415
        303:
416
          $ref: "../responses/SOL005_resp.yaml#/responses/303"
417
        400:
418
          $ref: "../responses/SOL005_resp.yaml#/responses/400"
419
        401:
420
          $ref: "../responses/SOL005_resp.yaml#/responses/401"
421
        403:
422
          $ref: "../responses/SOL005_resp.yaml#/responses/403"
423
        405:
424
          $ref: "../responses/SOL005_resp.yaml#/responses/405"
425
        406:
426
          $ref: "../responses/SOL005_resp.yaml#/responses/406"
427
        500:
428
          $ref: "../responses/SOL005_resp.yaml#/responses/500"
429
        503:
430
          $ref: "../responses/SOL005_resp.yaml#/responses/503"
431
    get:
432
      summary: Query multiple subscriptions.
433
434
      description: >
        Query Subscription Information
435

436
437
438
        The client can use this method to retrieve the list of active subscriptions 
        for alarms related to a NS subscribed by the client. 
        It can be used e.g. for resynchronization after error situations.
439

440
441
        This method shall follow the provisions specified in the Tables 8.4.4.3.2-1 and 8.4.4.3.2-2
        for URI query parameters, request and response data structures, and response codes.
442
443
        Table 8.4.4.3.2-1: URI query parameters supported.
      parameters:
444
445
        - name: filter
          in: query
446
          required: false
447
          type: string
448
          description: >
Giacomo Bernini's avatar
Giacomo Bernini committed
449
450
451
452
453
            Attribute-based filtering expression according to clause 5.2 of ETSI GS NFV SOL 013.
            The NFVO shall support receiving this parameter as part of the URI query string. The
            OSS/BSS may supply this parameter.
            All attribute names that appear in the FmSubscription and in data types referenced from it
            shall be supported by the NFVO in the filter expression.
454
455
456
        - name: nextpage_opaque_marker
          in: query
          description: >
Giacomo Bernini's avatar
Giacomo Bernini committed
457
458
            Marker to obtain the next page of a paged response. Shall be supported by the NFVO if the NFVO
            supports alternative 2 (paging) according to clause 5.4.2.1 of ETSI GS NFV-SOL 013 for this resource.
459
460
          required: false
          type: string
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
        - 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:
rameshnaraya's avatar
rameshnaraya committed
477
          description: >
478
            200 OK
479

Giacomo Bernini's avatar
Giacomo Bernini committed
480
481
482
483
484
485
486
487
488
            The list of subscriptions has been queried successfully.
            The response body shall contain in an array the representations of all active subscriptions of the
            functional block that invokes the method, i.e. zero or more representations of FM subscriptions, as
            defined in clause 8.5.2.3.
            If the "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 NFVO supports alternative 2 (paging) according to clause 5.4.2.1 of ETSI GS NFV SOL 013 for
            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.
489
490
          headers:
            Content-Type:
rameshnaraya's avatar
rameshnaraya committed
491
              description: The MIME type of the body of the response.
492
493
494
495
              type: string
              maximum: 1
              minimum: 1
            WWW-Authenticate:
496
              type: string
497
498
              description: >
                Challenge if the corresponding HTTP request has not provided
499
500
501
                authorization, or error details if the corresponding HTTP request
                has provided an invalid authorization token.
              maximum: 1
502
503
504
505
506
507
508
              minimum: 0
            Version:
              description: >
                Version of the API used in the response.
              type: string
              maximum: 1
              minimum: 1
509
510
511
512
513
514
            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
515
516
517
          schema:
            type: array
            items:
518
              $ref: "definitions/SOL005NSFaultManagement_def.yaml#/definitions/FmSubscription"
519
        400:
520
          $ref: "../responses/SOL005_resp.yaml#/responses/400"
521
        401:
522
          $ref: "../responses/SOL005_resp.yaml#/responses/401"
523
        403:
524
          $ref: "../responses/SOL005_resp.yaml#/responses/403"
525
        405:
526
          $ref: "../responses/SOL005_resp.yaml#/responses/405"
527
        406:
528
          $ref: "../responses/SOL005_resp.yaml#/responses/406"
529
        412:
530
          $ref: "../responses/SOL005_resp.yaml#/responses/412"
531
        500:
532
          $ref: "../responses/SOL005_resp.yaml#/responses/500"
533
        503:
534
          $ref: "../responses/SOL005_resp.yaml#/responses/503"
535
536
537
538

  ###############################################################################
  # Individual subscription                                                     #
  ###############################################################################
539
  '/subscriptions/{subscriptionId}':
Giacomo Bernini's avatar
upd  
Giacomo Bernini committed
540
    #ETSI GS NFV-SOL 005 V2.6.1 location: 8.4.5
541
542
543
544
545
546
547
548
549
550
551
    parameters:
      - name: subscriptionId
        description: >
          Identifier of this subscription.
          This identifier can be retrieved from the resource referenced by the
          "Location" HTTP header in the response to a POST request creating a
          new subscription resource. It can also be retrieved from the "id"
          attribute in the payload body of that response.
        in: path
        type: string
        required: true
552
553
554
555
556
557
558
559
560
561
562
563
564
      - name: Authorization
        description: >
          The authorization token for the request.
          Reference: IETF RFC 7235.
        in: header
        required: false
        type: string
      - name: Version
        description: >
          Version of the API requested to use when responding to this request.
        in: header
        required: true
        type: string
565
    get:
566
      summary: Read an individual subscription.
567
568
      description: >
        Query Subscription Information
569

570
571
572
        The client can use this method for reading an individual subscription for alarms related to NSs subscribed
        by the client. This method shall follow the provisions specified in the Tables 8.4.5.3.2-1 and 8.4.5.3.2-2
        for URI query parameters, request and response data structures, and response codes
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
      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:
590
591
          description: >
            200 OK
592

Giacomo Bernini's avatar
Giacomo Bernini committed
593
594
            Shall be returned when information about an individual subscription has been read successfully.
            The response body shall contain a representation of the subscription resource.
595
596
597
598
599
600
601
602
603
          headers:
            Content-Type:
              description: >
                The MIME type of the body of the request.
                Reference: IETF RFC 7231
              type: string
              maximum: 1
              minimum: 1
            WWW-Authenticate:
604
              type: string
605
606
              description: >
                Challenge if the corresponding HTTP request has not provided
607
608
                authorization, or error details if the corresponding HTTP request
                has provided an invalid authorization token.
609
610
              maximum: 1
              minimum: 0
611
612
613
614
615
616
            Version:
              description: >
                Version of the API used in the response.
              type: string
              maximum: 1
              minimum: 1
617
          schema:
618
            $ref: "definitions/SOL005NSFaultManagement_def.yaml#/definitions/FmSubscription"
619
        400:
620
          $ref: "../responses/SOL005_resp.yaml#/responses/400"
621
        401:
622
          $ref: "../responses/SOL005_resp.yaml#/responses/401"
623
        403:
624
          $ref: "../responses/SOL005_resp.yaml#/responses/403"
625
        405:
626
          $ref: "../responses/SOL005_resp.yaml#/responses/405"
627
        406:
628
          $ref: "../responses/SOL005_resp.yaml#/responses/406"
629
        500:
630
          $ref: "../responses/SOL005_resp.yaml#/responses/500"
631
        503:
632
          $ref: "../responses/SOL005_resp.yaml#/responses/503"
633
    delete:
634
      summary: Terminate a subscription.
635
636
      description: >
        Terminate Subscription
637

638
        This method terminates an individual subscription.
Giacomo Bernini's avatar
Giacomo Bernini committed
639
640
641
642
643
        As the result of successfully executing this method, the "Individual subscription" resource shall
        not exist any longer. This means that no notifications for that subscription shall be sent to the
        formerly-subscribed API consumer.
        NOTE: Due to race conditions, some notifications might still be received by the formerly-subscribed
        API consumer for a certain time period after the deletion.
644
645
      responses:
        204:
646
          description: >
647
            204 - No Content
648

Giacomo Bernini's avatar
Giacomo Bernini committed
649
            Shall be returned when the subscription resource has been deleted successfully.
650
651
652
            The response body shall be empty.
          headers:
            WWW-Authenticate:
653
              type: string
654
655
              description: >
                Challenge if the corresponding HTTP request has not provided
656
657
                authorization, or error details if the corresponding HTTP request
                has provided an invalid authorization token.
658
659
              maximum: 1
              minimum: 0
660
661
662
663
664
665
            Version:
              description: >
                Version of the API used in the response.
              type: string
              maximum: 1
              minimum: 1
666
        400:
667
          $ref: "../responses/SOL005_resp.yaml#/responses/400"
668
        401:
669
          $ref: "../responses/SOL005_resp.yaml#/responses/401"
670
        403:
671
          $ref: "../responses/SOL005_resp.yaml#/responses/403"
672
        405:
673
          $ref: "../responses/SOL005_resp.yaml#/responses/405"
674
        406:
675
          $ref: "../responses/SOL005_resp.yaml#/responses/406"
676
        500:
677
          $ref: "../responses/SOL005_resp.yaml#/responses/500"
678
        503:
Giacomo Bernini's avatar
upd  
Giacomo Bernini committed
679
          $ref: "../responses/SOL005_resp.yaml#/responses/503"