@itentialopensource/adapter-onap_blueprint_processor 0.1.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (94) hide show
  1. package/.eslintignore +5 -0
  2. package/.eslintrc.js +18 -0
  3. package/.jshintrc +3 -0
  4. package/AUTH.md +37 -0
  5. package/BROKER.md +211 -0
  6. package/CALLS.md +476 -0
  7. package/CHANGELOG.md +9 -0
  8. package/CODE_OF_CONDUCT.md +43 -0
  9. package/CONTRIBUTING.md +13 -0
  10. package/ENHANCE.md +69 -0
  11. package/LICENSE +201 -0
  12. package/PROPERTIES.md +646 -0
  13. package/README.md +343 -0
  14. package/SUMMARY.md +9 -0
  15. package/SYSTEMINFO.md +19 -0
  16. package/TAB1.md +11 -0
  17. package/TAB2.md +319 -0
  18. package/TROUBLESHOOT.md +47 -0
  19. package/adapter.js +4563 -0
  20. package/adapterBase.js +1452 -0
  21. package/changelogs/CHANGELOG.md +0 -0
  22. package/entities/.generic/action.json +214 -0
  23. package/entities/.generic/schema.json +28 -0
  24. package/entities/.system/action.json +50 -0
  25. package/entities/.system/mockdatafiles/getToken-default.json +3 -0
  26. package/entities/.system/mockdatafiles/healthcheck-default.json +3 -0
  27. package/entities/.system/schema.json +19 -0
  28. package/entities/.system/schemaTokenReq.json +53 -0
  29. package/entities/.system/schemaTokenResp.json +53 -0
  30. package/entities/BlueprintModelCatalog/action.json +374 -0
  31. package/entities/BlueprintModelCatalog/mockdatafiles/getAllBlueprintModels-default.json +41 -0
  32. package/entities/BlueprintModelCatalog/mockdatafiles/getAllBlueprintModelsByKeyword-default.json +28 -0
  33. package/entities/BlueprintModelCatalog/mockdatafiles/searchBlueprintModelsByTags-default.json +28 -0
  34. package/entities/BlueprintModelCatalog/schema.json +36 -0
  35. package/entities/ExecutionServiceCatalog/action.json +24 -0
  36. package/entities/ExecutionServiceCatalog/schema.json +19 -0
  37. package/entities/ModelTypeCatalog/action.json +87 -0
  38. package/entities/ModelTypeCatalog/mockdatafiles/getModelTypeByDefinitionType-default.json +68 -0
  39. package/entities/ModelTypeCatalog/mockdatafiles/searchModelTypesByTags-default.json +68 -0
  40. package/entities/ModelTypeCatalog/schema.json +22 -0
  41. package/entities/ResourceConfiguration/action.json +107 -0
  42. package/entities/ResourceConfiguration/mockdatafiles/getAllConfigSnapshotsByID-default.json +26 -0
  43. package/entities/ResourceConfiguration/mockdatafiles/getAllConfigSnapshotsByType-default.json +18 -0
  44. package/entities/ResourceConfiguration/schema.json +23 -0
  45. package/entities/ResourceDictionary/action.json +209 -0
  46. package/entities/ResourceDictionary/mockdatafiles/getAllResourceDictionaryGroups-default.json +6 -0
  47. package/entities/ResourceDictionary/mockdatafiles/searchResourceDictionaryByNames-default.json +14609 -0
  48. package/entities/ResourceDictionary/mockdatafiles/searchResourceDictionaryByTags-default.json +5329 -0
  49. package/entities/ResourceDictionary/schema.json +28 -0
  50. package/entities/ResourceTemplate/action.json +65 -0
  51. package/entities/ResourceTemplate/mockdatafiles/getTemplatesWithOccurrences-default.json +26 -0
  52. package/entities/ResourceTemplate/schema.json +21 -0
  53. package/entities/Resources/action.json +87 -0
  54. package/entities/Resources/mockdatafiles/getAllResourcesUsingResolutionKey-default.json +70 -0
  55. package/entities/Resources/mockdatafiles/getResourcesWithOccurrences-default.json +70 -0
  56. package/entities/Resources/schema.json +22 -0
  57. package/error.json +190 -0
  58. package/metadata.json +89 -0
  59. package/package.json +80 -0
  60. package/pronghorn.json +22633 -0
  61. package/propertiesDecorators.json +14 -0
  62. package/propertiesSchema.json +1658 -0
  63. package/refs?service=git-upload-pack +0 -0
  64. package/report/adapter-openapi.json +3789 -0
  65. package/report/adapter-openapi.yaml +2624 -0
  66. package/report/adapterInfo.json +10 -0
  67. package/report/cds-bp-processor-api-swagger.json +3203 -0
  68. package/report/creationReport.json +460 -0
  69. package/report/updateReport1727443189469.json +120 -0
  70. package/sampleProperties.json +268 -0
  71. package/test/integration/adapterTestBasicGet.js +83 -0
  72. package/test/integration/adapterTestConnectivity.js +142 -0
  73. package/test/integration/adapterTestIntegration.js +1693 -0
  74. package/test/unit/adapterBaseTestUnit.js +1024 -0
  75. package/test/unit/adapterTestUnit.js +3287 -0
  76. package/utils/adapterInfo.js +206 -0
  77. package/utils/addAuth.js +94 -0
  78. package/utils/artifactize.js +146 -0
  79. package/utils/basicGet.js +50 -0
  80. package/utils/checkMigrate.js +63 -0
  81. package/utils/entitiesToDB.js +179 -0
  82. package/utils/findPath.js +74 -0
  83. package/utils/methodDocumentor.js +273 -0
  84. package/utils/modify.js +152 -0
  85. package/utils/packModificationScript.js +35 -0
  86. package/utils/patches2bundledDeps.js +90 -0
  87. package/utils/pre-commit.sh +32 -0
  88. package/utils/removeHooks.js +20 -0
  89. package/utils/setup.js +33 -0
  90. package/utils/taskMover.js +309 -0
  91. package/utils/tbScript.js +239 -0
  92. package/utils/tbUtils.js +489 -0
  93. package/utils/testRunner.js +298 -0
  94. package/utils/troubleshootingAdapter.js +193 -0
@@ -0,0 +1,3789 @@
1
+ {
2
+ "openapi": "3.0.0",
3
+ "info": {
4
+ "title": "CDS Blueprint Processor API Reference",
5
+ "description": "Shows all resources and endpoints which CDS BP processor currently provides with sample requests/responses, parameter description and other information.",
6
+ "contact": {
7
+ "name": "ONAP Community",
8
+ "url": "https://www.onap.org/",
9
+ "email": "onap-discuss@lists.onap.org"
10
+ },
11
+ "version": "v1"
12
+ },
13
+ "servers": [
14
+ {
15
+ "url": "http://localhost:8080/api/v1",
16
+ "variables": {}
17
+ }
18
+ ],
19
+ "paths": {
20
+ "/blueprint-model": {
21
+ "get": {
22
+ "tags": [
23
+ "Blueprint Model Catalog"
24
+ ],
25
+ "summary": "getAllBlueprintModels",
26
+ "description": "Lists all meta-data of blueprint models which are saved in CDS.",
27
+ "operationId": "getAllBlueprintModels",
28
+ "parameters": [],
29
+ "responses": {
30
+ "200": {
31
+ "description": "OK",
32
+ "headers": {},
33
+ "content": {
34
+ "application/json": {
35
+ "schema": {
36
+ "type": "array",
37
+ "items": {
38
+ "$ref": "#/components/schemas/BlueprintModelSearch"
39
+ },
40
+ "description": ""
41
+ }
42
+ }
43
+ }
44
+ },
45
+ "500": {
46
+ "description": "Internal Server Error",
47
+ "headers": {},
48
+ "content": {}
49
+ }
50
+ },
51
+ "deprecated": false
52
+ },
53
+ "post": {
54
+ "tags": [
55
+ "Blueprint Model Catalog"
56
+ ],
57
+ "summary": "saveBlueprintModel",
58
+ "description": "Saves a blueprint model by the given CBA zip file input. There is no validation of the attached CBA happening when this API is called.",
59
+ "operationId": "saveBlueprintModel",
60
+ "parameters": [],
61
+ "requestBody": {
62
+ "description": "CBA file to be uploaded (example: cba.zip)",
63
+ "content": {
64
+ "text/plain": {
65
+ "schema": {
66
+ "type": "object",
67
+ "description": "CBA file to be uploaded (example: cba.zip)"
68
+ }
69
+ }
70
+ },
71
+ "required": true
72
+ },
73
+ "responses": {
74
+ "200": {
75
+ "description": "OK",
76
+ "headers": {},
77
+ "content": {
78
+ "application/json": {
79
+ "schema": {
80
+ "$ref": "#/components/schemas/BlueprintModelSearch"
81
+ }
82
+ }
83
+ }
84
+ },
85
+ "500": {
86
+ "description": "Internal Server Error",
87
+ "headers": {},
88
+ "content": {}
89
+ }
90
+ },
91
+ "deprecated": false
92
+ }
93
+ },
94
+ "/blueprint-model/bootstrap": {
95
+ "post": {
96
+ "tags": [
97
+ "Blueprint Model Catalog"
98
+ ],
99
+ "summary": "bootstrapCDS",
100
+ "description": "Loads all Model Types, Resource Dictionaries and Blueprint Models which are included in CDS by default. Before starting to work with CDS, bootstrap should be called to load all the basic models that each orginization might support. Parameter values can be set as `false` to skip loading e.g. the Resource Dictionaries but this is not recommended.",
101
+ "operationId": "bootstrapCDS",
102
+ "parameters": [],
103
+ "requestBody": {
104
+ "description": "Specifies which elements to load",
105
+ "content": {
106
+ "application/json": {
107
+ "schema": {
108
+ "allOf": [
109
+ {
110
+ "$ref": "#/components/schemas/BootstrapRequest"
111
+ },
112
+ {
113
+ "description": "Specifies which elements to load"
114
+ }
115
+ ]
116
+ }
117
+ }
118
+ },
119
+ "required": true
120
+ },
121
+ "responses": {
122
+ "200": {
123
+ "description": "OK",
124
+ "headers": {},
125
+ "content": {
126
+ "application/json": {
127
+ "schema": {
128
+ "type": "object"
129
+ }
130
+ }
131
+ }
132
+ },
133
+ "500": {
134
+ "description": "Internal Server Error",
135
+ "headers": {},
136
+ "content": {}
137
+ }
138
+ },
139
+ "deprecated": false
140
+ }
141
+ },
142
+ "/blueprint-model/by-name/{name}/version/{version}": {
143
+ "get": {
144
+ "tags": [
145
+ "Blueprint Model Catalog"
146
+ ],
147
+ "summary": "getBlueprintModelByNameAndVersion",
148
+ "description": "Get Meta-Data of a Blueprint Model by its name and version.",
149
+ "operationId": "getBlueprintModelByNameAndVersion",
150
+ "parameters": [
151
+ {
152
+ "name": "name",
153
+ "in": "path",
154
+ "description": "Name of the blueprint model",
155
+ "required": true,
156
+ "style": "simple",
157
+ "schema": {
158
+ "type": "string",
159
+ "example": "pnf_netconf"
160
+ }
161
+ },
162
+ {
163
+ "name": "version",
164
+ "in": "path",
165
+ "description": "Version of the blueprint model",
166
+ "required": true,
167
+ "style": "simple",
168
+ "schema": {
169
+ "type": "string",
170
+ "example": "1.0.0"
171
+ }
172
+ }
173
+ ],
174
+ "responses": {
175
+ "200": {
176
+ "description": "OK",
177
+ "headers": {},
178
+ "content": {
179
+ "application/json": {
180
+ "schema": {
181
+ "$ref": "#/components/schemas/BlueprintModelSearch"
182
+ }
183
+ }
184
+ }
185
+ },
186
+ "404": {
187
+ "description": "Not Found",
188
+ "headers": {},
189
+ "content": {}
190
+ }
191
+ },
192
+ "deprecated": false
193
+ }
194
+ },
195
+ "/blueprint-model/download/by-name/{name}/version/{version}": {
196
+ "get": {
197
+ "tags": [
198
+ "Blueprint Model Catalog"
199
+ ],
200
+ "summary": "downloadBlueprintModelByNameAndVersion",
201
+ "description": "Gets the CBA of a blueprint model by its name and version. Response can be saved to a file to download the CBA.",
202
+ "operationId": "downloadBlueprintModelByNameAndVersion",
203
+ "parameters": [
204
+ {
205
+ "name": "name",
206
+ "in": "path",
207
+ "description": "Name of the blueprint model",
208
+ "required": true,
209
+ "style": "simple",
210
+ "schema": {
211
+ "type": "string",
212
+ "example": "pnf_netconf"
213
+ }
214
+ },
215
+ {
216
+ "name": "version",
217
+ "in": "path",
218
+ "description": "Version of the blueprint model",
219
+ "required": true,
220
+ "style": "simple",
221
+ "schema": {
222
+ "type": "string",
223
+ "example": "1.0.0"
224
+ }
225
+ }
226
+ ],
227
+ "responses": {
228
+ "200": {
229
+ "description": "OK",
230
+ "headers": {},
231
+ "content": {
232
+ "application/json": {
233
+ "schema": {
234
+ "type": "object"
235
+ }
236
+ }
237
+ }
238
+ },
239
+ "404": {
240
+ "description": "Not Found",
241
+ "headers": {},
242
+ "content": {}
243
+ }
244
+ },
245
+ "deprecated": false
246
+ }
247
+ },
248
+ "/blueprint-model/download/{id}": {
249
+ "get": {
250
+ "tags": [
251
+ "Blueprint Model Catalog"
252
+ ],
253
+ "summary": "downloadBlueprintModelByID",
254
+ "description": "Gets the CBA of a blueprint model by its ID. Response can be saved to a file to download the CBA.",
255
+ "operationId": "downloadBlueprintModelByID",
256
+ "parameters": [
257
+ {
258
+ "name": "id",
259
+ "in": "path",
260
+ "description": "ID of the blueprint model to download",
261
+ "required": true,
262
+ "style": "simple",
263
+ "schema": {
264
+ "type": "string",
265
+ "example": "67ec1f96-ab55-4b81-aff9-23ee0ed1d7a4"
266
+ }
267
+ }
268
+ ],
269
+ "responses": {
270
+ "200": {
271
+ "description": "OK",
272
+ "headers": {},
273
+ "content": {
274
+ "application/json": {
275
+ "schema": {
276
+ "type": "object"
277
+ }
278
+ }
279
+ }
280
+ },
281
+ "404": {
282
+ "description": "Not Found",
283
+ "headers": {},
284
+ "content": {}
285
+ }
286
+ },
287
+ "deprecated": false
288
+ }
289
+ },
290
+ "/blueprint-model/enrich": {
291
+ "post": {
292
+ "tags": [
293
+ "Blueprint Model Catalog"
294
+ ],
295
+ "summary": "enrichBlueprintModel",
296
+ "description": "Enriches the attached CBA and returns the enriched CBA zip file in the response. The enrichment process will complete the package by providing all the definition of types used.",
297
+ "operationId": "enrichBlueprintModel",
298
+ "parameters": [],
299
+ "requestBody": {
300
+ "description": "CBA zip file to be uploaded (example: cba_unenriched.zip)",
301
+ "content": {
302
+ "text/plain": {
303
+ "schema": {
304
+ "type": "object",
305
+ "description": "CBA zip file to be uploaded (example: cba_unenriched.zip)"
306
+ }
307
+ }
308
+ },
309
+ "required": true
310
+ },
311
+ "responses": {
312
+ "200": {
313
+ "description": "successful operation",
314
+ "headers": {},
315
+ "content": {
316
+ "application/json": {
317
+ "schema": {
318
+ "type": "object"
319
+ }
320
+ }
321
+ }
322
+ }
323
+ },
324
+ "deprecated": false
325
+ }
326
+ },
327
+ "/blueprint-model/enrichandpublish": {
328
+ "post": {
329
+ "tags": [
330
+ "Blueprint Model Catalog"
331
+ ],
332
+ "summary": "enrichAndPublishBlueprintModel",
333
+ "description": "Enriches the attached CBA, validates it and saves it in CDS if validation was successful.",
334
+ "operationId": "enrichAndPublishBlueprintModel",
335
+ "parameters": [],
336
+ "requestBody": {
337
+ "description": "Unenriched CBA zip file to be uploaded (example: cba_unenriched.zip)",
338
+ "content": {
339
+ "text/plain": {
340
+ "schema": {
341
+ "type": "object",
342
+ "description": "Unenriched CBA zip file to be uploaded (example: cba_unenriched.zip)"
343
+ }
344
+ }
345
+ },
346
+ "required": true
347
+ },
348
+ "responses": {
349
+ "200": {
350
+ "description": "OK",
351
+ "headers": {},
352
+ "content": {
353
+ "application/json": {
354
+ "schema": {
355
+ "$ref": "#/components/schemas/BlueprintModelSearch"
356
+ }
357
+ }
358
+ }
359
+ },
360
+ "503": {
361
+ "description": "Service Unavailable",
362
+ "headers": {},
363
+ "content": {}
364
+ }
365
+ },
366
+ "deprecated": false
367
+ }
368
+ },
369
+ "/blueprint-model/meta-data/{keyword}": {
370
+ "get": {
371
+ "tags": [
372
+ "Blueprint Model Catalog"
373
+ ],
374
+ "summary": "getAllBlueprintModelsByKeyword",
375
+ "description": "Lists all blueprint models by a matching keyword in any of the meta-data of the blueprint models. Blueprint models are just returned if a whole keyword is matching, not just parts of it. Not case-sensitive. Used by CDS UI.",
376
+ "operationId": "getAllBlueprintModelsByKeyword",
377
+ "parameters": [
378
+ {
379
+ "name": "keyword",
380
+ "in": "path",
381
+ "description": "Keyword to search for in blueprint model meta-data",
382
+ "required": true,
383
+ "style": "simple",
384
+ "schema": {
385
+ "type": "string",
386
+ "example": "pnf_netconf"
387
+ }
388
+ }
389
+ ],
390
+ "responses": {
391
+ "200": {
392
+ "description": "successful operation",
393
+ "headers": {},
394
+ "content": {
395
+ "application/json": {
396
+ "schema": {
397
+ "type": "array",
398
+ "items": {
399
+ "$ref": "#/components/schemas/BlueprintModelSearch"
400
+ },
401
+ "description": ""
402
+ }
403
+ }
404
+ }
405
+ }
406
+ },
407
+ "deprecated": false
408
+ }
409
+ },
410
+ "/blueprint-model/name/{name}/version/{version}": {
411
+ "delete": {
412
+ "tags": [
413
+ "Blueprint Model Catalog"
414
+ ],
415
+ "summary": "deleteBlueprintModelByNameAndVersion",
416
+ "description": "Deletes a blueprint model identified by its name and version from CDS.",
417
+ "operationId": "deleteBlueprintModelByNameAndVersion",
418
+ "parameters": [
419
+ {
420
+ "name": "name",
421
+ "in": "path",
422
+ "description": "Name of the blueprint model",
423
+ "required": true,
424
+ "style": "simple",
425
+ "schema": {
426
+ "type": "string",
427
+ "example": "pnf_netconf"
428
+ }
429
+ },
430
+ {
431
+ "name": "version",
432
+ "in": "path",
433
+ "description": "Version of the blueprint model",
434
+ "required": true,
435
+ "style": "simple",
436
+ "schema": {
437
+ "type": "string",
438
+ "example": "1.0.0"
439
+ }
440
+ }
441
+ ],
442
+ "responses": {
443
+ "200": {
444
+ "description": "successful operation",
445
+ "headers": {},
446
+ "content": {
447
+ "application/json": {
448
+ "schema": {
449
+ "type": "object"
450
+ }
451
+ }
452
+ }
453
+ }
454
+ },
455
+ "deprecated": false
456
+ }
457
+ },
458
+ "/blueprint-model/paged": {
459
+ "get": {
460
+ "tags": [
461
+ "Blueprint Model Catalog"
462
+ ],
463
+ "summary": "getAllBlueprintModelPaged",
464
+ "description": "Lists all blueprint models which are saved in CDS in an ordered mode.",
465
+ "operationId": "getAllBlueprintModelPaged",
466
+ "parameters": [
467
+ {
468
+ "name": "limit",
469
+ "in": "query",
470
+ "description": "Maximum number of returned blueprint models",
471
+ "style": "form",
472
+ "explode": true,
473
+ "schema": {
474
+ "type": "integer",
475
+ "format": "int32",
476
+ "default": 20
477
+ }
478
+ },
479
+ {
480
+ "name": "offset",
481
+ "in": "query",
482
+ "description": "Offset",
483
+ "style": "form",
484
+ "explode": true,
485
+ "schema": {
486
+ "type": "integer",
487
+ "format": "int32",
488
+ "default": 0
489
+ }
490
+ },
491
+ {
492
+ "name": "sort",
493
+ "in": "query",
494
+ "description": "Order of returned blueprint models",
495
+ "style": "form",
496
+ "explode": true,
497
+ "schema": {
498
+ "allOf": [
499
+ {
500
+ "$ref": "#/components/schemas/sort1"
501
+ },
502
+ {
503
+ "description": "Order of returned blueprint models"
504
+ }
505
+ ]
506
+ }
507
+ },
508
+ {
509
+ "name": "sortType",
510
+ "in": "query",
511
+ "description": "Ascend or descend ordering",
512
+ "style": "form",
513
+ "explode": true,
514
+ "schema": {
515
+ "type": "string",
516
+ "default": "ASC"
517
+ }
518
+ }
519
+ ],
520
+ "responses": {
521
+ "200": {
522
+ "description": "successful operation",
523
+ "headers": {},
524
+ "content": {
525
+ "application/json": {
526
+ "schema": {
527
+ "$ref": "#/components/schemas/PageBlueprintModelSearch"
528
+ }
529
+ }
530
+ }
531
+ }
532
+ },
533
+ "deprecated": false
534
+ }
535
+ },
536
+ "/blueprint-model/paged/meta-data/{keyword}": {
537
+ "get": {
538
+ "tags": [
539
+ "Blueprint Model Catalog"
540
+ ],
541
+ "summary": "getAllBlueprintModelsPagedByKeyword",
542
+ "description": "Lists all blueprint models by a matching keyword in any of the meta-data of the blueprint models in an ordered mode. Blueprint models are just returned if a whole keyword is matching, not just parts of it. Not case-sensitive. Used by CDS UI.",
543
+ "operationId": "getAllBlueprintModelsPagedByKeyword",
544
+ "parameters": [
545
+ {
546
+ "name": "keyword",
547
+ "in": "path",
548
+ "description": "Keyword to search for in blueprint model meta-data",
549
+ "required": true,
550
+ "style": "simple",
551
+ "schema": {
552
+ "type": "string",
553
+ "example": "pnf_netconf"
554
+ }
555
+ },
556
+ {
557
+ "name": "limit",
558
+ "in": "query",
559
+ "description": "Maximum number of returned blueprint models",
560
+ "style": "form",
561
+ "explode": true,
562
+ "schema": {
563
+ "type": "integer",
564
+ "format": "int32",
565
+ "default": 20
566
+ }
567
+ },
568
+ {
569
+ "name": "offset",
570
+ "in": "query",
571
+ "description": "Offset",
572
+ "style": "form",
573
+ "explode": true,
574
+ "schema": {
575
+ "type": "integer",
576
+ "format": "int32",
577
+ "default": 0
578
+ }
579
+ },
580
+ {
581
+ "name": "sort",
582
+ "in": "query",
583
+ "description": "Order of returned blueprint models",
584
+ "style": "form",
585
+ "explode": true,
586
+ "schema": {
587
+ "allOf": [
588
+ {
589
+ "$ref": "#/components/schemas/sort1"
590
+ },
591
+ {
592
+ "description": "Order of returned blueprint models"
593
+ }
594
+ ]
595
+ }
596
+ },
597
+ {
598
+ "name": "sortType",
599
+ "in": "query",
600
+ "description": "Ascend or descend ordering",
601
+ "style": "form",
602
+ "explode": true,
603
+ "schema": {
604
+ "type": "string",
605
+ "default": "ASC"
606
+ }
607
+ }
608
+ ],
609
+ "responses": {
610
+ "200": {
611
+ "description": "successful operation",
612
+ "headers": {},
613
+ "content": {
614
+ "application/json": {
615
+ "schema": {
616
+ "$ref": "#/components/schemas/PageBlueprintModelSearch"
617
+ }
618
+ }
619
+ }
620
+ }
621
+ },
622
+ "deprecated": false
623
+ }
624
+ },
625
+ "/blueprint-model/publish": {
626
+ "post": {
627
+ "tags": [
628
+ "Blueprint Model Catalog"
629
+ ],
630
+ "summary": "publishBlueprintModel",
631
+ "description": "Validates the attached CBA file and saves it in CDS if validation was successful. CBA needs to be already enriched.",
632
+ "operationId": "publishBlueprintModel",
633
+ "parameters": [],
634
+ "requestBody": {
635
+ "description": "Enriched CBA zip file to be uploaded (example: cba_enriched.zip)",
636
+ "content": {
637
+ "text/plain": {
638
+ "schema": {
639
+ "type": "object",
640
+ "description": "Enriched CBA zip file to be uploaded (example: cba_enriched.zip)"
641
+ }
642
+ }
643
+ },
644
+ "required": true
645
+ },
646
+ "responses": {
647
+ "200": {
648
+ "description": "successful operation",
649
+ "headers": {},
650
+ "content": {
651
+ "application/json": {
652
+ "schema": {
653
+ "$ref": "#/components/schemas/BlueprintModelSearch"
654
+ }
655
+ }
656
+ }
657
+ }
658
+ },
659
+ "deprecated": false
660
+ }
661
+ },
662
+ "/blueprint-model/search/{tags}": {
663
+ "get": {
664
+ "tags": [
665
+ "Blueprint Model Catalog"
666
+ ],
667
+ "summary": "searchBlueprintModelsByTags",
668
+ "description": "Searches for all blueprint models which contain the specified input parameter in their tags. Blueprint models which contain just parts of the searched word in their tags are also returned.",
669
+ "operationId": "searchBlueprintModelsByTags",
670
+ "parameters": [
671
+ {
672
+ "name": "tags",
673
+ "in": "path",
674
+ "description": "Tag to search for",
675
+ "required": true,
676
+ "style": "simple",
677
+ "schema": {
678
+ "type": "string",
679
+ "example": "test"
680
+ }
681
+ }
682
+ ],
683
+ "responses": {
684
+ "200": {
685
+ "description": "successful operation",
686
+ "headers": {},
687
+ "content": {
688
+ "application/json": {
689
+ "schema": {
690
+ "type": "array",
691
+ "items": {
692
+ "$ref": "#/components/schemas/BlueprintModelSearch"
693
+ },
694
+ "description": ""
695
+ }
696
+ }
697
+ }
698
+ }
699
+ },
700
+ "deprecated": false
701
+ }
702
+ },
703
+ "/blueprint-model/workflow-spec": {
704
+ "post": {
705
+ "tags": [
706
+ "Blueprint Model Catalog"
707
+ ],
708
+ "summary": "getWorkflowSpecification",
709
+ "description": "Get the workflow of a blueprint identified by Blueprint and workflow name. Inputs, outputs and data types of workflow is returned.",
710
+ "operationId": "getWorkflowSpecification",
711
+ "parameters": [],
712
+ "requestBody": {
713
+ "description": "Blueprint and workflow identification",
714
+ "content": {
715
+ "application/json": {
716
+ "schema": {
717
+ "allOf": [
718
+ {
719
+ "$ref": "#/components/schemas/WorkFlowSpecRequest"
720
+ },
721
+ {
722
+ "description": "Blueprint and workflow identification"
723
+ }
724
+ ]
725
+ }
726
+ }
727
+ },
728
+ "required": true
729
+ },
730
+ "responses": {
731
+ "200": {
732
+ "description": "successful operation",
733
+ "headers": {},
734
+ "content": {
735
+ "application/json": {
736
+ "schema": {
737
+ "type": "object"
738
+ }
739
+ }
740
+ }
741
+ }
742
+ },
743
+ "deprecated": false
744
+ }
745
+ },
746
+ "/blueprint-model/workflows/blueprint-name/{name}/version/{version}": {
747
+ "get": {
748
+ "tags": [
749
+ "Blueprint Model Catalog"
750
+ ],
751
+ "summary": "getBlueprintWorkflowsByNameAndVersion",
752
+ "description": "Get all available workflows of a Blueprint identified by its name and version.",
753
+ "operationId": "getBlueprintWorkflowsByNameAndVersion",
754
+ "parameters": [
755
+ {
756
+ "name": "name",
757
+ "in": "path",
758
+ "description": "Name of the blueprint model",
759
+ "required": true,
760
+ "style": "simple",
761
+ "schema": {
762
+ "type": "string",
763
+ "example": "pnf_netconf"
764
+ }
765
+ },
766
+ {
767
+ "name": "version",
768
+ "in": "path",
769
+ "description": "Version of the blueprint model",
770
+ "required": true,
771
+ "style": "simple",
772
+ "schema": {
773
+ "type": "string",
774
+ "example": "1.0.0"
775
+ }
776
+ }
777
+ ],
778
+ "responses": {
779
+ "200": {
780
+ "description": "successful operation",
781
+ "headers": {},
782
+ "content": {
783
+ "application/json": {
784
+ "schema": {
785
+ "type": "object"
786
+ }
787
+ }
788
+ }
789
+ }
790
+ },
791
+ "deprecated": false
792
+ }
793
+ },
794
+ "/blueprint-model/{id}": {
795
+ "get": {
796
+ "tags": [
797
+ "Blueprint Model Catalog"
798
+ ],
799
+ "summary": "getBlueprintModelByID",
800
+ "description": "Get meta-data of a blueprint model by its internally created ID.",
801
+ "operationId": "getBlueprintModelByID",
802
+ "parameters": [
803
+ {
804
+ "name": "id",
805
+ "in": "path",
806
+ "description": "ID of the blueprint model to search for",
807
+ "required": true,
808
+ "style": "simple",
809
+ "schema": {
810
+ "type": "string",
811
+ "example": "67ec1f96-ab55-4b81-aff9-23ee0ed1d7a4"
812
+ }
813
+ }
814
+ ],
815
+ "responses": {
816
+ "200": {
817
+ "description": "OK",
818
+ "headers": {},
819
+ "content": {
820
+ "application/json": {
821
+ "schema": {
822
+ "$ref": "#/components/schemas/BlueprintModelSearch"
823
+ }
824
+ }
825
+ }
826
+ },
827
+ "404": {
828
+ "description": "Not Found",
829
+ "headers": {},
830
+ "content": {}
831
+ }
832
+ },
833
+ "deprecated": false
834
+ },
835
+ "delete": {
836
+ "tags": [
837
+ "Blueprint Model Catalog"
838
+ ],
839
+ "summary": "deleteBlueprintModelByID",
840
+ "description": "Delete a blueprint model by its ID. ID is the internally created ID of blueprint, not the name of blueprint.",
841
+ "operationId": "deleteBlueprintModelByID",
842
+ "parameters": [
843
+ {
844
+ "name": "id",
845
+ "in": "path",
846
+ "description": "ID of the blueprint model to delete",
847
+ "required": true,
848
+ "style": "simple",
849
+ "schema": {
850
+ "type": "string",
851
+ "example": "67ec1f96-ab55-4b81-aff9-23ee0ed1d7a4"
852
+ }
853
+ }
854
+ ],
855
+ "responses": {
856
+ "200": {
857
+ "description": "OK",
858
+ "headers": {},
859
+ "content": {
860
+ "application/json": {
861
+ "schema": {
862
+ "type": "object"
863
+ }
864
+ }
865
+ }
866
+ },
867
+ "404": {
868
+ "description": "RESOURCE_NOT_FOUND",
869
+ "headers": {},
870
+ "content": {}
871
+ }
872
+ },
873
+ "deprecated": false
874
+ }
875
+ },
876
+ "/execution-service/process": {
877
+ "post": {
878
+ "tags": [
879
+ "Execution Service Catalog"
880
+ ],
881
+ "summary": "executeCBAWorkflowAction",
882
+ "description": "Execute the appropriate CBA's action based on the ExecutionServiceInput object passed as input.",
883
+ "operationId": "executeCBAWorkflowAction",
884
+ "parameters": [],
885
+ "requestBody": {
886
+ "description": "ExecutionServiceInput payload.",
887
+ "content": {
888
+ "application/json": {
889
+ "schema": {
890
+ "allOf": [
891
+ {
892
+ "$ref": "#/components/schemas/ExecutionServiceInput"
893
+ },
894
+ {
895
+ "description": "ExecutionServiceInput payload."
896
+ }
897
+ ]
898
+ }
899
+ }
900
+ },
901
+ "required": true
902
+ },
903
+ "responses": {
904
+ "200": {
905
+ "description": "successful operation",
906
+ "headers": {},
907
+ "content": {
908
+ "application/json": {
909
+ "schema": {
910
+ "$ref": "#/components/schemas/ExecutionServiceOutput"
911
+ }
912
+ }
913
+ }
914
+ }
915
+ },
916
+ "deprecated": false
917
+ }
918
+ },
919
+ "/model-type/by-definition/{definitionType}": {
920
+ "get": {
921
+ "tags": [
922
+ "Model Type Catalog"
923
+ ],
924
+ "summary": "getModelTypeByDefinitionType",
925
+ "description": "Retrieve a list of model types by definition type provided.",
926
+ "operationId": "getModelTypeByDefinitionType",
927
+ "parameters": [
928
+ {
929
+ "name": "definitionType",
930
+ "in": "path",
931
+ "description": "",
932
+ "required": true,
933
+ "style": "simple",
934
+ "schema": {
935
+ "type": "string"
936
+ }
937
+ }
938
+ ],
939
+ "responses": {
940
+ "200": {
941
+ "description": "successful operation",
942
+ "headers": {},
943
+ "content": {
944
+ "application/json": {
945
+ "schema": {
946
+ "type": "array",
947
+ "items": {
948
+ "$ref": "#/components/schemas/ModelType"
949
+ },
950
+ "description": ""
951
+ }
952
+ }
953
+ }
954
+ }
955
+ },
956
+ "deprecated": false
957
+ }
958
+ },
959
+ "/model-type/search/{tags}": {
960
+ "get": {
961
+ "tags": [
962
+ "Model Type Catalog"
963
+ ],
964
+ "summary": "searchModelTypesByTags",
965
+ "description": "Retrieve a list of model types by tags provided.",
966
+ "operationId": "searchModelTypesByTags",
967
+ "parameters": [
968
+ {
969
+ "name": "tags",
970
+ "in": "path",
971
+ "description": "",
972
+ "required": true,
973
+ "style": "simple",
974
+ "schema": {
975
+ "type": "string"
976
+ }
977
+ }
978
+ ],
979
+ "responses": {
980
+ "200": {
981
+ "description": "successful operation",
982
+ "headers": {},
983
+ "content": {
984
+ "application/json": {
985
+ "schema": {
986
+ "type": "array",
987
+ "items": {
988
+ "$ref": "#/components/schemas/ModelType"
989
+ },
990
+ "description": ""
991
+ }
992
+ }
993
+ }
994
+ }
995
+ },
996
+ "deprecated": false
997
+ }
998
+ },
999
+ "/model-type/{name}": {
1000
+ "get": {
1001
+ "tags": [
1002
+ "Model Type Catalog"
1003
+ ],
1004
+ "summary": "getModelTypeByName",
1005
+ "description": "Retrieve a model type by name provided.",
1006
+ "operationId": "getModelTypeByName",
1007
+ "parameters": [
1008
+ {
1009
+ "name": "name",
1010
+ "in": "path",
1011
+ "description": "",
1012
+ "required": true,
1013
+ "style": "simple",
1014
+ "schema": {
1015
+ "type": "string"
1016
+ }
1017
+ }
1018
+ ],
1019
+ "responses": {
1020
+ "200": {
1021
+ "description": "successful operation",
1022
+ "headers": {},
1023
+ "content": {
1024
+ "application/json": {
1025
+ "schema": {
1026
+ "$ref": "#/components/schemas/ModelType"
1027
+ }
1028
+ }
1029
+ }
1030
+ }
1031
+ },
1032
+ "deprecated": false
1033
+ },
1034
+ "delete": {
1035
+ "tags": [
1036
+ "Model Type Catalog"
1037
+ ],
1038
+ "summary": "deleteModelTypeByName",
1039
+ "description": "Remove a model type by name provided.",
1040
+ "operationId": "deleteModelTypeByName",
1041
+ "parameters": [
1042
+ {
1043
+ "name": "name",
1044
+ "in": "path",
1045
+ "description": "",
1046
+ "required": true,
1047
+ "style": "simple",
1048
+ "schema": {
1049
+ "type": "string"
1050
+ }
1051
+ }
1052
+ ],
1053
+ "responses": {
1054
+ "200": {
1055
+ "description": "successful operation",
1056
+ "headers": {},
1057
+ "content": {
1058
+ "application/json": {
1059
+ "schema": {
1060
+ "$ref": "#/components/schemas/ModelType"
1061
+ }
1062
+ }
1063
+ }
1064
+ }
1065
+ },
1066
+ "deprecated": false
1067
+ }
1068
+ },
1069
+ "/configs": {
1070
+ "get": {
1071
+ "tags": [
1072
+ "Resource configuration"
1073
+ ],
1074
+ "summary": "getResourceConfigSnapshot",
1075
+ "description": "Retrieve a config snapshot, identified by its Resource Id and Type. An extra 'format' parameter can be passed to tell what content-type is expected.",
1076
+ "operationId": "getResourceConfigSnapshot",
1077
+ "parameters": [
1078
+ {
1079
+ "name": "resourceType",
1080
+ "in": "query",
1081
+ "description": "Resource Type associated of the resource configuration snapshot",
1082
+ "required": true,
1083
+ "style": "form",
1084
+ "explode": true,
1085
+ "schema": {
1086
+ "type": "string",
1087
+ "example": "\"PNF\""
1088
+ }
1089
+ },
1090
+ {
1091
+ "name": "resourceId",
1092
+ "in": "query",
1093
+ "description": "Resource Id associated of the resource configuration snapshot",
1094
+ "required": true,
1095
+ "style": "form",
1096
+ "explode": true,
1097
+ "schema": {
1098
+ "type": "string",
1099
+ "example": "\"1\""
1100
+ }
1101
+ },
1102
+ {
1103
+ "name": "status",
1104
+ "in": "query",
1105
+ "description": "Status of the snapshot being retrieved",
1106
+ "style": "form",
1107
+ "explode": true,
1108
+ "schema": {
1109
+ "type": "string",
1110
+ "default": "RUNNING"
1111
+ }
1112
+ },
1113
+ {
1114
+ "name": "format",
1115
+ "in": "query",
1116
+ "description": "Expected format of the snapshot being retrieved",
1117
+ "style": "form",
1118
+ "explode": true,
1119
+ "schema": {
1120
+ "type": "string",
1121
+ "default": "text/plain"
1122
+ }
1123
+ }
1124
+ ],
1125
+ "responses": {
1126
+ "200": {
1127
+ "description": "successful operation",
1128
+ "headers": {},
1129
+ "content": {
1130
+ "text/plain": {
1131
+ "schema": {
1132
+ "type": "string"
1133
+ }
1134
+ },
1135
+ "application/json": {
1136
+ "schema": {
1137
+ "type": "string"
1138
+ }
1139
+ },
1140
+ "application/xml": {
1141
+ "schema": {
1142
+ "type": "string",
1143
+ "xml": {
1144
+ "name": "response",
1145
+ "attribute": false,
1146
+ "wrapped": false
1147
+ }
1148
+ }
1149
+ }
1150
+ }
1151
+ }
1152
+ },
1153
+ "deprecated": false
1154
+ }
1155
+ },
1156
+ "/configs/allByID": {
1157
+ "get": {
1158
+ "tags": [
1159
+ "Resource configuration"
1160
+ ],
1161
+ "summary": "getAllConfigSnapshotsByID",
1162
+ "description": "Retrieve all config snapshots, identified by its Resource Id, ordered by most recently created/modified date. ",
1163
+ "operationId": "getAllConfigSnapshotsByID",
1164
+ "parameters": [
1165
+ {
1166
+ "name": "resourceId",
1167
+ "in": "query",
1168
+ "description": "Resource Id associated of the resource configuration snapshots",
1169
+ "required": true,
1170
+ "style": "form",
1171
+ "explode": true,
1172
+ "schema": {
1173
+ "type": "string",
1174
+ "example": "\"1\""
1175
+ }
1176
+ },
1177
+ {
1178
+ "name": "status",
1179
+ "in": "query",
1180
+ "description": "Status of the snapshot being retrieved",
1181
+ "style": "form",
1182
+ "explode": true,
1183
+ "schema": {
1184
+ "type": "string",
1185
+ "default": "ANY"
1186
+ }
1187
+ }
1188
+ ],
1189
+ "responses": {
1190
+ "200": {
1191
+ "description": "successful operation",
1192
+ "headers": {},
1193
+ "content": {
1194
+ "application/json": {
1195
+ "schema": {
1196
+ "type": "array",
1197
+ "items": {
1198
+ "$ref": "#/components/schemas/ResourceConfigSnapshot"
1199
+ },
1200
+ "description": ""
1201
+ }
1202
+ }
1203
+ }
1204
+ }
1205
+ },
1206
+ "deprecated": false
1207
+ }
1208
+ },
1209
+ "/configs/allByType": {
1210
+ "get": {
1211
+ "tags": [
1212
+ "Resource configuration"
1213
+ ],
1214
+ "summary": "getAllConfigSnapshotsByType",
1215
+ "description": "Retrieve all config snapshots matching a specified Resource Type, ordered by most recently created/modified date. ",
1216
+ "operationId": "getAllConfigSnapshotsByType",
1217
+ "parameters": [
1218
+ {
1219
+ "name": "resourceType",
1220
+ "in": "query",
1221
+ "description": "Resource Type associated of the resource configuration snapshot",
1222
+ "required": true,
1223
+ "style": "form",
1224
+ "explode": true,
1225
+ "schema": {
1226
+ "type": "string",
1227
+ "example": "\"PNF\""
1228
+ }
1229
+ },
1230
+ {
1231
+ "name": "status",
1232
+ "in": "query",
1233
+ "description": "Status of the snapshot being retrieved",
1234
+ "style": "form",
1235
+ "explode": true,
1236
+ "schema": {
1237
+ "type": "string",
1238
+ "default": "ANY"
1239
+ }
1240
+ }
1241
+ ],
1242
+ "responses": {
1243
+ "200": {
1244
+ "description": "successful operation",
1245
+ "headers": {},
1246
+ "content": {
1247
+ "application/json": {
1248
+ "schema": {
1249
+ "type": "array",
1250
+ "items": {
1251
+ "$ref": "#/components/schemas/ResourceConfigSnapshot"
1252
+ },
1253
+ "description": ""
1254
+ }
1255
+ }
1256
+ }
1257
+ }
1258
+ },
1259
+ "deprecated": false
1260
+ }
1261
+ },
1262
+ "/configs/{resourceType}/{resourceId}/{status}": {
1263
+ "post": {
1264
+ "tags": [
1265
+ "Resource configuration"
1266
+ ],
1267
+ "summary": "storeConfigSnapshotByResourceIdAndResourceType",
1268
+ "description": "Store a resource configuration snapshot, identified by its resourceId and resourceType, and optionally its status, either RUNNING or CANDIDATE.",
1269
+ "operationId": "storeConfigSnapshotByResourceIdAndResourceType",
1270
+ "parameters": [
1271
+ {
1272
+ "name": "resourceType",
1273
+ "in": "path",
1274
+ "description": "Resource Type associated with the resolution",
1275
+ "required": true,
1276
+ "style": "simple",
1277
+ "schema": {
1278
+ "type": "string",
1279
+ "example": "\"PNF\""
1280
+ }
1281
+ },
1282
+ {
1283
+ "name": "resourceId",
1284
+ "in": "path",
1285
+ "description": "Resource Id associated with the resolution",
1286
+ "required": true,
1287
+ "style": "simple",
1288
+ "schema": {
1289
+ "type": "string",
1290
+ "example": "\"1\""
1291
+ }
1292
+ },
1293
+ {
1294
+ "name": "status",
1295
+ "in": "path",
1296
+ "description": "Status of the snapshot being retrieved",
1297
+ "required": true,
1298
+ "style": "simple",
1299
+ "schema": {
1300
+ "type": "string"
1301
+ }
1302
+ }
1303
+ ],
1304
+ "requestBody": {
1305
+ "description": "Config snapshot to store",
1306
+ "content": {
1307
+ "text/plain": {
1308
+ "schema": {
1309
+ "type": "string",
1310
+ "description": "Config snapshot to store"
1311
+ }
1312
+ }
1313
+ },
1314
+ "required": true
1315
+ },
1316
+ "responses": {
1317
+ "200": {
1318
+ "description": "successful operation",
1319
+ "headers": {},
1320
+ "content": {
1321
+ "application/json": {
1322
+ "schema": {
1323
+ "$ref": "#/components/schemas/ResourceConfigSnapshot"
1324
+ }
1325
+ }
1326
+ }
1327
+ }
1328
+ },
1329
+ "deprecated": false
1330
+ },
1331
+ "delete": {
1332
+ "tags": [
1333
+ "Resource configuration"
1334
+ ],
1335
+ "summary": "deleteConfigSnapshotByResourceIdAndResourceType",
1336
+ "description": "Delete a resource configuration snapshot, identified by its resourceId and resourceType, and optionally its status, either RUNNING or CANDIDATE.",
1337
+ "operationId": "deleteConfigSnapshotByResourceIdAndResourceType",
1338
+ "parameters": [
1339
+ {
1340
+ "name": "resourceType",
1341
+ "in": "path",
1342
+ "description": "Resource Type associated with the resolution.",
1343
+ "required": true,
1344
+ "style": "simple",
1345
+ "schema": {
1346
+ "type": "string"
1347
+ }
1348
+ },
1349
+ {
1350
+ "name": "resourceId",
1351
+ "in": "path",
1352
+ "description": "Resource Id associated with the resolution.",
1353
+ "required": true,
1354
+ "style": "simple",
1355
+ "schema": {
1356
+ "type": "string"
1357
+ }
1358
+ },
1359
+ {
1360
+ "name": "status",
1361
+ "in": "path",
1362
+ "description": "Status of the snapshot being deleted.",
1363
+ "required": true,
1364
+ "style": "simple",
1365
+ "schema": {
1366
+ "type": "string"
1367
+ }
1368
+ }
1369
+ ],
1370
+ "responses": {
1371
+ "200": {
1372
+ "description": "successful operation",
1373
+ "headers": {},
1374
+ "content": {
1375
+ "application/json": {
1376
+ "schema": {
1377
+ "type": "object"
1378
+ }
1379
+ }
1380
+ }
1381
+ }
1382
+ },
1383
+ "deprecated": false
1384
+ }
1385
+ },
1386
+ "/dictionary": {
1387
+ "post": {
1388
+ "tags": [
1389
+ "Resource Dictionary"
1390
+ ],
1391
+ "summary": "saveResourceDictionary",
1392
+ "description": "Save a resource dictionary by dictionary provided.",
1393
+ "operationId": "saveResourceDictionary",
1394
+ "parameters": [],
1395
+ "requestBody": {
1396
+ "description": "Resource dictionary to store",
1397
+ "content": {
1398
+ "application/json": {
1399
+ "schema": {
1400
+ "allOf": [
1401
+ {
1402
+ "$ref": "#/components/schemas/ResourceDictionary"
1403
+ },
1404
+ {
1405
+ "description": "Resource dictionary to store"
1406
+ }
1407
+ ]
1408
+ }
1409
+ }
1410
+ },
1411
+ "required": true
1412
+ },
1413
+ "responses": {
1414
+ "200": {
1415
+ "description": "successful operation",
1416
+ "headers": {},
1417
+ "content": {
1418
+ "application/json": {
1419
+ "schema": {
1420
+ "$ref": "#/components/schemas/ResourceDictionary"
1421
+ }
1422
+ }
1423
+ }
1424
+ }
1425
+ },
1426
+ "deprecated": false
1427
+ }
1428
+ },
1429
+ "/dictionary/by-names": {
1430
+ "post": {
1431
+ "tags": [
1432
+ "Resource Dictionary"
1433
+ ],
1434
+ "summary": "searchResourceDictionaryByNames",
1435
+ "description": "Search for a resource dictionary by names provided.",
1436
+ "operationId": "searchResourceDictionaryByNames",
1437
+ "parameters": [],
1438
+ "requestBody": {
1439
+ "description": "List of names",
1440
+ "content": {
1441
+ "application/json": {
1442
+ "schema": {
1443
+ "type": "array",
1444
+ "items": {
1445
+ "type": "string"
1446
+ },
1447
+ "description": "List of names"
1448
+ }
1449
+ }
1450
+ },
1451
+ "required": true
1452
+ },
1453
+ "responses": {
1454
+ "200": {
1455
+ "description": "successful operation",
1456
+ "headers": {},
1457
+ "content": {
1458
+ "application/json": {
1459
+ "schema": {
1460
+ "type": "array",
1461
+ "items": {
1462
+ "$ref": "#/components/schemas/ResourceDictionary"
1463
+ },
1464
+ "description": ""
1465
+ }
1466
+ }
1467
+ }
1468
+ }
1469
+ },
1470
+ "deprecated": false
1471
+ }
1472
+ },
1473
+ "/dictionary/definition": {
1474
+ "post": {
1475
+ "tags": [
1476
+ "Resource Dictionary"
1477
+ ],
1478
+ "summary": "saveResourceDictionaryByDefinition",
1479
+ "description": "Save a resource dictionary by provided resource definition json.",
1480
+ "operationId": "saveResourceDictionaryByDefinition",
1481
+ "parameters": [],
1482
+ "requestBody": {
1483
+ "description": "Resource definition to generate Resource Dictionary",
1484
+ "content": {
1485
+ "application/json": {
1486
+ "schema": {
1487
+ "allOf": [
1488
+ {
1489
+ "$ref": "#/components/schemas/ResourceDefinition"
1490
+ },
1491
+ {
1492
+ "description": "Resource definition to generate Resource Dictionary"
1493
+ }
1494
+ ]
1495
+ }
1496
+ }
1497
+ },
1498
+ "required": true
1499
+ },
1500
+ "responses": {
1501
+ "200": {
1502
+ "description": "successful operation",
1503
+ "headers": {},
1504
+ "content": {
1505
+ "application/json": {
1506
+ "schema": {
1507
+ "$ref": "#/components/schemas/ResourceDictionary"
1508
+ }
1509
+ }
1510
+ }
1511
+ }
1512
+ },
1513
+ "deprecated": false
1514
+ }
1515
+ },
1516
+ "/dictionary/definition-bulk": {
1517
+ "post": {
1518
+ "tags": [
1519
+ "Resource Dictionary"
1520
+ ],
1521
+ "summary": "saveMultipleDictionariesByDefinition",
1522
+ "description": "Save multiple resource dictionaries by provided resource definition json array.",
1523
+ "operationId": "saveMultipleDictionariesByDefinition",
1524
+ "parameters": [],
1525
+ "requestBody": {
1526
+ "description": "Resource definition json array to generate Resource Dictionaries",
1527
+ "content": {
1528
+ "application/json": {
1529
+ "schema": {
1530
+ "type": "array",
1531
+ "items": {
1532
+ "$ref": "#/components/schemas/ResourceDefinition"
1533
+ },
1534
+ "description": "Resource definition json array to generate Resource Dictionaries"
1535
+ }
1536
+ }
1537
+ },
1538
+ "required": true
1539
+ },
1540
+ "responses": {
1541
+ "200": {
1542
+ "description": "successful operation",
1543
+ "headers": {},
1544
+ "content": {
1545
+ "application/json": {
1546
+ "schema": {
1547
+ "$ref": "#/components/schemas/ResourceDictionary"
1548
+ }
1549
+ }
1550
+ }
1551
+ }
1552
+ },
1553
+ "deprecated": false
1554
+ }
1555
+ },
1556
+ "/dictionary/paged": {
1557
+ "get": {
1558
+ "tags": [
1559
+ "Resource Dictionary"
1560
+ ],
1561
+ "summary": "getAllBlueprintDictionaryPaged",
1562
+ "description": "Lists all blueprint Dictionary which are saved in CDS in an ordered mode.",
1563
+ "operationId": "getAllBlueprintDictionaryPaged",
1564
+ "parameters": [
1565
+ {
1566
+ "name": "limit",
1567
+ "in": "query",
1568
+ "description": "Maximum number of returned blueprint dictionary",
1569
+ "style": "form",
1570
+ "explode": true,
1571
+ "schema": {
1572
+ "type": "integer",
1573
+ "format": "int32",
1574
+ "default": 20
1575
+ }
1576
+ },
1577
+ {
1578
+ "name": "offset",
1579
+ "in": "query",
1580
+ "description": "Offset",
1581
+ "style": "form",
1582
+ "explode": true,
1583
+ "schema": {
1584
+ "type": "integer",
1585
+ "format": "int32",
1586
+ "default": 0
1587
+ }
1588
+ },
1589
+ {
1590
+ "name": "sort",
1591
+ "in": "query",
1592
+ "description": "Order of returned blueprint dictionary",
1593
+ "style": "form",
1594
+ "explode": true,
1595
+ "schema": {
1596
+ "allOf": [
1597
+ {
1598
+ "$ref": "#/components/schemas/sort3"
1599
+ },
1600
+ {
1601
+ "description": "Order of returned blueprint dictionary"
1602
+ }
1603
+ ]
1604
+ }
1605
+ },
1606
+ {
1607
+ "name": "sortType",
1608
+ "in": "query",
1609
+ "description": "Ascend or descend ordering",
1610
+ "style": "form",
1611
+ "explode": true,
1612
+ "schema": {
1613
+ "type": "string",
1614
+ "default": "ASC"
1615
+ }
1616
+ }
1617
+ ],
1618
+ "responses": {
1619
+ "200": {
1620
+ "description": "successful operation",
1621
+ "headers": {},
1622
+ "content": {
1623
+ "application/json": {
1624
+ "schema": {
1625
+ "type": "object"
1626
+ }
1627
+ }
1628
+ }
1629
+ }
1630
+ },
1631
+ "deprecated": false
1632
+ }
1633
+ },
1634
+ "/dictionary/resource_dictionary_group": {
1635
+ "get": {
1636
+ "tags": [
1637
+ "Resource Dictionary"
1638
+ ],
1639
+ "summary": "getAllResourceDictionaryGroups",
1640
+ "description": "Retrieve all resource dictionary groups.",
1641
+ "operationId": "getAllResourceDictionaryGroups",
1642
+ "parameters": [],
1643
+ "responses": {
1644
+ "200": {
1645
+ "description": "successful operation",
1646
+ "headers": {},
1647
+ "content": {
1648
+ "application/json": {
1649
+ "schema": {
1650
+ "type": "array",
1651
+ "items": {
1652
+ "type": "string"
1653
+ },
1654
+ "description": ""
1655
+ }
1656
+ }
1657
+ }
1658
+ }
1659
+ },
1660
+ "deprecated": false
1661
+ }
1662
+ },
1663
+ "/dictionary/search/{tags}": {
1664
+ "get": {
1665
+ "tags": [
1666
+ "Resource Dictionary"
1667
+ ],
1668
+ "summary": "searchResourceDictionaryByTags",
1669
+ "description": "Search for a resource dictionary by tags provided.",
1670
+ "operationId": "searchResourceDictionaryByTags",
1671
+ "parameters": [
1672
+ {
1673
+ "name": "tags",
1674
+ "in": "path",
1675
+ "description": "Tags list",
1676
+ "required": true,
1677
+ "style": "simple",
1678
+ "schema": {
1679
+ "type": "string",
1680
+ "example": "\"status\""
1681
+ }
1682
+ }
1683
+ ],
1684
+ "responses": {
1685
+ "200": {
1686
+ "description": "successful operation",
1687
+ "headers": {},
1688
+ "content": {
1689
+ "application/json": {
1690
+ "schema": {
1691
+ "type": "array",
1692
+ "items": {
1693
+ "$ref": "#/components/schemas/ResourceDictionary"
1694
+ },
1695
+ "description": ""
1696
+ }
1697
+ }
1698
+ }
1699
+ }
1700
+ },
1701
+ "deprecated": false
1702
+ }
1703
+ },
1704
+ "/dictionary/source-mapping": {
1705
+ "get": {
1706
+ "tags": [
1707
+ "Resource Dictionary"
1708
+ ],
1709
+ "summary": "getSourceMapping",
1710
+ "description": "Search for a source mapping.",
1711
+ "operationId": "getSourceMapping",
1712
+ "parameters": [],
1713
+ "responses": {
1714
+ "200": {
1715
+ "description": "successful operation",
1716
+ "headers": {},
1717
+ "content": {
1718
+ "application/json": {
1719
+ "schema": {
1720
+ "$ref": "#/components/schemas/ResourceSourceMapping"
1721
+ }
1722
+ }
1723
+ }
1724
+ }
1725
+ },
1726
+ "deprecated": false
1727
+ }
1728
+ },
1729
+ "/dictionary/{name}": {
1730
+ "get": {
1731
+ "tags": [
1732
+ "Resource Dictionary"
1733
+ ],
1734
+ "summary": "getResourceDictionaryByName",
1735
+ "description": "Retrieve a resource dictionary by name provided.",
1736
+ "operationId": "getResourceDictionaryByName",
1737
+ "parameters": [
1738
+ {
1739
+ "name": "name",
1740
+ "in": "path",
1741
+ "description": "Name of the resource",
1742
+ "required": true,
1743
+ "style": "simple",
1744
+ "schema": {
1745
+ "type": "string",
1746
+ "example": "\"hostname\""
1747
+ }
1748
+ }
1749
+ ],
1750
+ "responses": {
1751
+ "200": {
1752
+ "description": "successful operation",
1753
+ "headers": {},
1754
+ "content": {
1755
+ "application/json": {
1756
+ "schema": {
1757
+ "$ref": "#/components/schemas/ResourceDictionary"
1758
+ }
1759
+ }
1760
+ }
1761
+ }
1762
+ },
1763
+ "deprecated": false
1764
+ },
1765
+ "delete": {
1766
+ "tags": [
1767
+ "Resource Dictionary"
1768
+ ],
1769
+ "summary": "deleteResourceDictionaryByName",
1770
+ "description": "Remove a resource dictionary by name provided.",
1771
+ "operationId": "deleteResourceDictionaryByName",
1772
+ "parameters": [
1773
+ {
1774
+ "name": "name",
1775
+ "in": "path",
1776
+ "description": "Name of the resource",
1777
+ "required": true,
1778
+ "style": "simple",
1779
+ "schema": {
1780
+ "type": "string"
1781
+ }
1782
+ }
1783
+ ],
1784
+ "responses": {
1785
+ "200": {
1786
+ "description": "successful operation",
1787
+ "headers": {},
1788
+ "content": {
1789
+ "application/json": {
1790
+ "schema": {
1791
+ "type": "object"
1792
+ }
1793
+ }
1794
+ }
1795
+ }
1796
+ },
1797
+ "deprecated": false
1798
+ }
1799
+ },
1800
+ "/template/occurrences": {
1801
+ "get": {
1802
+ "tags": [
1803
+ "Resource Template"
1804
+ ],
1805
+ "summary": "getTemplatesWithOccurrences",
1806
+ "description": "With optional 'occurrence' options, subset of stored resolved templates can be retrieved using the blueprint name, blueprint version, artifact name and the resolution-key.",
1807
+ "operationId": "getTemplatesWithOccurrences",
1808
+ "parameters": [
1809
+ {
1810
+ "name": "bpName",
1811
+ "in": "query",
1812
+ "description": "Name of the CBA.",
1813
+ "required": true,
1814
+ "style": "form",
1815
+ "explode": true,
1816
+ "schema": {
1817
+ "type": "string"
1818
+ }
1819
+ },
1820
+ {
1821
+ "name": "bpVersion",
1822
+ "in": "query",
1823
+ "description": "Version of the CBA.",
1824
+ "required": true,
1825
+ "style": "form",
1826
+ "explode": true,
1827
+ "schema": {
1828
+ "type": "string"
1829
+ }
1830
+ },
1831
+ {
1832
+ "name": "artifactName",
1833
+ "in": "query",
1834
+ "description": "Artifact name for which to retrieve a resolved resource.",
1835
+ "required": true,
1836
+ "style": "form",
1837
+ "explode": true,
1838
+ "schema": {
1839
+ "type": "string"
1840
+ }
1841
+ },
1842
+ {
1843
+ "name": "resolutionKey",
1844
+ "in": "query",
1845
+ "description": "Resolution Key associated with the resolution.",
1846
+ "required": true,
1847
+ "style": "form",
1848
+ "explode": true,
1849
+ "schema": {
1850
+ "type": "string"
1851
+ }
1852
+ },
1853
+ {
1854
+ "name": "firstN",
1855
+ "in": "query",
1856
+ "description": "Number of earlier N occurrences of the templates.",
1857
+ "style": "form",
1858
+ "explode": true,
1859
+ "schema": {
1860
+ "type": "integer",
1861
+ "format": "int32"
1862
+ }
1863
+ },
1864
+ {
1865
+ "name": "lastN",
1866
+ "in": "query",
1867
+ "description": "Number of latest N occurrences of the templates.",
1868
+ "style": "form",
1869
+ "explode": true,
1870
+ "schema": {
1871
+ "type": "integer",
1872
+ "format": "int32"
1873
+ }
1874
+ },
1875
+ {
1876
+ "name": "begin",
1877
+ "in": "query",
1878
+ "description": "For Range option - 'begin' is the start occurrence of range of the templates.",
1879
+ "style": "form",
1880
+ "explode": true,
1881
+ "schema": {
1882
+ "type": "integer",
1883
+ "format": "int32"
1884
+ }
1885
+ },
1886
+ {
1887
+ "name": "end",
1888
+ "in": "query",
1889
+ "description": "For Range option - 'end' is the end occurrence of the range of the templates.",
1890
+ "style": "form",
1891
+ "explode": true,
1892
+ "schema": {
1893
+ "type": "integer",
1894
+ "format": "int32"
1895
+ }
1896
+ }
1897
+ ],
1898
+ "responses": {
1899
+ "200": {
1900
+ "description": "successful operation",
1901
+ "headers": {},
1902
+ "content": {
1903
+ "application/json": {
1904
+ "schema": {
1905
+ "type": "array",
1906
+ "items": {
1907
+ "$ref": "#/components/schemas/TemplateResolution"
1908
+ },
1909
+ "description": ""
1910
+ }
1911
+ }
1912
+ }
1913
+ }
1914
+ },
1915
+ "deprecated": false
1916
+ }
1917
+ },
1918
+ "/template/{bpName}/{bpVersion}/{artifactName}/{resolutionKey}": {
1919
+ "post": {
1920
+ "tags": [
1921
+ "Resource Template"
1922
+ ],
1923
+ "summary": "storeTemplateWithResolutionKey",
1924
+ "description": "Store a template for a given CBA's action, identified by its blueprint name, blueprint version, artifact name and resolution key.",
1925
+ "operationId": "storeTemplateWithResolutionKey",
1926
+ "parameters": [
1927
+ {
1928
+ "name": "bpName",
1929
+ "in": "path",
1930
+ "description": "Name of the CBA",
1931
+ "required": true,
1932
+ "style": "simple",
1933
+ "schema": {
1934
+ "type": "string"
1935
+ }
1936
+ },
1937
+ {
1938
+ "name": "bpVersion",
1939
+ "in": "path",
1940
+ "description": "Version of the CBA",
1941
+ "required": true,
1942
+ "style": "simple",
1943
+ "schema": {
1944
+ "type": "string"
1945
+ }
1946
+ },
1947
+ {
1948
+ "name": "artifactName",
1949
+ "in": "path",
1950
+ "description": "Artifact name for which to retrieve a resolved resource",
1951
+ "required": true,
1952
+ "style": "simple",
1953
+ "schema": {
1954
+ "type": "string"
1955
+ }
1956
+ },
1957
+ {
1958
+ "name": "resolutionKey",
1959
+ "in": "path",
1960
+ "description": "Resolution Key associated with the resolution",
1961
+ "required": true,
1962
+ "style": "simple",
1963
+ "schema": {
1964
+ "type": "string"
1965
+ }
1966
+ }
1967
+ ],
1968
+ "requestBody": {
1969
+ "description": "Template to store",
1970
+ "content": {
1971
+ "text/plain": {
1972
+ "schema": {
1973
+ "type": "string",
1974
+ "description": "Template to store"
1975
+ }
1976
+ }
1977
+ },
1978
+ "required": true
1979
+ },
1980
+ "responses": {
1981
+ "200": {
1982
+ "description": "successful operation",
1983
+ "headers": {},
1984
+ "content": {
1985
+ "application/json": {
1986
+ "schema": {
1987
+ "$ref": "#/components/schemas/TemplateResolution"
1988
+ }
1989
+ }
1990
+ }
1991
+ }
1992
+ },
1993
+ "deprecated": false
1994
+ }
1995
+ },
1996
+ "/template/{bpName}/{bpVersion}/{artifactName}/{resourceType}/{resourceId}": {
1997
+ "post": {
1998
+ "tags": [
1999
+ "Resource Template"
2000
+ ],
2001
+ "summary": "storeTemplateWithResourceIdAndResourceType",
2002
+ "description": "Store a template for a given CBA's action, identified by its blueprint name, blueprint version, artifact name, resourceId and resourceType.",
2003
+ "operationId": "storeTemplateWithResourceIdAndResourceType",
2004
+ "parameters": [
2005
+ {
2006
+ "name": "bpName",
2007
+ "in": "path",
2008
+ "description": "Name of the CBA",
2009
+ "required": true,
2010
+ "style": "simple",
2011
+ "schema": {
2012
+ "type": "string"
2013
+ }
2014
+ },
2015
+ {
2016
+ "name": "bpVersion",
2017
+ "in": "path",
2018
+ "description": "Version of the CBA",
2019
+ "required": true,
2020
+ "style": "simple",
2021
+ "schema": {
2022
+ "type": "string"
2023
+ }
2024
+ },
2025
+ {
2026
+ "name": "artifactName",
2027
+ "in": "path",
2028
+ "description": "Artifact name for which to retrieve a resolved resource",
2029
+ "required": true,
2030
+ "style": "simple",
2031
+ "schema": {
2032
+ "type": "string"
2033
+ }
2034
+ },
2035
+ {
2036
+ "name": "resourceType",
2037
+ "in": "path",
2038
+ "description": "Resource Type associated with the resolution",
2039
+ "required": true,
2040
+ "style": "simple",
2041
+ "schema": {
2042
+ "type": "string"
2043
+ }
2044
+ },
2045
+ {
2046
+ "name": "resourceId",
2047
+ "in": "path",
2048
+ "description": "Resource Id associated with the resolution",
2049
+ "required": true,
2050
+ "style": "simple",
2051
+ "schema": {
2052
+ "type": "string"
2053
+ }
2054
+ }
2055
+ ],
2056
+ "requestBody": {
2057
+ "description": "Template to store",
2058
+ "content": {
2059
+ "text/plain": {
2060
+ "schema": {
2061
+ "type": "string",
2062
+ "description": "Template to store"
2063
+ }
2064
+ }
2065
+ },
2066
+ "required": true
2067
+ },
2068
+ "responses": {
2069
+ "200": {
2070
+ "description": "successful operation",
2071
+ "headers": {},
2072
+ "content": {
2073
+ "application/json": {
2074
+ "schema": {
2075
+ "$ref": "#/components/schemas/TemplateResolution"
2076
+ }
2077
+ }
2078
+ }
2079
+ }
2080
+ },
2081
+ "deprecated": false
2082
+ }
2083
+ },
2084
+ "/resources": {
2085
+ "get": {
2086
+ "tags": [
2087
+ "Resources"
2088
+ ],
2089
+ "summary": "getAllResourcesUsingResolutionKey",
2090
+ "description": "Retrieve all stored resolved resources using the blueprint name, blueprint version, artifact name and the resolution-key.",
2091
+ "operationId": "getAllResourcesUsingResolutionKey",
2092
+ "parameters": [
2093
+ {
2094
+ "name": "bpName",
2095
+ "in": "query",
2096
+ "description": "Name of the CBA",
2097
+ "required": true,
2098
+ "style": "form",
2099
+ "explode": true,
2100
+ "schema": {
2101
+ "type": "string"
2102
+ }
2103
+ },
2104
+ {
2105
+ "name": "bpVersion",
2106
+ "in": "query",
2107
+ "description": "Version of the CBA",
2108
+ "required": true,
2109
+ "style": "form",
2110
+ "explode": true,
2111
+ "schema": {
2112
+ "type": "string"
2113
+ }
2114
+ },
2115
+ {
2116
+ "name": "artifactName",
2117
+ "in": "query",
2118
+ "description": "Artifact name for which to retrieve a resolved resource",
2119
+ "required": true,
2120
+ "style": "form",
2121
+ "explode": true,
2122
+ "schema": {
2123
+ "type": "string"
2124
+ }
2125
+ },
2126
+ {
2127
+ "name": "resolutionKey",
2128
+ "in": "query",
2129
+ "description": "Resolution Key associated with the resolution",
2130
+ "style": "form",
2131
+ "explode": true,
2132
+ "schema": {
2133
+ "type": "string"
2134
+ }
2135
+ },
2136
+ {
2137
+ "name": "resourceType",
2138
+ "in": "query",
2139
+ "description": "Resource Type associated with the resolution",
2140
+ "style": "form",
2141
+ "explode": true,
2142
+ "schema": {
2143
+ "type": "string"
2144
+ }
2145
+ },
2146
+ {
2147
+ "name": "resourceId",
2148
+ "in": "query",
2149
+ "description": "Resource Id associated with the resolution",
2150
+ "style": "form",
2151
+ "explode": true,
2152
+ "schema": {
2153
+ "type": "string"
2154
+ }
2155
+ }
2156
+ ],
2157
+ "responses": {
2158
+ "200": {
2159
+ "description": "successful operation",
2160
+ "headers": {},
2161
+ "content": {
2162
+ "application/json": {
2163
+ "schema": {
2164
+ "type": "array",
2165
+ "items": {
2166
+ "$ref": "#/components/schemas/ResourceResolution"
2167
+ },
2168
+ "description": ""
2169
+ }
2170
+ }
2171
+ }
2172
+ }
2173
+ },
2174
+ "deprecated": false
2175
+ },
2176
+ "delete": {
2177
+ "tags": [
2178
+ "Resources"
2179
+ ],
2180
+ "summary": "deleteAllResourcesUsingResolutionKey",
2181
+ "description": "Delete all the resources associated to a resolution-key using blueprint metadata, artifact name and the resolution-key.",
2182
+ "operationId": "deleteAllResourcesUsingResolutionKey",
2183
+ "parameters": [
2184
+ {
2185
+ "name": "bpName",
2186
+ "in": "query",
2187
+ "description": "Name of the CBA",
2188
+ "required": true,
2189
+ "style": "form",
2190
+ "explode": true,
2191
+ "schema": {
2192
+ "type": "string"
2193
+ }
2194
+ },
2195
+ {
2196
+ "name": "bpVersion",
2197
+ "in": "query",
2198
+ "description": "Version of the CBA",
2199
+ "required": true,
2200
+ "style": "form",
2201
+ "explode": true,
2202
+ "schema": {
2203
+ "type": "string"
2204
+ }
2205
+ },
2206
+ {
2207
+ "name": "artifactName",
2208
+ "in": "query",
2209
+ "description": "Artifact name for which to retrieve a resolved resource",
2210
+ "required": true,
2211
+ "style": "form",
2212
+ "explode": true,
2213
+ "schema": {
2214
+ "type": "string"
2215
+ }
2216
+ },
2217
+ {
2218
+ "name": "resolutionKey",
2219
+ "in": "query",
2220
+ "description": "Resolution Key associated with the resolution",
2221
+ "style": "form",
2222
+ "explode": true,
2223
+ "schema": {
2224
+ "type": "string"
2225
+ }
2226
+ },
2227
+ {
2228
+ "name": "resourceType",
2229
+ "in": "query",
2230
+ "description": "resourceType associated with the resolution, must be used with resourceId",
2231
+ "style": "form",
2232
+ "explode": true,
2233
+ "schema": {
2234
+ "type": "string"
2235
+ }
2236
+ },
2237
+ {
2238
+ "name": "resourceId",
2239
+ "in": "query",
2240
+ "description": "Resolution Key associated with the resolution, must be used with resourceType",
2241
+ "style": "form",
2242
+ "explode": true,
2243
+ "schema": {
2244
+ "type": "string"
2245
+ }
2246
+ },
2247
+ {
2248
+ "name": "lastN",
2249
+ "in": "query",
2250
+ "description": "Only delete last N occurrences",
2251
+ "style": "form",
2252
+ "explode": true,
2253
+ "schema": {
2254
+ "type": "integer",
2255
+ "format": "int32"
2256
+ }
2257
+ }
2258
+ ],
2259
+ "responses": {
2260
+ "200": {
2261
+ "description": "successful operation",
2262
+ "headers": {},
2263
+ "content": {
2264
+ "application/json": {
2265
+ "schema": {
2266
+ "type": "object"
2267
+ }
2268
+ }
2269
+ }
2270
+ }
2271
+ },
2272
+ "deprecated": false
2273
+ }
2274
+ },
2275
+ "/resources/occurrences": {
2276
+ "get": {
2277
+ "tags": [
2278
+ "Resources"
2279
+ ],
2280
+ "summary": "getResourcesWithOccurrences",
2281
+ "description": "With optional 'occurrence' options, subset of stored resolved resources can be retrieved using the blueprint name, blueprint version, artifact name and the resolution-key.",
2282
+ "operationId": "getResourcesWithOccurrences",
2283
+ "parameters": [
2284
+ {
2285
+ "name": "bpName",
2286
+ "in": "query",
2287
+ "description": "Name of the CBA.",
2288
+ "required": true,
2289
+ "style": "form",
2290
+ "explode": true,
2291
+ "schema": {
2292
+ "type": "string"
2293
+ }
2294
+ },
2295
+ {
2296
+ "name": "bpVersion",
2297
+ "in": "query",
2298
+ "description": "Version of the CBA.",
2299
+ "required": true,
2300
+ "style": "form",
2301
+ "explode": true,
2302
+ "schema": {
2303
+ "type": "string"
2304
+ }
2305
+ },
2306
+ {
2307
+ "name": "artifactName",
2308
+ "in": "query",
2309
+ "description": "Artifact name for which to retrieve a resolved resource.",
2310
+ "required": true,
2311
+ "style": "form",
2312
+ "explode": true,
2313
+ "schema": {
2314
+ "type": "string"
2315
+ }
2316
+ },
2317
+ {
2318
+ "name": "resolutionKey",
2319
+ "in": "query",
2320
+ "description": "Resolution Key associated with the resolution.",
2321
+ "required": true,
2322
+ "style": "form",
2323
+ "explode": true,
2324
+ "schema": {
2325
+ "type": "string"
2326
+ }
2327
+ },
2328
+ {
2329
+ "name": "firstN",
2330
+ "in": "query",
2331
+ "description": "Number of earlier N occurrences of the resolutions.",
2332
+ "style": "form",
2333
+ "explode": true,
2334
+ "schema": {
2335
+ "type": "integer",
2336
+ "format": "int32"
2337
+ }
2338
+ },
2339
+ {
2340
+ "name": "lastN",
2341
+ "in": "query",
2342
+ "description": "Number of latest N occurrences of the resolutions.",
2343
+ "style": "form",
2344
+ "explode": true,
2345
+ "schema": {
2346
+ "type": "integer",
2347
+ "format": "int32"
2348
+ }
2349
+ },
2350
+ {
2351
+ "name": "begin",
2352
+ "in": "query",
2353
+ "description": "For Range option - 'begin' is the start occurrence of range of the resolutions.",
2354
+ "style": "form",
2355
+ "explode": true,
2356
+ "schema": {
2357
+ "type": "integer",
2358
+ "format": "int32"
2359
+ }
2360
+ },
2361
+ {
2362
+ "name": "end",
2363
+ "in": "query",
2364
+ "description": "For Range option - 'end' is the end occurrence of the range of the resolutions.",
2365
+ "style": "form",
2366
+ "explode": true,
2367
+ "schema": {
2368
+ "type": "integer",
2369
+ "format": "int32"
2370
+ }
2371
+ }
2372
+ ],
2373
+ "responses": {
2374
+ "200": {
2375
+ "description": "successful operation",
2376
+ "headers": {},
2377
+ "content": {
2378
+ "application/json": {
2379
+ "schema": {
2380
+ "type": "array",
2381
+ "items": {
2382
+ "$ref": "#/components/schemas/ResourceResolution"
2383
+ },
2384
+ "description": ""
2385
+ }
2386
+ }
2387
+ }
2388
+ }
2389
+ },
2390
+ "deprecated": false
2391
+ }
2392
+ },
2393
+ "/resources/resource": {
2394
+ "get": {
2395
+ "tags": [
2396
+ "Resources"
2397
+ ],
2398
+ "summary": "getResourceValueUsingResolutionKey",
2399
+ "description": "Retrieve a stored resource value using the blueprint metadata, artifact name, resolution-key along with the name of the resource value to retrieve.",
2400
+ "operationId": "getResourceValueUsingResolutionKey",
2401
+ "parameters": [
2402
+ {
2403
+ "name": "bpName",
2404
+ "in": "query",
2405
+ "description": "Name of the CBA",
2406
+ "required": true,
2407
+ "style": "form",
2408
+ "explode": true,
2409
+ "schema": {
2410
+ "type": "string"
2411
+ }
2412
+ },
2413
+ {
2414
+ "name": "bpVersion",
2415
+ "in": "query",
2416
+ "description": "Version of the CBA",
2417
+ "required": true,
2418
+ "style": "form",
2419
+ "explode": true,
2420
+ "schema": {
2421
+ "type": "string"
2422
+ }
2423
+ },
2424
+ {
2425
+ "name": "artifactName",
2426
+ "in": "query",
2427
+ "description": "Artifact name for which to retrieve a resolved resource",
2428
+ "required": true,
2429
+ "style": "form",
2430
+ "explode": true,
2431
+ "schema": {
2432
+ "type": "string"
2433
+ }
2434
+ },
2435
+ {
2436
+ "name": "resolutionKey",
2437
+ "in": "query",
2438
+ "description": "Resolution Key associated with the resolution",
2439
+ "required": true,
2440
+ "style": "form",
2441
+ "explode": true,
2442
+ "schema": {
2443
+ "type": "string"
2444
+ }
2445
+ },
2446
+ {
2447
+ "name": "name",
2448
+ "in": "query",
2449
+ "description": "Name of the resource to retrieve",
2450
+ "required": true,
2451
+ "style": "form",
2452
+ "explode": true,
2453
+ "schema": {
2454
+ "type": "string"
2455
+ }
2456
+ }
2457
+ ],
2458
+ "responses": {
2459
+ "200": {
2460
+ "description": "successful operation",
2461
+ "headers": {},
2462
+ "content": {
2463
+ "application/json": {
2464
+ "schema": {
2465
+ "type": "object"
2466
+ }
2467
+ }
2468
+ }
2469
+ }
2470
+ },
2471
+ "deprecated": false
2472
+ }
2473
+ }
2474
+ },
2475
+ "components": {
2476
+ "schemas": {
2477
+ "ActionIdentifiers": {
2478
+ "title": "ActionIdentifiers",
2479
+ "required": [
2480
+ "actionName",
2481
+ "mode"
2482
+ ],
2483
+ "type": "object",
2484
+ "properties": {
2485
+ "blueprintName": {
2486
+ "type": "string",
2487
+ "description": "Name of the CBA."
2488
+ },
2489
+ "blueprintVersion": {
2490
+ "type": "string",
2491
+ "description": "Version of the CBA."
2492
+ },
2493
+ "actionName": {
2494
+ "type": "string",
2495
+ "description": "Name of the workflow to execute."
2496
+ },
2497
+ "mode": {
2498
+ "allOf": [
2499
+ {
2500
+ "$ref": "#/components/schemas/Mode"
2501
+ },
2502
+ {
2503
+ "description": "Async processing is only supported for gRPC client."
2504
+ }
2505
+ ]
2506
+ }
2507
+ }
2508
+ },
2509
+ "ArtifactDefinition": {
2510
+ "title": "ArtifactDefinition",
2511
+ "type": "object",
2512
+ "properties": {
2513
+ "type": {
2514
+ "type": "string"
2515
+ },
2516
+ "file": {
2517
+ "type": "string"
2518
+ },
2519
+ "repository": {
2520
+ "type": "string"
2521
+ },
2522
+ "description": {
2523
+ "type": "string"
2524
+ },
2525
+ "properties": {
2526
+ "type": "object",
2527
+ "additionalProperties": {
2528
+ "$ref": "#/components/schemas/JsonNode"
2529
+ }
2530
+ },
2531
+ "deploy_Path": {
2532
+ "type": "string"
2533
+ }
2534
+ }
2535
+ },
2536
+ "BlueprintModelSearch": {
2537
+ "title": "BlueprintModelSearch",
2538
+ "required": [
2539
+ "id",
2540
+ "artifactVersion",
2541
+ "createdDate",
2542
+ "artifactName",
2543
+ "published",
2544
+ "updatedBy",
2545
+ "tags"
2546
+ ],
2547
+ "type": "object",
2548
+ "properties": {
2549
+ "id": {
2550
+ "type": "string",
2551
+ "description": "ID of Blueprint model, is automatically created by CDS",
2552
+ "example": "658f9a48-7f54-41ba-ae18-c69f26f3dc94"
2553
+ },
2554
+ "artifactUUId": {
2555
+ "type": "string",
2556
+ "description": "Artifact UUID, usually null"
2557
+ },
2558
+ "artifactType": {
2559
+ "type": "string",
2560
+ "description": "Artifact Type, usually null",
2561
+ "example": "SDNC_MODEL"
2562
+ },
2563
+ "artifactVersion": {
2564
+ "type": "string",
2565
+ "description": "Artifact Version, usually 1.0.0",
2566
+ "example": "1.0.0"
2567
+ },
2568
+ "artifactDescription": {
2569
+ "type": "string",
2570
+ "description": "Artifact Description, usually empty"
2571
+ },
2572
+ "internalVersion": {
2573
+ "type": "integer",
2574
+ "description": "Internal Version of CBA, usually null",
2575
+ "format": "int32"
2576
+ },
2577
+ "createdDate": {
2578
+ "type": "string",
2579
+ "description": "Datetime of the creation of CBA in CDS",
2580
+ "format": "date-time",
2581
+ "example": "2020-11-19T10:34:56.000Z"
2582
+ },
2583
+ "artifactName": {
2584
+ "type": "string",
2585
+ "description": "Artifact Name, defined in Metadata",
2586
+ "example": "pnf_netconf"
2587
+ },
2588
+ "published": {
2589
+ "type": "string",
2590
+ "description": "Artifact Name, defined in Metadata",
2591
+ "example": "pnf_netconf"
2592
+ },
2593
+ "updatedBy": {
2594
+ "type": "string",
2595
+ "description": "Name of publisher, defined in Metadata",
2596
+ "example": "Deutsche Telekom AG"
2597
+ },
2598
+ "tags": {
2599
+ "type": "string",
2600
+ "description": "Tags to identify the CBA, defined in Metadata",
2601
+ "example": "test"
2602
+ }
2603
+ }
2604
+ },
2605
+ "BootstrapRequest": {
2606
+ "title": "BootstrapRequest",
2607
+ "required": [
2608
+ "loadModelType",
2609
+ "loadResourceDictionary",
2610
+ "loadCBA"
2611
+ ],
2612
+ "type": "object",
2613
+ "properties": {
2614
+ "loadModelType": {
2615
+ "type": "boolean",
2616
+ "description": "Specifies if default model types should be loaded",
2617
+ "example": true
2618
+ },
2619
+ "loadResourceDictionary": {
2620
+ "type": "boolean",
2621
+ "description": "Specifies if default data dictionaries should be loaded",
2622
+ "example": true
2623
+ },
2624
+ "loadCBA": {
2625
+ "type": "boolean",
2626
+ "description": "Specifies if default blueprint models should be loaded",
2627
+ "example": true
2628
+ }
2629
+ }
2630
+ },
2631
+ "CapabilityAssignment": {
2632
+ "title": "CapabilityAssignment",
2633
+ "type": "object",
2634
+ "properties": {
2635
+ "attributes": {
2636
+ "type": "object",
2637
+ "additionalProperties": {
2638
+ "$ref": "#/components/schemas/JsonNode"
2639
+ }
2640
+ },
2641
+ "properties": {
2642
+ "type": "object",
2643
+ "additionalProperties": {
2644
+ "$ref": "#/components/schemas/JsonNode"
2645
+ }
2646
+ }
2647
+ }
2648
+ },
2649
+ "CommonHeader": {
2650
+ "title": "CommonHeader",
2651
+ "required": [
2652
+ "timestamp",
2653
+ "originatorId",
2654
+ "requestId",
2655
+ "subRequestId"
2656
+ ],
2657
+ "type": "object",
2658
+ "properties": {
2659
+ "timestamp": {
2660
+ "type": "string",
2661
+ "description": "Date of the execution",
2662
+ "format": "date-time",
2663
+ "example": "2012-04-23T18:25:43.511Z"
2664
+ },
2665
+ "originatorId": {
2666
+ "type": "string",
2667
+ "description": "Identify the system/person triggering the request."
2668
+ },
2669
+ "requestId": {
2670
+ "type": "string",
2671
+ "description": "Uniquely identify a request."
2672
+ },
2673
+ "subRequestId": {
2674
+ "type": "string",
2675
+ "description": "Allow for fine-grain request identifier"
2676
+ }
2677
+ }
2678
+ },
2679
+ "ConstraintClause": {
2680
+ "title": "ConstraintClause",
2681
+ "type": "object",
2682
+ "properties": {
2683
+ "equal": {
2684
+ "$ref": "#/components/schemas/JsonNode"
2685
+ },
2686
+ "length": {
2687
+ "$ref": "#/components/schemas/JsonNode"
2688
+ },
2689
+ "pattern": {
2690
+ "type": "string"
2691
+ },
2692
+ "schema": {
2693
+ "type": "string"
2694
+ },
2695
+ "greater_than": {
2696
+ "$ref": "#/components/schemas/JsonNode"
2697
+ },
2698
+ "greater_or_equal": {
2699
+ "$ref": "#/components/schemas/JsonNode"
2700
+ },
2701
+ "less_than": {
2702
+ "$ref": "#/components/schemas/JsonNode"
2703
+ },
2704
+ "less_or_equal": {
2705
+ "$ref": "#/components/schemas/JsonNode"
2706
+ },
2707
+ "in_range": {
2708
+ "type": "array",
2709
+ "items": {
2710
+ "$ref": "#/components/schemas/JsonNode"
2711
+ },
2712
+ "description": ""
2713
+ },
2714
+ "valid_values": {
2715
+ "type": "array",
2716
+ "items": {
2717
+ "$ref": "#/components/schemas/JsonNode"
2718
+ },
2719
+ "description": ""
2720
+ },
2721
+ "min_length": {
2722
+ "$ref": "#/components/schemas/JsonNode"
2723
+ },
2724
+ "max_length": {
2725
+ "$ref": "#/components/schemas/JsonNode"
2726
+ }
2727
+ }
2728
+ },
2729
+ "EntrySchema": {
2730
+ "title": "EntrySchema",
2731
+ "type": "object",
2732
+ "properties": {
2733
+ "type": {
2734
+ "type": "string"
2735
+ },
2736
+ "constraints": {
2737
+ "type": "array",
2738
+ "items": {
2739
+ "$ref": "#/components/schemas/ConstraintClause"
2740
+ },
2741
+ "description": ""
2742
+ }
2743
+ }
2744
+ },
2745
+ "ExecutionServiceInput": {
2746
+ "title": "ExecutionServiceInput",
2747
+ "required": [
2748
+ "commonHeader",
2749
+ "actionIdentifiers",
2750
+ "payload"
2751
+ ],
2752
+ "type": "object",
2753
+ "properties": {
2754
+ "commonHeader": {
2755
+ "$ref": "#/components/schemas/CommonHeader"
2756
+ },
2757
+ "actionIdentifiers": {
2758
+ "$ref": "#/components/schemas/ActionIdentifiers"
2759
+ },
2760
+ "payload": {
2761
+ "$ref": "#/components/schemas/ObjectNode"
2762
+ }
2763
+ }
2764
+ },
2765
+ "ExecutionServiceOutput": {
2766
+ "title": "ExecutionServiceOutput",
2767
+ "required": [
2768
+ "commonHeader",
2769
+ "actionIdentifiers",
2770
+ "status",
2771
+ "payload"
2772
+ ],
2773
+ "type": "object",
2774
+ "properties": {
2775
+ "commonHeader": {
2776
+ "$ref": "#/components/schemas/CommonHeader"
2777
+ },
2778
+ "actionIdentifiers": {
2779
+ "$ref": "#/components/schemas/ActionIdentifiers"
2780
+ },
2781
+ "status": {
2782
+ "$ref": "#/components/schemas/Status"
2783
+ },
2784
+ "payload": {
2785
+ "$ref": "#/components/schemas/ObjectNode"
2786
+ }
2787
+ }
2788
+ },
2789
+ "Implementation": {
2790
+ "title": "Implementation",
2791
+ "type": "object",
2792
+ "properties": {
2793
+ "primary": {
2794
+ "type": "string"
2795
+ },
2796
+ "dependencies": {
2797
+ "type": "array",
2798
+ "items": {
2799
+ "type": "string"
2800
+ },
2801
+ "description": ""
2802
+ },
2803
+ "timeout": {
2804
+ "type": "integer",
2805
+ "format": "int32"
2806
+ },
2807
+ "lock": {
2808
+ "$ref": "#/components/schemas/LockAssignment"
2809
+ },
2810
+ "operation_host": {
2811
+ "type": "string"
2812
+ }
2813
+ }
2814
+ },
2815
+ "InterfaceAssignment": {
2816
+ "title": "InterfaceAssignment",
2817
+ "type": "object",
2818
+ "properties": {
2819
+ "operations": {
2820
+ "type": "object",
2821
+ "additionalProperties": {
2822
+ "$ref": "#/components/schemas/OperationAssignment"
2823
+ }
2824
+ },
2825
+ "inputs": {
2826
+ "type": "object",
2827
+ "additionalProperties": {
2828
+ "$ref": "#/components/schemas/JsonNode"
2829
+ }
2830
+ }
2831
+ }
2832
+ },
2833
+ "JsonNode": {
2834
+ "title": "JsonNode",
2835
+ "type": "object",
2836
+ "properties": {
2837
+ "double": {
2838
+ "type": "boolean"
2839
+ },
2840
+ "int": {
2841
+ "type": "boolean"
2842
+ },
2843
+ "long": {
2844
+ "type": "boolean"
2845
+ },
2846
+ "boolean": {
2847
+ "type": "boolean"
2848
+ },
2849
+ "short": {
2850
+ "type": "boolean"
2851
+ },
2852
+ "nodeType": {
2853
+ "$ref": "#/components/schemas/NodeType"
2854
+ },
2855
+ "object": {
2856
+ "type": "boolean"
2857
+ },
2858
+ "number": {
2859
+ "type": "boolean"
2860
+ },
2861
+ "binary": {
2862
+ "type": "boolean"
2863
+ },
2864
+ "floatingPointNumber": {
2865
+ "type": "boolean"
2866
+ },
2867
+ "containerNode": {
2868
+ "type": "boolean"
2869
+ },
2870
+ "missingNode": {
2871
+ "type": "boolean"
2872
+ },
2873
+ "pojo": {
2874
+ "type": "boolean"
2875
+ },
2876
+ "valueNode": {
2877
+ "type": "boolean"
2878
+ },
2879
+ "bigDecimal": {
2880
+ "type": "boolean"
2881
+ },
2882
+ "textual": {
2883
+ "type": "boolean"
2884
+ },
2885
+ "bigInteger": {
2886
+ "type": "boolean"
2887
+ },
2888
+ "integralNumber": {
2889
+ "type": "boolean"
2890
+ },
2891
+ "array": {
2892
+ "type": "boolean"
2893
+ },
2894
+ "null": {
2895
+ "type": "boolean"
2896
+ },
2897
+ "float": {
2898
+ "type": "boolean"
2899
+ }
2900
+ }
2901
+ },
2902
+ "LockAssignment": {
2903
+ "title": "LockAssignment",
2904
+ "type": "object",
2905
+ "properties": {
2906
+ "key": {
2907
+ "$ref": "#/components/schemas/JsonNode"
2908
+ },
2909
+ "acquireTimeout": {
2910
+ "$ref": "#/components/schemas/JsonNode"
2911
+ }
2912
+ }
2913
+ },
2914
+ "ModelType": {
2915
+ "title": "ModelType",
2916
+ "required": [
2917
+ "modelName",
2918
+ "derivedFrom",
2919
+ "definitionType",
2920
+ "definition",
2921
+ "description",
2922
+ "version",
2923
+ "tags",
2924
+ "updatedBy"
2925
+ ],
2926
+ "type": "object",
2927
+ "properties": {
2928
+ "modelName": {
2929
+ "type": "string"
2930
+ },
2931
+ "derivedFrom": {
2932
+ "type": "string"
2933
+ },
2934
+ "definitionType": {
2935
+ "type": "string"
2936
+ },
2937
+ "definition": {
2938
+ "$ref": "#/components/schemas/JsonNode"
2939
+ },
2940
+ "description": {
2941
+ "type": "string"
2942
+ },
2943
+ "version": {
2944
+ "type": "string"
2945
+ },
2946
+ "tags": {
2947
+ "type": "string"
2948
+ },
2949
+ "creationDate": {
2950
+ "type": "string",
2951
+ "format": "date-time"
2952
+ },
2953
+ "updatedBy": {
2954
+ "type": "string"
2955
+ }
2956
+ }
2957
+ },
2958
+ "NodeFilterDefinition": {
2959
+ "title": "NodeFilterDefinition",
2960
+ "type": "object",
2961
+ "properties": {
2962
+ "properties": {
2963
+ "type": "object",
2964
+ "additionalProperties": {
2965
+ "$ref": "#/components/schemas/PropertyDefinition"
2966
+ }
2967
+ },
2968
+ "capabilities": {
2969
+ "type": "array",
2970
+ "items": {
2971
+ "type": "string"
2972
+ },
2973
+ "description": ""
2974
+ }
2975
+ }
2976
+ },
2977
+ "NodeTemplate": {
2978
+ "title": "NodeTemplate",
2979
+ "type": "object",
2980
+ "properties": {
2981
+ "description": {
2982
+ "type": "string"
2983
+ },
2984
+ "type": {
2985
+ "type": "string"
2986
+ },
2987
+ "metadata": {
2988
+ "type": "object",
2989
+ "additionalProperties": {
2990
+ "type": "string"
2991
+ }
2992
+ },
2993
+ "directives": {
2994
+ "type": "array",
2995
+ "items": {
2996
+ "type": "string"
2997
+ },
2998
+ "description": ""
2999
+ },
3000
+ "properties": {
3001
+ "type": "object",
3002
+ "additionalProperties": {
3003
+ "$ref": "#/components/schemas/JsonNode"
3004
+ }
3005
+ },
3006
+ "attributes": {
3007
+ "type": "object",
3008
+ "additionalProperties": {
3009
+ "$ref": "#/components/schemas/JsonNode"
3010
+ }
3011
+ },
3012
+ "capabilities": {
3013
+ "type": "object",
3014
+ "additionalProperties": {
3015
+ "$ref": "#/components/schemas/CapabilityAssignment"
3016
+ }
3017
+ },
3018
+ "requirements": {
3019
+ "type": "object",
3020
+ "additionalProperties": {
3021
+ "$ref": "#/components/schemas/RequirementAssignment"
3022
+ }
3023
+ },
3024
+ "interfaces": {
3025
+ "type": "object",
3026
+ "additionalProperties": {
3027
+ "$ref": "#/components/schemas/InterfaceAssignment"
3028
+ }
3029
+ },
3030
+ "artifacts": {
3031
+ "type": "object",
3032
+ "additionalProperties": {
3033
+ "$ref": "#/components/schemas/ArtifactDefinition"
3034
+ }
3035
+ },
3036
+ "copy": {
3037
+ "type": "string"
3038
+ },
3039
+ "node_filter": {
3040
+ "$ref": "#/components/schemas/NodeFilterDefinition"
3041
+ }
3042
+ }
3043
+ },
3044
+ "ObjectNode": {
3045
+ "title": "ObjectNode",
3046
+ "type": "object",
3047
+ "properties": {
3048
+ "nodeType": {
3049
+ "$ref": "#/components/schemas/NodeType"
3050
+ },
3051
+ "double": {
3052
+ "type": "boolean"
3053
+ },
3054
+ "int": {
3055
+ "type": "boolean"
3056
+ },
3057
+ "long": {
3058
+ "type": "boolean"
3059
+ },
3060
+ "boolean": {
3061
+ "type": "boolean"
3062
+ },
3063
+ "short": {
3064
+ "type": "boolean"
3065
+ },
3066
+ "object": {
3067
+ "type": "boolean"
3068
+ },
3069
+ "number": {
3070
+ "type": "boolean"
3071
+ },
3072
+ "binary": {
3073
+ "type": "boolean"
3074
+ },
3075
+ "floatingPointNumber": {
3076
+ "type": "boolean"
3077
+ },
3078
+ "containerNode": {
3079
+ "type": "boolean"
3080
+ },
3081
+ "missingNode": {
3082
+ "type": "boolean"
3083
+ },
3084
+ "pojo": {
3085
+ "type": "boolean"
3086
+ },
3087
+ "valueNode": {
3088
+ "type": "boolean"
3089
+ },
3090
+ "bigDecimal": {
3091
+ "type": "boolean"
3092
+ },
3093
+ "textual": {
3094
+ "type": "boolean"
3095
+ },
3096
+ "bigInteger": {
3097
+ "type": "boolean"
3098
+ },
3099
+ "integralNumber": {
3100
+ "type": "boolean"
3101
+ },
3102
+ "array": {
3103
+ "type": "boolean"
3104
+ },
3105
+ "null": {
3106
+ "type": "boolean"
3107
+ },
3108
+ "float": {
3109
+ "type": "boolean"
3110
+ }
3111
+ }
3112
+ },
3113
+ "OperationAssignment": {
3114
+ "title": "OperationAssignment",
3115
+ "type": "object",
3116
+ "properties": {
3117
+ "description": {
3118
+ "type": "string"
3119
+ },
3120
+ "implementation": {
3121
+ "$ref": "#/components/schemas/Implementation"
3122
+ },
3123
+ "inputs": {
3124
+ "type": "object",
3125
+ "additionalProperties": {
3126
+ "$ref": "#/components/schemas/JsonNode"
3127
+ }
3128
+ },
3129
+ "outputs": {
3130
+ "type": "object",
3131
+ "additionalProperties": {
3132
+ "$ref": "#/components/schemas/JsonNode"
3133
+ }
3134
+ }
3135
+ }
3136
+ },
3137
+ "Page": {
3138
+ "title": "Page",
3139
+ "type": "object",
3140
+ "properties": {
3141
+ "totalPages": {
3142
+ "type": "integer",
3143
+ "format": "int32"
3144
+ },
3145
+ "totalElements": {
3146
+ "type": "integer",
3147
+ "format": "int64"
3148
+ },
3149
+ "pageable": {
3150
+ "$ref": "#/components/schemas/Pageable"
3151
+ },
3152
+ "first": {
3153
+ "type": "boolean"
3154
+ },
3155
+ "numberOfElements": {
3156
+ "type": "integer",
3157
+ "format": "int32"
3158
+ },
3159
+ "size": {
3160
+ "type": "integer",
3161
+ "format": "int32"
3162
+ },
3163
+ "content": {
3164
+ "type": "array",
3165
+ "items": {
3166
+ "type": "object"
3167
+ },
3168
+ "description": ""
3169
+ },
3170
+ "number": {
3171
+ "type": "integer",
3172
+ "format": "int32"
3173
+ },
3174
+ "sort": {
3175
+ "$ref": "#/components/schemas/Sort"
3176
+ },
3177
+ "last": {
3178
+ "type": "boolean"
3179
+ },
3180
+ "empty": {
3181
+ "type": "boolean"
3182
+ }
3183
+ }
3184
+ },
3185
+ "PageBlueprintModelSearch": {
3186
+ "title": "PageBlueprintModelSearch",
3187
+ "type": "object",
3188
+ "properties": {
3189
+ "totalPages": {
3190
+ "type": "integer",
3191
+ "format": "int32"
3192
+ },
3193
+ "totalElements": {
3194
+ "type": "integer",
3195
+ "format": "int64"
3196
+ },
3197
+ "pageable": {
3198
+ "$ref": "#/components/schemas/Pageable"
3199
+ },
3200
+ "first": {
3201
+ "type": "boolean"
3202
+ },
3203
+ "numberOfElements": {
3204
+ "type": "integer",
3205
+ "format": "int32"
3206
+ },
3207
+ "size": {
3208
+ "type": "integer",
3209
+ "format": "int32"
3210
+ },
3211
+ "content": {
3212
+ "type": "array",
3213
+ "items": {
3214
+ "$ref": "#/components/schemas/BlueprintModelSearch"
3215
+ },
3216
+ "description": ""
3217
+ },
3218
+ "number": {
3219
+ "type": "integer",
3220
+ "format": "int32"
3221
+ },
3222
+ "sort": {
3223
+ "$ref": "#/components/schemas/Sort"
3224
+ },
3225
+ "last": {
3226
+ "type": "boolean"
3227
+ },
3228
+ "empty": {
3229
+ "type": "boolean"
3230
+ }
3231
+ }
3232
+ },
3233
+ "Pageable": {
3234
+ "title": "Pageable",
3235
+ "type": "object",
3236
+ "properties": {
3237
+ "paged": {
3238
+ "type": "boolean"
3239
+ },
3240
+ "pageNumber": {
3241
+ "type": "integer",
3242
+ "format": "int32"
3243
+ },
3244
+ "pageSize": {
3245
+ "type": "integer",
3246
+ "format": "int32"
3247
+ },
3248
+ "unpaged": {
3249
+ "type": "boolean"
3250
+ },
3251
+ "offset": {
3252
+ "type": "integer",
3253
+ "format": "int64"
3254
+ },
3255
+ "sort": {
3256
+ "$ref": "#/components/schemas/Sort"
3257
+ }
3258
+ }
3259
+ },
3260
+ "PropertyDefinition": {
3261
+ "title": "PropertyDefinition",
3262
+ "type": "object",
3263
+ "properties": {
3264
+ "description": {
3265
+ "type": "string"
3266
+ },
3267
+ "required": {
3268
+ "type": "boolean"
3269
+ },
3270
+ "type": {
3271
+ "type": "string"
3272
+ },
3273
+ "status": {
3274
+ "type": "string"
3275
+ },
3276
+ "constraints": {
3277
+ "type": "array",
3278
+ "items": {
3279
+ "$ref": "#/components/schemas/ConstraintClause"
3280
+ },
3281
+ "description": ""
3282
+ },
3283
+ "metadata": {
3284
+ "type": "object",
3285
+ "additionalProperties": {
3286
+ "type": "string"
3287
+ }
3288
+ },
3289
+ "value": {
3290
+ "$ref": "#/components/schemas/JsonNode"
3291
+ },
3292
+ "input-param": {
3293
+ "type": "boolean"
3294
+ },
3295
+ "default": {
3296
+ "$ref": "#/components/schemas/JsonNode"
3297
+ },
3298
+ "entry_schema": {
3299
+ "$ref": "#/components/schemas/EntrySchema"
3300
+ },
3301
+ "external-schema": {
3302
+ "type": "string"
3303
+ }
3304
+ }
3305
+ },
3306
+ "RequirementAssignment": {
3307
+ "title": "RequirementAssignment",
3308
+ "type": "object",
3309
+ "properties": {
3310
+ "capability": {
3311
+ "type": "string"
3312
+ },
3313
+ "node": {
3314
+ "type": "string"
3315
+ },
3316
+ "relationship": {
3317
+ "type": "string"
3318
+ }
3319
+ }
3320
+ },
3321
+ "ResourceConfigSnapshot": {
3322
+ "title": "ResourceConfigSnapshot",
3323
+ "required": [
3324
+ "resourceType",
3325
+ "resourceId",
3326
+ "status",
3327
+ "config_snapshot",
3328
+ "createdDate"
3329
+ ],
3330
+ "type": "object",
3331
+ "properties": {
3332
+ "resourceType": {
3333
+ "type": "string",
3334
+ "description": "Resource type.",
3335
+ "example": "ServiceInstance"
3336
+ },
3337
+ "resourceId": {
3338
+ "type": "string",
3339
+ "description": "ID associated with the resource type in the inventory system.",
3340
+ "example": "1"
3341
+ },
3342
+ "status": {
3343
+ "allOf": [
3344
+ {
3345
+ "$ref": "#/components/schemas/Status1"
3346
+ },
3347
+ {
3348
+ "description": "Status of the snapshot, either running or candidate."
3349
+ }
3350
+ ]
3351
+ },
3352
+ "config_snapshot": {
3353
+ "type": "string",
3354
+ "description": "Snapshot of the resource as retrieved from resource.",
3355
+ "example": "config_snapshot"
3356
+ },
3357
+ "id": {
3358
+ "type": "string"
3359
+ },
3360
+ "createdDate": {
3361
+ "type": "string",
3362
+ "description": "Creation date of the snapshot.",
3363
+ "format": "date-time"
3364
+ }
3365
+ }
3366
+ },
3367
+ "ResourceDefinition": {
3368
+ "title": "ResourceDefinition",
3369
+ "required": [
3370
+ "name",
3371
+ "property",
3372
+ "group",
3373
+ "updated-by",
3374
+ "sources"
3375
+ ],
3376
+ "type": "object",
3377
+ "properties": {
3378
+ "tags": {
3379
+ "type": "string"
3380
+ },
3381
+ "name": {
3382
+ "type": "string",
3383
+ "description": "Name",
3384
+ "example": "default-source"
3385
+ },
3386
+ "property": {
3387
+ "$ref": "#/components/schemas/PropertyDefinition"
3388
+ },
3389
+ "group": {
3390
+ "type": "string",
3391
+ "description": "Group",
3392
+ "example": "default"
3393
+ },
3394
+ "updated-by": {
3395
+ "type": "string",
3396
+ "description": "Updated by",
3397
+ "example": "example@onap.com"
3398
+ },
3399
+ "sources": {
3400
+ "type": "object",
3401
+ "additionalProperties": {
3402
+ "$ref": "#/components/schemas/NodeTemplate"
3403
+ },
3404
+ "description": "Sources"
3405
+ }
3406
+ }
3407
+ },
3408
+ "ResourceDictionary": {
3409
+ "title": "ResourceDictionary",
3410
+ "required": [
3411
+ "name",
3412
+ "dataType",
3413
+ "entrySchema",
3414
+ "resourceDictionaryGroup",
3415
+ "definition",
3416
+ "description",
3417
+ "tags",
3418
+ "updatedBy"
3419
+ ],
3420
+ "type": "object",
3421
+ "properties": {
3422
+ "name": {
3423
+ "type": "string",
3424
+ "description": "Name",
3425
+ "example": "sample-db-source"
3426
+ },
3427
+ "dataType": {
3428
+ "type": "string",
3429
+ "description": "Data type",
3430
+ "example": "string"
3431
+ },
3432
+ "entrySchema": {
3433
+ "type": "string",
3434
+ "description": "Entry schema",
3435
+ "example": "dt-license-key"
3436
+ },
3437
+ "resourceDictionaryGroup": {
3438
+ "type": "string",
3439
+ "description": "Resource dictionary group",
3440
+ "example": "default"
3441
+ },
3442
+ "definition": {
3443
+ "$ref": "#/components/schemas/ResourceDefinition"
3444
+ },
3445
+ "description": {
3446
+ "type": "string",
3447
+ "description": "Description",
3448
+ "example": "demo_artifacts_version"
3449
+ },
3450
+ "tags": {
3451
+ "type": "string",
3452
+ "description": "Tags",
3453
+ "example": "hostname"
3454
+ },
3455
+ "creationDate": {
3456
+ "type": "string",
3457
+ "format": "date-time"
3458
+ },
3459
+ "updatedBy": {
3460
+ "type": "string",
3461
+ "description": "Updated by",
3462
+ "example": "username"
3463
+ }
3464
+ }
3465
+ },
3466
+ "ResourceResolution": {
3467
+ "title": "ResourceResolution",
3468
+ "required": [
3469
+ "blueprintName",
3470
+ "blueprintVersion",
3471
+ "artifactName",
3472
+ "name",
3473
+ "value",
3474
+ "status",
3475
+ "resolutionKey",
3476
+ "resourceType",
3477
+ "resourceId",
3478
+ "occurrence",
3479
+ "dictionaryName",
3480
+ "dictionarySource",
3481
+ "dictionaryVersion",
3482
+ "createdDate"
3483
+ ],
3484
+ "type": "object",
3485
+ "properties": {
3486
+ "blueprintName": {
3487
+ "type": "string",
3488
+ "description": "Name of the CBA."
3489
+ },
3490
+ "blueprintVersion": {
3491
+ "type": "string",
3492
+ "description": "Version of the CBA."
3493
+ },
3494
+ "artifactName": {
3495
+ "type": "string",
3496
+ "description": "Artifact name for which to retrieve a resolved resource."
3497
+ },
3498
+ "name": {
3499
+ "type": "string",
3500
+ "description": "Name of the resource."
3501
+ },
3502
+ "value": {
3503
+ "type": "string",
3504
+ "description": "Value of the resolution."
3505
+ },
3506
+ "status": {
3507
+ "type": "string",
3508
+ "description": "Whether success of failure."
3509
+ },
3510
+ "resolutionKey": {
3511
+ "type": "string",
3512
+ "description": "Resolution Key uniquely identifying the resolution of a given artifact within a CBA."
3513
+ },
3514
+ "resourceType": {
3515
+ "type": "string",
3516
+ "description": "Resolution type.",
3517
+ "example": "ServiceInstance"
3518
+ },
3519
+ "resourceId": {
3520
+ "type": "string",
3521
+ "description": "ID associated with the resolution type in the inventory system."
3522
+ },
3523
+ "occurrence": {
3524
+ "type": "integer",
3525
+ "description": "If resolution occurred multiple time, this field provides the index.",
3526
+ "format": "int32"
3527
+ },
3528
+ "dictionaryName": {
3529
+ "type": "string",
3530
+ "description": "Name of the data dictionary used for the resolution."
3531
+ },
3532
+ "dictionarySource": {
3533
+ "type": "string",
3534
+ "description": "Source associated with the data dictionary used for the resolution."
3535
+ },
3536
+ "dictionaryVersion": {
3537
+ "type": "integer",
3538
+ "description": "Version of the data dictionary used for the resolution.",
3539
+ "format": "int32"
3540
+ },
3541
+ "id": {
3542
+ "type": "string"
3543
+ },
3544
+ "createdDate": {
3545
+ "type": "string",
3546
+ "description": "Creation date of the resolution.",
3547
+ "format": "date-time"
3548
+ }
3549
+ }
3550
+ },
3551
+ "ResourceSourceMapping": {
3552
+ "title": "ResourceSourceMapping",
3553
+ "type": "object",
3554
+ "properties": {
3555
+ "resourceSourceMappings": {
3556
+ "type": "object",
3557
+ "additionalProperties": {
3558
+ "type": "string"
3559
+ }
3560
+ }
3561
+ }
3562
+ },
3563
+ "Sort": {
3564
+ "title": "Sort",
3565
+ "type": "object",
3566
+ "properties": {
3567
+ "sorted": {
3568
+ "type": "boolean"
3569
+ },
3570
+ "unsorted": {
3571
+ "type": "boolean"
3572
+ },
3573
+ "empty": {
3574
+ "type": "boolean"
3575
+ }
3576
+ }
3577
+ },
3578
+ "Status": {
3579
+ "title": "Status",
3580
+ "required": [
3581
+ "code",
3582
+ "eventType",
3583
+ "timestamp",
3584
+ "message"
3585
+ ],
3586
+ "type": "object",
3587
+ "properties": {
3588
+ "code": {
3589
+ "type": "integer",
3590
+ "description": "HTTP status code equivalent.",
3591
+ "format": "int32"
3592
+ },
3593
+ "eventType": {
3594
+ "type": "string",
3595
+ "description": "Type of the event being emitted by CDS."
3596
+ },
3597
+ "timestamp": {
3598
+ "type": "string",
3599
+ "description": "Time when the execution ended.",
3600
+ "format": "date-time",
3601
+ "example": "2012-04-23T18:25:43.511Z"
3602
+ },
3603
+ "errorMessage": {
3604
+ "type": "string",
3605
+ "description": "Error message when system failed"
3606
+ },
3607
+ "message": {
3608
+ "type": "string",
3609
+ "description": "Message providing request status"
3610
+ }
3611
+ }
3612
+ },
3613
+ "TemplateResolution": {
3614
+ "title": "TemplateResolution",
3615
+ "required": [
3616
+ "blueprintName",
3617
+ "blueprintVersion",
3618
+ "artifactName",
3619
+ "result",
3620
+ "resolutionKey",
3621
+ "resourceType",
3622
+ "resourceId",
3623
+ "occurrence",
3624
+ "createdDate"
3625
+ ],
3626
+ "type": "object",
3627
+ "properties": {
3628
+ "blueprintName": {
3629
+ "type": "string",
3630
+ "description": "Name of the CBA."
3631
+ },
3632
+ "blueprintVersion": {
3633
+ "type": "string",
3634
+ "description": "Version of the CBA."
3635
+ },
3636
+ "artifactName": {
3637
+ "type": "string",
3638
+ "description": "Artifact name for which to retrieve a resolved resource."
3639
+ },
3640
+ "result": {
3641
+ "type": "string",
3642
+ "description": "Rendered template."
3643
+ },
3644
+ "resolutionKey": {
3645
+ "type": "string",
3646
+ "description": "Resolution Key uniquely identifying the resolution of a given artifact within a CBA."
3647
+ },
3648
+ "resourceType": {
3649
+ "type": "string",
3650
+ "description": "Resolution type.",
3651
+ "example": "ServiceInstance"
3652
+ },
3653
+ "resourceId": {
3654
+ "type": "string",
3655
+ "description": "ID associated with the resolution type in the inventory system."
3656
+ },
3657
+ "occurrence": {
3658
+ "type": "integer",
3659
+ "description": "If resolution occurred multiple time, this field provides the index.",
3660
+ "format": "int32"
3661
+ },
3662
+ "id": {
3663
+ "type": "string"
3664
+ },
3665
+ "createdDate": {
3666
+ "type": "string",
3667
+ "description": "Creation date of the resolution.",
3668
+ "format": "date-time"
3669
+ }
3670
+ }
3671
+ },
3672
+ "WorkFlowSpecRequest": {
3673
+ "title": "WorkFlowSpecRequest",
3674
+ "required": [
3675
+ "blueprintName",
3676
+ "workflowName"
3677
+ ],
3678
+ "type": "object",
3679
+ "properties": {
3680
+ "blueprintName": {
3681
+ "type": "string",
3682
+ "description": "Name of the BLueprint",
3683
+ "example": "pnf_netconf"
3684
+ },
3685
+ "version": {
3686
+ "type": "string"
3687
+ },
3688
+ "returnContent": {
3689
+ "type": "string"
3690
+ },
3691
+ "workflowName": {
3692
+ "type": "string",
3693
+ "description": "Name of the Workflow",
3694
+ "example": "config-assign"
3695
+ },
3696
+ "specType": {
3697
+ "type": "string"
3698
+ }
3699
+ }
3700
+ },
3701
+ "Mode": {
3702
+ "title": "Mode",
3703
+ "enum": [
3704
+ "sync",
3705
+ "async"
3706
+ ],
3707
+ "type": "string",
3708
+ "description": "Async processing is only supported for gRPC client."
3709
+ },
3710
+ "NodeType": {
3711
+ "title": "NodeType",
3712
+ "enum": [
3713
+ "ARRAY",
3714
+ "BINARY",
3715
+ "BOOLEAN",
3716
+ "MISSING",
3717
+ "NULL",
3718
+ "NUMBER",
3719
+ "OBJECT",
3720
+ "POJO",
3721
+ "STRING"
3722
+ ],
3723
+ "type": "string"
3724
+ },
3725
+ "sort1": {
3726
+ "title": "sort1",
3727
+ "enum": [
3728
+ "DATE",
3729
+ "NAME",
3730
+ "VERSION"
3731
+ ],
3732
+ "type": "string"
3733
+ },
3734
+ "sort3": {
3735
+ "title": "sort3",
3736
+ "enum": [
3737
+ "DATE"
3738
+ ],
3739
+ "type": "string"
3740
+ },
3741
+ "Status1": {
3742
+ "title": "Status1",
3743
+ "enum": [
3744
+ "RUNNING",
3745
+ "CANDIDATE"
3746
+ ],
3747
+ "type": "string",
3748
+ "description": "Status of the snapshot, either running or candidate."
3749
+ }
3750
+ },
3751
+ "securitySchemes": {
3752
+ "BasicAuth": {
3753
+ "type": "http",
3754
+ "scheme": "basic"
3755
+ }
3756
+ }
3757
+ },
3758
+ "security": [],
3759
+ "tags": [
3760
+ {
3761
+ "name": "Blueprint Model Catalog",
3762
+ "description": "Manages all blueprint models which are available in CDS"
3763
+ },
3764
+ {
3765
+ "name": "Execution Service Catalog",
3766
+ "description": "Interaction with CBA which are available in CDS"
3767
+ },
3768
+ {
3769
+ "name": "Model Type Catalog",
3770
+ "description": "Manages data types in CDS"
3771
+ },
3772
+ {
3773
+ "name": "Resource configuration",
3774
+ "description": "Interaction with stored configurations"
3775
+ },
3776
+ {
3777
+ "name": "Resource Dictionary",
3778
+ "description": "Interaction with stored dictionaries"
3779
+ },
3780
+ {
3781
+ "name": "Resource Template",
3782
+ "description": "Interaction with resolved templates"
3783
+ },
3784
+ {
3785
+ "name": "Resources",
3786
+ "description": "Interaction with resolved resources"
3787
+ }
3788
+ ]
3789
+ }