Add note on openapi and useGraphModule property + add default value in Helm chart

Author: jreynard-code

api/kubernetes/helm-chart/values.yaml

@@ -176,6 +176,7 @@ config:
         password: changeme
         port: 6379
         username: default
+        useGraphModule: true
         tls:
           enabled: false
           bundle: "changeme"

dataset/src/main/kotlin/com/cosmotech/dataset/service/DatasetServiceImpl.kt

@@ -129,13 +129,14 @@ class DatasetServiceImpl(
     private val unifiedJedis: UnifiedJedis,
     private val csmRbac: CsmRbac,
     private val csmAdmin: CsmAdmin,
-    private val resourceScanner: ResourceScanner,
-    @Value("\${csm.platform.twincache.useGraphModule}") private val useGraphModule: Boolean
+    private val resourceScanner: ResourceScanner
 ) : CsmPhoenixService(), DatasetApiServiceInterface {
 
+  @Value("\${csm.platform.twincache.useGraphModule}") private var useGraphModule: Boolean = true
+
   private val notImplementedExceptionMessage =
       "The API is not configured to use Graph functionnalities. " +
-          "This endpoint is deactivated so. " +
+          "This endpoint is deactivated. " +
           "To change that, set the API configuration entry 'csm.platform.twincache.useGraphModule' to true"
 
   override fun findAllDatasets(organizationId: String, page: Int?, size: Int?): List<Dataset> {

dataset/src/main/openapi/dataset.yaml

@@ -288,6 +288,7 @@ paths:
         * The id of the edge
 
         All following columns content are up to you.
+        Note: This endpoint is activated only if `csm.platform.twincache.useGraphModule` property is set to true
       requestBody:
         required: true
         content:
@@ -331,7 +332,9 @@ paths:
       tags:
         - dataset
       summary: Create a sub-dataset from the dataset in parameter
-      description: Create a copy of the dataset using the results of the list of queries given in parameter.
+      description: |
+        Create a copy of the dataset using the results of the list of queries given in parameter.
+        Note: This endpoint is activated only if `csm.platform.twincache.useGraphModule` property is set to true
       requestBody:
         description: the Cypher query to filter
         required: true
@@ -383,6 +386,7 @@ paths:
             Local File (import a new file)
 
         During refresh, datas are overwritten
+        Note: This endpoint is activated only if `csm.platform.twincache.useGraphModule` property is set to true
       responses:
         '200':
           description: Successful response
@@ -409,7 +413,9 @@ paths:
       tags:
         - dataset
       summary: Rollback the dataset after a failed refresh
-      description: Rollback the twingraph on a dataset after a failed refresh
+      description: |
+        Rollback the twingraph on a dataset after a failed refresh
+        Note: This endpoint is activated only if `csm.platform.twincache.useGraphModule` property is set to true
       responses:
         '200':
           description: Successful response
@@ -440,7 +446,9 @@ paths:
       tags:
         - dataset
       summary: Return the result of a query made on the graph instance as a json
-      description: Run a query on a graph instance and return the result as a json
+      description: |
+        Run a query on a graph instance and return the result as a json
+        Note: This endpoint is activated only if `csm.platform.twincache.useGraphModule` property is set to true
       requestBody:
         description: the query to run
         required: true
@@ -489,7 +497,9 @@ paths:
       tags:
         - dataset
       summary: Create new entities in a graph instance
-      description: create new entities in a graph instance
+      description: | 
+        Create new entities in a graph instance
+        Note: This endpoint is activated only if `csm.platform.twincache.useGraphModule` property is set to true
       requestBody:
         description: the entities to create
         required: true
@@ -514,7 +524,9 @@ paths:
       tags:
         - dataset
       summary: Get entities in a graph instance
-      description: get entities in a graph instance
+      description: |
+        Get entities in a graph instance
+        Note: This endpoint is activated only if `csm.platform.twincache.useGraphModule` property is set to true
       parameters:
         - name: ids
           in: query
@@ -538,7 +550,9 @@ paths:
       summary: Update entities in a graph instance
       description: update entities in a graph instance
       requestBody:
-        description: the entities to update
+        description: | 
+          The entities to update
+          Note: This endpoint is activated only if `csm.platform.twincache.useGraphModule` property is set to true
         required: true
         content:
           application/json:
@@ -561,7 +575,9 @@ paths:
       tags:
         - dataset
       summary: Delete entities in a graph instance
-      description: delete entities in a graph instance
+      description: | 
+        Delete entities in a graph instance
+        Note: This endpoint is activated only if `csm.platform.twincache.useGraphModule` property is set to true
       parameters:
         - name: ids
           in: query
@@ -627,7 +643,9 @@ paths:
       tags:
         - dataset
       summary: "Async batch update by loading a CSV file on a graph instance "
-      description: "Async batch update by loading a CSV file on a graph instance "
+      description: |
+        Async batch update by loading a CSV file on a graph instance 
+        Note: This endpoint is activated only if `csm.platform.twincache.useGraphModule` property is set to true
       requestBody:
         required: true
         content:
@@ -679,7 +697,9 @@ paths:
       tags:
         - dataset
       summary: Run a query on a graph instance and return the result as a zip file in async mode
-      description: Run a query on a graph instance and return the result as a zip file in async mode
+      description: |
+        Run a query on a graph instance and return the result as a zip file in async mode
+        Note: This endpoint is activated only if `csm.platform.twincache.useGraphModule` property is set to true
       requestBody:
         description: the query to run
         required: true
@@ -716,7 +736,9 @@ paths:
       tags:
         - dataset
       summary: Download a graph as a zip file
-      description: Download the compressed graph reference by the hash in a zip file
+      description: |
+        Download the compressed graph reference by the hash in a zip file
+        Note: This endpoint is activated only if `csm.platform.twincache.useGraphModule` property is set to true
       responses:
         '200':
           description: Successful response

doc/Apis/DatasetApi.md

@@ -151,7 +151,7 @@ Create a new Dataset
 
 Create a sub-dataset from the dataset in parameter
 
-    Create a copy of the dataset using the results of the list of queries given in parameter.
+    Create a copy of the dataset using the results of the list of queries given in parameter. Note: This endpoint is activated only if `csm.platform.twincache.useGraphModule` property is set to true 
 
 ### Parameters
 
@@ -180,7 +180,7 @@ Create a sub-dataset from the dataset in parameter
 
 Create new entities in a graph instance
 
-    create new entities in a graph instance
+    Create new entities in a graph instance Note: This endpoint is activated only if `csm.platform.twincache.useGraphModule` property is set to true 
 
 ### Parameters
 
@@ -236,7 +236,7 @@ null (empty response body)
 
 Delete entities in a graph instance
 
-    delete entities in a graph instance
+    Delete entities in a graph instance Note: This endpoint is activated only if `csm.platform.twincache.useGraphModule` property is set to true 
 
 ### Parameters
 
@@ -266,7 +266,7 @@ null (empty response body)
 
 Download a graph as a zip file
 
-    Download the compressed graph reference by the hash in a zip file
+    Download the compressed graph reference by the hash in a zip file Note: This endpoint is activated only if `csm.platform.twincache.useGraphModule` property is set to true 
 
 ### Parameters
 
@@ -454,7 +454,7 @@ Get the dataset's refresh job status
 
 Get entities in a graph instance
 
-    get entities in a graph instance
+    Get entities in a graph instance Note: This endpoint is activated only if `csm.platform.twincache.useGraphModule` property is set to true 
 
 ### Parameters
 
@@ -511,7 +511,7 @@ Get entities in a graph instance
 
 Refresh data on dataset from dataset's source
 
-    Refresh dataset from parent source. At date, sources can be:      dataset (refresh from another dataset)      Azure Digital twin      Azure storage      Local File (import a new file)  During refresh, datas are overwritten 
+    Refresh dataset from parent source. At date, sources can be:      dataset (refresh from another dataset)      Azure Digital twin      Azure storage      Local File (import a new file)  During refresh, datas are overwritten Note: This endpoint is activated only if `csm.platform.twincache.useGraphModule` property is set to true 
 
 ### Parameters
 
@@ -592,7 +592,7 @@ null (empty response body)
 
 Rollback the dataset after a failed refresh
 
-    Rollback the twingraph on a dataset after a failed refresh
+    Rollback the twingraph on a dataset after a failed refresh Note: This endpoint is activated only if `csm.platform.twincache.useGraphModule` property is set to true 
 
 ### Parameters
 
@@ -675,7 +675,7 @@ Set the Dataset default security
 
 Run a query on a graph instance and return the result as a zip file in async mode
 
-    Run a query on a graph instance and return the result as a zip file in async mode
+    Run a query on a graph instance and return the result as a zip file in async mode Note: This endpoint is activated only if `csm.platform.twincache.useGraphModule` property is set to true 
 
 ### Parameters
 
@@ -704,7 +704,7 @@ Run a query on a graph instance and return the result as a zip file in async mod
 
 Async batch update by loading a CSV file on a graph instance 
 
-    Async batch update by loading a CSV file on a graph instance 
+    Async batch update by loading a CSV file on a graph instance  Note: This endpoint is activated only if `csm.platform.twincache.useGraphModule` property is set to true 
 
 ### Parameters
 
@@ -734,7 +734,7 @@ Async batch update by loading a CSV file on a graph instance
 
 Return the result of a query made on the graph instance as a json
 
-    Run a query on a graph instance and return the result as a json
+    Run a query on a graph instance and return the result as a json Note: This endpoint is activated only if `csm.platform.twincache.useGraphModule` property is set to true 
 
 ### Parameters
 
@@ -854,7 +854,7 @@ Update entities in a graph instance
 | **organization\_id** | **String**| the Organization identifier | [default to null] |
 | **dataset\_id** | **String**| the Dataset Identifier | [default to null] |
 | **type** | **String**| the entity model type | [default to null] [enum: node, relationship] |
-| **GraphProperties** | [**List**](../Models/GraphProperties.md)| the entities to update | |
+| **GraphProperties** | [**List**](../Models/GraphProperties.md)| The entities to update Note: This endpoint is activated only if `csm.platform.twincache.useGraphModule` property is set to true  | |
 
 ### Return type
 
@@ -875,7 +875,7 @@ Update entities in a graph instance
 
 Upload data from zip file to dataset's twingraph
 
-    To create a new graph from flat files,  you need to create a Zip file. This Zip file must countain two folders named Edges and Nodes.  .zip hierarchy: *main_folder/Nodes *main_folder/Edges  In each folder you can place one or multiple csv files containing your Nodes or Edges data.  Your csv files must follow the following header (column name) requirements:  The Nodes CSVs requires at least one column (the 1st).Column name = 'id'. It will represent the nodes ID Ids must be populated with string  The Edges CSVs require three columns named, in order, * source * target * id  those colomns represent * The source of the edge * The target of the edge * The id of the edge  All following columns content are up to you. 
+    To create a new graph from flat files,  you need to create a Zip file. This Zip file must countain two folders named Edges and Nodes.  .zip hierarchy: *main_folder/Nodes *main_folder/Edges  In each folder you can place one or multiple csv files containing your Nodes or Edges data.  Your csv files must follow the following header (column name) requirements:  The Nodes CSVs requires at least one column (the 1st).Column name = 'id'. It will represent the nodes ID Ids must be populated with string  The Edges CSVs require three columns named, in order, * source * target * id  those colomns represent * The source of the edge * The target of the edge * The id of the edge  All following columns content are up to you. Note: This endpoint is activated only if `csm.platform.twincache.useGraphModule` property is set to true 
 
 ### Parameters