1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
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
106
107
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
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
200
201
202
203
204
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
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
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
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
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
|
{
"swagger": "2.0",
"info": {
"version": "v3.2",
"title": "Nokia VNFM API version 3.2 WIP - VNF Lifecycle Change Notification - Subscription interface"
},
"basePath": "/vnfm/lcn/v3",
"schemes": [
"https"
],
"securityDefinitions": {
"OauthPassword": {
"description": "OAuth 2.0 resource owner password credentials grant (https://tools.ietf.org/html/rfc6749#section-4.3) with bearer token type. Note: the given tokenUrl does not inherit from the basePath\n",
"type": "oauth2",
"tokenUrl": "/auth/realms/cbam/protocol/openid-connect/token",
"flow": "password",
"scopes": {
"default": "default scope"
}
},
"OauthClient": {
"description": "OAuth 2.0 client credentials grant (https://tools.ietf.org/html/rfc6749#section-4.4) with bearer token type. Note: the given tokenUrl does not inherit from the basePath\n",
"type": "oauth2",
"tokenUrl": "/auth/realms/cbam/protocol/openid-connect/token",
"flow": "application",
"scopes": {
"default": "default scope"
}
}
},
"security": [
{
"OauthPassword": [
"default"
]
},
{
"OauthClient": [
"default"
]
}
],
"produces": [
"application/json",
"application/problem+json"
],
"consumes": [
"application/json"
],
"paths": {
"/subscriptions": {
"post": {
"description": "Creates subscription to notifications.\n",
"parameters": [
{
"name": "subscriptionRequest",
"description": "Parameters for the subscription to be created",
"in": "body",
"required": true,
"schema": {
"$ref": "#/definitions/CreateSubscriptionRequest"
}
},
{
"enum": [
"3.2"
],
"name": "Nokia-VNFM-API-Version",
"required": true,
"in": "header",
"type": "string",
"description": "The microversion corresponding to the version of the current specification"
}
],
"responses": {
"201": {
"description": "Created subscription",
"headers": {
"Location": {
"description": "The url of the subscription",
"type": "string",
"format": "url"
},
"Nokia-VNFM-API-Version": {
"enum": [
"3.2"
],
"type": "string",
"description": "The microversion corresponding to the version of the current specification"
}
},
"schema": {
"$ref": "#/definitions/Subscription"
}
},
"default": {
"headers": {
"Nokia-VNFM-API-Version": {
"enum": [
"3.2"
],
"type": "string",
"description": "The microversion corresponding to the version of the current specification"
}
},
"description": "Error payload",
"schema": {
"$ref": "#/definitions/ProblemDetails"
}
}
},
"tags": [
"subscriptions"
]
},
"get": {
"description": "Lists subscriptions",
"parameters": [
{
"enum": [
"3.2"
],
"name": "Nokia-VNFM-API-Version",
"required": true,
"in": "header",
"type": "string",
"description": "The microversion corresponding to the version of the current specification"
}
],
"responses": {
"200": {
"description": "Successful response",
"schema": {
"type": "array",
"items": {
"$ref": "#/definitions/Subscription"
}
},
"headers": {
"Nokia-VNFM-API-Version": {
"enum": [
"3.2"
],
"type": "string",
"description": "The microversion corresponding to the version of the current specification"
}
}
},
"default": {
"headers": {
"Nokia-VNFM-API-Version": {
"enum": [
"3.2"
],
"type": "string",
"description": "The microversion corresponding to the version of the current specification"
}
},
"description": "Error payload",
"schema": {
"$ref": "#/definitions/ProblemDetails"
}
}
},
"tags": [
"subscriptions"
]
}
},
"/subscriptions/{subscriptionId}": {
"get": {
"description": "Gets specific subscription data",
"parameters": [
{
"name": "subscriptionId",
"in": "path",
"description": "The identifier of the subscription",
"required": true,
"type": "string"
},
{
"enum": [
"3.2"
],
"name": "Nokia-VNFM-API-Version",
"required": true,
"in": "header",
"type": "string",
"description": "The microversion corresponding to the version of the current specification"
}
],
"responses": {
"200": {
"description": "Successful response",
"schema": {
"$ref": "#/definitions/Subscription"
},
"headers": {
"Nokia-VNFM-API-Version": {
"enum": [
"3.2"
],
"type": "string",
"description": "The microversion corresponding to the version of the current specification"
}
}
},
"default": {
"headers": {
"Nokia-VNFM-API-Version": {
"enum": [
"3.2"
],
"type": "string",
"description": "The microversion corresponding to the version of the current specification"
}
},
"description": "Error payload",
"schema": {
"$ref": "#/definitions/ProblemDetails"
}
}
},
"tags": [
"subscriptions"
]
},
"delete": {
"description": "Delete the subscription\n",
"parameters": [
{
"name": "subscriptionId",
"in": "path",
"description": "The identifier of the subscription",
"required": true,
"type": "string"
},
{
"enum": [
"3.2"
],
"name": "Nokia-VNFM-API-Version",
"required": true,
"in": "header",
"type": "string",
"description": "The microversion corresponding to the version of the current specification"
}
],
"responses": {
"204": {
"description": "Successful response",
"headers": {
"Nokia-VNFM-API-Version": {
"enum": [
"3.2"
],
"type": "string",
"description": "The microversion corresponding to the version of the current specification"
}
}
},
"default": {
"headers": {
"Nokia-VNFM-API-Version": {
"enum": [
"3.2"
],
"type": "string",
"description": "The microversion corresponding to the version of the current specification"
}
},
"description": "Error payload",
"schema": {
"$ref": "#/definitions/ProblemDetails"
}
}
},
"tags": [
"subscriptions"
]
}
}
},
"definitions": {
"CreateSubscriptionRequest": {
"type": "object",
"required": [
"callbackUrl"
],
"properties": {
"filter": {
"description": "Filter settings for this subscription. Omitting this field indicates that all notifications should be sent to the subscriber.\n",
"$ref": "#/definitions/SubscriptionFilter"
},
"callbackUrl": {
"description": "The URL to use as endpoint when sending notifications corresponding to this subscription request. **Nokia extension to ETSI NFV IFA007.**\n",
"type": "string"
},
"authentication": {
"description": "Authentication parameters to use when sending notifications corresponding to this subscription. **Nokia extension to ETSI NFV IFA007.**\n",
"$ref": "#/definitions/SubscriptionAuthentication"
}
}
},
"OperationType": {
"type": "string",
"enum": [
"INSTANTIATE",
"SCALE",
"SCALE_TO_LEVEL",
"MODIFY_INFO",
"CHANGE_FLAVOUR",
"OPERATE",
"HEAL",
"UPGRADE",
"TERMINATE",
"OTHER"
]
},
"SubscriptionFilter": {
"description": "Filter settings for subscriptions. Multiple filter options mean that all should be satisfied (AND relation). **Options may be expanded in later API specification updates.**\n",
"type": "object",
"properties": {
"vnfdId": {
"description": "An identifier with the intention of being globally unique.\n",
"type": "string"
},
"vnfProductName": {
"description": "Subscribe to notifications of VNFs with the given product name\n",
"type": "string"
},
"vnfSoftwareVersion": {
"description": "Subscribe to notifications of VNFs with the given software version (to be used in conjunction with vnfProductName)\n",
"type": "string"
},
"vnfInstanceId": {
"description": "An identifier with the intention of being globally unique.\n",
"type": "string"
},
"notificationTypes": {
"description": "Only send notifications of the included types. If no types are given, all notifications will be sent.\n",
"type": "array",
"items": {
"$ref": "#/definitions/VnfNotificationType"
}
},
"operationTypes": {
"description": "Only send notifications of the included operation types. Only valid for VnfLifecycleChangeNotification notification type.\n",
"type": "array",
"items": {
"$ref": "#/definitions/OperationType"
}
}
}
},
"SubscriptionAuthentication": {
"description": "Authentication parameters to use when sending notifications for subscriptions. **Options may be expanded in later API specification updates.**\n",
"type": "object",
"required": [
"type"
],
"properties": {
"type": {
"description": "type of authentication. OAUTH2_PASSWD means the \"resource owner password credentials grant\" flow. OAUTH2_CLIENT means the \"client credentials grant\" flow.\n",
"type": "string",
"enum": [
"NONE",
"BASIC",
"OAUTH2_PASSWD",
"OAUTH2_CLIENT"
]
},
"userName": {
"description": "The name of the user to authenticate with. Used for basic- and OAUTH2_PASSWD authentication. This corresponds to the \"resource owner\" user in case of Oauth 2.\n",
"type": "string"
},
"password": {
"description": "The password of the user to authenticate with. Used for basic- and OAUTH2_PASSWD authentication.\n",
"type": "string",
"format": "password"
},
"clientName": {
"description": "The client designation to be used for Oauth 2 authentication (both flows)\n",
"type": "string"
},
"clientPassword": {
"description": "The client password to be used for Oauth 2 authentication (both flows)\n",
"type": "string"
},
"tokenUrl": {
"description": "The endpoint where the authentication token can be obtained. Used for Oauth 2 authentication (both flows)\n",
"type": "string"
}
}
},
"Subscription": {
"type": "object",
"required": [
"id",
"callbackUrl"
],
"properties": {
"id": {
"description": "An identifier with the intention of being globally unique.\n",
"type": "string"
},
"lcnApiVersion": {
"description": "Version of the API on which the subscription was created. This may influence the occurrence and contents and of the LCN notifications sent to the subscriber.\n",
"type": "string"
},
"filter": {
"description": "Filter settings for this subscription.\n",
"$ref": "#/definitions/SubscriptionFilter"
},
"callbackUrl": {
"description": "The URL to use as endpoint when sending notifications corresponding to this subscription\n",
"type": "string"
},
"_links": {
"required": [
"self"
],
"type": "object",
"description": "Link relations for this object",
"properties": {
"self": {
"$ref": "#/definitions/Link"
},
"list": {
"$ref": "#/definitions/Link"
},
"create": {
"$ref": "#/definitions/Link"
},
"delete": {
"$ref": "#/definitions/Link"
}
}
}
}
},
"Link": {
"type": "object",
"required": [
"href"
],
"properties": {
"href": {
"description": "The URL that references the target resource.\n",
"type": "string",
"format": "url"
}
}
},
"ProblemDetails": {
"description": "Problem detail object based on RFC7807\n",
"type": "object",
"required": [
"status",
"detail"
],
"properties": {
"type": {
"description": "A URI reference [RFC3986] that identifies the problem type. This specification encourages that, when dereferenced, it provide human-readable documentation for the problem type (e.g., using HTML [W3C.REC-html5-20141028]). When this member is not present, its value is assumed to be \"about:blank\".\n",
"type": "string",
"format": "URI"
},
"title": {
"description": "A short, human-readable summary of the problem type. It SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization (e.g., using proactive content negotiation; see [RFC7231], Section 3.4).\n",
"type": "string"
},
"status": {
"description": "The HTTP status code ([RFC7231], Section 6) generated by the origin server for this occurrence of the problem.\n",
"type": "integer"
},
"detail": {
"description": "A human-readable explanation specific to this occurrence of the problem.\n",
"type": "string"
},
"instance": {
"description": "A URI reference that identifies the specific occurrence of the problem. It may or may not yield further information if dereferenced.\n",
"type": "string",
"format": "URI"
}
}
},
"VnfNotificationType": {
"description": "**OtherNotification** is provided for forward compatibility with subsequent API microversions.\n",
"type": "string",
"enum": [
"VnfIdentifierCreationNotification",
"VnfIdentifierDeletionNotification",
"VnfLifecycleChangeNotification",
"VnfInfoAttributeValueChangeNotification",
"OtherNotification"
]
}
}
}
|
