VNFIndicator.yaml 29 KB
Newer Older
1 2 3
swagger: "2.0"

info:
4
  version: "1.2.0"
5
  title: SOL003 - VNF Indicator interface
6
  description: >
7 8 9
    SOL003 - VNF Indicator interface


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

14 15 16 17 18 19 20
    
    In clause 4.3.2 of ETSI GS NFV-SOL 003 v2.4.1, an attribute-based
    filtering mechanism is defined. This mechanism is currently not
    included in the corresponding OpenAPI design for this GS version. Changes
    to the attribute-based filtering mechanism are being considered in v2.5.1
    of this GS for inclusion in the corresponding future ETSI NFV OpenAPI
    design.
21
    Please report bugs to https://forge.etsi.org/bugzilla/buglist.cgi?component=Nfv-Openapis&list_id=61&product=NFV&resolution=
22 23 24 25
  license:
    name: "ETSI Forge copyright notice"
    url: https://forge.etsi.org/etsi-forge-copyright-notice.txt

26
externalDocs:
27 28
  description: ETSI GS NFV-SOL 003 V2.5.1
  url: https://www.etsi.org/deliver/etsi_gs/NFV-SOL/001_099/002/02.05.01_60/gs_nfv-sol002v020501p.pdf
29

30 31 32 33 34 35 36 37 38 39 40
basePath: "/vnfind/v1"

schemes:
  - https

consumes:
  - "application/json"
produces:
  - "application/json"

paths:
41 42 43
  ###############################################################################
  # API Versions                                                                #
  ###############################################################################
44
  '/api-versions':
45
    $ref: '../../endpoints/SOL002SOL003_endpoints.yaml#/endpoints/api-versions'
46

47 48 49 50 51 52 53
###############################################################################
# VNF indicators                                                              #
###############################################################################
  '/indicators':
  #SOL003 location: 8.4.2
    get:
      description: >
Gergely Csatari's avatar
Gergely Csatari committed
54 55 56
        Get Indicator Value


57 58 59 60 61 62 63 64 65 66 67 68 69 70
        The GET method queries multiple VNF indicators.
      parameters:
        - name: Accept
          description: >
            Content-Types that are acceptable for the response.
            Reference: IETF RFC 7231
          in: header
          required: true
          type: string
        - name: Authorization
          description: >
            The authorization token for the request.
            Reference: IETF RFC 7235
          in: header
Gergely Csatari's avatar
Gergely Csatari committed
71
          required: false
72
          type: string
73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91
        - name: filter
          description: >
            Attribute-based filtering expression according to clause 4.3.2.
            The VNFM shall support receiving this parameter as part of the 
            URI query string. The NFVO may supply this parameter. 
            All attribute names that appear in the VnfIndicator and in 
            data types referenced from it shall be supported by the VNFM 
            in the filter expression.
          in: query
          required: false
          type: string
        - name: nextpage_opaque_marker
          description: >
            Marker to obtain the next page of a paged response. Shall be 
            supported by the VNFM if the VNFM supports alternative 2 (paging) 
            according to clause 4.7.2.1 for this resource.
          in: query
          required: false
          type: string
92 93 94 95 96 97
        - name: Version
          description: >
            Version of the API requested to use when responding to this request.
          in: header
          required: true
          type: string
98 99 100
      responses:
        200:
          description: > 
101 102
            OK

103 104 105 106 107 108 109 110 111
            Information about zero or more VNF indicators was queried 
            successfully.
            The response body shall contain in an array the representations 
            of all VNF indicators that match the attribute filter, i.e. 
            zero or more representations of VNF indicators as defined in 
            clause 8.5.2.2.
            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.
112 113 114 115 116 117 118 119
          headers:
            Content-Type:
              description: >
                The MIME type of the body of the request.
                Reference: IETF RFC 7231
              type: string
              maximum: 1
              minimum: 1
Gergely Csatari's avatar
Gergely Csatari committed
120 121 122 123 124 125 126 127
            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
128 129 130 131 132 133
            Version:
              description: >
                Version of the API used in the response.
              type: string
              maximum: 1
              minimum: 1
134 135 136 137 138 139
            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
140 141 142 143 144
          schema:
            type: array
            items: 
              $ref: "../../definitions/SOL002SOL003VNFIndicator_def.yaml#/definitions/VnfIndicator"
        400:
145
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/400"
146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175
        401:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/401"
        403:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/403"
        405:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/405"
        406:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/406"
        500:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/500"
        503:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/503"
###############################################################################
# VNF indicators related to a VNF instance                                    #
###############################################################################
  '/indicators/{vnfInstanceId}':
  #SOL003 location: 8.4.3
    parameters:
      - name: vnfInstanceId
        description: >
          Identifier of the VNF instance to which the VNF indicator applies.
          This identifier can be retrieved from the resource referenced by the
          "Location" HTTP header in the response to a POST request creating a
          new VNF instance resource. It can also be retrieved from the "id"
          attribute in the payload body of that response.
        in: path
        type: string
        required: true
    get:
      description: >
Gergely Csatari's avatar
Gergely Csatari committed
176 177 178
        Get Indicator Value


179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200
        The GET method queries multiple VNF indicators related to a VNF
        instance.
      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
        - name: Authorization
          description: >
            The authorization token for the request.
            Reference: IETF RFC 7235
          in: header
Gergely Csatari's avatar
Gergely Csatari committed
201
          required: false
202
          type: string
203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221
        - name: filter
          description: >
            Attribute-based filtering expression according to clause 4.3.2.
            The VNFM shall support receiving this parameter as part of the 
            URI query string. The NFVO may supply this parameter. 
            All attribute names that appear in the VnfIndicator and in 
            data types referenced from it shall be supported by the VNFM 
            in the filter expression.
          in: query
          required: false
          type: string
        - name: nextpage_opaque_marker
          description: >
            Marker to obtain the next page of a paged response. Shall be 
            supported by the VNFM if the VNFM supports alternative 2 (paging) 
            according to clause 4.7.2.1 for this resource.
          in: query
          required: false
          type: string
222 223 224 225 226 227
        - name: Version
          description: >
            Version of the API requested to use when responding to this request.
          in: header
          required: true
          type: string
228 229 230
      responses:
        200:
          description: > 
231 232
            OK

233 234 235 236 237 238 239 240 241
            Information about zero or more VNF indicators was queried 
            successfully.
            The response body shall contain in an array the representations 
            of all VNF indicators that are related to the particular VNF 
            instance and that match the attribute filter, i.e. zero or more
            representations of VNF indicators as defined in clause 8.5.2.2.
            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.
242 243 244 245 246 247 248 249
          headers:
            Content-Type:
              description: >
                The MIME type of the body of the request.
                Reference: IETF RFC 7231
              type: string
              maximum: 1
              minimum: 1
Gergely Csatari's avatar
Gergely Csatari committed
250 251 252 253 254 255 256 257
            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
258 259 260 261 262 263
            Version:
              description: >
                Version of the API used in the response.
              type: string
              maximum: 1
              minimum: 1
264 265 266 267 268 269
            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
270 271 272 273 274
          schema:
            type: array
            items: 
              $ref: "../../definitions/SOL002SOL003VNFIndicator_def.yaml#/definitions/VnfIndicator"
        400:
275
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/400"
276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314
        401:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/401"
        403:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/403"
        405:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/405"
        406:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/406"
        500:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/500"
        503:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/503"
###############################################################################
# Individual VNF indicator                                                    #
###############################################################################
  '/indicators/{vnfInstanceId}/{indicatorId}':
  #SOL003 location: 8.4.4
    parameters:
      - name: indicatorId
        description: >
          Identifier of the VNF indicator.
          This identifier can be retrieved from the resource referenced by the
          payload body in the response to a POST request creating a new VNF
          instance resource.
        in: path
        type: string
        required: true
      - name: vnfInstanceId
        description: >
          Identifier of the VNF instance to which the VNF indicator applies.
          This identifier can be retrieved from the resource referenced by the
          "Location" HTTP header in the response to a POST request creating a
          new VNF instance resource. It can also be retrieved from the "id"
          attribute in the payload body of that response.
        in: path
        type: string
        required: true
    get:
      description: >
Gergely Csatari's avatar
Gergely Csatari committed
315 316 317
        Get Indicator Value


318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338
        The GET method reads a VNF indicator.
      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
        - name: Authorization
          description: >
            The authorization token for the request.
            Reference: IETF RFC 7235
          in: header
Gergely Csatari's avatar
Gergely Csatari committed
339
          required: false
340
          type: string
341 342 343 344 345 346
        - name: Version
          description: >
            Version of the API requested to use when responding to this request.
          in: header
          required: true
          type: string
347 348 349
      responses:
        200:
          description: > 
350 351
            OK

352 353 354 355 356 357 358 359 360 361 362
            The VNF indicator was read successfully.
            The response body shall contain the representation of the VNF
            indicator.
          headers:
            Content-Type:
              description: >
                The MIME type of the body of the request.
                Reference: IETF RFC 7231
              type: string
              maximum: 1
              minimum: 1
Gergely Csatari's avatar
Gergely Csatari committed
363 364 365 366 367 368 369 370
            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
371 372 373 374 375 376
            Version:
              description: >
                Version of the API used in the response.
              type: string
              maximum: 1
              minimum: 1
377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398
          schema: 
            $ref: "../../definitions/SOL002SOL003VNFIndicator_def.yaml#/definitions/VnfIndicator"
        400:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/400"
        401:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/401"
        403:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/403"
        405:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/405"
        406:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/406"
        500:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/500"
        503:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/503"
###############################################################################
# Subscriptions                                                              #
###############################################################################
  '/subscriptions':
    post:
      description: >
Gergely Csatari's avatar
Gergely Csatari committed
399 400 401
        Subscribe


402
        The POST method creates a new subscription.
403 404 405 406 407 408 409 410 411 412
        Creation of two subscription resources with the same callbackURI and
        the same filter can result in performance degradation and will provide
        duplicates of notifications to the NFVO, and might make sense only in
        very rare use cases. Consequently, the VNFM 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).
413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438
      parameters:
        - name: VnfIndicatorSubscriptionRequest
          description: Details of the subscription to be created.
          in: body
          required: true
          schema:
            $ref: "../../definitions/SOL002SOL003VNFIndicator_def.yaml#/definitions/VnfIndicatorSubscriptionRequest"
        - 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
        - name: Authorization
          description: >
            The authorization token for the request.
            Reference: IETF RFC 7235
          in: header
Gergely Csatari's avatar
Gergely Csatari committed
439
          required: false
440
          type: string
441 442 443 444 445 446
        - name: Version
          description: >
            Version of the API requested to use when responding to this request.
          in: header
          required: true
          type: string
447 448 449
      responses:
        201:
          description: > 
450 451
            Created

452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468
            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:
              description: >
                The MIME type of the body of the request.
                Reference: IETF RFC 7231
              type: string
              maximum: 1
              minimum: 1
            Location:
              description: The resource URI of the created VNF instance
              type: string
              format: url
Gergely Csatari's avatar
Gergely Csatari committed
469 470 471 472 473 474 475 476
            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
477 478 479 480 481 482
            Version:
              description: >
                Version of the API used in the response.
              type: string
              maximum: 1
              minimum: 1
483 484 485 486
          schema:
            type: array
            items: 
              $ref: "../../definitions/SOL002SOL003VNFIndicator_def.yaml#/definitions/VnfIndicatorSubscription"
487 488
        303:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/303"
489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504
        400:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/400"
        401:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/401"
        403:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/403"
        405:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/405"
        406:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/406"
        500:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/500"
        503:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/503"
    get:
      description: >
Gergely Csatari's avatar
Gergely Csatari committed
505 506 507
        Query Subscription Information


508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530
        The GET method queries the list of active subscriptions of the
        functional block that invokes the method. 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
        - name: Authorization
          description: >
            The authorization token for the request.
            Reference: IETF RFC 7235
          in: header
Gergely Csatari's avatar
Gergely Csatari committed
531
          required: false
532
          type: string
533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551
        - name: filter
          description: >
            Attribute-based filtering expression according to clause 4.3.2.
            The VNFM shall support receiving this parameter as part of the 
            URI query string. The NFVO may supply this parameter. 
            All attribute names that appear in the VnfIndicatorSubscription
            and in data types referenced from it shall be supported by the 
            VNFM in the filter expression.
          in: query
          required: false
          type: string
        - name: nextpage_opaque_marker
          description: >
            Marker to obtain the next page of a paged response. Shall be 
            supported by the VNFM if the VNFM supports alternative 2 (paging) 
            according to clause 4.7.2.1 for this resource.
          in: query
          required: false
          type: string
552 553 554 555 556 557
        - name: Version
          description: >
            Version of the API requested to use when responding to this request.
          in: header
          required: true
          type: string
558 559 560
      responses:
        200:
          description: > 
561 562
            OK

563
            The list of subscriptions was queried successfully.
564 565 566 567 568 569 570 571
            The response body shall contain in an array the representations 
            of all active subscriptions of the functional block that invokes 
            the method which match the attribute filter, i.e. zero or more
            representations of VNF indicator subscriptions as defined in 
            clause 8.5.2.4.
            If the VNFM supports alternative 2 (paging) according to clause 
            4.7.2.1 for this resource, inclusion of the Link HTTP header in 
            this response shall follow the provisions in clause 4.7.2.3.
572 573 574 575 576 577 578 579 580 581 582 583
          headers:
            Content-Type:
              description: >
                The MIME type of the body of the request.
                Reference: IETF RFC 7231
              type: string
              maximum: 1
              minimum: 1
            Location:
              description: The resource URI of the created VNF instance
              type: string
              format: url
Gergely Csatari's avatar
Gergely Csatari committed
584 585 586 587 588 589 590 591
            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
592 593 594 595 596 597
            Version:
              description: >
                Version of the API used in the response.
              type: string
              maximum: 1
              minimum: 1
598 599 600 601 602 603
            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
604 605 606 607 608
          schema:
            type: array
            items: 
              $ref: "../../definitions/SOL002SOL003VNFIndicator_def.yaml#/definitions/VnfIndicatorSubscription"
        400:
609
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/400"
610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639
        401:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/401"
        403:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/403"
        405:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/405"
        406:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/406"
        500:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/500"
        503:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/503"
###############################################################################
# Individual subscription                                                     #
###############################################################################
  '/indicators/subscriptions/{subscriptionId}':
  #SOL003 location: 8.4.6
    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
    get:
      description: >
Gergely Csatari's avatar
Gergely Csatari committed
640 641 642
        Query Subscription Information


643 644 645 646 647 648 649 650 651 652 653 654 655 656
        The GET method reads an individual subscription.
      parameters:
        - name: Accept
          description: >
            Content-Types that are acceptable for the response.
            Reference: IETF RFC 7231
          in: header
          required: true
          type: string
        - name: Authorization
          description: >
            The authorization token for the request.
            Reference: IETF RFC 7235
          in: header
Gergely Csatari's avatar
Gergely Csatari committed
657 658 659 660 661 662 663
          required: false
          type: string
        - name: Content-Type
          description: >
            The MIME type of the body of the request.
            Reference: IETF RFC 7231
          in: header
664 665
          required: true
          type: string
666 667 668 669 670 671
        - name: Version
          description: >
            Version of the API requested to use when responding to this request.
          in: header
          required: true
          type: string
672 673 674
      responses:
        200:
          description: > 
675 676
            OK

677 678 679 680 681 682 683 684 685 686 687
            The operation has completed successfully.
            The response body shall contain a representation of the
            subscription resource.
          headers:
            Content-Type:
              description: >
                The MIME type of the body of the request.
                Reference: IETF RFC 7231
              type: string
              maximum: 1
              minimum: 1
Gergely Csatari's avatar
Gergely Csatari committed
688 689 690 691 692 693 694 695
            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
696 697 698 699 700 701
            Version:
              description: >
                Version of the API used in the response.
              type: string
              maximum: 1
              minimum: 1
702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719
          schema: 
            $ref: "../../definitions/SOL002SOL003VNFIndicator_def.yaml#/definitions/VnfIndicatorSubscription"
        400:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/400"
        401:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/401"
        403:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/403"
        405:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/405"
        406:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/406"
        500:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/500"
        503:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/503"
    delete:
      description: >
Gergely Csatari's avatar
Gergely Csatari committed
720 721 722
        Terminate Subscription

        
723 724 725 726 727 728 729
        The DELETE method terminates an individual subscription.
      parameters:
        - name: Authorization
          description: >
            The authorization token for the request.
            Reference: IETF RFC 7235
          in: header
Gergely Csatari's avatar
Gergely Csatari committed
730 731 732 733 734 735 736
          required: false
          type: string
        - name: Content-Type
          description: >
            The MIME type of the body of the request.
            Reference: IETF RFC 7231
          in: header
737 738
          required: true
          type: string
739 740 741 742 743 744
        - name: Version
          description: >
            Version of the API requested to use when responding to this request.
          in: header
          required: true
          type: string
745 746 747
      responses:
        204:
          description: > 
748 749
            No Content

750 751
            The subscription resource was deleted successfully.
            The response body shall be empty.
Gergely Csatari's avatar
Gergely Csatari committed
752 753 754 755 756 757 758 759 760
          headers:
            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
761 762 763 764 765 766
            Version:
              description: >
                Version of the API used in the response.
              type: string
              maximum: 1
              minimum: 1
767 768 769 770 771 772 773 774 775 776 777 778 779 780
        400:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/400"
        401:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/401"
        403:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/403"
        405:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/405"
        406:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/406"
        500:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/500"
        503:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/503"