chore: add links to the documentation (#683)

camunda · Jun 7, 2023 · 2adb598 · 2adb598
1 parent c6fc6da
commit 2adb598
Show file tree

Hide file tree

Showing 7 changed files with 31 additions and 27 deletions.
diff --git a/connectors/google/google-sheets/README.md b/connectors/google/google-sheets/README.md
@@ -97,7 +97,7 @@ mvn clean package
 
 ```json
 {
-  "action": "Create Worksheet",
+  "action": "Create worksheet",
   "status": "OK",
   "response": null
 }
@@ -313,7 +313,7 @@ mvn clean package
 
 ```json
 {
-  "action": "Delete Worksheet",
+  "action": "Delete worksheet",
   "status": "OK",
   "response": null
 }
@@ -467,7 +467,7 @@ mvn clean package
 ```json
 
 {
-  "action": "Create Row",
+  "action": "Create row",
   "status": "OK",
   "response": null
 }
@@ -602,7 +602,7 @@ mvn clean package
 
 ```json
 {
-  "action": "Get Row by index",
+  "action": "Get row by index",
   "status": "OK",
   "response": []
 }
@@ -648,7 +648,7 @@ mvn clean package
 
 ```json
 {
-  "action": "Get Worksheet data",
+  "action": "Get worksheet data",
   "status": "OK",
   "response": [
     []

diff --git a/connectors/google/google-sheets/element-templates/google-sheets-connector.json b/connectors/google/google-sheets/element-templates/google-sheets-connector.json
@@ -3,7 +3,7 @@
   "name": "Google Sheets connector",
   "id": "io.camunda.connectors.GoogleSheets.v1",
   "version": 1,
-  "documentationRef": "https://docs.camunda.io/docs/components/connectors/out-of-the-box-connectors/googlesheets/",
+  "documentationRef": "https://docs.camunda.io/docs/components/connectors/out-of-the-box-connectors/google-sheets/",
   "description": "Work with spreadsheets",
   "category": {
     "id": "connectors",
@@ -69,7 +69,7 @@
     },
     {
       "label": "Bearer token",
-      "description": "Enter Google API Bearer token that is authorized to interact with desired Drive",
+      "description": "Enter Google API Bearer token that is authorized to interact with desired spreadsheet",
       "group": "authentication",
       "type": "String",
       "binding": {
@@ -120,7 +120,7 @@
     },
     {
       "label": "Refresh token",
-      "description": "Enter Google API refresh token that is authorized to interact with desired Drive",
+      "description": "Enter Google API refresh token that is authorized to interact with desired spreadsheet",
       "group": "authentication",
       "type": "String",
       "binding": {
@@ -266,7 +266,11 @@
       },
       "constraints": {
         "notEmpty": true,
-        "maxLength": 100
+        "maxLength": 100,
+        "pattern": {
+          "value": "^([0-9]*$)",
+          "message": "Must be a number."
+        }
       },
       "condition": {
         "property": "operationType",
@@ -326,7 +330,7 @@
     },
     {
       "label": "Worksheet index",
-      "description": "Enter index of the place where to add worksheet (leave empty if add to the end of sheet list) Details in the <a href=\"https://docs.camunda.io/docs/components/connectors/use-connectors\" target=\"_blank\">documentation</a>",
+      "description": "Enter index of the place where to add worksheet (leave empty if add to the end of sheet list) Details in the <a href=\"https://docs.camunda.io/docs/components/connectors/out-of-the-box-connectors/google-sheets/#what-is-a-worksheet-index\" target=\"_blank\">documentation</a>",
       "group": "operationDetails",
       "type": "String",
       "feel": "optional",
@@ -378,7 +382,7 @@
     },
     {
       "label": "Row index",
-      "description": "Enter row index. Details in the <a href=\"https://docs.camunda.io/docs/components/connectors/use-connectors\" target=\"_blank\">documentation</a>",
+      "description": "Enter row index. Details in the <a href=\"https://docs.camunda.io/docs/components/connectors/out-of-the-box-connectors/google-sheets/#what-is-a-row-index\" target=\"_blank\">documentation</a>",
       "group": "operationDetails",
       "type": "String",
       "feel": "optional",
@@ -402,7 +406,7 @@
     },
     {
       "label": "Row index",
-      "description": "Enter the index of the row to add . Details in the <a href=\"https://docs.camunda.io/docs/components/connectors/use-connectors\" target=\"_blank\">documentation</a>",
+      "description": "Enter the index of the row to add . Details in the <a href=\"https://docs.camunda.io/docs/components/connectors/out-of-the-box-connectors/google-sheets/#what-is-a-row-index\" target=\"_blank\">documentation</a>",
       "group": "operationDetails",
       "type": "String",
       "feel": "optional",
@@ -427,7 +431,7 @@
     {
       "id": "columnIndexFormat",
       "label": "Index format",
-      "description": "Choose the type of the index. Details in the <a href=\"https://docs.camunda.io/docs/components/connectors/use-connectors\" target=\"_blank\">documentation</a>",
+      "description": "Choose the type of the index. Details in the <a href=\"https://docs.camunda.io/docs/components/connectors/out-of-the-box-connectors/google-sheets/#how-can-i-define-which-column-will-be-deleted\" target=\"_blank\">documentation</a>",
       "group": "operationDetails",
       "type": "Dropdown",
       "optional": false,
@@ -455,7 +459,7 @@
     },
     {
       "label": "Column letter index",
-      "description": "Enter the index of the column. Details in the <a href=\"https://docs.camunda.io/docs/components/connectors/use-connectors\" target=\"_blank\">documentation</a>",
+      "description": "Enter the index of the column. Details in the <a href=\"https://docs.camunda.io/docs/components/connectors/out-of-the-box-connectors/google-sheets/#how-can-i-define-which-column-will-be-deleted\" target=\"_blank\">documentation</a>",
       "group": "operationDetails",
       "type": "String",
       "feel": "optional",
@@ -478,8 +482,8 @@
       }
     },
     {
-      "label": "Column number index",
-      "description": "Enter the index of the column. Details in the <a href=\"https://docs.camunda.io/docs/components/connectors/use-connectors\" target=\"_blank\">documentation</a>",
+      "label": "Column numeric index",
+      "description": "Enter the index of the column. Details in the <a href=\"https://docs.camunda.io/docs/components/connectors/out-of-the-box-connectors/google-sheets/#how-can-i-define-which-column-will-be-deleted\" target=\"_blank\">documentation</a>",
       "group": "operationDetails",
       "type": "String",
       "feel": "optional",
@@ -503,7 +507,7 @@
     },
     {
       "label": "Start index",
-      "description": "Enter start index (leave empty if add to the end of the sheet). Details in the <a href=\"https://docs.camunda.io/docs/components/connectors/use-connectors\" target=\"_blank\">documentation</a>",
+      "description": "Enter start index (leave empty if add to the end of the sheet). Details in the <a href=\"https://docs.camunda.io/docs/components/connectors/out-of-the-box-connectors/google-sheets/#create-empty-column-or-row\" target=\"_blank\">documentation</a>",
       "group": "operationDetails",
       "type": "String",
       "feel": "optional",
@@ -527,7 +531,7 @@
     },
     {
       "label": "End index",
-      "description": "Enter End index (leave empty if add to the end of the sheet) Details in the <a href=\"https://docs.camunda.io/docs/components/connectors/use-connectors\" target=\"_blank\">documentation</a>",
+      "description": "Enter End index (leave empty if add to the end of the sheet) Details in the <a href=\"https://docs.camunda.io/docs/components/connectors/out-of-the-box-connectors/google-sheets/#create-empty-column-or-row\" target=\"_blank\">documentation</a>",
       "group": "operationDetails",
       "type": "String",
       "feel": "optional",
@@ -551,7 +555,7 @@
     },
     {
       "label": "Cell ID",
-      "description": "Enter the ID of the cell. Details in the <a href=\"https://docs.camunda.io/docs/components/connectors/use-connectors/#result-variable\" target=\"_blank\">documentation</a>",
+      "description": "Enter the ID of the cell. Details in the <a href=\"https://docs.camunda.io/docs/components/connectors/out-of-the-box-connectors/google-sheets/#add-values-to-spreadsheet\" target=\"_blank\">documentation</a>",
       "group": "operationDetails",
       "type": "String",
       "feel": "optional",
@@ -571,7 +575,7 @@
     },
     {
       "label": "Enter values",
-      "description": "Enter the array of values. <a href=\"https://docs.camunda.io/docs/components/connectors/use-connectors/#bpmn-errors\" target=\"_blank\">Learn more about the required format</a>",
+      "description": "Enter the array of values. <a href=\"https://docs.camunda.io/docs/components/connectors/out-of-the-box-connectors/google-sheets/#create-row\" target=\"_blank\">Learn more about the required format</a>",
       "group": "operationDetails",
       "type": "Text",
       "feel": "required",

diff --git a/...-sheets/src/main/java/io/camunda/connector/gsheets/operation/impl/CreateRowOperation.java b/...-sheets/src/main/java/io/camunda/connector/gsheets/operation/impl/CreateRowOperation.java
@@ -30,7 +30,7 @@ public Object execute(Authentication auth) {
     try {
       this.update(auth, model.getSpreadsheetId(), range, valueRange);
 
-      return new GoogleSheetsResult("Create Row", "OK");
+      return new GoogleSheetsResult("Create row", "OK");
     } catch (IOException e) {
       throw new RuntimeException(e);
     }

diff --git a/...s/src/main/java/io/camunda/connector/gsheets/operation/impl/CreateWorksheetOperation.java b/...s/src/main/java/io/camunda/connector/gsheets/operation/impl/CreateWorksheetOperation.java
@@ -41,7 +41,7 @@ public Object execute(Authentication auth) {
     try {
       this.batchUpdate(auth, model.getSpreadsheetId(), updateRequest);
 
-      return new GoogleSheetsResult("Create Worksheet", "OK");
+      return new GoogleSheetsResult("Create worksheet", "OK");
     } catch (IOException e) {
       throw new RuntimeException(e);
     }

diff --git a/...s/src/main/java/io/camunda/connector/gsheets/operation/impl/DeleteWorksheetOperation.java b/...s/src/main/java/io/camunda/connector/gsheets/operation/impl/DeleteWorksheetOperation.java
@@ -35,7 +35,7 @@ public Object execute(Authentication auth) {
     try {
       this.batchUpdate(auth, model.getSpreadsheetId(), updateRequest);
 
-      return new GoogleSheetsResult("Delete Worksheet", "OK");
+      return new GoogleSheetsResult("Delete worksheet", "OK");
     } catch (IOException e) {
       throw new RuntimeException(e);
     }

diff --git a/...ets/src/main/java/io/camunda/connector/gsheets/operation/impl/GetRowByIndexOperation.java b/...ets/src/main/java/io/camunda/connector/gsheets/operation/impl/GetRowByIndexOperation.java
@@ -29,10 +29,10 @@ public Object execute(Authentication auth) {
       List<List<Object>> values = this.get(auth, model.getSpreadsheetId(), range);
 
       if (values == null || values.isEmpty()) {
-        return new GoogleSheetsResult("Get Row by ID", "OK", null);
+        return new GoogleSheetsResult("Get row by index", "OK", null);
       }
 
-      return new GoogleSheetsResult("Get Row by index", "OK", values.get(0));
+      return new GoogleSheetsResult("Get row by index", "OK", values.get(0));
     } catch (IOException e) {
       throw new RuntimeException(e);
     }

diff --git a/.../src/main/java/io/camunda/connector/gsheets/operation/impl/GetWorksheetDataOperation.java b/.../src/main/java/io/camunda/connector/gsheets/operation/impl/GetWorksheetDataOperation.java
@@ -28,10 +28,10 @@ public Object execute(Authentication auth) {
           this.get(auth, model.getSpreadsheetId(), model.getWorksheetName());
 
       if (values == null || values.isEmpty()) {
-        return new GoogleSheetsResult("Get Worksheet data", "OK", null);
+        return new GoogleSheetsResult("Get worksheet data", "OK", null);
       }
 
-      return new GoogleSheetsResult("Get Worksheet data", "OK", values);
+      return new GoogleSheetsResult("Get worksheet data", "OK", values);
     } catch (IOException e) {
       throw new RuntimeException(e);
     }