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

3
info:
bernini's avatar
bernini committed
4
  version: "1.2.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:
19 20
  description: ETSI GS NFV-SOL 005 V2.7.1
  url: https://www.etsi.org/deliver/etsi_gs/NFV-SOL/001_099/005/02.06.01_60/gs_NFV-SOL005v020701p.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                                                                #
  ###############################################################################
33
  '/api_versions':
34 35
    $ref: '../endpoints/SOL005_endpoints.yaml#/endpoints/api-versions'

36
  ###############################################################################
37 38
  # Alarms                                                                      #
  ###############################################################################
39
  '/alarms':
40
    #ETSI GS NFV-SOL 005 V2.7.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 62
        The API consumer can use this method to retrieve information about the alarm list.
        This method shall follow the provisions specified in the Tables 8.4.2.3.2-1 and 8.4.2.3.2-2 for URI query parameters,
        request and response data structures, and response codes.
63
      parameters:
64 65
        - name: filter
          in: query
66
          required: false
67
          type: string
68
          description: >
bernini's avatar
bernini committed
69
            Attribute-based filtering expression according to clause 5.2 of ETSI GS NFV SOL 013.
70 71 72 73
            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: 
74 75 76 77 78 79 80
            - id            
            - nsInstanceId            
            - rootCauseFaultyComponent.faultyNestedNsInstanceId            
            - rootCauseFaultyComponent.faultyNsVirtualLinkInstanceId            
            - rootCauseFaultyComponent.faultyVnfInstanceId           
            - rootCauseFaultyResource.faultyResourceType            
            - eventType            
81 82
            - perceivedSeverity
            - probableCause
83 84 85 86
        - name: nextpage_opaque_marker
          in: query
          description: >
            Marker to obtain the next page of a paged response. Shall be supported by the NFVO
bernini's avatar
bernini committed
87
            if the NFVO supports alternative 2 (paging) according to clause 5.4.2.1 of ETSI GS NFV SOL 013.
88 89
          required: false
          type: string
90 91 92 93 94 95 96 97 98
        - 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
99
          description: >
100
            200 OK
101

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

  ###############################################################################
  # Individual alarm                                                            #
  ###############################################################################
159
  '/alarms/{alarmId}':
160
    #ETSI GS NFV-SOL 005 V2.7.1 location: 8.4.3
161 162 163
    parameters:
      - name: alarmId
        description: >
rameshnaraya's avatar
rameshnaraya committed
164 165 166 167 168
          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.
169 170 171
        in: path
        type: string
        required: true
172 173 174 175 176 177 178 179 180 181 182 183 184
      - 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
185
    get:
186
      summary: Read individual alarm.
187
      description: >
188 189 190
        The API consumer can use this method to read an individual alarm.
        This method shall follow the provisions specified in the Tables 8.4.3.3.2-1 and 8.4.3.3.2-2 for URI query parameters,
        request and response data structures, and response codes.
191 192 193 194 195 196 197 198 199 200 201 202 203 204 205
      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
206
      responses:
207
        200:
rameshnaraya's avatar
rameshnaraya committed
208
          description: >
209
            200 OK
210

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

256
        This method modifies an individual alarm resource.
257 258
        This method shall follow the provisions specified in the Tables 8.4.3.3.2-1 and 8.4.3.3.2-2 for URI query parameters,
        request and response data structures, and response codes.
259
      parameters:
260 261
        - name: body
          in: body
262 263
          required: true
          schema:
264 265 266
            $ref: "definitions/SOL005NSFaultManagement_def.yaml#/definitions/AlarmModifications"
          description: >
            The parameter for the alarm modification, as defined in clause 8.5.2.8.
267 268 269 270 271 272 273 274 275 276 277 278 279 280 281
        - 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
282 283
          enum:
            - application/merge-patch+json
284 285
      responses:
        200:
rameshnaraya's avatar
rameshnaraya committed
286
          description: >
287
            200 OK
288

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

            Shall be returned upon the following 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.
341
          $ref: "../responses/SOL005_resp.yaml#/responses/409"
342
        412:
343
          $ref: "../responses/SOL005_resp.yaml#/responses/412"
344
        500:
345
          $ref: "../responses/SOL005_resp.yaml#/responses/500"
346
        503:
347 348
          $ref: "../responses/SOL005_resp.yaml#/responses/503"

349 350 351
  ##############################################################################
  #Subscriptions                                                               #
  ##############################################################################
352
  '/subscriptions':
353
    #ETSI GS NFV-SOL 005 V2.7.1 location: 8.4.4
354 355 356 357 358 359 360 361 362 363 364 365 366 367
    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
368
    post:
369
      summary: Subscribe to alarms related to NSs.
370
      description: >
371
        The POST method creates a new subscription.
372 373
        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.
bernini's avatar
bernini committed
374 375
        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.
376
        Creation of two subscription resources with the same callbackURI and the same filter can result in performance
377 378 379 380 381
        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).
382
      parameters:
383 384 385 386 387 388 389 390 391 392 393 394 395
        - 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
396
          type: string
397 398
        - name: body
          in: body
rameshnaraya's avatar
rameshnaraya committed
399 400
          required: true
          schema:
401 402 403
            $ref: "definitions/SOL005NSFaultManagement_def.yaml#/definitions/FmSubscriptionRequest"
          description: >
            Details of the subscription to be created, as defined in clause 8.5.2.2.
404 405
      responses:
        201:
406 407
          description: >
            201 Created
408

bernini's avatar
bernini committed
409 410 411
            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
412
          schema:
413
            $ref: "definitions/SOL005NSFaultManagement_def.yaml#/definitions/FmSubscription"
414
          headers:
rameshnaraya's avatar
rameshnaraya committed
415
            Content-Type:
416
              type: string
rameshnaraya's avatar
rameshnaraya committed
417 418 419 420
              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.
421
            WWW-Authenticate:
422
              type: string
423 424
              description: >
                Challenge if the corresponding HTTP request has not provided
rameshnaraya's avatar
rameshnaraya committed
425
                authorization, or error details if the corresponding HTTP request
426 427
                has provided an invalid authorization token.
              maximum: 1
428 429 430 431 432 433 434
              minimum: 0
            Version:
              description: >
                Version of the API used in the response.
              type: string
              maximum: 1
              minimum: 1
435
        303:
436
          $ref: "../responses/SOL005_resp.yaml#/responses/303"
437
        400:
438
          $ref: "../responses/SOL005_resp.yaml#/responses/400"
439
        401:
440
          $ref: "../responses/SOL005_resp.yaml#/responses/401"
441
        403:
442
          $ref: "../responses/SOL005_resp.yaml#/responses/403"
443
        405:
444
          $ref: "../responses/SOL005_resp.yaml#/responses/405"
445
        406:
446
          $ref: "../responses/SOL005_resp.yaml#/responses/406"
447 448
        422:
          $ref: "../responses/SOL005_resp.yaml#/responses/422"
449
        500:
450
          $ref: "../responses/SOL005_resp.yaml#/responses/500"
451
        503:
452
          $ref: "../responses/SOL005_resp.yaml#/responses/503"
453
    get:
454
      summary: Query multiple subscriptions.
455 456
      description: >
        Query Subscription Information
457

458 459 460 461
        The API consumer can use this method to retrieve the list of active subscriptions for alarms related to an NS subscribed
        by the API consumer. It can be used e.g. for resynchronization after error situations.
        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.
462
      parameters:
463 464
        - name: filter
          in: query
465
          required: false
466
          type: string
467
          description: >
bernini's avatar
bernini committed
468 469 470 471 472
            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.
473 474 475
        - name: nextpage_opaque_marker
          in: query
          description: >
bernini's avatar
bernini committed
476 477
            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.
478 479
          required: false
          type: string
480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495
        - 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
496
          description: >
497
            200 OK
498

499 500 501 502 503 504
            Shall be returned when 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
bernini's avatar
bernini committed
505
            defined in clause 8.5.2.3.
506 507 508 509 510 511 512 513 514 515
            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 [16].
            If the NFVO supports alternative 2 (paging)
            according to clause 5.4.2.1 of ETSI
            GS NFV-SOL 013 [16] 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 [16].
516 517
          headers:
            Content-Type:
rameshnaraya's avatar
rameshnaraya committed
518
              description: The MIME type of the body of the response.
519 520 521 522
              type: string
              maximum: 1
              minimum: 1
            WWW-Authenticate:
523
              type: string
524 525
              description: >
                Challenge if the corresponding HTTP request has not provided
526 527 528
                authorization, or error details if the corresponding HTTP request
                has provided an invalid authorization token.
              maximum: 1
529 530 531 532 533 534 535
              minimum: 0
            Version:
              description: >
                Version of the API used in the response.
              type: string
              maximum: 1
              minimum: 1
536 537 538 539 540 541
            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
542 543 544
          schema:
            type: array
            items:
545
              $ref: "definitions/SOL005NSFaultManagement_def.yaml#/definitions/FmSubscription"
546
        400:
547
          $ref: "../responses/SOL005_resp.yaml#/responses/400"
548
        401:
549
          $ref: "../responses/SOL005_resp.yaml#/responses/401"
550
        403:
551
          $ref: "../responses/SOL005_resp.yaml#/responses/403"
552
        405:
553
          $ref: "../responses/SOL005_resp.yaml#/responses/405"
554
        406:
555
          $ref: "../responses/SOL005_resp.yaml#/responses/406"
556
        412:
557
          $ref: "../responses/SOL005_resp.yaml#/responses/412"
558
        500:
559
          $ref: "../responses/SOL005_resp.yaml#/responses/500"
560
        503:
561
          $ref: "../responses/SOL005_resp.yaml#/responses/503"
562 563 564 565

  ###############################################################################
  # Individual subscription                                                     #
  ###############################################################################
566
  '/subscriptions/{subscriptionId}':
567
    #ETSI GS NFV-SOL 005 V2.7.1 location: 8.4.5
568 569 570 571 572 573 574 575 576 577 578
    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
579 580 581 582 583 584 585 586 587 588 589 590 591
      - 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
592
    get:
593
      summary: Read an individual subscription.
594 595
      description: >
        Query Subscription Information
596

597 598 599 600
        The API consumer can use this method for reading an individual subscription for alarms related to NSs subscribed by
        the API consumer.
        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.
601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617
      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:
618 619
          description: >
            200 OK
620

bernini's avatar
bernini committed
621 622
            Shall be returned when information about an individual subscription has been read successfully.
            The response body shall contain a representation of the subscription resource.
623 624 625 626 627 628 629 630 631
          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:
632
              type: string
633 634
              description: >
                Challenge if the corresponding HTTP request has not provided
635 636
                authorization, or error details if the corresponding HTTP request
                has provided an invalid authorization token.
637 638
              maximum: 1
              minimum: 0
639 640 641 642 643 644
            Version:
              description: >
                Version of the API used in the response.
              type: string
              maximum: 1
              minimum: 1
645
          schema:
646
            $ref: "definitions/SOL005NSFaultManagement_def.yaml#/definitions/FmSubscription"
647
        400:
648
          $ref: "../responses/SOL005_resp.yaml#/responses/400"
649
        401:
650
          $ref: "../responses/SOL005_resp.yaml#/responses/401"
651
        403:
652
          $ref: "../responses/SOL005_resp.yaml#/responses/403"
653
        405:
654
          $ref: "../responses/SOL005_resp.yaml#/responses/405"
655
        406:
656
          $ref: "../responses/SOL005_resp.yaml#/responses/406"
657
        500:
658
          $ref: "../responses/SOL005_resp.yaml#/responses/500"
659
        503:
660
          $ref: "../responses/SOL005_resp.yaml#/responses/503"
661
    delete:
662
      summary: Terminate a subscription.
663 664
      description: >
        Terminate Subscription
665

666
        This method terminates an individual subscription.
bernini's avatar
bernini committed
667 668 669 670 671
        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.
672 673
      responses:
        204:
674
          description: >
675
            204 - No Content
676

bernini's avatar
bernini committed
677
            Shall be returned when the subscription resource has been deleted successfully.
678 679 680
            The response body shall be empty.
          headers:
            WWW-Authenticate:
681
              type: string
682 683
              description: >
                Challenge if the corresponding HTTP request has not provided
684 685
                authorization, or error details if the corresponding HTTP request
                has provided an invalid authorization token.
686 687
              maximum: 1
              minimum: 0
688 689 690 691 692 693
            Version:
              description: >
                Version of the API used in the response.
              type: string
              maximum: 1
              minimum: 1
694
        400:
695
          $ref: "../responses/SOL005_resp.yaml#/responses/400"
696
        401:
697
          $ref: "../responses/SOL005_resp.yaml#/responses/401"
698
        403:
699
          $ref: "../responses/SOL005_resp.yaml#/responses/403"
700
        405:
701
          $ref: "../responses/SOL005_resp.yaml#/responses/405"
702
        406:
703
          $ref: "../responses/SOL005_resp.yaml#/responses/406"
704
        500:
705
          $ref: "../responses/SOL005_resp.yaml#/responses/500"
706
        503:
bernini's avatar
bernini committed
707
          $ref: "../responses/SOL005_resp.yaml#/responses/503"