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

3
info:
4
  version: "1.2.0-impl:etsi.org:ETSI_NFV_OpenAPI:1"
5
  title: SOL002 - VNF Indicator interface
6
  description: >
7
    SOL002 - VNF Indicator interface
8
    IMPORTANT: Please note that this file might be not aligned to the current
9 10 11
    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.
12
    Please report bugs to https://forge.etsi.org/bugzilla/buglist.cgi?component=Nfv-Openapis
13
  license:
14
    name: ETSI Forge copyright notice
15
    url: https://forge.etsi.org/etsi-forge-copyright-notice.txt
16 17
  contact:
    name: NFV-SOL WG
18

19
externalDocs:
20 21
  description: ETSI GS NFV-SOL 002 V2.6.1
  url: https://www.etsi.org/deliver/etsi_gs/NFV-SOL/001_099/002/02.06.01_60/gs_nfv-sol002v020601p.pdf
22 23 24

basePath: /vnfind/v1

25
schemes:
26 27 28
  - http
  - https

29
consumes:
30 31
  - application/json

32
produces:
33 34 35
  - application/json

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

42 43 44
  ###############################################################################
  # VNF Indicators                                                              #
  ###############################################################################
45 46 47 48 49 50
  /indicators:
    parameters:
      - name: Version
        description: >
          Version of the API requested to use when responding to this request.
        in: header
51
        required: true
52
        type: string
53 54 55 56 57 58 59
      - name: Authorization
        description: >
          The authorization token for the request.
          Reference: IETF RFC 7235
        in: header
        required: false
        type: string
60
    get:
61 62 63 64 65
      summary: Query multiple indicators
      description: Get a list of indicators. Support of attribute based filtering via query parameters.
      parameters:
        - name: filter
          description: >
66
            Attribute-based filtering expression according to clause 5.2 of ETSI GS NFV-SOL 013.
67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100
            The VNFM shall support receiving this parameter as part of the URI query string.
            The EM/VNF may supply this parameter. The VNF may supply its instance Id as an attribute filter.
            All attribute names that appear in the VnfIndicator data type and in data types referenced from
            it shall be supported by the VNFM in the filter expression. If receiving, this parameter is not
            supported a 400 Bad Request response shall be returned (See table 8.4.2.3.2-2).

            EXAMPLE
            objects
            obj1: {"id":123, "weight":100, "parts":[{"id":1, "color":"red"}, {"id":2, "color":"green"}]}
            obj2: {"id":456, "weight":500, "parts":[{"id":3, "color":"green"}, {"id":4, "color":"blue"}]}

            Request 1:
            GET …/container

            Response 1:
            [
                {"id":123, "weight":100, "parts":[{"id":1, "color":"red"}, {"id":2, "color":"green"}]},
                {"id":456, "weight":500, "parts":[{"id":3, "color":"green"}, {"id":4, "color":"blue"}]}
            ]

            Request 2:
            GET …/container?filter=(eq.weight,100)

            Response 2:
            [
                {"id":123, "weight":100, "parts":[{"id":1, "color":"red"}, {"id":2, "color":"green"}]}
            ]
          #Request 2 in EXAMPLE from clause 4.3.2 probably wrong, since "," should be used after opOne (eq), "." is used
          in: query
          required: false
          type: string
        - name: nextpage_opaque_marker
          description: >
            Marker to obtain the next page of a paged response. Shall be supported by the EM/VNF
101 102
            if the EM/VNF supports alternative 2 (paging) according to clause 5.4.2.1 of 
            ETSI GS NFV-SOL 013for this resource.
103 104 105 106 107 108 109 110
          in: query
          required: false
          type: string
      responses:
        200:
          description: >
            200 OK

111 112 113 114 115 116 117 118 119 120 121 122
            Shall be returned when 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-based 
            filtering parameters, i.e. zero or more representations of VNF indicators 
            as defined in clause 8.5.2.2.
            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 EM/VNF supports alternative 2 (paging) according to clause 5.4.2.1 
            of ETSI GS NFV-SOL 013for this resource, inclusion of the Link HTTP header 
            in this response shall follow the provisions in clause 5.4.2.3 of 
            ETSI GS NFV-SOL 013.
123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142
          headers:
            Content-Type:
              description: The MIME type of the body of the response.
              type: string
              maximum: 1
              minimum: 1
            Version:
              description: The used API version.
              type: string
              maximum: 1
              minimum: 1
            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
          schema:
            type: array
            items:
143
              $ref: '../../definitions/SOL002SOl003VNFIndicator_def.yaml#/definitions/VnfIndicator'
144 145 146 147 148 149 150 151 152
        400:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/400"
        401:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/401"
        403:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/403"
        404:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/404"
        405:
153
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/405"
154 155 156 157 158 159 160 161 162 163 164 165 166 167
        406:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/406"
        416:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/416"
        422:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/422"
        429:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/429"
        500:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/500"
        503:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/503"
        504:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/504"
168

169 170 171
  ###############################################################################
  # VNF indicators related to a VNF instance                                    #
  ###############################################################################
172
  /indicators/{vnfInstanceId}:
173 174 175
    parameters:
      - name: vnfInstanceId
        in: path
176
        description: >
177
          Service Unavailable
178

179 180 181
          Identifier of the VNF instance to which the VNF indicators applies.
          NOTE: 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
182
          of that response.
183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201
        type: string
        required: true
      - name: Version
        description: >
          Version of the API requested to use when responding to this request.
        in: header
        required: true
        type: string
      - name: Authorization
        description: >
          The authorization token for the request.
          Reference: IETF RFC 7235
        in: header
        required: false
        type: string
    get:
      summary: Query multiple indicators related to a VNF instance.
      description: >
        Get a list of indicators related to a specific VNF instance. Support of attribute based filtering via query parameters.
202
      parameters:
203
        - name: filter
204
          description: >
205
            Attribute-based filtering expression according to clause 5.2 of ETSI GS NFV-SOL 013.
206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235
            The VNFM shall support receiving this parameter as part of the URI query string.
            The EM/VNF shall support receiving filtering parameters as part of the URI query string.
            The VNFM may supply filtering parameters.
            All attribute names that appear in the VnfIndicator data type and in data types referenced
            from it shall be supported in attribute-based filtering parameters.

            EXAMPLE
            objects
            obj1: {"id":123, "weight":100, "parts":[{"id":1, "color":"red"}, {"id":2, "color":"green"}]}
            obj2: {"id":456, "weight":500, "parts":[{"id":3, "color":"green"}, {"id":4, "color":"blue"}]}

            Request 1:
            GET …/container

            Response 1:
            [
                {"id":123, "weight":100, "parts":[{"id":1, "color":"red"}, {"id":2, "color":"green"}]},
                {"id":456, "weight":500, "parts":[{"id":3, "color":"green"}, {"id":4, "color":"blue"}]}
            ]

            Request 2:
            GET …/container?filter=(eq.weight,100)

            Response 2:
            [
                {"id":123, "weight":100, "parts":[{"id":1, "color":"red"}, {"id":2, "color":"green"}]}
            ]
          #Request 2 in EXAMPLE from clause 4.3.2 probably wrong, since "," should be used after opOne (eq), "." is used
          in: query
          required: false
236
          type: string
237
        - name: nextpage_opaque_marker
238
          description: >
239 240 241
            Marker to obtain the next page of a paged response. Shall be supported 
            by the EM/VNF if the EM/VNF supports alternative 2 (paging) according 
            to clause 5.4.2.1 of ETSI GS NFV-SOL 013 for this resource.
242 243
          in: query
          required: false
244
          type: string
245 246 247 248 249
      responses:
        200:
          description: >
            200 OK

250 251
            Shall be returned when information about zero or more VNF indicators 
            was queried successfully.
252 253 254 255
            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.
256 257 258 259 260 261 262
            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 EM/VMF 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.
263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282
          headers:
            Content-Type:
              description: The MIME type of the body of the response.
              type: string
              maximum: 1
              minimum: 1
            Version:
              description: The used API version.
              type: string
              maximum: 1
              minimum: 1
            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
          schema:
            type: array
            items:
283
              $ref: '../../definitions/SOL002SOl003VNFIndicator_def.yaml#/definitions/VnfIndicator'
284 285 286 287 288 289 290 291 292
        400:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/400"
        401:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/401"
        403:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/403"
        404:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/404"
        405:
293
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/405"
294 295 296 297 298 299 300 301 302 303 304 305 306 307
        406:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/406"
        416:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/416"
        422:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/422"
        429:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/429"
        500:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/500"
        503:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/503"
        504:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/504"
308

309 310 311 312
  ###############################################################################
  # Individual VNF indicator                                                    #
  ###############################################################################
  /indicators/{vnfInstanceId}/{indicatorId}:
313
    parameters:
314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331
      - name: vnfInstanceId
        in: path
        description: >
          Service Unavailable

          Identifier of the VNF instance to which the VNF indicators applies.
          NOTE: 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.
        type: string
        required: true
      - name: indicatorId
        in: path
        description: >
          Identifier of the VNF indicator.
        # LEH        NOTE from SOL002 is strange
        type: string
        required: true
332 333 334 335
      - name: Version
        description: >
          Version of the API requested to use when responding to this request.
        in: header
336
        required: true
337
        type: string
338 339 340 341 342 343 344
      - name: Authorization
        description: >
          The authorization token for the request.
          Reference: IETF RFC 7235
        in: header
        required: false
        type: string
345
    get:
346 347 348 349 350 351 352 353 354 355 356
      summary: Read an inidividual VNF indicator related to a VNF instance.
      description: >
        Read an individual VNF indicator related to a specific VNF instance.
        NOTE: 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.
      responses:
        200:
          description: >
            200 OK

357
            Shall be returned when the VNF indicator has been read successfully.
358 359 360 361 362 363 364 365 366 367 368 369 370
            The response body shall contain the representation of the VNF indicator.
          headers:
            Content-Type:
              description: The MIME type of the body of the response.
              type: string
              maximum: 1
              minimum: 1
            Version:
              description: The used API version.
              type: string
              maximum: 1
              minimum: 1
          schema:
371
            $ref: '../../definitions/SOL002SOl003VNFIndicator_def.yaml#/definitions/VnfIndicator'
372 373 374 375 376 377 378 379 380
        400:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/400"
        401:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/401"
        403:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/403"
        404:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/404"
        405:
381
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/405"
382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400
        406:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/406"
        416:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/416"
        422:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/422"
        429:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/429"
        500:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/500"
        503:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/503"
        504:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/504"

  /indicators/{indicatorId}:
    parameters:
      - name: indicatorId
        in: path
401
        description: >
402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426
          Identifier of the VNF indicator.
        type: string
        required: true
      - name: Version
        description: >
          Version of the API requested to use when responding to this request.
        in: header
        required: true
        type: string
      - name: Authorization
        description: >
          The authorization token for the request.
          Reference: IETF RFC 7235
        in: header
        required: false
        type: string
    get:
      summary: Read an inidividual VNF indicator related to a VNF instance.
      description: >
        Reads a VNF indicator.
      responses:
        200:
          description: >
            200 OK

427
            Shall be returned when the VNF indicator has been read successfully.
428 429 430 431 432 433 434 435 436 437 438 439 440
            The response body shall contain the representation of the VNF indicator.
          headers:
            Content-Type:
              description: The MIME type of the body of the response.
              type: string
              maximum: 1
              minimum: 1
            Version:
              description: The used API version.
              type: string
              maximum: 1
              minimum: 1
          schema:
441
            $ref: '../../definitions/SOL002SOl003VNFIndicator_def.yaml#/definitions/VnfIndicator'
442 443 444 445 446 447 448 449 450
        400:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/400"
        401:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/401"
        403:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/403"
        404:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/404"
        405:
451
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/405"
452 453 454 455 456 457 458 459 460 461 462 463 464 465
        406:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/406"
        416:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/416"
        422:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/422"
        429:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/429"
        500:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/500"
        503:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/503"
        504:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/504"
466

467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486
  ###############################################################################
  # Subscriptions                                                               #
  ###############################################################################
  /subscriptions:
    parameters:
      - name: Version
        description: >
          Version of the API requested to use when responding to this request.
        in: header
        required: true
        type: string
      - name: Authorization
        description: >
          The authorization token for the request.
          Reference: IETF RFC 7235
        in: header
        required: false
        type: string
    post:
      summary: Create a new subscription to VNF indicator change notifications
487 488 489 490 491
      description: >
        This method creates a new subscription.
        As the result of successfully executing this method, a new "Individual 
        subscription" resource as defined in clause 8.4.6 shall have been created. 
        This method shall not trigger any notification.
492 493 494 495 496 497
      parameters:
        - name: vnfIndicatorSubscriptionRequest
          in: body
          description: Details of the subscription to be created.
          required: true
          schema:
498
            $ref: '../../definitions/SOL002SOL003VNFIndicator_def.yaml#/definitions/VnfIndicatorSubscriptionRequest'
499 500 501 502 503
      responses:
        201:
          description: >
            201 CREATED

504 505 506
            Shall be returned when the subscription has been created successfully.
            The response body shall contain a representation of the created 
            "Individual subscription" resource.
507
          schema:
508
            $ref: '../../definitions/SOL002SOL003VNFIndicator_def.yaml#/definitions/VnfIndicatorSubscription'
509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528
          headers:
            Location:
              description: >
                Pointer to the created subscription resource.
              type: string
              format: URI
            Content-Type:
              description: The MIME type of the body of the response.
              type: string
              maximum: 1
              minimum: 1
            Version:
              description: The used API version.
              type: string
              maximum: 1
              minimum: 1
        303:
          description: >
            303 SEE OTHER

529 530 531 532 533
            Shall be returned when a subscription with the same callbackURI and 
            the same filter already exists and the policy of the VNFM is to not 
            create redundant subscriptions.
            The HTTP response shall include a "Location" HTTP header that contains 
            the resource URI of the existing "Individual subscription" resource.
534 535 536 537 538 539 540 541 542 543 544
            The response body shall be empty.
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/303"
        400:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/400"
        401:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/401"
        403:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/403"
        404:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/404"
        405:
545
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/405"
546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563
        406:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/406"
        416:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/416"
        422:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/422"
        429:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/429"
        500:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/500"
        503:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/503"
        504:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/504"
    get:
      summary: Query multiple subscriptions.
      description: >
        Service Unavailable
564

565 566 567 568 569
        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: filter
          description: >
570
            Attribute-based filtering expression according to clause 5.2 of ETSI GS NFV-SOL 013.
571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604
            The EM shall and the VNF may support receiving this parameter as part
            of the URI query string. The VNFM may supply this parameter.
            All attribute names that appear in the VnfIndicatorSubscription data
            type and in data types referenced from it shall be supported in the filter expression.
            If receiving, this parameter is not supported, a 400 Bad Request response shall
            be returned (see table 8.4.5.3.2-2).

            EXAMPLE
            objects
            obj1: {"id":123, "weight":100, "parts":[{"id":1, "color":"red"}, {"id":2, "color":"green"}]}
            obj2: {"id":456, "weight":500, "parts":[{"id":3, "color":"green"}, {"id":4, "color":"blue"}]}

            Request 1:
            GET …/container

            Response 1:
            [
                {"id":123, "weight":100, "parts":[{"id":1, "color":"red"}, {"id":2, "color":"green"}]},
                {"id":456, "weight":500, "parts":[{"id":3, "color":"green"}, {"id":4, "color":"blue"}]}
            ]

            Request 2:
            GET …/container?filter=(eq.weight,100)

            Response 2:
            [
                {"id":123, "weight":100, "parts":[{"id":1, "color":"red"}, {"id":2, "color":"green"}]}
            ]
          #Request 2 in EXAMPLE from clause 4.3.2 probably wrong, since "," should be used after opOne (eq), "." is used
          in: query
          required: false
          type: string
        - name: nextpage_opaque_marker
          description: >
605 606 607
            Marker to obtain the next page of a paged response. Shall be supported 
            by the EM if the EM supports alternative 2 (paging) according to 
            clause 5.4.2.1 of ETSI GS NFV-SOL 013 for this resource.
608 609 610 611 612 613 614 615
          in: query
          required: false
          type: string
      responses:
        200:
          description: >
            200 OK

616 617 618 619 620 621 622 623 624 625 626 627
            Shall be returned when the list of subscriptions was queried successfully.
            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 
            indicators subscriptions as defined in clause 8.5.2.4.
            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 EM 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.
628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647
          headers:
            Content-Type:
              description: The MIME type of the body of the response.
              type: string
              maximum: 1
              minimum: 1
            Version:
              description: The used API version.
              type: string
              maximum: 1
              minimum: 1
            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
          schema:
            type: array
            items:
648
              $ref: '../../definitions/SOL002SOL003VNFIndicator_def.yaml#/definitions/VnfIndicatorSubscription'
649 650 651 652 653 654 655 656 657
        400:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/400"
        401:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/401"
        403:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/403"
        404:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/404"
        405:
658
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/405"
659 660 661 662 663 664 665 666 667 668 669 670 671 672
        406:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/406"
        416:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/416"
        422:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/422"
        429:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/429"
        500:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/500"
        503:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/503"
        504:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/504"
673

674 675 676
  ###############################################################################
  # Individual Subscription                                                     #
  ###############################################################################
677 678 679 680 681 682
  /subscriptions/{subscriptionId}:
    parameters:
      - name: Version
        description: >
          Version of the API requested to use when responding to this request.
        in: header
683
        required: true
684
        type: string
685
      - name: Authorization
686
        description: >
687 688 689 690 691 692 693 694 695
          The authorization token for the request.
          Reference: IETF RFC 7235
        in: header
        required: false
        type: string
    get:
      summary: Read an individual subscription.
      description: >
        Service Unavailable
696

697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714
        This resource represents an individual subscription. The client can use this resource to
        read and to terminate a subscription to notifications related to VNF indicator value changes.
      parameters:
        - name: subscriptionId
          description: >
            Identifier of this subscription.
            NOTE:
             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
      responses:
        200:
          description: >
            200 OK

715 716 717 718
            Shall be returned when information about an individual subscription 
            has been read successfully. 
            The response body shall contain the representation of the 
            "Individual subscription" resource.
719 720 721 722 723 724 725 726 727 728 729 730
          headers:
            Content-Type:
              description: The MIME type of the body of the response.
              type: string
              maximum: 1
              minimum: 1
            Version:
              description: The used API version.
              type: string
              maximum: 1
              minimum: 1
          schema:
731
            $ref: '../../definitions/SOL002SOL003VNFIndicator_def.yaml#/definitions/VnfIndicatorSubscription'
732 733 734 735 736 737 738 739 740
        400:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/400"
        401:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/401"
        403:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/403"
        404:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/404"
        405:
741
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/405"
742 743 744 745 746 747 748 749 750 751 752 753 754 755
        406:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/406"
        416:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/416"
        422:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/422"
        429:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/429"
        500:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/500"
        503:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/503"
        504:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/504"
756
    delete:
757
      summary: Delete a subscription
758 759 760 761 762 763 764 765 766
      description: >
        This method terminates an individual subscription.
        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.
767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784
      parameters:
        - name: subscriptionId
          description: >
            Service Unavailable

            Identifier of this subscription.
            NOTE:
             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
      responses:
        204:
          description: >
            204 NO CONTENT

785
            Shall be returned when the subscription has been deleted successfully.
786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801
            The response body shall be empty.
          headers:
            Version:
              description: The used API version.
              type: string
              maximum: 1
              minimum: 1
        400:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/400"
        401:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/401"
        403:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/403"
        404:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/404"
        405:
802
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/405"
803 804 805 806 807 808 809 810 811 812 813 814 815 816
        406:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/406"
        416:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/416"
        422:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/422"
        429:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/429"
        500:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/500"
        503:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/503"
        504:
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/504"