fix(docs): minor doc corrections for consistency

kestra-io · Jan 14, 2024 · d84fc2a · d84fc2a
1 parent f733bc9
commit d84fc2a
Show file tree

Hide file tree

Showing 7 changed files with 12 additions and 12 deletions.
diff --git a/plugin-jdbc-arrow-flight/src/main/java/io/kestra/plugin/jdbc/arrowflight/Query.java b/plugin-jdbc-arrow-flight/src/main/java/io/kestra/plugin/jdbc/arrowflight/Query.java
@@ -33,17 +33,17 @@
             code = {
                 "url: jdbc:arrow-flight-sql://localhost:31010/?useEncryption=false",
                 "username: db_user",
-                "password: db_password",
+                "password: db_passwd",
                 "sql: select * FROM departments",
                 "fetch: true",
             }
         ),
         @Example(
-            title = "Send a sql query to a Dremio coordinator and fetch rows as outputs using Apache Arrow Flight SQL driver.",
+            title = "Send a SQL query to a Dremio coordinator and fetch rows as outputs using Apache Arrow Flight SQL driver.",
             code = {
                 "url: jdbc:arrow-flight-sql://dremio-coordinator:32010/?schema=postgres.public",
                 "username: dremio_user",
-                "password: dremio_password",
+                "password: dremio_passwd",
                 "sql: select * FROM departments",
                 "fetch: true",
             }

diff --git a/plugin-jdbc-arrow-flight/src/main/java/io/kestra/plugin/jdbc/arrowflight/Trigger.java b/plugin-jdbc-arrow-flight/src/main/java/io/kestra/plugin/jdbc/arrowflight/Trigger.java
@@ -46,7 +46,7 @@
                 "  - id: watch",
                 "    type: io.kestra.plugin.jdbc.arrowflight.Trigger",
                 "    username: dremio_user",
-                "    password: dremio_password",
+                "    password: dremio_passwd",
                 "    url: jdbc:arrow-flight-sql://dremio-coordinator:32010/?schema=postgres.public",
                 "    interval: \"PT5M\"",
                 "    sql: \"SELECT * FROM my_table\"",

diff --git a/plugin-jdbc-arrow-flight/src/main/java/io/kestra/plugin/jdbc/arrowflight/package-info.java b/plugin-jdbc-arrow-flight/src/main/java/io/kestra/plugin/jdbc/arrowflight/package-info.java
@@ -1,5 +1,5 @@
 @PluginSubGroup(
-    description = "This sub-group of plugins contains tasks for accessing a databases through Apache Arrow Flight SQL.",
+    description = "This sub-group of plugins contains tasks for accessing a database through Apache Arrow Flight SQL.",
     categories = PluginSubGroup.PluginCategory.DATABASE
 )
 package io.kestra.plugin.jdbc.arrowflight;

diff --git a/plugin-jdbc-clickhouse/src/main/java/io/kestra/plugin/jdbc/clickhouse/Query.java b/plugin-jdbc-clickhouse/src/main/java/io/kestra/plugin/jdbc/clickhouse/Query.java
@@ -29,7 +29,7 @@
 @Plugin(
     examples = {
         @Example(
-            title = "Send a sql query to a Clickhouse database and fetch a row as output.",
+            title = "Send a SQL query to a Clickhouse database and fetch a row as output.",
             code = {
                 "url: jdbc:clickhouse://127.0.0.1:56982/",
                 "username: ch_user",

diff --git a/plugin-jdbc-mysql/src/main/java/io/kestra/plugin/jdbc/mysql/Query.java b/plugin-jdbc-mysql/src/main/java/io/kestra/plugin/jdbc/mysql/Query.java
@@ -33,7 +33,7 @@
 @Plugin(
     examples = {
         @Example(
-            title = "Send a sql query to a MySQL Database and fetch a row as output.",
+            title = "Send a SQL query to a MySQL Database and fetch a row as output.",
             code = {
                 "url: jdbc:mysql://127.0.0.1:3306/",
                 "username: mysql_user",

diff --git a/plugin-jdbc/src/main/java/io/kestra/plugin/jdbc/AbstractJdbcQuery.java b/plugin-jdbc/src/main/java/io/kestra/plugin/jdbc/AbstractJdbcQuery.java
@@ -212,7 +212,7 @@ public static class Output implements io.kestra.core.models.tasks.Output {
         private final URI uri;
 
         @Schema(
-            title = "The number of rows to be fetched.",
+            title = "The number of rows fetched.",
             description = "Only populated if `store` or `fetch` parameter is set to true."
         )
         private final Long size;

diff --git a/plugin-jdbc/src/main/java/io/kestra/plugin/jdbc/JdbcQueryInterface.java b/plugin-jdbc/src/main/java/io/kestra/plugin/jdbc/JdbcQueryInterface.java
@@ -6,14 +6,14 @@
 
 public interface JdbcQueryInterface extends JdbcStatementInterface {
     @Schema(
-        title = "The sql query to run."
+        title = "The SQL query to run."
     )
     @PluginProperty(dynamic = true)
     String getSql();
 
     @Schema(
         title = "Whether to fetch the data from the query result to the task output." +
-            " This parameter is evaluated after 'fetchOne' and 'store'."
+            " This parameter is evaluated after `fetchOne` and `store`."
     )
     @PluginProperty(dynamic = false)
     boolean isFetch();
@@ -23,14 +23,14 @@ public interface JdbcQueryInterface extends JdbcStatementInterface {
             " File will be saved as Amazon Ion (text format)." +
             " \n" +
             " See <a href=\"http://amzn.github.io/ion-docs/\">Amazon Ion documentation</a>" +
-            " This parameter is evaluated after 'fetchOne' but before 'fetch'."
+            " This parameter is evaluated after `fetchOne` but before `fetch`."
     )
     @PluginProperty(dynamic = false)
     boolean isStore();
 
     @Schema(
         title = "Whether to fetch only one data row from the query result to the task output." +
-            " This parameter is evaluated before 'store' and 'fetch'."
+            " This parameter is evaluated before `store` and `fetch`."
     )
     @PluginProperty(dynamic = false)
     boolean isFetchOne();