docs: documentation updated

cognitedata · Jul 27, 2023 · 25c1fbb · 25c1fbb
1 parent a45519e
commit 25c1fbb
Show file tree

Hide file tree

Showing 2 changed files with 26 additions and 3 deletions.
diff --git a/config/config.example.yml b/config/config.example.yml
@@ -257,6 +257,29 @@ cognite:
         # Table to store relationships in
         relationships-table:
 
+    # CDF target configurations. Regardless of the configuration here, a form of timeseries is always created (either full or minimal) for now.
+    # In the future however, users are expected to create target specific destinations.
+    metadata-targets:
+      # Configuration to enable some form of clean i.e. assets, timeseries or relationships.
+      clean:
+        # Toggle CDF assets destination as a target
+        assets: false
+        # Toggle CDF timeseries destination as a target
+        timeseries: false
+        # Toggle CDF relationships destination as a target
+        relationships: false
+      # Configuration for some form or CDF raw destination.
+      # When this is used, it is required that 'database' name and any of the other keys are provided
+      raw:
+        # Database name 
+        database:
+        # Assets table name
+        assets-table:
+        # Timeseries table name
+        timeseries-table:
+        # Relationships table name
+        relationships-table:
+
     # Read from CDF instead of OPC-UA when starting, to speed up start on slow servers.
     # Requires extraction.data-types.expand-node-ids and append-internal-values to be set to true.
 

diff --git a/schema/cognite_config.schema.json b/schema/cognite_config.schema.json
@@ -34,7 +34,7 @@
             "description": "Metadata targets for objects, variable and references in CDF.",
             "unevaluatedProperties": false,
             "properties": {
-                "raw-metadata": {
+                "raw": {
                     "type": "object",
                     "description": "Details of CDF raw (database and table).",
                     "unevaluatedProperties": false,
@@ -58,7 +58,7 @@
                         }
                     }
                 },
-                "clean-metadata": {
+                "clean": {
                     "unevaluatedProperties": false,
                     "description": "Enable or disable assets, timeseries and/or relationships",
                     "type": "object",
@@ -77,7 +77,7 @@
                         }
                     }
                 },
-                "flexible-data-models": {
+                "data-models": {
                     "unevaluatedProperties": false,
                     "description": "configuration for flexible data models in CDF",
                     "type": "object",