@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,2624 @@
1
+ openapi: 3.0.0
2
+ info:
3
+ title: CDS Blueprint Processor API Reference
4
+ description: Shows all resources and endpoints which CDS BP processor currently provides with sample requests/responses, parameter description and other information.
5
+ contact:
6
+ name: ONAP Community
7
+ url: https://www.onap.org/
8
+ email: onap-discuss@lists.onap.org
9
+ version: 'v1'
10
+ servers:
11
+ - url: http://localhost:8080/api/v1
12
+ variables: {}
13
+ paths:
14
+ /blueprint-model:
15
+ get:
16
+ tags:
17
+ - Blueprint Model Catalog
18
+ summary: getAllBlueprintModels
19
+ description: Lists all meta-data of blueprint models which are saved in CDS.
20
+ operationId: getAllBlueprintModels
21
+ parameters: []
22
+ responses:
23
+ '200':
24
+ description: OK
25
+ headers: {}
26
+ content:
27
+ application/json:
28
+ schema:
29
+ type: array
30
+ items:
31
+ $ref: '#/components/schemas/BlueprintModelSearch'
32
+ description: ''
33
+ '500':
34
+ description: Internal Server Error
35
+ headers: {}
36
+ content: {}
37
+ deprecated: false
38
+ post:
39
+ tags:
40
+ - Blueprint Model Catalog
41
+ summary: saveBlueprintModel
42
+ 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.
43
+ operationId: saveBlueprintModel
44
+ parameters: []
45
+ requestBody:
46
+ description: 'CBA file to be uploaded (example: cba.zip)'
47
+ content:
48
+ text/plain:
49
+ schema:
50
+ type: object
51
+ description: 'CBA file to be uploaded (example: cba.zip)'
52
+ required: true
53
+ responses:
54
+ '200':
55
+ description: OK
56
+ headers: {}
57
+ content:
58
+ application/json:
59
+ schema:
60
+ $ref: '#/components/schemas/BlueprintModelSearch'
61
+ '500':
62
+ description: Internal Server Error
63
+ headers: {}
64
+ content: {}
65
+ deprecated: false
66
+ /blueprint-model/bootstrap:
67
+ post:
68
+ tags:
69
+ - Blueprint Model Catalog
70
+ summary: bootstrapCDS
71
+ 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.
72
+ operationId: bootstrapCDS
73
+ parameters: []
74
+ requestBody:
75
+ description: Specifies which elements to load
76
+ content:
77
+ application/json:
78
+ schema:
79
+ allOf:
80
+ - $ref: '#/components/schemas/BootstrapRequest'
81
+ - description: Specifies which elements to load
82
+ required: true
83
+ responses:
84
+ '200':
85
+ description: OK
86
+ headers: {}
87
+ content:
88
+ application/json:
89
+ schema:
90
+ type: object
91
+ '500':
92
+ description: Internal Server Error
93
+ headers: {}
94
+ content: {}
95
+ deprecated: false
96
+ /blueprint-model/by-name/{name}/version/{version}:
97
+ get:
98
+ tags:
99
+ - Blueprint Model Catalog
100
+ summary: getBlueprintModelByNameAndVersion
101
+ description: Get Meta-Data of a Blueprint Model by its name and version.
102
+ operationId: getBlueprintModelByNameAndVersion
103
+ parameters:
104
+ - name: name
105
+ in: path
106
+ description: Name of the blueprint model
107
+ required: true
108
+ style: simple
109
+ schema:
110
+ type: string
111
+ example: pnf_netconf
112
+ - name: version
113
+ in: path
114
+ description: Version of the blueprint model
115
+ required: true
116
+ style: simple
117
+ schema:
118
+ type: string
119
+ example: 1.0.0
120
+ responses:
121
+ '200':
122
+ description: OK
123
+ headers: {}
124
+ content:
125
+ application/json:
126
+ schema:
127
+ $ref: '#/components/schemas/BlueprintModelSearch'
128
+ '404':
129
+ description: Not Found
130
+ headers: {}
131
+ content: {}
132
+ deprecated: false
133
+ /blueprint-model/download/by-name/{name}/version/{version}:
134
+ get:
135
+ tags:
136
+ - Blueprint Model Catalog
137
+ summary: downloadBlueprintModelByNameAndVersion
138
+ description: Gets the CBA of a blueprint model by its name and version. Response can be saved to a file to download the CBA.
139
+ operationId: downloadBlueprintModelByNameAndVersion
140
+ parameters:
141
+ - name: name
142
+ in: path
143
+ description: Name of the blueprint model
144
+ required: true
145
+ style: simple
146
+ schema:
147
+ type: string
148
+ example: pnf_netconf
149
+ - name: version
150
+ in: path
151
+ description: Version of the blueprint model
152
+ required: true
153
+ style: simple
154
+ schema:
155
+ type: string
156
+ example: 1.0.0
157
+ responses:
158
+ '200':
159
+ description: OK
160
+ headers: {}
161
+ content:
162
+ application/json:
163
+ schema:
164
+ type: object
165
+ '404':
166
+ description: Not Found
167
+ headers: {}
168
+ content: {}
169
+ deprecated: false
170
+ /blueprint-model/download/{id}:
171
+ get:
172
+ tags:
173
+ - Blueprint Model Catalog
174
+ summary: downloadBlueprintModelByID
175
+ description: Gets the CBA of a blueprint model by its ID. Response can be saved to a file to download the CBA.
176
+ operationId: downloadBlueprintModelByID
177
+ parameters:
178
+ - name: id
179
+ in: path
180
+ description: ID of the blueprint model to download
181
+ required: true
182
+ style: simple
183
+ schema:
184
+ type: string
185
+ example: 67ec1f96-ab55-4b81-aff9-23ee0ed1d7a4
186
+ responses:
187
+ '200':
188
+ description: OK
189
+ headers: {}
190
+ content:
191
+ application/json:
192
+ schema:
193
+ type: object
194
+ '404':
195
+ description: Not Found
196
+ headers: {}
197
+ content: {}
198
+ deprecated: false
199
+ /blueprint-model/enrich:
200
+ post:
201
+ tags:
202
+ - Blueprint Model Catalog
203
+ summary: enrichBlueprintModel
204
+ 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.
205
+ operationId: enrichBlueprintModel
206
+ parameters: []
207
+ requestBody:
208
+ description: 'CBA zip file to be uploaded (example: cba_unenriched.zip)'
209
+ content:
210
+ text/plain:
211
+ schema:
212
+ type: object
213
+ description: 'CBA zip file to be uploaded (example: cba_unenriched.zip)'
214
+ required: true
215
+ responses:
216
+ '200':
217
+ description: successful operation
218
+ headers: {}
219
+ content:
220
+ application/json:
221
+ schema:
222
+ type: object
223
+ deprecated: false
224
+ /blueprint-model/enrichandpublish:
225
+ post:
226
+ tags:
227
+ - Blueprint Model Catalog
228
+ summary: enrichAndPublishBlueprintModel
229
+ description: Enriches the attached CBA, validates it and saves it in CDS if validation was successful.
230
+ operationId: enrichAndPublishBlueprintModel
231
+ parameters: []
232
+ requestBody:
233
+ description: 'Unenriched CBA zip file to be uploaded (example: cba_unenriched.zip)'
234
+ content:
235
+ text/plain:
236
+ schema:
237
+ type: object
238
+ description: 'Unenriched CBA zip file to be uploaded (example: cba_unenriched.zip)'
239
+ required: true
240
+ responses:
241
+ '200':
242
+ description: OK
243
+ headers: {}
244
+ content:
245
+ application/json:
246
+ schema:
247
+ $ref: '#/components/schemas/BlueprintModelSearch'
248
+ '503':
249
+ description: Service Unavailable
250
+ headers: {}
251
+ content: {}
252
+ deprecated: false
253
+ /blueprint-model/meta-data/{keyword}:
254
+ get:
255
+ tags:
256
+ - Blueprint Model Catalog
257
+ summary: getAllBlueprintModelsByKeyword
258
+ 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.
259
+ operationId: getAllBlueprintModelsByKeyword
260
+ parameters:
261
+ - name: keyword
262
+ in: path
263
+ description: Keyword to search for in blueprint model meta-data
264
+ required: true
265
+ style: simple
266
+ schema:
267
+ type: string
268
+ example: pnf_netconf
269
+ responses:
270
+ '200':
271
+ description: successful operation
272
+ headers: {}
273
+ content:
274
+ application/json:
275
+ schema:
276
+ type: array
277
+ items:
278
+ $ref: '#/components/schemas/BlueprintModelSearch'
279
+ description: ''
280
+ deprecated: false
281
+ /blueprint-model/name/{name}/version/{version}:
282
+ delete:
283
+ tags:
284
+ - Blueprint Model Catalog
285
+ summary: deleteBlueprintModelByNameAndVersion
286
+ description: Deletes a blueprint model identified by its name and version from CDS.
287
+ operationId: deleteBlueprintModelByNameAndVersion
288
+ parameters:
289
+ - name: name
290
+ in: path
291
+ description: Name of the blueprint model
292
+ required: true
293
+ style: simple
294
+ schema:
295
+ type: string
296
+ example: pnf_netconf
297
+ - name: version
298
+ in: path
299
+ description: Version of the blueprint model
300
+ required: true
301
+ style: simple
302
+ schema:
303
+ type: string
304
+ example: 1.0.0
305
+ responses:
306
+ '200':
307
+ description: successful operation
308
+ headers: {}
309
+ content:
310
+ application/json:
311
+ schema:
312
+ type: object
313
+ deprecated: false
314
+ /blueprint-model/paged:
315
+ get:
316
+ tags:
317
+ - Blueprint Model Catalog
318
+ summary: getAllBlueprintModelPaged
319
+ description: Lists all blueprint models which are saved in CDS in an ordered mode.
320
+ operationId: getAllBlueprintModelPaged
321
+ parameters:
322
+ - name: limit
323
+ in: query
324
+ description: Maximum number of returned blueprint models
325
+ style: form
326
+ explode: true
327
+ schema:
328
+ type: integer
329
+ format: int32
330
+ default: 20
331
+ - name: offset
332
+ in: query
333
+ description: Offset
334
+ style: form
335
+ explode: true
336
+ schema:
337
+ type: integer
338
+ format: int32
339
+ default: 0
340
+ - name: sort
341
+ in: query
342
+ description: Order of returned blueprint models
343
+ style: form
344
+ explode: true
345
+ schema:
346
+ allOf:
347
+ - $ref: '#/components/schemas/sort1'
348
+ - description: Order of returned blueprint models
349
+ - name: sortType
350
+ in: query
351
+ description: Ascend or descend ordering
352
+ style: form
353
+ explode: true
354
+ schema:
355
+ type: string
356
+ default: ASC
357
+ responses:
358
+ '200':
359
+ description: successful operation
360
+ headers: {}
361
+ content:
362
+ application/json:
363
+ schema:
364
+ $ref: '#/components/schemas/PageBlueprintModelSearch'
365
+ deprecated: false
366
+ /blueprint-model/paged/meta-data/{keyword}:
367
+ get:
368
+ tags:
369
+ - Blueprint Model Catalog
370
+ summary: getAllBlueprintModelsPagedByKeyword
371
+ 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.
372
+ operationId: getAllBlueprintModelsPagedByKeyword
373
+ parameters:
374
+ - name: keyword
375
+ in: path
376
+ description: Keyword to search for in blueprint model meta-data
377
+ required: true
378
+ style: simple
379
+ schema:
380
+ type: string
381
+ example: pnf_netconf
382
+ - name: limit
383
+ in: query
384
+ description: Maximum number of returned blueprint models
385
+ style: form
386
+ explode: true
387
+ schema:
388
+ type: integer
389
+ format: int32
390
+ default: 20
391
+ - name: offset
392
+ in: query
393
+ description: Offset
394
+ style: form
395
+ explode: true
396
+ schema:
397
+ type: integer
398
+ format: int32
399
+ default: 0
400
+ - name: sort
401
+ in: query
402
+ description: Order of returned blueprint models
403
+ style: form
404
+ explode: true
405
+ schema:
406
+ allOf:
407
+ - $ref: '#/components/schemas/sort1'
408
+ - description: Order of returned blueprint models
409
+ - name: sortType
410
+ in: query
411
+ description: Ascend or descend ordering
412
+ style: form
413
+ explode: true
414
+ schema:
415
+ type: string
416
+ default: ASC
417
+ responses:
418
+ '200':
419
+ description: successful operation
420
+ headers: {}
421
+ content:
422
+ application/json:
423
+ schema:
424
+ $ref: '#/components/schemas/PageBlueprintModelSearch'
425
+ deprecated: false
426
+ /blueprint-model/publish:
427
+ post:
428
+ tags:
429
+ - Blueprint Model Catalog
430
+ summary: publishBlueprintModel
431
+ description: Validates the attached CBA file and saves it in CDS if validation was successful. CBA needs to be already enriched.
432
+ operationId: publishBlueprintModel
433
+ parameters: []
434
+ requestBody:
435
+ description: 'Enriched CBA zip file to be uploaded (example: cba_enriched.zip)'
436
+ content:
437
+ text/plain:
438
+ schema:
439
+ type: object
440
+ description: 'Enriched CBA zip file to be uploaded (example: cba_enriched.zip)'
441
+ required: true
442
+ responses:
443
+ '200':
444
+ description: successful operation
445
+ headers: {}
446
+ content:
447
+ application/json:
448
+ schema:
449
+ $ref: '#/components/schemas/BlueprintModelSearch'
450
+ deprecated: false
451
+ /blueprint-model/search/{tags}:
452
+ get:
453
+ tags:
454
+ - Blueprint Model Catalog
455
+ summary: searchBlueprintModelsByTags
456
+ 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.
457
+ operationId: searchBlueprintModelsByTags
458
+ parameters:
459
+ - name: tags
460
+ in: path
461
+ description: Tag to search for
462
+ required: true
463
+ style: simple
464
+ schema:
465
+ type: string
466
+ example: test
467
+ responses:
468
+ '200':
469
+ description: successful operation
470
+ headers: {}
471
+ content:
472
+ application/json:
473
+ schema:
474
+ type: array
475
+ items:
476
+ $ref: '#/components/schemas/BlueprintModelSearch'
477
+ description: ''
478
+ deprecated: false
479
+ /blueprint-model/workflow-spec:
480
+ post:
481
+ tags:
482
+ - Blueprint Model Catalog
483
+ summary: getWorkflowSpecification
484
+ description: Get the workflow of a blueprint identified by Blueprint and workflow name. Inputs, outputs and data types of workflow is returned.
485
+ operationId: getWorkflowSpecification
486
+ parameters: []
487
+ requestBody:
488
+ description: Blueprint and workflow identification
489
+ content:
490
+ application/json:
491
+ schema:
492
+ allOf:
493
+ - $ref: '#/components/schemas/WorkFlowSpecRequest'
494
+ - description: Blueprint and workflow identification
495
+ required: true
496
+ responses:
497
+ '200':
498
+ description: successful operation
499
+ headers: {}
500
+ content:
501
+ application/json:
502
+ schema:
503
+ type: object
504
+ deprecated: false
505
+ /blueprint-model/workflows/blueprint-name/{name}/version/{version}:
506
+ get:
507
+ tags:
508
+ - Blueprint Model Catalog
509
+ summary: getBlueprintWorkflowsByNameAndVersion
510
+ description: Get all available workflows of a Blueprint identified by its name and version.
511
+ operationId: getBlueprintWorkflowsByNameAndVersion
512
+ parameters:
513
+ - name: name
514
+ in: path
515
+ description: Name of the blueprint model
516
+ required: true
517
+ style: simple
518
+ schema:
519
+ type: string
520
+ example: pnf_netconf
521
+ - name: version
522
+ in: path
523
+ description: Version of the blueprint model
524
+ required: true
525
+ style: simple
526
+ schema:
527
+ type: string
528
+ example: 1.0.0
529
+ responses:
530
+ '200':
531
+ description: successful operation
532
+ headers: {}
533
+ content:
534
+ application/json:
535
+ schema:
536
+ type: object
537
+ deprecated: false
538
+ /blueprint-model/{id}:
539
+ get:
540
+ tags:
541
+ - Blueprint Model Catalog
542
+ summary: getBlueprintModelByID
543
+ description: Get meta-data of a blueprint model by its internally created ID.
544
+ operationId: getBlueprintModelByID
545
+ parameters:
546
+ - name: id
547
+ in: path
548
+ description: ID of the blueprint model to search for
549
+ required: true
550
+ style: simple
551
+ schema:
552
+ type: string
553
+ example: 67ec1f96-ab55-4b81-aff9-23ee0ed1d7a4
554
+ responses:
555
+ '200':
556
+ description: OK
557
+ headers: {}
558
+ content:
559
+ application/json:
560
+ schema:
561
+ $ref: '#/components/schemas/BlueprintModelSearch'
562
+ '404':
563
+ description: Not Found
564
+ headers: {}
565
+ content: {}
566
+ deprecated: false
567
+ delete:
568
+ tags:
569
+ - Blueprint Model Catalog
570
+ summary: deleteBlueprintModelByID
571
+ description: Delete a blueprint model by its ID. ID is the internally created ID of blueprint, not the name of blueprint.
572
+ operationId: deleteBlueprintModelByID
573
+ parameters:
574
+ - name: id
575
+ in: path
576
+ description: ID of the blueprint model to delete
577
+ required: true
578
+ style: simple
579
+ schema:
580
+ type: string
581
+ example: 67ec1f96-ab55-4b81-aff9-23ee0ed1d7a4
582
+ responses:
583
+ '200':
584
+ description: OK
585
+ headers: {}
586
+ content:
587
+ application/json:
588
+ schema:
589
+ type: object
590
+ '404':
591
+ description: RESOURCE_NOT_FOUND
592
+ headers: {}
593
+ content: {}
594
+ deprecated: false
595
+ /execution-service/process:
596
+ post:
597
+ tags:
598
+ - Execution Service Catalog
599
+ summary: executeCBAWorkflowAction
600
+ description: Execute the appropriate CBA's action based on the ExecutionServiceInput object passed as input.
601
+ operationId: executeCBAWorkflowAction
602
+ parameters: []
603
+ requestBody:
604
+ description: ExecutionServiceInput payload.
605
+ content:
606
+ application/json:
607
+ schema:
608
+ allOf:
609
+ - $ref: '#/components/schemas/ExecutionServiceInput'
610
+ - description: ExecutionServiceInput payload.
611
+ required: true
612
+ responses:
613
+ '200':
614
+ description: successful operation
615
+ headers: {}
616
+ content:
617
+ application/json:
618
+ schema:
619
+ $ref: '#/components/schemas/ExecutionServiceOutput'
620
+ deprecated: false
621
+ /model-type/by-definition/{definitionType}:
622
+ get:
623
+ tags:
624
+ - Model Type Catalog
625
+ summary: getModelTypeByDefinitionType
626
+ description: Retrieve a list of model types by definition type provided.
627
+ operationId: getModelTypeByDefinitionType
628
+ parameters:
629
+ - name: definitionType
630
+ in: path
631
+ description: ''
632
+ required: true
633
+ style: simple
634
+ schema:
635
+ type: string
636
+ responses:
637
+ '200':
638
+ description: successful operation
639
+ headers: {}
640
+ content:
641
+ application/json:
642
+ schema:
643
+ type: array
644
+ items:
645
+ $ref: '#/components/schemas/ModelType'
646
+ description: ''
647
+ deprecated: false
648
+ /model-type/search/{tags}:
649
+ get:
650
+ tags:
651
+ - Model Type Catalog
652
+ summary: searchModelTypesByTags
653
+ description: Retrieve a list of model types by tags provided.
654
+ operationId: searchModelTypesByTags
655
+ parameters:
656
+ - name: tags
657
+ in: path
658
+ description: ''
659
+ required: true
660
+ style: simple
661
+ schema:
662
+ type: string
663
+ responses:
664
+ '200':
665
+ description: successful operation
666
+ headers: {}
667
+ content:
668
+ application/json:
669
+ schema:
670
+ type: array
671
+ items:
672
+ $ref: '#/components/schemas/ModelType'
673
+ description: ''
674
+ deprecated: false
675
+ /model-type/{name}:
676
+ get:
677
+ tags:
678
+ - Model Type Catalog
679
+ summary: getModelTypeByName
680
+ description: Retrieve a model type by name provided.
681
+ operationId: getModelTypeByName
682
+ parameters:
683
+ - name: name
684
+ in: path
685
+ description: ''
686
+ required: true
687
+ style: simple
688
+ schema:
689
+ type: string
690
+ responses:
691
+ '200':
692
+ description: successful operation
693
+ headers: {}
694
+ content:
695
+ application/json:
696
+ schema:
697
+ $ref: '#/components/schemas/ModelType'
698
+ deprecated: false
699
+ delete:
700
+ tags:
701
+ - Model Type Catalog
702
+ summary: deleteModelTypeByName
703
+ description: Remove a model type by name provided.
704
+ operationId: deleteModelTypeByName
705
+ parameters:
706
+ - name: name
707
+ in: path
708
+ description: ''
709
+ required: true
710
+ style: simple
711
+ schema:
712
+ type: string
713
+ responses:
714
+ '200':
715
+ description: successful operation
716
+ headers: {}
717
+ content:
718
+ application/json:
719
+ schema:
720
+ $ref: '#/components/schemas/ModelType'
721
+ deprecated: false
722
+ /configs:
723
+ get:
724
+ tags:
725
+ - Resource configuration
726
+ summary: getResourceConfigSnapshot
727
+ 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.
728
+ operationId: getResourceConfigSnapshot
729
+ parameters:
730
+ - name: resourceType
731
+ in: query
732
+ description: Resource Type associated of the resource configuration snapshot
733
+ required: true
734
+ style: form
735
+ explode: true
736
+ schema:
737
+ type: string
738
+ example: '"PNF"'
739
+ - name: resourceId
740
+ in: query
741
+ description: Resource Id associated of the resource configuration snapshot
742
+ required: true
743
+ style: form
744
+ explode: true
745
+ schema:
746
+ type: string
747
+ example: '"1"'
748
+ - name: status
749
+ in: query
750
+ description: Status of the snapshot being retrieved
751
+ style: form
752
+ explode: true
753
+ schema:
754
+ type: string
755
+ default: RUNNING
756
+ - name: format
757
+ in: query
758
+ description: Expected format of the snapshot being retrieved
759
+ style: form
760
+ explode: true
761
+ schema:
762
+ type: string
763
+ default: text/plain
764
+ responses:
765
+ '200':
766
+ description: successful operation
767
+ headers: {}
768
+ content:
769
+ text/plain:
770
+ schema:
771
+ type: string
772
+ application/json:
773
+ schema:
774
+ type: string
775
+ application/xml:
776
+ schema:
777
+ type: string
778
+ xml:
779
+ name: response
780
+ attribute: false
781
+ wrapped: false
782
+ deprecated: false
783
+ /configs/allByID:
784
+ get:
785
+ tags:
786
+ - Resource configuration
787
+ summary: getAllConfigSnapshotsByID
788
+ description: 'Retrieve all config snapshots, identified by its Resource Id, ordered by most recently created/modified date. '
789
+ operationId: getAllConfigSnapshotsByID
790
+ parameters:
791
+ - name: resourceId
792
+ in: query
793
+ description: Resource Id associated of the resource configuration snapshots
794
+ required: true
795
+ style: form
796
+ explode: true
797
+ schema:
798
+ type: string
799
+ example: '"1"'
800
+ - name: status
801
+ in: query
802
+ description: Status of the snapshot being retrieved
803
+ style: form
804
+ explode: true
805
+ schema:
806
+ type: string
807
+ default: ANY
808
+ responses:
809
+ '200':
810
+ description: successful operation
811
+ headers: {}
812
+ content:
813
+ application/json:
814
+ schema:
815
+ type: array
816
+ items:
817
+ $ref: '#/components/schemas/ResourceConfigSnapshot'
818
+ description: ''
819
+ deprecated: false
820
+ /configs/allByType:
821
+ get:
822
+ tags:
823
+ - Resource configuration
824
+ summary: getAllConfigSnapshotsByType
825
+ description: 'Retrieve all config snapshots matching a specified Resource Type, ordered by most recently created/modified date. '
826
+ operationId: getAllConfigSnapshotsByType
827
+ parameters:
828
+ - name: resourceType
829
+ in: query
830
+ description: Resource Type associated of the resource configuration snapshot
831
+ required: true
832
+ style: form
833
+ explode: true
834
+ schema:
835
+ type: string
836
+ example: '"PNF"'
837
+ - name: status
838
+ in: query
839
+ description: Status of the snapshot being retrieved
840
+ style: form
841
+ explode: true
842
+ schema:
843
+ type: string
844
+ default: ANY
845
+ responses:
846
+ '200':
847
+ description: successful operation
848
+ headers: {}
849
+ content:
850
+ application/json:
851
+ schema:
852
+ type: array
853
+ items:
854
+ $ref: '#/components/schemas/ResourceConfigSnapshot'
855
+ description: ''
856
+ deprecated: false
857
+ /configs/{resourceType}/{resourceId}/{status}:
858
+ post:
859
+ tags:
860
+ - Resource configuration
861
+ summary: storeConfigSnapshotByResourceIdAndResourceType
862
+ description: Store a resource configuration snapshot, identified by its resourceId and resourceType, and optionally its status, either RUNNING or CANDIDATE.
863
+ operationId: storeConfigSnapshotByResourceIdAndResourceType
864
+ parameters:
865
+ - name: resourceType
866
+ in: path
867
+ description: Resource Type associated with the resolution
868
+ required: true
869
+ style: simple
870
+ schema:
871
+ type: string
872
+ example: '"PNF"'
873
+ - name: resourceId
874
+ in: path
875
+ description: Resource Id associated with the resolution
876
+ required: true
877
+ style: simple
878
+ schema:
879
+ type: string
880
+ example: '"1"'
881
+ - name: status
882
+ in: path
883
+ description: Status of the snapshot being retrieved
884
+ required: true
885
+ style: simple
886
+ schema:
887
+ type: string
888
+ requestBody:
889
+ description: Config snapshot to store
890
+ content:
891
+ text/plain:
892
+ schema:
893
+ type: string
894
+ description: Config snapshot to store
895
+ required: true
896
+ responses:
897
+ '200':
898
+ description: successful operation
899
+ headers: {}
900
+ content:
901
+ application/json:
902
+ schema:
903
+ $ref: '#/components/schemas/ResourceConfigSnapshot'
904
+ deprecated: false
905
+ delete:
906
+ tags:
907
+ - Resource configuration
908
+ summary: deleteConfigSnapshotByResourceIdAndResourceType
909
+ description: Delete a resource configuration snapshot, identified by its resourceId and resourceType, and optionally its status, either RUNNING or CANDIDATE.
910
+ operationId: deleteConfigSnapshotByResourceIdAndResourceType
911
+ parameters:
912
+ - name: resourceType
913
+ in: path
914
+ description: Resource Type associated with the resolution.
915
+ required: true
916
+ style: simple
917
+ schema:
918
+ type: string
919
+ - name: resourceId
920
+ in: path
921
+ description: Resource Id associated with the resolution.
922
+ required: true
923
+ style: simple
924
+ schema:
925
+ type: string
926
+ - name: status
927
+ in: path
928
+ description: Status of the snapshot being deleted.
929
+ required: true
930
+ style: simple
931
+ schema:
932
+ type: string
933
+ responses:
934
+ '200':
935
+ description: successful operation
936
+ headers: {}
937
+ content:
938
+ application/json:
939
+ schema:
940
+ type: object
941
+ deprecated: false
942
+ /dictionary:
943
+ post:
944
+ tags:
945
+ - Resource Dictionary
946
+ summary: saveResourceDictionary
947
+ description: Save a resource dictionary by dictionary provided.
948
+ operationId: saveResourceDictionary
949
+ parameters: []
950
+ requestBody:
951
+ description: Resource dictionary to store
952
+ content:
953
+ application/json:
954
+ schema:
955
+ allOf:
956
+ - $ref: '#/components/schemas/ResourceDictionary'
957
+ - description: Resource dictionary to store
958
+ required: true
959
+ responses:
960
+ '200':
961
+ description: successful operation
962
+ headers: {}
963
+ content:
964
+ application/json:
965
+ schema:
966
+ $ref: '#/components/schemas/ResourceDictionary'
967
+ deprecated: false
968
+ /dictionary/by-names:
969
+ post:
970
+ tags:
971
+ - Resource Dictionary
972
+ summary: searchResourceDictionaryByNames
973
+ description: Search for a resource dictionary by names provided.
974
+ operationId: searchResourceDictionaryByNames
975
+ parameters: []
976
+ requestBody:
977
+ description: List of names
978
+ content:
979
+ application/json:
980
+ schema:
981
+ type: array
982
+ items:
983
+ type: string
984
+ description: List of names
985
+ required: true
986
+ responses:
987
+ '200':
988
+ description: successful operation
989
+ headers: {}
990
+ content:
991
+ application/json:
992
+ schema:
993
+ type: array
994
+ items:
995
+ $ref: '#/components/schemas/ResourceDictionary'
996
+ description: ''
997
+ deprecated: false
998
+ /dictionary/definition:
999
+ post:
1000
+ tags:
1001
+ - Resource Dictionary
1002
+ summary: saveResourceDictionaryByDefinition
1003
+ description: Save a resource dictionary by provided resource definition json.
1004
+ operationId: saveResourceDictionaryByDefinition
1005
+ parameters: []
1006
+ requestBody:
1007
+ description: Resource definition to generate Resource Dictionary
1008
+ content:
1009
+ application/json:
1010
+ schema:
1011
+ allOf:
1012
+ - $ref: '#/components/schemas/ResourceDefinition'
1013
+ - description: Resource definition to generate Resource Dictionary
1014
+ required: true
1015
+ responses:
1016
+ '200':
1017
+ description: successful operation
1018
+ headers: {}
1019
+ content:
1020
+ application/json:
1021
+ schema:
1022
+ $ref: '#/components/schemas/ResourceDictionary'
1023
+ deprecated: false
1024
+ /dictionary/definition-bulk:
1025
+ post:
1026
+ tags:
1027
+ - Resource Dictionary
1028
+ summary: saveMultipleDictionariesByDefinition
1029
+ description: Save multiple resource dictionaries by provided resource definition json array.
1030
+ operationId: saveMultipleDictionariesByDefinition
1031
+ parameters: []
1032
+ requestBody:
1033
+ description: Resource definition json array to generate Resource Dictionaries
1034
+ content:
1035
+ application/json:
1036
+ schema:
1037
+ type: array
1038
+ items:
1039
+ $ref: '#/components/schemas/ResourceDefinition'
1040
+ description: Resource definition json array to generate Resource Dictionaries
1041
+ required: true
1042
+ responses:
1043
+ '200':
1044
+ description: successful operation
1045
+ headers: {}
1046
+ content:
1047
+ application/json:
1048
+ schema:
1049
+ $ref: '#/components/schemas/ResourceDictionary'
1050
+ deprecated: false
1051
+ /dictionary/paged:
1052
+ get:
1053
+ tags:
1054
+ - Resource Dictionary
1055
+ summary: getAllBlueprintDictionaryPaged
1056
+ description: Lists all blueprint Dictionary which are saved in CDS in an ordered mode.
1057
+ operationId: getAllBlueprintDictionaryPaged
1058
+ parameters:
1059
+ - name: limit
1060
+ in: query
1061
+ description: Maximum number of returned blueprint dictionary
1062
+ style: form
1063
+ explode: true
1064
+ schema:
1065
+ type: integer
1066
+ format: int32
1067
+ default: 20
1068
+ - name: offset
1069
+ in: query
1070
+ description: Offset
1071
+ style: form
1072
+ explode: true
1073
+ schema:
1074
+ type: integer
1075
+ format: int32
1076
+ default: 0
1077
+ - name: sort
1078
+ in: query
1079
+ description: Order of returned blueprint dictionary
1080
+ style: form
1081
+ explode: true
1082
+ schema:
1083
+ allOf:
1084
+ - $ref: '#/components/schemas/sort3'
1085
+ - description: Order of returned blueprint dictionary
1086
+ - name: sortType
1087
+ in: query
1088
+ description: Ascend or descend ordering
1089
+ style: form
1090
+ explode: true
1091
+ schema:
1092
+ type: string
1093
+ default: ASC
1094
+ responses:
1095
+ '200':
1096
+ description: successful operation
1097
+ headers: {}
1098
+ content:
1099
+ application/json:
1100
+ schema:
1101
+ type: object
1102
+ deprecated: false
1103
+ /dictionary/resource_dictionary_group:
1104
+ get:
1105
+ tags:
1106
+ - Resource Dictionary
1107
+ summary: getAllResourceDictionaryGroups
1108
+ description: Retrieve all resource dictionary groups.
1109
+ operationId: getAllResourceDictionaryGroups
1110
+ parameters: []
1111
+ responses:
1112
+ '200':
1113
+ description: successful operation
1114
+ headers: {}
1115
+ content:
1116
+ application/json:
1117
+ schema:
1118
+ type: array
1119
+ items:
1120
+ type: string
1121
+ description: ''
1122
+ deprecated: false
1123
+ /dictionary/search/{tags}:
1124
+ get:
1125
+ tags:
1126
+ - Resource Dictionary
1127
+ summary: searchResourceDictionaryByTags
1128
+ description: Search for a resource dictionary by tags provided.
1129
+ operationId: searchResourceDictionaryByTags
1130
+ parameters:
1131
+ - name: tags
1132
+ in: path
1133
+ description: Tags list
1134
+ required: true
1135
+ style: simple
1136
+ schema:
1137
+ type: string
1138
+ example: '"status"'
1139
+ responses:
1140
+ '200':
1141
+ description: successful operation
1142
+ headers: {}
1143
+ content:
1144
+ application/json:
1145
+ schema:
1146
+ type: array
1147
+ items:
1148
+ $ref: '#/components/schemas/ResourceDictionary'
1149
+ description: ''
1150
+ deprecated: false
1151
+ /dictionary/source-mapping:
1152
+ get:
1153
+ tags:
1154
+ - Resource Dictionary
1155
+ summary: getSourceMapping
1156
+ description: Search for a source mapping.
1157
+ operationId: getSourceMapping
1158
+ parameters: []
1159
+ responses:
1160
+ '200':
1161
+ description: successful operation
1162
+ headers: {}
1163
+ content:
1164
+ application/json:
1165
+ schema:
1166
+ $ref: '#/components/schemas/ResourceSourceMapping'
1167
+ deprecated: false
1168
+ /dictionary/{name}:
1169
+ get:
1170
+ tags:
1171
+ - Resource Dictionary
1172
+ summary: getResourceDictionaryByName
1173
+ description: Retrieve a resource dictionary by name provided.
1174
+ operationId: getResourceDictionaryByName
1175
+ parameters:
1176
+ - name: name
1177
+ in: path
1178
+ description: Name of the resource
1179
+ required: true
1180
+ style: simple
1181
+ schema:
1182
+ type: string
1183
+ example: '"hostname"'
1184
+ responses:
1185
+ '200':
1186
+ description: successful operation
1187
+ headers: {}
1188
+ content:
1189
+ application/json:
1190
+ schema:
1191
+ $ref: '#/components/schemas/ResourceDictionary'
1192
+ deprecated: false
1193
+ delete:
1194
+ tags:
1195
+ - Resource Dictionary
1196
+ summary: deleteResourceDictionaryByName
1197
+ description: Remove a resource dictionary by name provided.
1198
+ operationId: deleteResourceDictionaryByName
1199
+ parameters:
1200
+ - name: name
1201
+ in: path
1202
+ description: Name of the resource
1203
+ required: true
1204
+ style: simple
1205
+ schema:
1206
+ type: string
1207
+ responses:
1208
+ '200':
1209
+ description: successful operation
1210
+ headers: {}
1211
+ content:
1212
+ application/json:
1213
+ schema:
1214
+ type: object
1215
+ deprecated: false
1216
+ /template/occurrences:
1217
+ get:
1218
+ tags:
1219
+ - Resource Template
1220
+ summary: getTemplatesWithOccurrences
1221
+ 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.
1222
+ operationId: getTemplatesWithOccurrences
1223
+ parameters:
1224
+ - name: bpName
1225
+ in: query
1226
+ description: Name of the CBA.
1227
+ required: true
1228
+ style: form
1229
+ explode: true
1230
+ schema:
1231
+ type: string
1232
+ - name: bpVersion
1233
+ in: query
1234
+ description: Version of the CBA.
1235
+ required: true
1236
+ style: form
1237
+ explode: true
1238
+ schema:
1239
+ type: string
1240
+ - name: artifactName
1241
+ in: query
1242
+ description: Artifact name for which to retrieve a resolved resource.
1243
+ required: true
1244
+ style: form
1245
+ explode: true
1246
+ schema:
1247
+ type: string
1248
+ - name: resolutionKey
1249
+ in: query
1250
+ description: Resolution Key associated with the resolution.
1251
+ required: true
1252
+ style: form
1253
+ explode: true
1254
+ schema:
1255
+ type: string
1256
+ - name: firstN
1257
+ in: query
1258
+ description: Number of earlier N occurrences of the templates.
1259
+ style: form
1260
+ explode: true
1261
+ schema:
1262
+ type: integer
1263
+ format: int32
1264
+ - name: lastN
1265
+ in: query
1266
+ description: Number of latest N occurrences of the templates.
1267
+ style: form
1268
+ explode: true
1269
+ schema:
1270
+ type: integer
1271
+ format: int32
1272
+ - name: begin
1273
+ in: query
1274
+ description: For Range option - 'begin' is the start occurrence of range of the templates.
1275
+ style: form
1276
+ explode: true
1277
+ schema:
1278
+ type: integer
1279
+ format: int32
1280
+ - name: end
1281
+ in: query
1282
+ description: For Range option - 'end' is the end occurrence of the range of the templates.
1283
+ style: form
1284
+ explode: true
1285
+ schema:
1286
+ type: integer
1287
+ format: int32
1288
+ responses:
1289
+ '200':
1290
+ description: successful operation
1291
+ headers: {}
1292
+ content:
1293
+ application/json:
1294
+ schema:
1295
+ type: array
1296
+ items:
1297
+ $ref: '#/components/schemas/TemplateResolution'
1298
+ description: ''
1299
+ deprecated: false
1300
+ /template/{bpName}/{bpVersion}/{artifactName}/{resolutionKey}:
1301
+ post:
1302
+ tags:
1303
+ - Resource Template
1304
+ summary: storeTemplateWithResolutionKey
1305
+ description: Store a template for a given CBA's action, identified by its blueprint name, blueprint version, artifact name and resolution key.
1306
+ operationId: storeTemplateWithResolutionKey
1307
+ parameters:
1308
+ - name: bpName
1309
+ in: path
1310
+ description: Name of the CBA
1311
+ required: true
1312
+ style: simple
1313
+ schema:
1314
+ type: string
1315
+ - name: bpVersion
1316
+ in: path
1317
+ description: Version of the CBA
1318
+ required: true
1319
+ style: simple
1320
+ schema:
1321
+ type: string
1322
+ - name: artifactName
1323
+ in: path
1324
+ description: Artifact name for which to retrieve a resolved resource
1325
+ required: true
1326
+ style: simple
1327
+ schema:
1328
+ type: string
1329
+ - name: resolutionKey
1330
+ in: path
1331
+ description: Resolution Key associated with the resolution
1332
+ required: true
1333
+ style: simple
1334
+ schema:
1335
+ type: string
1336
+ requestBody:
1337
+ description: Template to store
1338
+ content:
1339
+ text/plain:
1340
+ schema:
1341
+ type: string
1342
+ description: Template to store
1343
+ required: true
1344
+ responses:
1345
+ '200':
1346
+ description: successful operation
1347
+ headers: {}
1348
+ content:
1349
+ application/json:
1350
+ schema:
1351
+ $ref: '#/components/schemas/TemplateResolution'
1352
+ deprecated: false
1353
+ /template/{bpName}/{bpVersion}/{artifactName}/{resourceType}/{resourceId}:
1354
+ post:
1355
+ tags:
1356
+ - Resource Template
1357
+ summary: storeTemplateWithResourceIdAndResourceType
1358
+ description: Store a template for a given CBA's action, identified by its blueprint name, blueprint version, artifact name, resourceId and resourceType.
1359
+ operationId: storeTemplateWithResourceIdAndResourceType
1360
+ parameters:
1361
+ - name: bpName
1362
+ in: path
1363
+ description: Name of the CBA
1364
+ required: true
1365
+ style: simple
1366
+ schema:
1367
+ type: string
1368
+ - name: bpVersion
1369
+ in: path
1370
+ description: Version of the CBA
1371
+ required: true
1372
+ style: simple
1373
+ schema:
1374
+ type: string
1375
+ - name: artifactName
1376
+ in: path
1377
+ description: Artifact name for which to retrieve a resolved resource
1378
+ required: true
1379
+ style: simple
1380
+ schema:
1381
+ type: string
1382
+ - name: resourceType
1383
+ in: path
1384
+ description: Resource Type associated with the resolution
1385
+ required: true
1386
+ style: simple
1387
+ schema:
1388
+ type: string
1389
+ - name: resourceId
1390
+ in: path
1391
+ description: Resource Id associated with the resolution
1392
+ required: true
1393
+ style: simple
1394
+ schema:
1395
+ type: string
1396
+ requestBody:
1397
+ description: Template to store
1398
+ content:
1399
+ text/plain:
1400
+ schema:
1401
+ type: string
1402
+ description: Template to store
1403
+ required: true
1404
+ responses:
1405
+ '200':
1406
+ description: successful operation
1407
+ headers: {}
1408
+ content:
1409
+ application/json:
1410
+ schema:
1411
+ $ref: '#/components/schemas/TemplateResolution'
1412
+ deprecated: false
1413
+ /resources:
1414
+ get:
1415
+ tags:
1416
+ - Resources
1417
+ summary: getAllResourcesUsingResolutionKey
1418
+ description: Retrieve all stored resolved resources using the blueprint name, blueprint version, artifact name and the resolution-key.
1419
+ operationId: getAllResourcesUsingResolutionKey
1420
+ parameters:
1421
+ - name: bpName
1422
+ in: query
1423
+ description: Name of the CBA
1424
+ required: true
1425
+ style: form
1426
+ explode: true
1427
+ schema:
1428
+ type: string
1429
+ - name: bpVersion
1430
+ in: query
1431
+ description: Version of the CBA
1432
+ required: true
1433
+ style: form
1434
+ explode: true
1435
+ schema:
1436
+ type: string
1437
+ - name: artifactName
1438
+ in: query
1439
+ description: Artifact name for which to retrieve a resolved resource
1440
+ required: true
1441
+ style: form
1442
+ explode: true
1443
+ schema:
1444
+ type: string
1445
+ - name: resolutionKey
1446
+ in: query
1447
+ description: Resolution Key associated with the resolution
1448
+ style: form
1449
+ explode: true
1450
+ schema:
1451
+ type: string
1452
+ - name: resourceType
1453
+ in: query
1454
+ description: Resource Type associated with the resolution
1455
+ style: form
1456
+ explode: true
1457
+ schema:
1458
+ type: string
1459
+ - name: resourceId
1460
+ in: query
1461
+ description: Resource Id associated with the resolution
1462
+ style: form
1463
+ explode: true
1464
+ schema:
1465
+ type: string
1466
+ responses:
1467
+ '200':
1468
+ description: successful operation
1469
+ headers: {}
1470
+ content:
1471
+ application/json:
1472
+ schema:
1473
+ type: array
1474
+ items:
1475
+ $ref: '#/components/schemas/ResourceResolution'
1476
+ description: ''
1477
+ deprecated: false
1478
+ delete:
1479
+ tags:
1480
+ - Resources
1481
+ summary: deleteAllResourcesUsingResolutionKey
1482
+ description: Delete all the resources associated to a resolution-key using blueprint metadata, artifact name and the resolution-key.
1483
+ operationId: deleteAllResourcesUsingResolutionKey
1484
+ parameters:
1485
+ - name: bpName
1486
+ in: query
1487
+ description: Name of the CBA
1488
+ required: true
1489
+ style: form
1490
+ explode: true
1491
+ schema:
1492
+ type: string
1493
+ - name: bpVersion
1494
+ in: query
1495
+ description: Version of the CBA
1496
+ required: true
1497
+ style: form
1498
+ explode: true
1499
+ schema:
1500
+ type: string
1501
+ - name: artifactName
1502
+ in: query
1503
+ description: Artifact name for which to retrieve a resolved resource
1504
+ required: true
1505
+ style: form
1506
+ explode: true
1507
+ schema:
1508
+ type: string
1509
+ - name: resolutionKey
1510
+ in: query
1511
+ description: Resolution Key associated with the resolution
1512
+ style: form
1513
+ explode: true
1514
+ schema:
1515
+ type: string
1516
+ - name: resourceType
1517
+ in: query
1518
+ description: resourceType associated with the resolution, must be used with resourceId
1519
+ style: form
1520
+ explode: true
1521
+ schema:
1522
+ type: string
1523
+ - name: resourceId
1524
+ in: query
1525
+ description: Resolution Key associated with the resolution, must be used with resourceType
1526
+ style: form
1527
+ explode: true
1528
+ schema:
1529
+ type: string
1530
+ - name: lastN
1531
+ in: query
1532
+ description: Only delete last N occurrences
1533
+ style: form
1534
+ explode: true
1535
+ schema:
1536
+ type: integer
1537
+ format: int32
1538
+ responses:
1539
+ '200':
1540
+ description: successful operation
1541
+ headers: {}
1542
+ content:
1543
+ application/json:
1544
+ schema:
1545
+ type: object
1546
+ deprecated: false
1547
+ /resources/occurrences:
1548
+ get:
1549
+ tags:
1550
+ - Resources
1551
+ summary: getResourcesWithOccurrences
1552
+ 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.
1553
+ operationId: getResourcesWithOccurrences
1554
+ parameters:
1555
+ - name: bpName
1556
+ in: query
1557
+ description: Name of the CBA.
1558
+ required: true
1559
+ style: form
1560
+ explode: true
1561
+ schema:
1562
+ type: string
1563
+ - name: bpVersion
1564
+ in: query
1565
+ description: Version of the CBA.
1566
+ required: true
1567
+ style: form
1568
+ explode: true
1569
+ schema:
1570
+ type: string
1571
+ - name: artifactName
1572
+ in: query
1573
+ description: Artifact name for which to retrieve a resolved resource.
1574
+ required: true
1575
+ style: form
1576
+ explode: true
1577
+ schema:
1578
+ type: string
1579
+ - name: resolutionKey
1580
+ in: query
1581
+ description: Resolution Key associated with the resolution.
1582
+ required: true
1583
+ style: form
1584
+ explode: true
1585
+ schema:
1586
+ type: string
1587
+ - name: firstN
1588
+ in: query
1589
+ description: Number of earlier N occurrences of the resolutions.
1590
+ style: form
1591
+ explode: true
1592
+ schema:
1593
+ type: integer
1594
+ format: int32
1595
+ - name: lastN
1596
+ in: query
1597
+ description: Number of latest N occurrences of the resolutions.
1598
+ style: form
1599
+ explode: true
1600
+ schema:
1601
+ type: integer
1602
+ format: int32
1603
+ - name: begin
1604
+ in: query
1605
+ description: For Range option - 'begin' is the start occurrence of range of the resolutions.
1606
+ style: form
1607
+ explode: true
1608
+ schema:
1609
+ type: integer
1610
+ format: int32
1611
+ - name: end
1612
+ in: query
1613
+ description: For Range option - 'end' is the end occurrence of the range of the resolutions.
1614
+ style: form
1615
+ explode: true
1616
+ schema:
1617
+ type: integer
1618
+ format: int32
1619
+ responses:
1620
+ '200':
1621
+ description: successful operation
1622
+ headers: {}
1623
+ content:
1624
+ application/json:
1625
+ schema:
1626
+ type: array
1627
+ items:
1628
+ $ref: '#/components/schemas/ResourceResolution'
1629
+ description: ''
1630
+ deprecated: false
1631
+ /resources/resource:
1632
+ get:
1633
+ tags:
1634
+ - Resources
1635
+ summary: getResourceValueUsingResolutionKey
1636
+ description: Retrieve a stored resource value using the blueprint metadata, artifact name, resolution-key along with the name of the resource value to retrieve.
1637
+ operationId: getResourceValueUsingResolutionKey
1638
+ parameters:
1639
+ - name: bpName
1640
+ in: query
1641
+ description: Name of the CBA
1642
+ required: true
1643
+ style: form
1644
+ explode: true
1645
+ schema:
1646
+ type: string
1647
+ - name: bpVersion
1648
+ in: query
1649
+ description: Version of the CBA
1650
+ required: true
1651
+ style: form
1652
+ explode: true
1653
+ schema:
1654
+ type: string
1655
+ - name: artifactName
1656
+ in: query
1657
+ description: Artifact name for which to retrieve a resolved resource
1658
+ required: true
1659
+ style: form
1660
+ explode: true
1661
+ schema:
1662
+ type: string
1663
+ - name: resolutionKey
1664
+ in: query
1665
+ description: Resolution Key associated with the resolution
1666
+ required: true
1667
+ style: form
1668
+ explode: true
1669
+ schema:
1670
+ type: string
1671
+ - name: name
1672
+ in: query
1673
+ description: Name of the resource to retrieve
1674
+ required: true
1675
+ style: form
1676
+ explode: true
1677
+ schema:
1678
+ type: string
1679
+ responses:
1680
+ '200':
1681
+ description: successful operation
1682
+ headers: {}
1683
+ content:
1684
+ application/json:
1685
+ schema:
1686
+ type: object
1687
+ deprecated: false
1688
+ components:
1689
+ schemas:
1690
+ ActionIdentifiers:
1691
+ title: ActionIdentifiers
1692
+ required:
1693
+ - actionName
1694
+ - mode
1695
+ type: object
1696
+ properties:
1697
+ blueprintName:
1698
+ type: string
1699
+ description: Name of the CBA.
1700
+ blueprintVersion:
1701
+ type: string
1702
+ description: Version of the CBA.
1703
+ actionName:
1704
+ type: string
1705
+ description: Name of the workflow to execute.
1706
+ mode:
1707
+ allOf:
1708
+ - $ref: '#/components/schemas/Mode'
1709
+ - description: Async processing is only supported for gRPC client.
1710
+ ArtifactDefinition:
1711
+ title: ArtifactDefinition
1712
+ type: object
1713
+ properties:
1714
+ type:
1715
+ type: string
1716
+ file:
1717
+ type: string
1718
+ repository:
1719
+ type: string
1720
+ description:
1721
+ type: string
1722
+ properties:
1723
+ type: object
1724
+ additionalProperties:
1725
+ $ref: '#/components/schemas/JsonNode'
1726
+ deploy_Path:
1727
+ type: string
1728
+ BlueprintModelSearch:
1729
+ title: BlueprintModelSearch
1730
+ required:
1731
+ - id
1732
+ - artifactVersion
1733
+ - createdDate
1734
+ - artifactName
1735
+ - published
1736
+ - updatedBy
1737
+ - tags
1738
+ type: object
1739
+ properties:
1740
+ id:
1741
+ type: string
1742
+ description: ID of Blueprint model, is automatically created by CDS
1743
+ example: 658f9a48-7f54-41ba-ae18-c69f26f3dc94
1744
+ artifactUUId:
1745
+ type: string
1746
+ description: Artifact UUID, usually null
1747
+ artifactType:
1748
+ type: string
1749
+ description: Artifact Type, usually null
1750
+ example: SDNC_MODEL
1751
+ artifactVersion:
1752
+ type: string
1753
+ description: Artifact Version, usually 1.0.0
1754
+ example: 1.0.0
1755
+ artifactDescription:
1756
+ type: string
1757
+ description: Artifact Description, usually empty
1758
+ internalVersion:
1759
+ type: integer
1760
+ description: Internal Version of CBA, usually null
1761
+ format: int32
1762
+ createdDate:
1763
+ type: string
1764
+ description: Datetime of the creation of CBA in CDS
1765
+ format: date-time
1766
+ example: 2020-11-19T10:34:56.000Z
1767
+ artifactName:
1768
+ type: string
1769
+ description: Artifact Name, defined in Metadata
1770
+ example: pnf_netconf
1771
+ published:
1772
+ type: string
1773
+ description: Artifact Name, defined in Metadata
1774
+ example: pnf_netconf
1775
+ updatedBy:
1776
+ type: string
1777
+ description: Name of publisher, defined in Metadata
1778
+ example: Deutsche Telekom AG
1779
+ tags:
1780
+ type: string
1781
+ description: Tags to identify the CBA, defined in Metadata
1782
+ example: test
1783
+ BootstrapRequest:
1784
+ title: BootstrapRequest
1785
+ required:
1786
+ - loadModelType
1787
+ - loadResourceDictionary
1788
+ - loadCBA
1789
+ type: object
1790
+ properties:
1791
+ loadModelType:
1792
+ type: boolean
1793
+ description: Specifies if default model types should be loaded
1794
+ example: true
1795
+ loadResourceDictionary:
1796
+ type: boolean
1797
+ description: Specifies if default data dictionaries should be loaded
1798
+ example: true
1799
+ loadCBA:
1800
+ type: boolean
1801
+ description: Specifies if default blueprint models should be loaded
1802
+ example: true
1803
+ CapabilityAssignment:
1804
+ title: CapabilityAssignment
1805
+ type: object
1806
+ properties:
1807
+ attributes:
1808
+ type: object
1809
+ additionalProperties:
1810
+ $ref: '#/components/schemas/JsonNode'
1811
+ properties:
1812
+ type: object
1813
+ additionalProperties:
1814
+ $ref: '#/components/schemas/JsonNode'
1815
+ CommonHeader:
1816
+ title: CommonHeader
1817
+ required:
1818
+ - timestamp
1819
+ - originatorId
1820
+ - requestId
1821
+ - subRequestId
1822
+ type: object
1823
+ properties:
1824
+ timestamp:
1825
+ type: string
1826
+ description: Date of the execution
1827
+ format: date-time
1828
+ example: 2012-04-23T18:25:43.511Z
1829
+ originatorId:
1830
+ type: string
1831
+ description: Identify the system/person triggering the request.
1832
+ requestId:
1833
+ type: string
1834
+ description: Uniquely identify a request.
1835
+ subRequestId:
1836
+ type: string
1837
+ description: Allow for fine-grain request identifier
1838
+ ConstraintClause:
1839
+ title: ConstraintClause
1840
+ type: object
1841
+ properties:
1842
+ equal:
1843
+ $ref: '#/components/schemas/JsonNode'
1844
+ length:
1845
+ $ref: '#/components/schemas/JsonNode'
1846
+ pattern:
1847
+ type: string
1848
+ schema:
1849
+ type: string
1850
+ greater_than:
1851
+ $ref: '#/components/schemas/JsonNode'
1852
+ greater_or_equal:
1853
+ $ref: '#/components/schemas/JsonNode'
1854
+ less_than:
1855
+ $ref: '#/components/schemas/JsonNode'
1856
+ less_or_equal:
1857
+ $ref: '#/components/schemas/JsonNode'
1858
+ in_range:
1859
+ type: array
1860
+ items:
1861
+ $ref: '#/components/schemas/JsonNode'
1862
+ description: ''
1863
+ valid_values:
1864
+ type: array
1865
+ items:
1866
+ $ref: '#/components/schemas/JsonNode'
1867
+ description: ''
1868
+ min_length:
1869
+ $ref: '#/components/schemas/JsonNode'
1870
+ max_length:
1871
+ $ref: '#/components/schemas/JsonNode'
1872
+ EntrySchema:
1873
+ title: EntrySchema
1874
+ type: object
1875
+ properties:
1876
+ type:
1877
+ type: string
1878
+ constraints:
1879
+ type: array
1880
+ items:
1881
+ $ref: '#/components/schemas/ConstraintClause'
1882
+ description: ''
1883
+ ExecutionServiceInput:
1884
+ title: ExecutionServiceInput
1885
+ required:
1886
+ - commonHeader
1887
+ - actionIdentifiers
1888
+ - payload
1889
+ type: object
1890
+ properties:
1891
+ commonHeader:
1892
+ $ref: '#/components/schemas/CommonHeader'
1893
+ actionIdentifiers:
1894
+ $ref: '#/components/schemas/ActionIdentifiers'
1895
+ payload:
1896
+ $ref: '#/components/schemas/ObjectNode'
1897
+ ExecutionServiceOutput:
1898
+ title: ExecutionServiceOutput
1899
+ required:
1900
+ - commonHeader
1901
+ - actionIdentifiers
1902
+ - status
1903
+ - payload
1904
+ type: object
1905
+ properties:
1906
+ commonHeader:
1907
+ $ref: '#/components/schemas/CommonHeader'
1908
+ actionIdentifiers:
1909
+ $ref: '#/components/schemas/ActionIdentifiers'
1910
+ status:
1911
+ $ref: '#/components/schemas/Status'
1912
+ payload:
1913
+ $ref: '#/components/schemas/ObjectNode'
1914
+ Implementation:
1915
+ title: Implementation
1916
+ type: object
1917
+ properties:
1918
+ primary:
1919
+ type: string
1920
+ dependencies:
1921
+ type: array
1922
+ items:
1923
+ type: string
1924
+ description: ''
1925
+ timeout:
1926
+ type: integer
1927
+ format: int32
1928
+ lock:
1929
+ $ref: '#/components/schemas/LockAssignment'
1930
+ operation_host:
1931
+ type: string
1932
+ InterfaceAssignment:
1933
+ title: InterfaceAssignment
1934
+ type: object
1935
+ properties:
1936
+ operations:
1937
+ type: object
1938
+ additionalProperties:
1939
+ $ref: '#/components/schemas/OperationAssignment'
1940
+ inputs:
1941
+ type: object
1942
+ additionalProperties:
1943
+ $ref: '#/components/schemas/JsonNode'
1944
+ JsonNode:
1945
+ title: JsonNode
1946
+ type: object
1947
+ properties:
1948
+ double:
1949
+ type: boolean
1950
+ int:
1951
+ type: boolean
1952
+ long:
1953
+ type: boolean
1954
+ boolean:
1955
+ type: boolean
1956
+ short:
1957
+ type: boolean
1958
+ nodeType:
1959
+ $ref: '#/components/schemas/NodeType'
1960
+ object:
1961
+ type: boolean
1962
+ number:
1963
+ type: boolean
1964
+ binary:
1965
+ type: boolean
1966
+ floatingPointNumber:
1967
+ type: boolean
1968
+ containerNode:
1969
+ type: boolean
1970
+ missingNode:
1971
+ type: boolean
1972
+ pojo:
1973
+ type: boolean
1974
+ valueNode:
1975
+ type: boolean
1976
+ bigDecimal:
1977
+ type: boolean
1978
+ textual:
1979
+ type: boolean
1980
+ bigInteger:
1981
+ type: boolean
1982
+ integralNumber:
1983
+ type: boolean
1984
+ array:
1985
+ type: boolean
1986
+ 'null':
1987
+ type: boolean
1988
+ float:
1989
+ type: boolean
1990
+ LockAssignment:
1991
+ title: LockAssignment
1992
+ type: object
1993
+ properties:
1994
+ key:
1995
+ $ref: '#/components/schemas/JsonNode'
1996
+ acquireTimeout:
1997
+ $ref: '#/components/schemas/JsonNode'
1998
+ ModelType:
1999
+ title: ModelType
2000
+ required:
2001
+ - modelName
2002
+ - derivedFrom
2003
+ - definitionType
2004
+ - definition
2005
+ - description
2006
+ - version
2007
+ - tags
2008
+ - updatedBy
2009
+ type: object
2010
+ properties:
2011
+ modelName:
2012
+ type: string
2013
+ derivedFrom:
2014
+ type: string
2015
+ definitionType:
2016
+ type: string
2017
+ definition:
2018
+ $ref: '#/components/schemas/JsonNode'
2019
+ description:
2020
+ type: string
2021
+ version:
2022
+ type: string
2023
+ tags:
2024
+ type: string
2025
+ creationDate:
2026
+ type: string
2027
+ format: date-time
2028
+ updatedBy:
2029
+ type: string
2030
+ NodeFilterDefinition:
2031
+ title: NodeFilterDefinition
2032
+ type: object
2033
+ properties:
2034
+ properties:
2035
+ type: object
2036
+ additionalProperties:
2037
+ $ref: '#/components/schemas/PropertyDefinition'
2038
+ capabilities:
2039
+ type: array
2040
+ items:
2041
+ type: string
2042
+ description: ''
2043
+ NodeTemplate:
2044
+ title: NodeTemplate
2045
+ type: object
2046
+ properties:
2047
+ description:
2048
+ type: string
2049
+ type:
2050
+ type: string
2051
+ metadata:
2052
+ type: object
2053
+ additionalProperties:
2054
+ type: string
2055
+ directives:
2056
+ type: array
2057
+ items:
2058
+ type: string
2059
+ description: ''
2060
+ properties:
2061
+ type: object
2062
+ additionalProperties:
2063
+ $ref: '#/components/schemas/JsonNode'
2064
+ attributes:
2065
+ type: object
2066
+ additionalProperties:
2067
+ $ref: '#/components/schemas/JsonNode'
2068
+ capabilities:
2069
+ type: object
2070
+ additionalProperties:
2071
+ $ref: '#/components/schemas/CapabilityAssignment'
2072
+ requirements:
2073
+ type: object
2074
+ additionalProperties:
2075
+ $ref: '#/components/schemas/RequirementAssignment'
2076
+ interfaces:
2077
+ type: object
2078
+ additionalProperties:
2079
+ $ref: '#/components/schemas/InterfaceAssignment'
2080
+ artifacts:
2081
+ type: object
2082
+ additionalProperties:
2083
+ $ref: '#/components/schemas/ArtifactDefinition'
2084
+ copy:
2085
+ type: string
2086
+ node_filter:
2087
+ $ref: '#/components/schemas/NodeFilterDefinition'
2088
+ ObjectNode:
2089
+ title: ObjectNode
2090
+ type: object
2091
+ properties:
2092
+ nodeType:
2093
+ $ref: '#/components/schemas/NodeType'
2094
+ double:
2095
+ type: boolean
2096
+ int:
2097
+ type: boolean
2098
+ long:
2099
+ type: boolean
2100
+ boolean:
2101
+ type: boolean
2102
+ short:
2103
+ type: boolean
2104
+ object:
2105
+ type: boolean
2106
+ number:
2107
+ type: boolean
2108
+ binary:
2109
+ type: boolean
2110
+ floatingPointNumber:
2111
+ type: boolean
2112
+ containerNode:
2113
+ type: boolean
2114
+ missingNode:
2115
+ type: boolean
2116
+ pojo:
2117
+ type: boolean
2118
+ valueNode:
2119
+ type: boolean
2120
+ bigDecimal:
2121
+ type: boolean
2122
+ textual:
2123
+ type: boolean
2124
+ bigInteger:
2125
+ type: boolean
2126
+ integralNumber:
2127
+ type: boolean
2128
+ array:
2129
+ type: boolean
2130
+ 'null':
2131
+ type: boolean
2132
+ float:
2133
+ type: boolean
2134
+ OperationAssignment:
2135
+ title: OperationAssignment
2136
+ type: object
2137
+ properties:
2138
+ description:
2139
+ type: string
2140
+ implementation:
2141
+ $ref: '#/components/schemas/Implementation'
2142
+ inputs:
2143
+ type: object
2144
+ additionalProperties:
2145
+ $ref: '#/components/schemas/JsonNode'
2146
+ outputs:
2147
+ type: object
2148
+ additionalProperties:
2149
+ $ref: '#/components/schemas/JsonNode'
2150
+ Page:
2151
+ title: Page
2152
+ type: object
2153
+ properties:
2154
+ totalPages:
2155
+ type: integer
2156
+ format: int32
2157
+ totalElements:
2158
+ type: integer
2159
+ format: int64
2160
+ pageable:
2161
+ $ref: '#/components/schemas/Pageable'
2162
+ first:
2163
+ type: boolean
2164
+ numberOfElements:
2165
+ type: integer
2166
+ format: int32
2167
+ size:
2168
+ type: integer
2169
+ format: int32
2170
+ content:
2171
+ type: array
2172
+ items:
2173
+ type: object
2174
+ description: ''
2175
+ number:
2176
+ type: integer
2177
+ format: int32
2178
+ sort:
2179
+ $ref: '#/components/schemas/Sort'
2180
+ last:
2181
+ type: boolean
2182
+ empty:
2183
+ type: boolean
2184
+ PageBlueprintModelSearch:
2185
+ title: PageBlueprintModelSearch
2186
+ type: object
2187
+ properties:
2188
+ totalPages:
2189
+ type: integer
2190
+ format: int32
2191
+ totalElements:
2192
+ type: integer
2193
+ format: int64
2194
+ pageable:
2195
+ $ref: '#/components/schemas/Pageable'
2196
+ first:
2197
+ type: boolean
2198
+ numberOfElements:
2199
+ type: integer
2200
+ format: int32
2201
+ size:
2202
+ type: integer
2203
+ format: int32
2204
+ content:
2205
+ type: array
2206
+ items:
2207
+ $ref: '#/components/schemas/BlueprintModelSearch'
2208
+ description: ''
2209
+ number:
2210
+ type: integer
2211
+ format: int32
2212
+ sort:
2213
+ $ref: '#/components/schemas/Sort'
2214
+ last:
2215
+ type: boolean
2216
+ empty:
2217
+ type: boolean
2218
+ Pageable:
2219
+ title: Pageable
2220
+ type: object
2221
+ properties:
2222
+ paged:
2223
+ type: boolean
2224
+ pageNumber:
2225
+ type: integer
2226
+ format: int32
2227
+ pageSize:
2228
+ type: integer
2229
+ format: int32
2230
+ unpaged:
2231
+ type: boolean
2232
+ offset:
2233
+ type: integer
2234
+ format: int64
2235
+ sort:
2236
+ $ref: '#/components/schemas/Sort'
2237
+ PropertyDefinition:
2238
+ title: PropertyDefinition
2239
+ type: object
2240
+ properties:
2241
+ description:
2242
+ type: string
2243
+ required:
2244
+ type: boolean
2245
+ type:
2246
+ type: string
2247
+ status:
2248
+ type: string
2249
+ constraints:
2250
+ type: array
2251
+ items:
2252
+ $ref: '#/components/schemas/ConstraintClause'
2253
+ description: ''
2254
+ metadata:
2255
+ type: object
2256
+ additionalProperties:
2257
+ type: string
2258
+ value:
2259
+ $ref: '#/components/schemas/JsonNode'
2260
+ input-param:
2261
+ type: boolean
2262
+ default:
2263
+ $ref: '#/components/schemas/JsonNode'
2264
+ entry_schema:
2265
+ $ref: '#/components/schemas/EntrySchema'
2266
+ external-schema:
2267
+ type: string
2268
+ RequirementAssignment:
2269
+ title: RequirementAssignment
2270
+ type: object
2271
+ properties:
2272
+ capability:
2273
+ type: string
2274
+ node:
2275
+ type: string
2276
+ relationship:
2277
+ type: string
2278
+ ResourceConfigSnapshot:
2279
+ title: ResourceConfigSnapshot
2280
+ required:
2281
+ - resourceType
2282
+ - resourceId
2283
+ - status
2284
+ - config_snapshot
2285
+ - createdDate
2286
+ type: object
2287
+ properties:
2288
+ resourceType:
2289
+ type: string
2290
+ description: Resource type.
2291
+ example: ServiceInstance
2292
+ resourceId:
2293
+ type: string
2294
+ description: ID associated with the resource type in the inventory system.
2295
+ example: '1'
2296
+ status:
2297
+ allOf:
2298
+ - $ref: '#/components/schemas/Status1'
2299
+ - description: Status of the snapshot, either running or candidate.
2300
+ config_snapshot:
2301
+ type: string
2302
+ description: Snapshot of the resource as retrieved from resource.
2303
+ example: config_snapshot
2304
+ id:
2305
+ type: string
2306
+ createdDate:
2307
+ type: string
2308
+ description: Creation date of the snapshot.
2309
+ format: date-time
2310
+ ResourceDefinition:
2311
+ title: ResourceDefinition
2312
+ required:
2313
+ - name
2314
+ - property
2315
+ - group
2316
+ - updated-by
2317
+ - sources
2318
+ type: object
2319
+ properties:
2320
+ tags:
2321
+ type: string
2322
+ name:
2323
+ type: string
2324
+ description: Name
2325
+ example: default-source
2326
+ property:
2327
+ $ref: '#/components/schemas/PropertyDefinition'
2328
+ group:
2329
+ type: string
2330
+ description: Group
2331
+ example: default
2332
+ updated-by:
2333
+ type: string
2334
+ description: Updated by
2335
+ example: example@onap.com
2336
+ sources:
2337
+ type: object
2338
+ additionalProperties:
2339
+ $ref: '#/components/schemas/NodeTemplate'
2340
+ description: Sources
2341
+ ResourceDictionary:
2342
+ title: ResourceDictionary
2343
+ required:
2344
+ - name
2345
+ - dataType
2346
+ - entrySchema
2347
+ - resourceDictionaryGroup
2348
+ - definition
2349
+ - description
2350
+ - tags
2351
+ - updatedBy
2352
+ type: object
2353
+ properties:
2354
+ name:
2355
+ type: string
2356
+ description: Name
2357
+ example: sample-db-source
2358
+ dataType:
2359
+ type: string
2360
+ description: Data type
2361
+ example: string
2362
+ entrySchema:
2363
+ type: string
2364
+ description: Entry schema
2365
+ example: dt-license-key
2366
+ resourceDictionaryGroup:
2367
+ type: string
2368
+ description: Resource dictionary group
2369
+ example: default
2370
+ definition:
2371
+ $ref: '#/components/schemas/ResourceDefinition'
2372
+ description:
2373
+ type: string
2374
+ description: Description
2375
+ example: demo_artifacts_version
2376
+ tags:
2377
+ type: string
2378
+ description: Tags
2379
+ example: hostname
2380
+ creationDate:
2381
+ type: string
2382
+ format: date-time
2383
+ updatedBy:
2384
+ type: string
2385
+ description: Updated by
2386
+ example: username
2387
+ ResourceResolution:
2388
+ title: ResourceResolution
2389
+ required:
2390
+ - blueprintName
2391
+ - blueprintVersion
2392
+ - artifactName
2393
+ - name
2394
+ - value
2395
+ - status
2396
+ - resolutionKey
2397
+ - resourceType
2398
+ - resourceId
2399
+ - occurrence
2400
+ - dictionaryName
2401
+ - dictionarySource
2402
+ - dictionaryVersion
2403
+ - createdDate
2404
+ type: object
2405
+ properties:
2406
+ blueprintName:
2407
+ type: string
2408
+ description: Name of the CBA.
2409
+ blueprintVersion:
2410
+ type: string
2411
+ description: Version of the CBA.
2412
+ artifactName:
2413
+ type: string
2414
+ description: Artifact name for which to retrieve a resolved resource.
2415
+ name:
2416
+ type: string
2417
+ description: Name of the resource.
2418
+ value:
2419
+ type: string
2420
+ description: Value of the resolution.
2421
+ status:
2422
+ type: string
2423
+ description: Whether success of failure.
2424
+ resolutionKey:
2425
+ type: string
2426
+ description: Resolution Key uniquely identifying the resolution of a given artifact within a CBA.
2427
+ resourceType:
2428
+ type: string
2429
+ description: Resolution type.
2430
+ example: ServiceInstance
2431
+ resourceId:
2432
+ type: string
2433
+ description: ID associated with the resolution type in the inventory system.
2434
+ occurrence:
2435
+ type: integer
2436
+ description: If resolution occurred multiple time, this field provides the index.
2437
+ format: int32
2438
+ dictionaryName:
2439
+ type: string
2440
+ description: Name of the data dictionary used for the resolution.
2441
+ dictionarySource:
2442
+ type: string
2443
+ description: Source associated with the data dictionary used for the resolution.
2444
+ dictionaryVersion:
2445
+ type: integer
2446
+ description: Version of the data dictionary used for the resolution.
2447
+ format: int32
2448
+ id:
2449
+ type: string
2450
+ createdDate:
2451
+ type: string
2452
+ description: Creation date of the resolution.
2453
+ format: date-time
2454
+ ResourceSourceMapping:
2455
+ title: ResourceSourceMapping
2456
+ type: object
2457
+ properties:
2458
+ resourceSourceMappings:
2459
+ type: object
2460
+ additionalProperties:
2461
+ type: string
2462
+ Sort:
2463
+ title: Sort
2464
+ type: object
2465
+ properties:
2466
+ sorted:
2467
+ type: boolean
2468
+ unsorted:
2469
+ type: boolean
2470
+ empty:
2471
+ type: boolean
2472
+ Status:
2473
+ title: Status
2474
+ required:
2475
+ - code
2476
+ - eventType
2477
+ - timestamp
2478
+ - message
2479
+ type: object
2480
+ properties:
2481
+ code:
2482
+ type: integer
2483
+ description: HTTP status code equivalent.
2484
+ format: int32
2485
+ eventType:
2486
+ type: string
2487
+ description: Type of the event being emitted by CDS.
2488
+ timestamp:
2489
+ type: string
2490
+ description: Time when the execution ended.
2491
+ format: date-time
2492
+ example: 2012-04-23T18:25:43.511Z
2493
+ errorMessage:
2494
+ type: string
2495
+ description: Error message when system failed
2496
+ message:
2497
+ type: string
2498
+ description: Message providing request status
2499
+ TemplateResolution:
2500
+ title: TemplateResolution
2501
+ required:
2502
+ - blueprintName
2503
+ - blueprintVersion
2504
+ - artifactName
2505
+ - result
2506
+ - resolutionKey
2507
+ - resourceType
2508
+ - resourceId
2509
+ - occurrence
2510
+ - createdDate
2511
+ type: object
2512
+ properties:
2513
+ blueprintName:
2514
+ type: string
2515
+ description: Name of the CBA.
2516
+ blueprintVersion:
2517
+ type: string
2518
+ description: Version of the CBA.
2519
+ artifactName:
2520
+ type: string
2521
+ description: Artifact name for which to retrieve a resolved resource.
2522
+ result:
2523
+ type: string
2524
+ description: Rendered template.
2525
+ resolutionKey:
2526
+ type: string
2527
+ description: Resolution Key uniquely identifying the resolution of a given artifact within a CBA.
2528
+ resourceType:
2529
+ type: string
2530
+ description: Resolution type.
2531
+ example: ServiceInstance
2532
+ resourceId:
2533
+ type: string
2534
+ description: ID associated with the resolution type in the inventory system.
2535
+ occurrence:
2536
+ type: integer
2537
+ description: If resolution occurred multiple time, this field provides the index.
2538
+ format: int32
2539
+ id:
2540
+ type: string
2541
+ createdDate:
2542
+ type: string
2543
+ description: Creation date of the resolution.
2544
+ format: date-time
2545
+ WorkFlowSpecRequest:
2546
+ title: WorkFlowSpecRequest
2547
+ required:
2548
+ - blueprintName
2549
+ - workflowName
2550
+ type: object
2551
+ properties:
2552
+ blueprintName:
2553
+ type: string
2554
+ description: Name of the BLueprint
2555
+ example: pnf_netconf
2556
+ version:
2557
+ type: string
2558
+ returnContent:
2559
+ type: string
2560
+ workflowName:
2561
+ type: string
2562
+ description: Name of the Workflow
2563
+ example: config-assign
2564
+ specType:
2565
+ type: string
2566
+ Mode:
2567
+ title: Mode
2568
+ enum:
2569
+ - sync
2570
+ - async
2571
+ type: string
2572
+ description: Async processing is only supported for gRPC client.
2573
+ NodeType:
2574
+ title: NodeType
2575
+ enum:
2576
+ - ARRAY
2577
+ - BINARY
2578
+ - BOOLEAN
2579
+ - MISSING
2580
+ - 'NULL'
2581
+ - NUMBER
2582
+ - OBJECT
2583
+ - POJO
2584
+ - STRING
2585
+ type: string
2586
+ sort1:
2587
+ title: sort1
2588
+ enum:
2589
+ - DATE
2590
+ - NAME
2591
+ - VERSION
2592
+ type: string
2593
+ sort3:
2594
+ title: sort3
2595
+ enum:
2596
+ - DATE
2597
+ type: string
2598
+ Status1:
2599
+ title: Status1
2600
+ enum:
2601
+ - RUNNING
2602
+ - CANDIDATE
2603
+ type: string
2604
+ description: Status of the snapshot, either running or candidate.
2605
+ securitySchemes:
2606
+ BasicAuth:
2607
+ type: http
2608
+ scheme: basic
2609
+ security: []
2610
+ tags:
2611
+ - name: Blueprint Model Catalog
2612
+ description: Manages all blueprint models which are available in CDS
2613
+ - name: Execution Service Catalog
2614
+ description: Interaction with CBA which are available in CDS
2615
+ - name: Model Type Catalog
2616
+ description: Manages data types in CDS
2617
+ - name: Resource configuration
2618
+ description: Interaction with stored configurations
2619
+ - name: Resource Dictionary
2620
+ description: Interaction with stored dictionaries
2621
+ - name: Resource Template
2622
+ description: Interaction with resolved templates
2623
+ - name: Resources
2624
+ description: Interaction with resolved resources