VNFIndicator.yaml 29.4 KB
Newer Older
1

2
3
4
swagger: "2.0"

info: 
5
  version: "1.2.0"
6
  title: "SOL002 - VNF Indicator interface"
7
  description: >
8
    VNF Indicator interface of ETSI NFV SOL002.
9
10
11
    
    This API allows the EM/VNF to provide information on value changes of VNF related indicators. 
    VNF related indicators are declared in the VNFD.
12
13


14
    IMPORTANT: Please note that this file might be not aligned to the current
15
16
17
    version of the ETSI Group Specification it refers to. In case of
    discrepancies the published ETSI Group Specification takes precedence.

18

19
    Please report bugs to https://forge.etsi.org/bugzilla/buglist.cgi?component=Nfv-Openapis
20
  
21
22
23
  license:
    name: "ETSI Forge copyright notice"
    url: https://forge.etsi.org/etsi-forge-copyright-notice.txt
24

25
externalDocs:
26
27
  description: ETSI GS NFV-SOL 002 V2.5.1
  url:  https://www.etsi.org/deliver/etsi_gs/NFV-SOL/001_099/002/02.05.01_60/gs_nfv-sol002v020501p.pdf
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42

basePath: /vnfind/v1

schemes: 
  - http
  - https

consumes: 
  - application/json

produces: 
  - application/json


paths:
43
44
45
46
47
48
49
50
51
  ###############################################################################
  # API Versions                                                                #
  ###############################################################################
  '/api-versions':
    parameters:
      - name: Version
        description: >
          Version of the API requested to use when responding to this request.
        in: header
52
        required: true
53
54
55
56
57
58
59
60
61
62
63
64
65
66
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
        type: string
    get:
      summary: Retrieve API version information
      description: >
        The GET method reads API version information. This method shall follow the provisions specified in
        table 4.6.3.3.3.2-1 for request and response data structures, and response codes. URI query parameters are not
        supported.
      responses:
        200:
          description: >
            API version information was read successfully.
            The response body shall contain 4.4 API version
            information, as defined in clause 4.4.1.13.
          schema:
            $ref: '../../definitions/SOL002SOL003_def.yaml#/definitions/ApiVersionInformation'
          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
        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: { $ref: '../../responses/SOL002SOL003_resp.yaml#/responses/405' }
        406: { $ref: '../../responses/SOL002SOL003_resp.yaml#/responses/406' }
        413: { $ref: '../../responses/SOL002SOL003_resp.yaml#/responses/413' }
        414: { $ref: '../../responses/SOL002SOL003_resp.yaml#/responses/414' }
        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' }

94
95
96
  ###############################################################################
  # VNF Indicators                                                              #
  ###############################################################################
97
98
99
100
101
102
  /indicators:
    parameters:
      - name: Version
        description: >
          Version of the API requested to use when responding to this request.
        in: header
103
        required: true
104
105
        type: string
    get:
106
107
        summary: Query multiple indicators
        description: Get a list of indicators. Support of attribute based filtering via query parameters.
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
        parameters:
          - 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 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
              if the EM/VNF supports alternative 2 (paging) according to clause 4.7.2.1 for this resource
            in: query
            required: false
            type: string
150
151
152
        responses:
          200:
            description: >
Gergely Csatari's avatar
Gergely Csatari committed
153
154
              OK

155
156
157
158
159
160
              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 EM/VNF 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.
161
162
163
164
165
166
167
168
169
170
171
            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
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
            schema:
              type: array
              items:
                $ref: 'definitions/VnfIndicator_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' }
          404: { $ref: '../../responses/SOL002SOL003_resp.yaml#/responses/404' }
          405: { $ref: '../../responses/SOL002SOL003_resp.yaml#/responses/405' }
          406: { $ref: '../../responses/SOL002SOL003_resp.yaml#/responses/406' }
          409: { $ref: 'responses/VNFIndicator_resp.yaml#/responses/409' }
          416: { $ref: '../../responses/SOL002SOL003_resp.yaml#/responses/416' }
          422: { $ref: '../../responses/SOL002SOL003_resp.yaml#/responses/422' }
          500: { $ref: '../../responses/SOL002SOL003_resp.yaml#/responses/500' }
          503: { $ref: '../../responses/SOL002SOL003_resp.yaml#/responses/503' }

188
  /indicators/{vnfInstanceId}:
189
190
191
192
      parameters:
       - name: vnfInstanceId
         in: path
         description: >
Gergely Csatari's avatar
Gergely Csatari committed
193
194
           Service Unavailable

195
196
197
198
199
200
           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
201
202
203
204
       - name: Version
         description: >
           Version of the API requested to use when responding to this request.
         in: header
205
         required: true
206
         type: string
207
208
209
210
      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.
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
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
        parameters:
          - 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 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
            type: string
          - name: nextpage_opaque_marker
            description: >
              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 4.7.2.1 for this resource.
            in: query
            required: false
            type: string
253
254
255
        responses:
          200:
            description: >
Gergely Csatari's avatar
Gergely Csatari committed
256
257
              OK

258
259
260
261
262
263
264
265
              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 EM/VMF 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.
266
267
268
269
270
271
272
273
274
275
276
            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
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
            schema:
              type: array
              items:
                $ref: 'definitions/VnfIndicator_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' }
          404: { $ref: '../../responses/SOL002SOL003_resp.yaml#/responses/404' }
          405: { $ref: '../../responses/SOL002SOL003_resp.yaml#/responses/405' }
          406: { $ref: '../../responses/SOL002SOL003_resp.yaml#/responses/406' }
          409: { $ref: 'responses/VNFIndicator_resp.yaml#/responses/409' }
          416: { $ref: '../../responses/SOL002SOL003_resp.yaml#/responses/416' }
          422: { $ref: '../../responses/SOL002SOL003_resp.yaml#/responses/422' }
          500: { $ref: '../../responses/SOL002SOL003_resp.yaml#/responses/500' }
          503: { $ref: '../../responses/SOL002SOL003_resp.yaml#/responses/503' }


294
  /indicators/{vnfInstanceId}/{indicatorId}:
295
296
297
298
      parameters:
       - name: vnfInstanceId
         in: path
         description: >
Gergely Csatari's avatar
Gergely Csatari committed
299
300
           Service Unavailable

301
302
303
304
305
306
307
308
309
310
311
312
313
           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
314
315
316
317
       - name: Version
         description: >
           Version of the API requested to use when responding to this request.
         in: header
318
         required: true
319
         type: string
320
      get:
321
        summary: Read an inidividual VNF indicator related to a VNF instance.
322
        description: >
323
          Read an individual VNF indicator related to a specific VNF instance.
324
325
326
327
328
329
          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: >
Gergely Csatari's avatar
Gergely Csatari committed
330
331
              OK

332
333
              The VNF indicator was read successfully.
              The response body shall contain the representation of the VNF indicator.
334
335
336
337
338
339
340
341
342
343
344
            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
345
346
347
348
349
350
351
352
353
354
355
356
357
358
            schema:
              $ref: 'definitions/VnfIndicator_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' }
          404: { $ref: '../../responses/SOL002SOL003_resp.yaml#/responses/404' }
          405: { $ref: '../../responses/SOL002SOL003_resp.yaml#/responses/405' }
          406: { $ref: '../../responses/SOL002SOL003_resp.yaml#/responses/406' }
          409: { $ref: 'responses/VNFIndicator_resp.yaml#/responses/409' }
          416: { $ref: '../../responses/SOL002SOL003_resp.yaml#/responses/416' }
          422: { $ref: '../../responses/SOL002SOL003_resp.yaml#/responses/422' }
          500: { $ref: '../../responses/SOL002SOL003_resp.yaml#/responses/500' }
          503: { $ref: '../../responses/SOL002SOL003_resp.yaml#/responses/503' }

359
  /indicators/{indicatorId}:
360
361
362
363
364
365
366
      parameters:
        - name: indicatorId
          in: path
          description: >
            Identifier of the VNF indicator.
          type: string
          required: true
367
368
369
370
        - name: Version
          description: >
            Version of the API requested to use when responding to this request.
          in: header
371
          required: true
372
          type: string
373
374
375
376
377
378
379
380
381
382
383
      get:
        summary: Read an inidividual VNF indicator related to a VNF instance.
        description: >
          Reads a VNF indicator.
        responses:
          200:
            description: >
              OK

              The VNF indicator was read successfully.
              The response body shall contain the representation of the VNF indicator.
384
385
386
387
388
389
390
391
392
393
394
            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
395
396
397
398
399
400
401
402
403
404
405
406
407
            schema:
              $ref: 'definitions/VnfIndicator_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' }
          404: { $ref: '../../responses/SOL002SOL003_resp.yaml#/responses/404' }
          405: { $ref: '../../responses/SOL002SOL003_resp.yaml#/responses/405' }
          406: { $ref: '../../responses/SOL002SOL003_resp.yaml#/responses/406' }
          409: { $ref: 'responses/VNFIndicator_resp.yaml#/responses/409' }
          416: { $ref: '../../responses/SOL002SOL003_resp.yaml#/responses/416' }
          422: { $ref: '../../responses/SOL002SOL003_resp.yaml#/responses/422' }
          500: { $ref: '../../responses/SOL002SOL003_resp.yaml#/responses/500' }
          503: { $ref: '../../responses/SOL002SOL003_resp.yaml#/responses/503' }
408

409
410
411
412
413
414
  /subscriptions:
    parameters:
      - name: Version
        description: >
          Version of the API requested to use when responding to this request.
        in: header
415
        required: true
416
417
        type: string
    post:
418
        summary: Create a new subscription to VNF indicator change notifications
419
420
421
422
423
424
425
426
427
428
429
        description: Create a new subscription
        parameters:
         - name: subscription
           in: body
           description: Subscription data.
           required: true
           schema: 
             $ref: 'definitions/VnfIndicatorSubscriptionRequest_def.yaml#/definitions/VnfIndicatorSubscriptionRequest'                  
        responses:
          201:
            description: >
Gergely Csatari's avatar
Gergely Csatari committed
430
431
              Created

432
433
434
435
436
437
438
439
440
              The subscription was created successfully.
              The response body shall contain a representation of the created subscription resource.
            schema:
              $ref: 'definitions/VnfIndicatorSubscription_def.yaml#/definitions/VnfIndicatorSubscription' 
            headers:
              Location:
                description: >
                  Pointer to the created subscription resource.
                type: string
441
442
443
444
445
446
447
448
449
450
451
                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
452
453
454
455
456
457
458
459
460
461
462
          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: { $ref: '../../responses/SOL002SOL003_resp.yaml#/responses/405' }
          406: { $ref: '../../responses/SOL002SOL003_resp.yaml#/responses/406' }
          409: { $ref: 'responses/VNFIndicator_resp.yaml#/responses/409' }
          416: { $ref: '../../responses/SOL002SOL003_resp.yaml#/responses/416' }
          422: { $ref: '../../responses/SOL002SOL003_resp.yaml#/responses/422' }
          500: { $ref: '../../responses/SOL002SOL003_resp.yaml#/responses/500' }
          503: { $ref: '../../responses/SOL002SOL003_resp.yaml#/responses/503' }
463
    get:
464
        summary: Query multiple subscriptions.
465
        description: >
Gergely Csatari's avatar
Gergely Csatari committed
466
467
          Service Unavailable

468
469
          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.
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
        parameters:
          - name: filter
            description: >
              Attribute-based filtering expression according to clause 4.3.2.
              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: >
              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 4.7.2.1 for this resource.
            in: query
            required: false
            type: string
513
514
515
        responses:
          200:
            description: >
Gergely Csatari's avatar
Gergely Csatari committed
516
517
              OK

518
519
520
521
522
523
524
              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 EM 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.
525
526
527
528
529
530
531
532
533
534
535
            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
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
            schema:
              type: array
              items:
                $ref: 'definitions/VnfIndicatorSubscription_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' }
          404: { $ref: '../../responses/SOL002SOL003_resp.yaml#/responses/404' }
          405: { $ref: '../../responses/SOL002SOL003_resp.yaml#/responses/405' }
          406: { $ref: '../../responses/SOL002SOL003_resp.yaml#/responses/406' }
          409: { $ref: 'responses/VNFIndicator_resp.yaml#/responses/409' }
          416: { $ref: '../../responses/SOL002SOL003_resp.yaml#/responses/416' }
          422: { $ref: '../../responses/SOL002SOL003_resp.yaml#/responses/422' }
          500: { $ref: '../../responses/SOL002SOL003_resp.yaml#/responses/500' }
          503: { $ref: '../../responses/SOL002SOL003_resp.yaml#/responses/503' }


553
554
555
556
557
558
  /subscriptions/{subscriptionId}:
    parameters:
      - name: Version
        description: >
          Version of the API requested to use when responding to this request.
        in: header
559
        required: true
560
561
        type: string
    get:
562
        summary: Read an individual subscription.
563
        description: >
Gergely Csatari's avatar
Gergely Csatari committed
564
565
          Service Unavailable

566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
          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: >
Gergely Csatari's avatar
Gergely Csatari committed
582
583
              OK

584
585
              The subscriptions was queried successfully. The response body shall contain
              the representation of the requested subscription.
586
587
588
589
590
591
592
593
594
595
596
            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
597
598
599
600
601
602
603
604
605
606
607
608
609
            schema:
              $ref: 'definitions/VnfIndicatorSubscription_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' }
          404: { $ref: '../../responses/SOL002SOL003_resp.yaml#/responses/404' }
          405: { $ref: '../../responses/SOL002SOL003_resp.yaml#/responses/405' }
          406: { $ref: '../../responses/SOL002SOL003_resp.yaml#/responses/406' }
          409: { $ref: 'responses/VNFIndicator_resp.yaml#/responses/409' }
          416: { $ref: '../../responses/SOL002SOL003_resp.yaml#/responses/416' }
          422: { $ref: '../../responses/SOL002SOL003_resp.yaml#/responses/422' }
          500: { $ref: '../../responses/SOL002SOL003_resp.yaml#/responses/500' }
          503: { $ref: '../../responses/SOL002SOL003_resp.yaml#/responses/503' }
610
    delete:
611
612
613
614
615
        summary: Delete a subscription 
        description: Terminate an individual subscription.
        parameters:
         - name: subscriptionId
           description: >
Gergely Csatari's avatar
Gergely Csatari committed
616
617
             Service Unavailable

618
619
620
621
622
623
624
625
626
627
628
             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: >
Gergely Csatari's avatar
Gergely Csatari committed
629
630
              No Content

631
632
              The subscription was deleted successfully.
              The response body shall be empty.
633
634
635
636
637
638
            headers:
              Version:
                description: The used API version.
                type: string
                maximum: 1
                minimum: 1
639
640
641
642
643
644
645
646
647
648
          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: { $ref: '../../responses/SOL002SOL003_resp.yaml#/responses/405' }
          406: { $ref: '../../responses/SOL002SOL003_resp.yaml#/responses/406' }
          409: { $ref: 'responses/VNFIndicator_resp.yaml#/responses/409' }
          416: { $ref: '../../responses/SOL002SOL003_resp.yaml#/responses/416' }
          422: { $ref: '../../responses/SOL002SOL003_resp.yaml#/responses/422' }
          500: { $ref: '../../responses/SOL002SOL003_resp.yaml#/responses/500' }
649
          503: { $ref: '../../responses/SOL002SOL003_resp.yaml#/responses/503' }