VNFIndicator.yaml 21.5 KB
Newer Older
1

2
3
4
swagger: "2.0"

info: 
5
  version: "1.1.1"
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
  description: ETSI GS NFV-SOL 002 V2.4.1
27
  url: http://www.etsi.org/deliver/etsi_gs/NFV-SOL/001_099/002/02.04.01_60/gs_NFV-SOL002v020401p.pdf
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
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
94
95
96
97
98
99
100
101
102
103
104
105

basePath: /vnfind/v1

schemes: 
  - http
  - https

consumes: 
  - application/json

produces: 
  - application/json


paths:

    /indicators:
      get:
        summary: Query multiple indicators
        description: Get a list of indicators. Support of attribute based filtering via query parameters.
#        parameters:
#         - name: id.eq
#           in: query
#           description: Attribute based filtering for indicator identifer as specified in VNFD.
#           type: array
#           items:
#             type: string
#         - name: name.eq
#           in: query
#           description: Attribute based filtering for indicator name as specified in VNFD.
#           type: array
#           items:
#             type: string
#         - name: value.eq
#           in: query
#           description: Attribute based filtering for indicator value equality.
#           type: array
#           items:
#             type: string
#         - name: value.neq
#           in: query
#           description: Attribute based filtering for indicator value unequality.
#           type: array
#           items:
#             type: string
#         - name: value.gt
#           in: query
#           description: Attribute based filtering for indicator value greater than.
#           type: array
#           items:
#             type: string
#         - name: value.gte
#           in: query
#           description: Attribute based filtering for indicator value greater then or equal.
#           type: array
#           items:
#             type: string
#         - name: value.lt
#           in: query
#           description: Attribute based filtering for indicator value less than.
#           type: array
#           items:
#             type: string
#         - name: value.lte
#           in: query
#           description: Attribute based filtering for indicator value less than or equal.
#           type: array
#           items:
#             type: string
#         - name: vnfInstanceId.eq
#           in: query
#           description: Attribute based filtering for indicators belonging to specified VNF instance.
#           type: array
#           items:
#             type: string
        responses:
          200:
            description: >
Gergely Csatari's avatar
Gergely Csatari committed
106
107
              OK

108
109
110
111
112
113
              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.
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
            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' }


    /indicators/{vnfInstanceId}:
      parameters:
       - name: vnfInstanceId
         in: path
         description: >
Gergely Csatari's avatar
Gergely Csatari committed
136
137
           Service Unavailable

138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
           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
      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.
#        parameters:
#         - name: id.eq
#           in: query
#           description: Attribute based filtering for indicator identifer as specified in VNFD.
#           type: array
#           items:
#             type: string
#         - name: name.eq
#           in: query
#           description: Attribute based filtering for indicator name as specified in VNFD.
#           type: array
#           items:
#             type: string
#         - name: value.eq
#           in: query
#           description: Attribute based filtering for indicator value equality.
#           type: array
#           items:
#             type: string
#         - name: value.neq
#           in: query
#           description: Attribute based filtering for indicator value unequality.
#           type: array
#           items:
#             type: string
#         - name: value.gt
#           in: query
#           description: Attribute based filtering for indicator value greater than.
#           type: array
#           items:
#             type: string
#         - name: value.gte
#           in: query
#           description: Attribute based filtering for indicator value greater then or equal.
#           type: array
#           items:
#             type: string
#         - name: value.lt
#           in: query
#           description: Attribute based filtering for indicator value less than.
#           type: array
#           items:
#             type: string
#         - name: value.lte
#           in: query
#           description: Attribute based filtering for indicator value less than or equal.
#           type: array
#           items:
#             type: string
        responses:
          200:
            description: >
Gergely Csatari's avatar
Gergely Csatari committed
200
201
              OK

202
203
204
205
206
207
208
209
              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.
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
            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' }


    /indicators/{vnfInstanceId}/{indicatorId}:
      parameters:
       - name: vnfInstanceId
         in: path
         description: >
Gergely Csatari's avatar
Gergely Csatari committed
232
233
           Service Unavailable

234
235
236
237
238
239
240
241
242
243
244
245
246
247
           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
      get:
248
        summary: Read an inidividual VNF indicator related to a VNF instance.
249
        description: >
250
          Read an individual VNF indicator related to a specific VNF instance.
251
252
253
254
255
256
          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
257
258
              OK

259
260
              The VNF indicator was read successfully.
              The response body shall contain the representation of the VNF indicator.
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
            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' }


    /subscriptions:
      post:
278
        summary: Create a new subscription to VNF indicator change notifications
279
280
281
282
283
284
285
286
287
288
289
        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
290
291
              Created

292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
              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
                format: URI                 
          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' }
      get:
314
        summary: Query multiple subscriptions.
315
        description: >
Gergely Csatari's avatar
Gergely Csatari committed
316
317
          Service Unavailable

318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
          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: id.eq
#           in: query
#           description: >
#             Attribute based filtering for subscription identifiers.
#           type: array
#           items:
#             type: string
#         - name: callbackUri.eq
#           in: query
#           description: >
#             Attribute based filtering for the subscription's call back URIs.
#           type: array
#           items:
#             type: string
#         - name: filter.indicatorIds.cont
#           in: query
#           description: >
#             Attribute based filtering for indicator identifiers.
#           type: array
#           items:
#             type: string
#         - name: filter.vnfInstanceSubscriptionFilter.vnfdIds.cont
#           in: query
#           description: >
#             Attribute based filtering for VNFD identifiers.
#           type: array
#           items:
#             type: string
#         - name: filter.vnfInstanceSubscriptionFilter.vnfProductsFromProviders.vnfProvider.eq
#           in: query
#           description: >
#             Attribute based filtering for VNF providers.
#           type: array
#           items:
#             type: string
#         - name: filter.vnfInstanceSubscriptionFilter.vnfProductsFromProviders.vnfProducts.vnfProductName.eq
#           in: query
#           description: >
#             Attribute based filtering for VNF product name.
#           type: array
#           items:
#             type: string
#         - name: filter.vnfInstanceSubscriptionFilter.vnfProductsFromProviders.vnfProducts.versions.vnfSoftwareVersion.cont
#           in: query
#           description: >
#             Attribute based filtering for VNF software versions.
#           type: array
#           items:
#             type: string
#         - name: filter.vnfInstanceSubscriptionFilter.vnfProductsFromProviders.vnfProducts.versions.vnfdVersion.cont
#           in: query
#           description: >
#             Attribute based filtering for VNFD versions.
#           type: array
#           items:
#             type: string
#         - name: filter.vnfInstanceSubscriptionFilter.vnfInstanceIds.cont
#           in: query
#           description: >
#             Attribute based filtering for VNF instance identifiers.
#           type: array
#           items:
#             type: string
#         - name: filter.vnfInstanceSubscriptionFilter.vnfInstanceNames.cont
#           in: query
#           description: >
#             Attribute based filtering for VNF instance names.
#           type: array
#           items:
#             type: string
        responses:
          200:
            description: >
Gergely Csatari's avatar
Gergely Csatari committed
394
395
              OK

396
397
398
399
400
401
402
              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.
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
            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' }


    /subscriptions/{subscriptionId}:
      get:
422
        summary: Read an individual subscription.
423
        description: >
Gergely Csatari's avatar
Gergely Csatari committed
424
425
          Service Unavailable

426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
          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
442
443
              OK

444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
              The subscriptions was queried successfully. The response body shall contain
              the representation of the requested subscription.
            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' }
      delete:
        summary: Delete a subscription 
        description: Terminate an individual subscription.
        parameters:
         - name: subscriptionId
           description: >
Gergely Csatari's avatar
Gergely Csatari committed
465
466
             Service Unavailable

467
468
469
470
471
472
473
474
475
476
477
             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
478
479
              No Content

480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
              The subscription was deleted successfully.
              The response body shall be empty.
          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' }