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

3
info:
4
  version: "1.2.1-impl:etsi.org:ETSI_NFV_OpenAPI:1"
moscatelli's avatar
moscatelli committed
5
  title: SOL002 - VNF Indicator interface
6
  description: >
moscatelli's avatar
moscatelli committed
7
    SOL002 - VNF Indicator interface
8
    IMPORTANT: Please note that this file might be not aligned to the current
moscatelli's avatar
moscatelli committed
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:
moscatelli's avatar
moscatelli committed
14
    name: ETSI Forge copyright notice
15
    url: https://forge.etsi.org/etsi-forge-copyright-notice.txt
moscatelli's avatar
moscatelli committed
16
17
  contact:
    name: NFV-SOL WG
18

19
externalDocs:
20
21
  description: ETSI GS NFV-SOL 002 V2.7.1
  url: https://www.etsi.org/deliver/etsi_gs/NFV-SOL/001_099/002/02.07.01_60/gs_nfv-sol002v020701p.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
  ###############################################################################
  # API Versions                                                                #
  ###############################################################################
39
  '/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:
Giacomo Bernini's avatar
Giacomo Bernini committed
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
168
169
170
        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"
  ###############################################################################
  # VNF indicators related to a VNF instance                                    #
  ###############################################################################
171
  /indicators/{vnfInstanceId}:
172
173
174
    parameters:
      - name: vnfInstanceId
        in: path
175
        description: >
176
          Service Unavailable
177

178
179
180
          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
181
          of that response.
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
        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.
201
      parameters:
202
        - name: filter
203
          description: >
204
            Attribute-based filtering expression according to clause 5.2 of ETSI GS NFV-SOL 013.
205
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
            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
235
          type: string
236
        - name: nextpage_opaque_marker
237
          description: >
238
239
240
            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.
241
242
          in: query
          required: false
243
          type: string
244
245
246
247
248
      responses:
        200:
          description: >
            200 OK

249
250
            Shall be returned when information about zero or more VNF indicators 
            was queried successfully.
251
252
253
254
            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.
255
256
257
258
259
260
261
            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.
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
          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:
Giacomo Bernini's avatar
Giacomo Bernini committed
282
              $ref: '../../definitions/SOL002SOL003VNFIndicator_def.yaml#/definitions/VnfIndicator'
283
284
285
286
287
288
289
290
291
        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:
292
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/405"
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
        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"
  ###############################################################################
  # Individual VNF indicator                                                    #
  ###############################################################################
  /indicators/{vnfInstanceId}/{indicatorId}:
311
    parameters:
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
      - 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
330
331
332
333
      - name: Version
        description: >
          Version of the API requested to use when responding to this request.
        in: header
334
        required: true
335
        type: string
336
337
338
339
340
341
342
      - name: Authorization
        description: >
          The authorization token for the request.
          Reference: IETF RFC 7235
        in: header
        required: false
        type: string
343
    get:
344
345
346
347
348
349
350
351
352
353
354
      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

355
            Shall be returned when the VNF indicator has been read successfully.
356
357
358
359
360
361
362
363
364
365
366
367
368
            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:
Giacomo Bernini's avatar
Giacomo Bernini committed
369
            $ref: '../../definitions/SOL002SOL003VNFIndicator_def.yaml#/definitions/VnfIndicator'
370
371
372
373
374
375
376
377
378
        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:
379
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/405"
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
        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"
  ###############################################################################
  # Subscriptions                                                               #
  ###############################################################################
  /subscriptions:
    post:
      summary: Create a new subscription to VNF indicator change notifications
400
401
402
403
404
      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.
405
406
407
408
409
410
411
412
413
        Creation of two "Individual subscription" resources with the same callbackURI and the same filter can result in
        performance degradation and will provide duplicates of notifications to the VNFM, and might make sense only in very
        rare use cases. Consequently, the API producer may either allow creating a new "Individual subscription" resource if
        another "Individual 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 "Individual subscription" resource (in
        which case it shall return a "303 See Other" response code referencing the existing "Individual subscription" resource
        with the same filter and callbackUri).
        This method shall follow the provisions specified in the tables 8.4.5.3.1-1 and 8.4.5.3.1-2 for URI query parameters,
        request and response data structures, and response codes
414
415
416
417
418
419
      parameters:
        - name: vnfIndicatorSubscriptionRequest
          in: body
          description: Details of the subscription to be created.
          required: true
          schema:
420
            $ref: '../../definitions/SOL002SOL003VNFIndicator_def.yaml#/definitions/VnfIndicatorSubscriptionRequest'
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
        - 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
          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
448
449
450
451
452
      responses:
        201:
          description: >
            201 CREATED

453
454
455
            Shall be returned when the subscription has been created successfully.
            The response body shall contain a representation of the created 
            "Individual subscription" resource.
456
          schema:
457
458
459
            type: array
            items:
              $ref: '../../definitions/SOL002SOL003VNFIndicator_def.yaml#/definitions/VnfIndicatorSubscription'
460
461
462
463
464
465
466
467
468
469
470
          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
471
472
473
474
475
476
477
478
            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
479
480
481
482
483
484
            Version:
              description: The used API version.
              type: string
              maximum: 1
              minimum: 1
        303:
485
486
487
488
489
490
491
492
493
494
          # description: >
          #   303 SEE OTHER

          #   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.
          #   The response body shall be empty.
          # schema:
495
496
497
498
499
500
501
502
503
504
          $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:
505
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/405"
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
        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
524

525
526
527
528
529
        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: >
530
            Attribute-based filtering expression according to clause 5.2 of ETSI GS NFV-SOL 013.
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
            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: >
565
566
567
            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.
568
569
570
571
572
573
574
575
          in: query
          required: false
          type: string
      responses:
        200:
          description: >
            200 OK

576
577
578
579
580
581
582
583
584
585
586
587
            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.
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
          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:
608
              $ref: '../../definitions/SOL002SOL003VNFIndicator_def.yaml#/definitions/VnfIndicatorSubscription'
609
610
611
612
613
614
615
616
617
        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:
618
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/405"
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
        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"
  ###############################################################################
  # Individual Subscription                                                     #
  ###############################################################################
636
637
638
639
640
641
  /subscriptions/{subscriptionId}:
    parameters:
      - name: Version
        description: >
          Version of the API requested to use when responding to this request.
        in: header
642
        required: true
643
        type: string
644
      - name: Authorization
645
        description: >
646
647
648
649
650
651
652
653
654
          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
Gergely Csatari's avatar
Gergely Csatari committed
655

656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
        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

674
675
676
677
            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.
678
679
680
681
682
683
684
685
686
687
688
689
          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:
690
            $ref: '../../definitions/SOL002SOL003VNFIndicator_def.yaml#/definitions/VnfIndicatorSubscription'
691
692
693
694
695
696
697
698
699
        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:
700
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/405"
701
702
703
704
705
706
707
708
709
710
711
712
713
714
        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"
715
    delete:
716
      summary: Delete a subscription
717
718
719
720
721
722
723
724
725
      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.
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
      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

744
            Shall be returned when the subscription has been deleted successfully.
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
            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:
761
          $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/405"
762
763
764
765
766
767
768
769
770
771
772
773
774
775
        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"