summaryrefslogtreecommitdiffstats
path: root/docs/api-reference/media/cds-bp-processor-api-swagger.json
blob: af3ed94e63abfb914ba4882db98bedda29abffbd (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
{
  "swagger" : "2.0",
  "info" : {
    "description" : "Shows all resources and endpoints which CDS BP processor currently provides with sample requests/responses, parameter description and other information.",
    "version" : "v1",
    "title" : "CDS Blueprint Processor API Reference",
    "termsOfService" : "https://www.onap.org/",
    "contact" : {
      "name" : "ONAP Community",
      "url" : "https://www.onap.org/",
      "email" : "onap-discuss@lists.onap.org"
    },
    "license" : {
      "name" : "Apache 2.0",
      "url" : "http://www.apache.org/licenses/LICENSE-2.0.html"
    }
  },
  "host" : "localhost:8080",
  "tags" : [ {
    "name" : "Blueprint Model Catalog API",
    "description" : "Manages all blueprint models which are available in CDS"
  } ],
  "schemes" : [ "http" ],
  "paths" : {
    "/api/v1/blueprint-model" : {
      "get" : {
        "tags" : [ "Blueprint Model Catalog API" ],
        "summary" : "List all Blueprint Models",
        "description" : "Lists all meta-data of blueprint models which are saved in CDS.",
        "operationId" : "BlueprintModelController_allBlueprintModel_GET.org.onap.ccsdk.cds.blueprintsprocessor.designer.api",
        "produces" : [ "application/json" ],
        "responses" : {
          "200" : {
            "description" : "OK",
            "schema" : {
              "type" : "array",
              "items" : {
                "$ref" : "#/definitions/BlueprintModelSearch"
              }
            }
          },
          "500" : {
            "description" : "Internal Server Error"
          }
        }
      },
      "post" : {
        "tags" : [ "Blueprint Model Catalog API" ],
        "summary" : "Save a Blueprint Model",
        "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.",
        "operationId" : "BlueprintModelController_saveBlueprint_POST.org.onap.ccsdk.cds.blueprintsprocessor.designer.api",
        "consumes" : [ "multipart/form-data" ],
        "produces" : [ "application/json" ],
        "parameters" : [ {
          "in" : "body",
          "name" : "file",
          "description" : "CBA file to be uploaded (example: cba.zip)",
          "required" : true,
          "schema" : {
            "$ref" : "#/definitions/FilePart"
          }
        } ],
        "responses" : {
          "200" : {
            "description" : "OK",
            "schema" : {
              "$ref" : "#/definitions/BlueprintModelSearch"
            }
          },
          "500" : {
            "description" : "Internal Server Error"
          }
        }
      }
    },
    "/api/v1/blueprint-model/bootstrap" : {
      "post" : {
        "tags" : [ "Blueprint Model Catalog API" ],
        "summary" : "Bootstrap CDS",
        "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.",
        "operationId" : "BlueprintModelController_bootstrap_POST.org.onap.ccsdk.cds.blueprintsprocessor.designer.api",
        "consumes" : [ "application/json" ],
        "produces" : [ "application/json" ],
        "parameters" : [ {
          "in" : "body",
          "name" : "body",
          "description" : "Specifies which elements to load",
          "required" : true,
          "schema" : {
            "$ref" : "#/definitions/BootstrapRequest"
          }
        } ],
        "responses" : {
          "200" : {
            "description" : "OK",
            "schema" : {
              "type" : "object"
            }
          },
          "500" : {
            "description" : "Internal Server Error"
          }
        }
      }
    },
    "/api/v1/blueprint-model/by-name/{name}/version/{version}" : {
      "get" : {
        "tags" : [ "Blueprint Model Catalog API" ],
        "summary" : "Get a Blueprint Model by Name and Version",
        "description" : "Get Meta-Data of a Blueprint Model by its name and version.",
        "operationId" : "BlueprintModelController_getBlueprintByNameAndVersion_GET.org.onap.ccsdk.cds.blueprintsprocessor.designer.api",
        "produces" : [ "application/json" ],
        "parameters" : [ {
          "name" : "name",
          "in" : "path",
          "description" : "Name of the blueprint model",
          "required" : true,
          "type" : "string",
          "x-example" : "pnf_netconf"
        }, {
          "name" : "version",
          "in" : "path",
          "description" : "Version of the blueprint model",
          "required" : true,
          "type" : "string",
          "x-example" : "1.0.0"
        } ],
        "responses" : {
          "200" : {
            "description" : "OK",
            "schema" : {
              "$ref" : "#/definitions/BlueprintModelSearch"
            }
          },
          "404" : {
            "description" : "Not Found"
          }
        }
      }
    },
    "/api/v1/blueprint-model/download/by-name/{name}/version/{version}" : {
      "get" : {
        "tags" : [ "Blueprint Model Catalog API" ],
        "summary" : "Download a Blueprint Model",
        "description" : "Gets the CBA of a blueprint model by its name and version. Response can be saved to a file to download the CBA.",
        "operationId" : "BlueprintModelController_downloadBlueprintByNameAndVersion_GET.org.onap.ccsdk.cds.blueprintsprocessor.designer.api",
        "produces" : [ "application/json" ],
        "parameters" : [ {
          "name" : "name",
          "in" : "path",
          "description" : "Name of the blueprint model",
          "required" : true,
          "type" : "string",
          "x-example" : "pnf_netconf"
        }, {
          "name" : "version",
          "in" : "path",
          "description" : "Version of the blueprint model",
          "required" : true,
          "type" : "string",
          "x-example" : "1.0.0"
        } ],
        "responses" : {
          "200" : {
            "description" : "OK",
            "schema" : {
              "type" : "object"
            }
          },
          "404" : {
            "description" : "Not Found"
          }
        }
      }
    },
    "/api/v1/blueprint-model/download/{id}" : {
      "get" : {
        "tags" : [ "Blueprint Model Catalog API" ],
        "summary" : "Download a Blueprint Model by ID",
        "description" : "Gets the CBA of a blueprint model by its ID. Response can be saved to a file to download the CBA.",
        "operationId" : "BlueprintModelController_downloadBluePrint_GET.org.onap.ccsdk.cds.blueprintsprocessor.designer.api",
        "produces" : [ "application/json" ],
        "parameters" : [ {
          "name" : "id",
          "in" : "path",
          "description" : "ID of the blueprint model to download",
          "required" : true,
          "type" : "string",
          "x-example" : "67ec1f96-ab55-4b81-aff9-23ee0ed1d7a4"
        } ],
        "responses" : {
          "200" : {
            "description" : "OK",
            "schema" : {
              "type" : "object"
            }
          },
          "404" : {
            "description" : "Not Found"
          }
        }
      }
    },
    "/api/v1/blueprint-model/enrich" : {
      "post" : {
        "tags" : [ "Blueprint Model Catalog API" ],
        "summary" : "Enrich a Blueprint Model",
        "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.",
        "operationId" : "BlueprintModelController_enrichBlueprint_POST.org.onap.ccsdk.cds.blueprintsprocessor.designer.api",
        "consumes" : [ "multipart/form-data" ],
        "produces" : [ "application/json" ],
        "parameters" : [ {
          "in" : "body",
          "name" : "file",
          "description" : "CBA zip file to be uploaded (example: cba_unenriched.zip)",
          "required" : true,
          "schema" : {
            "$ref" : "#/definitions/FilePart"
          }
        } ],
        "responses" : {
          "200" : {
            "description" : "successful operation",
            "schema" : {
              "type" : "object"
            }
          }
        }
      }
    },
    "/api/v1/blueprint-model/enrichandpublish" : {
      "post" : {
        "tags" : [ "Blueprint Model Catalog API" ],
        "summary" : "Enrich and publish a Blueprint Model",
        "description" : "Enriches the attached CBA, validates it and saves it in CDS if validation was successful.",
        "operationId" : "BlueprintModelController_enrichAndPubishlueprint_POST.org.onap.ccsdk.cds.blueprintsprocessor.designer.api",
        "consumes" : [ "multipart/form-data" ],
        "produces" : [ "application/json" ],
        "parameters" : [ {
          "in" : "body",
          "name" : "file",
          "description" : "Unenriched CBA zip file to be uploaded (example: cba_unenriched.zip)",
          "required" : true,
          "schema" : {
            "$ref" : "#/definitions/FilePart"
          }
        } ],
        "responses" : {
          "200" : {
            "description" : "OK",
            "schema" : {
              "$ref" : "#/definitions/BlueprintModelSearch"
            }
          },
          "503" : {
            "description" : "Service Unavailable"
          }
        }
      }
    },
    "/api/v1/blueprint-model/meta-data/{keyword}" : {
      "get" : {
        "tags" : [ "Blueprint Model Catalog API" ],
        "summary" : "Search for Blueprints by a Keyword",
        "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.",
        "operationId" : "BlueprintModelController_allBlueprintModelMetaData_GET.org.onap.ccsdk.cds.blueprintsprocessor.designer.api",
        "produces" : [ "application/json" ],
        "parameters" : [ {
          "name" : "keyword",
          "in" : "path",
          "description" : "Keyword to search for in blueprint model meta-data",
          "required" : true,
          "type" : "string",
          "x-example" : "pnf_netconf"
        } ],
        "responses" : {
          "200" : {
            "description" : "successful operation",
            "schema" : {
              "type" : "array",
              "items" : {
                "$ref" : "#/definitions/BlueprintModelSearch"
              }
            }
          }
        }
      }
    },
    "/api/v1/blueprint-model/name/{name}/version/{version}" : {
      "delete" : {
        "tags" : [ "Blueprint Model Catalog API" ],
        "summary" : "Delete a Blueprint Model by Name",
        "description" : "Deletes a blueprint model identified by its name and version from CDS.",
        "operationId" : "BlueprintModelController_deleteBlueprintByName_DELETE.org.onap.ccsdk.cds.blueprintsprocessor.designer.api",
        "parameters" : [ {
          "name" : "name",
          "in" : "path",
          "description" : "Name of the blueprint model",
          "required" : true,
          "type" : "string",
          "x-example" : "pnf_netconf"
        }, {
          "name" : "version",
          "in" : "path",
          "description" : "Version of the blueprint model",
          "required" : true,
          "type" : "string",
          "x-example" : "1.0.0"
        } ],
        "responses" : {
          "200" : {
            "description" : "successful operation",
            "schema" : {
              "type" : "object"
            }
          }
        }
      }
    },
    "/api/v1/blueprint-model/paged" : {
      "get" : {
        "tags" : [ "Blueprint Model Catalog API" ],
        "summary" : "Get Blueprints ordered",
        "description" : "Lists all blueprint models which are saved in CDS in an ordered mode.",
        "operationId" : "BlueprintModelController_allBlueprintModelPaged_GET.org.onap.ccsdk.cds.blueprintsprocessor.designer.api",
        "produces" : [ "application/json" ],
        "parameters" : [ {
          "name" : "limit",
          "in" : "query",
          "description" : "Maximum number of returned blueprint models",
          "required" : false,
          "type" : "integer",
          "default" : 20,
          "format" : "int32"
        }, {
          "name" : "offset",
          "in" : "query",
          "description" : "Offset",
          "required" : false,
          "type" : "integer",
          "default" : 0,
          "format" : "int32"
        }, {
          "name" : "sort",
          "in" : "query",
          "description" : "Order of returned blueprint models",
          "required" : false,
          "type" : "string",
          "default" : "DATE",
          "enum" : [ "DATE", "NAME", "VERSION" ]
        }, {
          "name" : "sortType",
          "in" : "query",
          "description" : "Ascend or descend ordering",
          "required" : false,
          "type" : "string",
          "default" : "ASC"
        } ],
        "responses" : {
          "200" : {
            "description" : "successful operation",
            "schema" : {
              "$ref" : "#/definitions/PageBlueprintModelSearch"
            }
          }
        }
      }
    },
    "/api/v1/blueprint-model/paged/meta-data/{keyword}" : {
      "get" : {
        "tags" : [ "Blueprint Model Catalog API" ],
        "summary" : "Search for Blueprints by a Keyword in an ordered mode",
        "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.",
        "operationId" : "BlueprintModelController_allBlueprintModelMetaDataPaged_GET.org.onap.ccsdk.cds.blueprintsprocessor.designer.api",
        "produces" : [ "application/json" ],
        "parameters" : [ {
          "name" : "keyword",
          "in" : "path",
          "description" : "Keyword to search for in blueprint model meta-data",
          "required" : true,
          "type" : "string",
          "x-example" : "pnf_netconf"
        }, {
          "name" : "limit",
          "in" : "query",
          "description" : "Maximum number of returned blueprint models",
          "required" : false,
          "type" : "integer",
          "default" : 20,
          "format" : "int32"
        }, {
          "name" : "offset",
          "in" : "query",
          "description" : "Offset",
          "required" : false,
          "type" : "integer",
          "default" : 0,
          "format" : "int32"
        }, {
          "name" : "sort",
          "in" : "query",
          "description" : "Order of returned blueprint models",
          "required" : false,
          "type" : "string",
          "default" : "DATE",
          "enum" : [ "DATE", "NAME", "VERSION" ]
        }, {
          "name" : "sortType",
          "in" : "query",
          "description" : "Ascend or descend ordering",
          "required" : false,
          "type" : "string",
          "default" : "ASC"
        } ],
        "responses" : {
          "200" : {
            "description" : "successful operation",
            "schema" : {
              "$ref" : "#/definitions/PageBlueprintModelSearch"
            }
          }
        }
      }
    },
    "/api/v1/blueprint-model/publish" : {
      "post" : {
        "tags" : [ "Blueprint Model Catalog API" ],
        "summary" : "Publish a Blueprint Model",
        "description" : "Validates the attached CBA file and saves it in CDS if validation was successful. CBA needs to be already enriched.",
        "operationId" : "BlueprintModelController_publishBlueprint_POST.org.onap.ccsdk.cds.blueprintsprocessor.designer.api",
        "consumes" : [ "multipart/form-data" ],
        "produces" : [ "application/json" ],
        "parameters" : [ {
          "in" : "body",
          "name" : "file",
          "description" : "Enriched CBA zip file to be uploaded (example: cba_enriched.zip)",
          "required" : true,
          "schema" : {
            "$ref" : "#/definitions/FilePart"
          }
        } ],
        "responses" : {
          "200" : {
            "description" : "successful operation",
            "schema" : {
              "$ref" : "#/definitions/BlueprintModelSearch"
            }
          }
        }
      }
    },
    "/api/v1/blueprint-model/search/{tags}" : {
      "get" : {
        "tags" : [ "Blueprint Model Catalog API" ],
        "summary" : "Search for a Blueprint by Tag",
        "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.",
        "operationId" : "BlueprintModelController_searchBlueprintModels_GET.org.onap.ccsdk.cds.blueprintsprocessor.designer.api",
        "produces" : [ "application/json" ],
        "parameters" : [ {
          "name" : "tags",
          "in" : "path",
          "description" : "Tag to search for",
          "required" : true,
          "type" : "string",
          "x-example" : "test"
        } ],
        "responses" : {
          "200" : {
            "description" : "successful operation",
            "schema" : {
              "type" : "array",
              "items" : {
                "$ref" : "#/definitions/BlueprintModelSearch"
              }
            }
          }
        }
      }
    },
    "/api/v1/blueprint-model/workflow-spec" : {
      "post" : {
        "tags" : [ "Blueprint Model Catalog API" ],
        "summary" : "Get Workflow Specification",
        "description" : "Get the workflow of a blueprint identified by Blueprint and workflow name. Inputs, outputs and data types of workflow is returned.",
        "operationId" : "BlueprintModelController_workflowSpec_POST.org.onap.ccsdk.cds.blueprintsprocessor.designer.api",
        "consumes" : [ "application/json" ],
        "produces" : [ "application/json" ],
        "parameters" : [ {
          "in" : "body",
          "name" : "body",
          "description" : "Blueprint and workflow identification",
          "required" : true,
          "schema" : {
            "$ref" : "#/definitions/WorkFlowSpecRequest"
          }
        } ],
        "responses" : {
          "200" : {
            "description" : "successful operation",
            "schema" : {
              "type" : "object"
            }
          }
        }
      }
    },
    "/api/v1/blueprint-model/workflows/blueprint-name/{name}/version/{version}" : {
      "get" : {
        "tags" : [ "Blueprint Model Catalog API" ],
        "summary" : "Get Workflows of a Blueprint",
        "description" : "Get all available workflows of a Blueprint identified by its name and version.",
        "operationId" : "BlueprintModelController_getWorkflowList_GET.org.onap.ccsdk.cds.blueprintsprocessor.designer.api",
        "produces" : [ "application/json" ],
        "parameters" : [ {
          "name" : "name",
          "in" : "path",
          "description" : "Name of the blueprint model",
          "required" : true,
          "type" : "string",
          "x-example" : "pnf_netconf"
        }, {
          "name" : "version",
          "in" : "path",
          "description" : "Version of the blueprint model",
          "required" : true,
          "type" : "string",
          "x-example" : "1.0.0"
        } ],
        "responses" : {
          "200" : {
            "description" : "successful operation",
            "schema" : {
              "type" : "object"
            }
          }
        }
      }
    },
    "/api/v1/blueprint-model/{id}" : {
      "get" : {
        "tags" : [ "Blueprint Model Catalog API" ],
        "summary" : "Get a Blueprint Model by ID",
        "description" : "Get meta-data of a blueprint model by its internally created ID.",
        "operationId" : "BlueprintModelController_getBlueprintModel_GET.org.onap.ccsdk.cds.blueprintsprocessor.designer.api",
        "produces" : [ "application/json" ],
        "parameters" : [ {
          "name" : "id",
          "in" : "path",
          "description" : "ID of the blueprint model to search for",
          "required" : true,
          "type" : "string",
          "x-example" : "67ec1f96-ab55-4b81-aff9-23ee0ed1d7a4"
        } ],
        "responses" : {
          "200" : {
            "description" : "OK",
            "schema" : {
              "$ref" : "#/definitions/BlueprintModelSearch"
            }
          },
          "404" : {
            "description" : "Not Found"
          }
        }
      },
      "delete" : {
        "tags" : [ "Blueprint Model Catalog API" ],
        "summary" : "Delete a Blueprint Model by ID",
        "description" : "Delete a blueprint model by its ID. ID is the internally created ID of blueprint, not the name of blueprint.",
        "operationId" : "BlueprintModelController_deleteBlueprint_DELETE.org.onap.ccsdk.cds.blueprintsprocessor.designer.api",
        "parameters" : [ {
          "name" : "id",
          "in" : "path",
          "description" : "ID of the blueprint model to delete",
          "required" : true,
          "type" : "string",
          "x-example" : "67ec1f96-ab55-4b81-aff9-23ee0ed1d7a4"
        } ],
        "responses" : {
          "200" : {
            "description" : "OK",
            "schema" : {
              "type" : "object"
            }
          },
          "404" : {
            "description" : "RESOURCE_NOT_FOUND"
          }
        }
      }
    }
  },
  "securityDefinitions" : {
    "Basic Auth" : {
      "type" : "basic"
    }
  },
  "definitions" : {
    "BlueprintModelSearch" : {
      "type" : "object",
      "required" : [ "artifactName", "artifactVersion", "createdDate", "id", "published", "tags", "updatedBy" ],
      "properties" : {
        "id" : {
          "type" : "string",
          "example" : "658f9a48-7f54-41ba-ae18-c69f26f3dc94",
          "description" : "ID of Blueprint model, is automatically created by CDS"
        },
        "artifactUUId" : {
          "type" : "string",
          "example" : null,
          "description" : "Artifact UUID, usually null"
        },
        "artifactType" : {
          "type" : "string",
          "example" : "SDNC_MODEL",
          "description" : "Artifact Type, usually null"
        },
        "artifactVersion" : {
          "type" : "string",
          "example" : "1.0.0",
          "description" : "Artifact Version, usually 1.0.0"
        },
        "artifactDescription" : {
          "type" : "string",
          "example" : "",
          "description" : "Artifact Description, usually empty"
        },
        "internalVersion" : {
          "type" : "integer",
          "format" : "int32",
          "example" : null,
          "description" : "Internal Version of CBA, usually null"
        },
        "createdDate" : {
          "type" : "string",
          "format" : "date-time",
          "example" : "2020-11-19T10:34:56.000Z",
          "description" : "Datetime of the creation of CBA in CDS"
        },
        "artifactName" : {
          "type" : "string",
          "example" : "pnf_netconf",
          "description" : "Artifact Name, defined in Metadata"
        },
        "published" : {
          "type" : "string",
          "example" : "pnf_netconf",
          "description" : "Artifact Name, defined in Metadata"
        },
        "updatedBy" : {
          "type" : "string",
          "example" : "Deutsche Telekom AG",
          "description" : "Name of publisher, defined in Metadata"
        },
        "tags" : {
          "type" : "string",
          "example" : "test",
          "description" : "Tags to identify the CBA, defined in Metadata"
        }
      }
    },
    "BootstrapRequest" : {
      "type" : "object",
      "required" : [ "loadCBA", "loadModelType", "loadResourceDictionary" ],
      "properties" : {
        "loadModelType" : {
          "type" : "boolean",
          "example" : true,
          "description" : "Specifies if default model types should be loaded"
        },
        "loadResourceDictionary" : {
          "type" : "boolean",
          "example" : true,
          "description" : "Specifies if default data dictionaries should be loaded"
        },
        "loadCBA" : {
          "type" : "boolean",
          "example" : true,
          "description" : "Specifies if default blueprint models should be loaded"
        }
      }
    },
    "FilePart" : {
      "type" : "object"
    },
    "Page" : {
      "type" : "object",
      "properties" : {
        "totalPages" : {
          "type" : "integer",
          "format" : "int32"
        },
        "totalElements" : {
          "type" : "integer",
          "format" : "int64"
        },
        "size" : {
          "type" : "integer",
          "format" : "int32"
        },
        "content" : {
          "type" : "array",
          "items" : {
            "type" : "object"
          }
        },
        "number" : {
          "type" : "integer",
          "format" : "int32"
        },
        "sort" : {
          "$ref" : "#/definitions/Sort"
        },
        "last" : {
          "type" : "boolean"
        },
        "numberOfElements" : {
          "type" : "integer",
          "format" : "int32"
        },
        "pageable" : {
          "$ref" : "#/definitions/Pageable"
        },
        "first" : {
          "type" : "boolean"
        },
        "empty" : {
          "type" : "boolean"
        }
      }
    },
    "PageBlueprintModelSearch" : {
      "type" : "object",
      "properties" : {
        "totalPages" : {
          "type" : "integer",
          "format" : "int32"
        },
        "totalElements" : {
          "type" : "integer",
          "format" : "int64"
        },
        "size" : {
          "type" : "integer",
          "format" : "int32"
        },
        "content" : {
          "type" : "array",
          "items" : {
            "$ref" : "#/definitions/BlueprintModelSearch"
          }
        },
        "number" : {
          "type" : "integer",
          "format" : "int32"
        },
        "sort" : {
          "$ref" : "#/definitions/Sort"
        },
        "last" : {
          "type" : "boolean"
        },
        "numberOfElements" : {
          "type" : "integer",
          "format" : "int32"
        },
        "pageable" : {
          "$ref" : "#/definitions/Pageable"
        },
        "first" : {
          "type" : "boolean"
        },
        "empty" : {
          "type" : "boolean"
        }
      }
    },
    "Pageable" : {
      "type" : "object",
      "properties" : {
        "offset" : {
          "type" : "integer",
          "format" : "int64"
        },
        "sort" : {
          "$ref" : "#/definitions/Sort"
        },
        "paged" : {
          "type" : "boolean"
        },
        "unpaged" : {
          "type" : "boolean"
        },
        "pageNumber" : {
          "type" : "integer",
          "format" : "int32"
        },
        "pageSize" : {
          "type" : "integer",
          "format" : "int32"
        }
      }
    },
    "Sort" : {
      "type" : "object",
      "properties" : {
        "unsorted" : {
          "type" : "boolean"
        },
        "sorted" : {
          "type" : "boolean"
        },
        "empty" : {
          "type" : "boolean"
        }
      }
    },
    "WorkFlowSpecRequest" : {
      "type" : "object",
      "required" : [ "blueprintName", "workflowName" ],
      "properties" : {
        "blueprintName" : {
          "type" : "string",
          "example" : "pnf_netconf",
          "description" : "Name of the BLueprint"
        },
        "version" : {
          "type" : "string"
        },
        "returnContent" : {
          "type" : "string"
        },
        "workflowName" : {
          "type" : "string",
          "example" : "config-assign",
          "description" : "Name of the Workflow"
        },
        "specType" : {
          "type" : "string"
        }
      }
    }
  }
}