From edcd63b99e475709b875936f43528561301c0e94 Mon Sep 17 00:00:00 2001 From: Ben Poppy Date: Tue, 13 Aug 2024 17:12:32 +0100 Subject: [PATCH] fix spelling issues --- .pre-commit-config.yaml | 2 +- src/schemas/json/kestra-0.18.json | 28 ++++++++++++++-------------- 2 files changed, 15 insertions(+), 15 deletions(-) diff --git a/.pre-commit-config.yaml b/.pre-commit-config.yaml index dae59730378..655502c55e7 100644 --- a/.pre-commit-config.yaml +++ b/.pre-commit-config.yaml @@ -19,5 +19,5 @@ repos: args: [ '--ignore-words-list', - 'crate,ninjs,ans,specif,seh,specifid,deriver,isnt,tye,forin,dependees,rouge,interm,fo,wast,nome,statics,ue,aack,gost,inout,provId,handels,bu,testng,ags,edn,aks,te,decorder,provid,branche,alse,nd,mape,wil,clude,wit,flate,omlet,THIRDPARTY,NotIn,notIn', + 'crate,ninjs,ans,specif,seh,specifid,deriver,isnt,tye,forin,dependees,rouge,interm,fo,wast,nome,statics,ue,aack,gost,inout,provId,handels,bu,testng,ags,edn,aks,te,decorder,provid,branche,alse,nd,mape,wil,clude,wit,flate,omlet,THIRDPARTY,NotIn,notIn,CopyIn', ] diff --git a/src/schemas/json/kestra-0.18.json b/src/schemas/json/kestra-0.18.json index 1899ef996a2..296daba2740 100644 --- a/src/schemas/json/kestra-0.18.json +++ b/src/schemas/json/kestra-0.18.json @@ -146923,7 +146923,7 @@ } }, "required": ["id", "type"], - "title": "Decrypt a file crypted with PGP", + "title": "Decrypt a file encrypted with PGP", "markdownDescription": "##### Examples\n\u003E Decrypt a file\n```yaml\nfrom: \"{{ inputs.file }}\"\nprivateKey: |\n -----BEGIN PGP PRIVATE KEY BLOCK-----\nprivateKeyPassphrase: my-passphrase\n```\n\n\u003E Decrypt a file and verify signature\n```yaml\nfrom: \"{{ inputs.file }}\"\nprivateKey: |\n -----BEGIN PGP PRIVATE KEY BLOCK-----\nprivateKeyPassphrase: my-passphrase\nsignUsersKey: \n - |\n -----BEGIN PGP PRIVATE KEY BLOCK-----\nrequiredSignerUsers: \n - signer@kestra.io\n```" }, "io.kestra.plugin.crypto.openpgp.Encrypt": { @@ -147019,7 +147019,7 @@ } }, "required": ["id", "recipients", "type"], - "title": "Encrypt a file crypted with PGP", + "title": "Encrypt a file encrypted with PGP", "markdownDescription": "##### Examples\n\u003E Encrypt a file not signed\n```yaml\nfrom: \"{{ inputs.file }}\"\nkey: |\n -----BEGIN PGP PUBLIC KEY BLOCK----- ... \nrecipients:\n - hello@kestra.io\n```\n\n\u003E Encrypt a file signed\n```yaml\nfrom: \"{{ inputs.file }}\"\nkey: |\n -----BEGIN PGP PUBLIC KEY BLOCK----- ... \nrecipients:\n - hello@kestra.io\nsignPublicKey: |\n -----BEGIN PGP PUBLIC KEY BLOCK----- ... \nsignPrivateKey: |\n -----BEGIN PGP PRIVATE KEY BLOCK-----\nsignPassphrase: my-passphrase\nsignUser: signer@kestra.io\n```" }, "io.kestra.plugin.databricks.AbstractTask-AuthenticationConfig": { @@ -148338,7 +148338,7 @@ }, "required": ["host", "httpPath", "id", "sql", "type"], "title": "Execute a SQL query on a Databricks cluster.", - "markdownDescription": "See [Retrieve the connection details](https://docs.databricks.com/integrations/jdbc-odbc-bi.html#retrieve-the-connection-details) in the Databricks documentation to discover how to retrieve the needed configuration properties.\nWe're using the Databricks JDBC driver to execute a Query, see [https://docs.databricks.com/integrations/jdbc-odbc-bi.html#jdbc-driver-capabilities](https://docs.databricks.com/integrations/jdbc-odbc-bi.html#jdbc-driver-capabilities) for its capabilities.\n\nDue to current limitation of the JDBC driver with Java 21, Arrow is disabled, performance may be impacted, see [here](https://community.databricks.com/t5/data-engineering/what-s-the-eta-for-supporting-java-21-in-the-jdbc-driver/td-p/57370) and [here](https://community.databricks.com/t5/data-engineering/java-21-support-with-databricks-jdbc-driver/m-p/49297) fro Databricks status on Java 21 support.\n##### Examples\n\u003E \n```yaml\nid: sqlQuery\ntype: io.kestra.plugin.databricks.sql.Query\naccessToken: \u003Cyour-accessToken\u003E\nhost: \u003Cyour-host\u003E\nhttpPath: \u003Cyour-httpPath\u003E\nsql: SELECT 1\n```" + "markdownDescription": "See [Retrieve the connection details](https://docs.databricks.com/integrations/jdbc-odbc-bi.html#retrieve-the-connection-details) in the Databricks documentation to discover how to retrieve the needed configuration properties.\nWe're using the Databricks JDBC driver to execute a Query, see [https://docs.databricks.com/integrations/jdbc-odbc-bi.html#jdbc-driver-capabilities](https://docs.databricks.com/integrations/jdbc-odbc-bi.html#jdbc-driver-capabilities) for its capabilities.\n\nDue to current limitation of the JDBC driver with Java 21, Arrow is disabled, performance may be impacted, see [here](https://community.databricks.com/t5/data-engineering/what-s-the-eta-for-supporting-java-21-in-the-jdbc-driver/td-p/57370) and [here](https://community.databricks.com/t5/data-engineering/java-21-support-with-databricks-jdbc-driver/m-p/49297) from Databricks status on Java 21 support.\n##### Examples\n\u003E \n```yaml\nid: sqlQuery\ntype: io.kestra.plugin.databricks.sql.Query\naccessToken: \u003Cyour-accessToken\u003E\nhost: \u003Cyour-host\u003E\nhttpPath: \u003Cyour-httpPath\u003E\nsql: SELECT 1\n```" }, "io.kestra.plugin.dataform.cli.DataformCLI": { "type": "object", @@ -158521,7 +158521,7 @@ "strictDeprecationMode": { "$dynamic": false, "type": "boolean", - "title": "Whether the REST client should return any response containing at leas one warning header as a failure." + "title": "Whether the REST client should return any response containing at least one warning header as a failure." }, "trustAllSsl": { "$dynamic": false, @@ -169786,7 +169786,7 @@ "enum": ["RECURSIVE", "DIRECTORY"], "title": "The listing type you want (like directory or recursive)", "default": "DIRECTORY", - "markdownDescription": "if DIRECTORY, will only list objects in the specified directory\nif RECURSIVE, will list objects in the specified directory recursively\nDefault value is DIRECTORY\nWhen using RECURSIVE value, be carefull to move your files to a location not in the `from` scope\n\nDefault value is : `DIRECTORY`" + "markdownDescription": "if DIRECTORY, will only list objects in the specified directory\nif RECURSIVE, will list objects in the specified directory recursively\nDefault value is DIRECTORY\nWhen using RECURSIVE value, be careful to move your files to a location not in the `from` scope\n\nDefault value is : `DIRECTORY`" }, "regExp": { "$dynamic": true, @@ -170395,7 +170395,7 @@ "enum": ["RECURSIVE", "DIRECTORY"], "title": "The listing type you want (like directory or recursive)", "default": "DIRECTORY", - "markdownDescription": "if DIRECTORY, will only list objects in the specified directory\nif RECURSIVE, will list objects in the specified directory recursively\nDefault value is DIRECTORY\nWhen using RECURSIVE value, be carefull to move your files to a location not in the `from` scope\n\nDefault value is : `DIRECTORY`" + "markdownDescription": "if DIRECTORY, will only list objects in the specified directory\nif RECURSIVE, will list objects in the specified directory recursively\nDefault value is DIRECTORY\nWhen using RECURSIVE value, be careful to move your files to a location not in the `from` scope\n\nDefault value is : `DIRECTORY`" }, "logLevel": { "type": "string", @@ -170578,7 +170578,7 @@ "enum": ["RECURSIVE", "DIRECTORY"], "title": "The listing type you want (like directory or recursive)", "default": "DIRECTORY", - "markdownDescription": "if DIRECTORY, will only list objects in the specified directory\nif RECURSIVE, will list objects in the specified directory recursively\nDefault value is DIRECTORY\nWhen using RECURSIVE value, be carefull to move your files to a location not in the `from` scope\n\nDefault value is : `DIRECTORY`" + "markdownDescription": "if DIRECTORY, will only list objects in the specified directory\nif RECURSIVE, will list objects in the specified directory recursively\nDefault value is DIRECTORY\nWhen using RECURSIVE value, be careful to move your files to a location not in the `from` scope\n\nDefault value is : `DIRECTORY`" }, "logLevel": { "type": "string", @@ -170689,7 +170689,7 @@ "enum": ["RECURSIVE", "DIRECTORY"], "title": "The listing type you want (like directory or recursive)", "default": "DIRECTORY", - "markdownDescription": "if DIRECTORY, will only list objects in the specified directory\nif RECURSIVE, will list objects in the specified directory recursively\nDefault value is DIRECTORY\nWhen using RECURSIVE value, be carefull to move your files to a location not in the `from` scope\n\nDefault value is : `DIRECTORY`" + "markdownDescription": "if DIRECTORY, will only list objects in the specified directory\nif RECURSIVE, will list objects in the specified directory recursively\nDefault value is DIRECTORY\nWhen using RECURSIVE value, be careful to move your files to a location not in the `from` scope\n\nDefault value is : `DIRECTORY`" }, "logLevel": { "type": "string", @@ -170988,7 +170988,7 @@ "enum": ["RECURSIVE", "DIRECTORY"], "title": "The listing type you want (like directory or recursive)", "default": "DIRECTORY", - "markdownDescription": "if DIRECTORY, will only list objects in the specified directory\nif RECURSIVE, will list objects in the specified directory recursively\nDefault value is DIRECTORY\nWhen using RECURSIVE value, be carefull to move your files to a location not in the `from` scope\n\nDefault value is : `DIRECTORY`" + "markdownDescription": "if DIRECTORY, will only list objects in the specified directory\nif RECURSIVE, will list objects in the specified directory recursively\nDefault value is DIRECTORY\nWhen using RECURSIVE value, be careful to move your files to a location not in the `from` scope\n\nDefault value is : `DIRECTORY`" }, "logLevel": { "type": "string", @@ -190263,7 +190263,7 @@ }, "required": ["hostname", "id", "password", "port", "type", "userDn"], "title": "Retrieves entries in LDAP.", - "markdownDescription": "Search and list entries based on a filter list for each base DN target.##### Examples\n\u003E Retrieve LDAP entries.\nIn this exemple, assuming that their is exactly one entry matching each of our filter,\nthe outputs of the task would be four entries in this order (since we search two times in the same baseDn) :\n(dn, description, mail) of {melusine, metatron, melusine, metatron}.\n```yaml\ndescription: What your task is supposed to do and why.\nuserDn: cn=admin,dc=orga,dc=en\npassword: admin\nbaseDn: ou=people,dc=orga,dc=en\nfilter: (|(sn=melusine*)(sn=metatron*))\nattributes:\n - description\n - mail\nhostname: 0.0.0.0\nport: 15060\n```" + "markdownDescription": "Search and list entries based on a filter list for each base DN target.##### Examples\n\u003E Retrieve LDAP entries.\nIn this example, assuming that their is exactly one entry matching each of our filter,\nthe outputs of the task would be four entries in this order (since we search two times in the same baseDn) :\n(dn, description, mail) of {melusine, metatron, melusine, metatron}.\n```yaml\ndescription: What your task is supposed to do and why.\nuserDn: cn=admin,dc=orga,dc=en\npassword: admin\nbaseDn: ou=people,dc=orga,dc=en\nfilter: (|(sn=melusine*)(sn=metatron*))\nattributes:\n - description\n - mail\nhostname: 0.0.0.0\nport: 15060\n```" }, "io.kestra.plugin.linear.issues.Create": { "type": "object", @@ -194664,7 +194664,7 @@ }, "required": ["id", "type", "url"], "title": "Send a Discord message using an Incoming Webhook", - "markdownDescription": "Add this task to a list of `errors` tasks to implement custom flow-level failure notifications. Check the \u003Ca href=\"https://discord.com/developers/docs/resources/webhook\"\u003EDiscord documentation\u003C/a\u003E for more details..##### Examples\n\u003E Send a Discord notification on a failed flow execution\n```yaml\nid: unreliable_flow\nnamespace: company.team\n\ntasks:\n - id: fail\n type: io.kestra.plugin.scripts.shell.Commands\n runner: PROCESS\n commands:\n - exit 1\n\nerrors:\n - id: alert_on_failure\n type: io.kestra.plugin.notifications.discord.DiscordIncomingWebhook\n url: \"{{ secret('DISCORD_WEBHOOK') }}\" # https://discord.com/api/webhooks/000000/xxxxxxxxxxx\n payload: |\n {\n \"username\": \"MyUsername\",\n \"content\": \"Failure alert for flow {{ flow.namespace }}.{{ flow.id }} with ID {{ execution.id }}\"\n \"embedList\": [{\n \"title\": \"Discord Notification\"\n }]\n }\n\n```\n\n\u003E Send a Discord message via incoming webhook\n```yaml\nid: discord_incoming_webhook\nnamespace: company.team\n\ntasks:\n - id: send_discord_message\n type: io.kestra.plugin.notifications.discord.DiscordIncomingWebhook\n url: \"{{ secret('DISCORD_WEBHOOK') }}\"\n payload: |\n {\n \"username\": \"MyUsername\",\n \"tts\": false,\n \"content\": \"Hello from the workflow {{ flow.id }}\",\n \"embeds\": [\n {\n \"title\": \"Discord Hello\",\n \"color\": 16777215\n \"description\": \"Namespace: dev\nFlow ID: discord\nExecution ID: 1p0JVFz24ZVLSK8iJN6hfs\nExecution Status: SUCCESS\n\n[Link to the Execution page](http://localhost:8080/ui/executions/dev/discord/1p0JVFz24ZVLSK8iJN6hfs)\",\n \"footer\": {\n \"text\": \"Succeded after 00:00:00.385\"\n }\n }\n ]\n }\n\n```" + "markdownDescription": "Add this task to a list of `errors` tasks to implement custom flow-level failure notifications. Check the \u003Ca href=\"https://discord.com/developers/docs/resources/webhook\"\u003EDiscord documentation\u003C/a\u003E for more details..##### Examples\n\u003E Send a Discord notification on a failed flow execution\n```yaml\nid: unreliable_flow\nnamespace: company.team\n\ntasks:\n - id: fail\n type: io.kestra.plugin.scripts.shell.Commands\n runner: PROCESS\n commands:\n - exit 1\n\nerrors:\n - id: alert_on_failure\n type: io.kestra.plugin.notifications.discord.DiscordIncomingWebhook\n url: \"{{ secret('DISCORD_WEBHOOK') }}\" # https://discord.com/api/webhooks/000000/xxxxxxxxxxx\n payload: |\n {\n \"username\": \"MyUsername\",\n \"content\": \"Failure alert for flow {{ flow.namespace }}.{{ flow.id }} with ID {{ execution.id }}\"\n \"embedList\": [{\n \"title\": \"Discord Notification\"\n }]\n }\n\n```\n\n\u003E Send a Discord message via incoming webhook\n```yaml\nid: discord_incoming_webhook\nnamespace: company.team\n\ntasks:\n - id: send_discord_message\n type: io.kestra.plugin.notifications.discord.DiscordIncomingWebhook\n url: \"{{ secret('DISCORD_WEBHOOK') }}\"\n payload: |\n {\n \"username\": \"MyUsername\",\n \"tts\": false,\n \"content\": \"Hello from the workflow {{ flow.id }}\",\n \"embeds\": [\n {\n \"title\": \"Discord Hello\",\n \"color\": 16777215\n \"description\": \"Namespace: dev\nFlow ID: discord\nExecution ID: 1p0JVFz24ZVLSK8iJN6hfs\nExecution Status: SUCCESS\n\n[Link to the Execution page](http://localhost:8080/ui/executions/dev/discord/1p0JVFz24ZVLSK8iJN6hfs)\",\n \"footer\": {\n \"text\": \"Succeeded after 00:00:00.385\"\n }\n }\n ]\n }\n\n```" }, "io.kestra.plugin.notifications.discord.DiscordTemplate-Embed": { "type": "object", @@ -205661,7 +205661,7 @@ "base": { "$dynamic": true, "type": "string", - "title": "The exchange rates currency used for convertion.", + "title": "The exchange rates currency used for conversion.", "default": "EUR", "minLength": 1, "markdownDescription": "Default value is : `EUR`" @@ -207516,7 +207516,7 @@ "type": "string", "title": "Endpoint URL.", "minLength": 1, - "markdownDescription": "The base URL contains the account id (a.k.a. Munchkin id) and is therefore unique for each Marketo subscription. Your base URL is found by logging into Marketo and navigating to the Admin \u003E Integration \u003E Web Services menu. It is labled as “Endpoint:” underneath the “REST API” section as shown in the following screenshots." + "markdownDescription": "The base URL contains the account id (a.k.a. Munchkin id) and is therefore unique for each Marketo subscription. Your base URL is found by logging into Marketo and navigating to the Admin \u003E Integration \u003E Web Services menu. It is labeled as “Endpoint:” underneath the “REST API” section as shown in the following screenshots." }, "id": { "type": "string", @@ -209808,7 +209808,7 @@ "channels": { "$dynamic": true, "title": "Channels to Sync.", - "markdownDescription": "By default the tap will sync all channels it has been invited to, but this can be overriden to limit it ot specific channels. Note this needs to be channel ID, not the name, as recommended by the Slack API. To get the ID for a channel, either use the Slack API or find it in the URL.", + "markdownDescription": "By default the tap will sync all channels it has been invited to, but this can be overridden to limit it to specific channels. Note this needs to be channel ID, not the name, as recommended by the Slack API. To get the ID for a channel, either use the Slack API or find it in the URL.", "type": "array", "items": { "$dynamic": true,