From be701f4b864e7f98957bad44b22ae70836863203 Mon Sep 17 00:00:00 2001 From: Torsten Curdt Date: Sat, 16 Nov 2019 22:33:03 +0100 Subject: [PATCH 1/2] added/updated descriptions to clarify node and credential fields --- packages/nodes-base/credentials/GoogleApi.credentials.ts | 2 ++ packages/nodes-base/credentials/TelegramApi.credentials.ts | 1 + packages/nodes-base/nodes/Google/GoogleSheets.node.ts | 6 +++--- packages/nodes-base/nodes/Telegram/Telegram.node.ts | 2 +- 4 files changed, 7 insertions(+), 4 deletions(-) diff --git a/packages/nodes-base/credentials/GoogleApi.credentials.ts b/packages/nodes-base/credentials/GoogleApi.credentials.ts index ab676305c..1c5d9d6f4 100644 --- a/packages/nodes-base/credentials/GoogleApi.credentials.ts +++ b/packages/nodes-base/credentials/GoogleApi.credentials.ts @@ -13,6 +13,7 @@ export class GoogleApi implements ICredentialType { name: 'email', type: 'string' as NodePropertyTypes, default: '', + description: 'The Google Service account similar to user-808@project.iam.gserviceaccount.com.
See the tutorial on how to create one.', }, { @@ -21,6 +22,7 @@ export class GoogleApi implements ICredentialType { lines: 5, type: 'string' as NodePropertyTypes, default: '', + description: 'Use the multiline editor. Make sure there are exactly 3 lines.
-----BEGIN PRIVATE KEY-----
KEY IN A SINGLE LINE
-----END PRIVATE KEY-----', }, ]; } diff --git a/packages/nodes-base/credentials/TelegramApi.credentials.ts b/packages/nodes-base/credentials/TelegramApi.credentials.ts index f1deba6fc..ca639e603 100644 --- a/packages/nodes-base/credentials/TelegramApi.credentials.ts +++ b/packages/nodes-base/credentials/TelegramApi.credentials.ts @@ -13,6 +13,7 @@ export class TelegramApi implements ICredentialType { name: 'accessToken', type: 'string' as NodePropertyTypes, default: '', + description: 'Chat with the bot father to obtain the access token.', }, ]; } diff --git a/packages/nodes-base/nodes/Google/GoogleSheets.node.ts b/packages/nodes-base/nodes/Google/GoogleSheets.node.ts index 028011a3f..be80ae375 100644 --- a/packages/nodes-base/nodes/Google/GoogleSheets.node.ts +++ b/packages/nodes-base/nodes/Google/GoogleSheets.node.ts @@ -81,7 +81,7 @@ export class GoogleSheets implements INodeType { type: 'string', default: '', required: true, - description: 'The ID of the Google Sheet.', + description: 'The ID of the Google Sheet.
Found as part of the sheet URL https://docs.google.com/spreadsheets/d/{ID}/', }, { displayName: 'Range', @@ -89,7 +89,7 @@ export class GoogleSheets implements INodeType { type: 'string', default: 'A:F', required: true, - description: 'The columns to read and append data to.
If it contains multiple sheets it can also be
added like this: "MySheet!A:F"', + description: 'The table range to read from or to append data to. See the Google documentation for the details.
If it contains multiple sheets it can also be
added like this: "MySheet!A:F"', }, // ---------------------------------- @@ -208,7 +208,7 @@ export class GoogleSheets implements INodeType { }, }, default: 0, - description: 'Index of the row which contains the key. Starts with 0.', + description: 'Index of the row which contains the keys. Starts at 0.
The incoming node data is matched to the keys for assignment. The matching is case sensitve.', }, diff --git a/packages/nodes-base/nodes/Telegram/Telegram.node.ts b/packages/nodes-base/nodes/Telegram/Telegram.node.ts index b10b26cbf..9697f94d5 100644 --- a/packages/nodes-base/nodes/Telegram/Telegram.node.ts +++ b/packages/nodes-base/nodes/Telegram/Telegram.node.ts @@ -433,7 +433,7 @@ export class Telegram implements INodeType { }, }, required: true, - description: 'Unique identifier for the target chat or username of the target
channel (in the format @channelusername).', + description: 'Unique identifier for the target chat or username of the target
channel (in the format @channelusername). To find your chat id ask @get_id_bot.', }, { displayName: 'Message ID', From 463a532a0a05f4a36b098015186f05be32e4f616 Mon Sep 17 00:00:00 2001 From: Jan Oberhauser Date: Sun, 17 Nov 2019 22:38:37 +0100 Subject: [PATCH 2/2] :zap: Display description also for credential parameters --- .../src/components/CredentialsInput.vue | 20 ++++++++++++++++++- 1 file changed, 19 insertions(+), 1 deletion(-) diff --git a/packages/editor-ui/src/components/CredentialsInput.vue b/packages/editor-ui/src/components/CredentialsInput.vue index 2f45ae892..0830b2a2a 100644 --- a/packages/editor-ui/src/components/CredentialsInput.vue +++ b/packages/editor-ui/src/components/CredentialsInput.vue @@ -22,8 +22,12 @@ - + {{parameter.displayName}}: + +
+ +
@@ -299,6 +303,20 @@ export default mixins( .parameter-wrapper { line-height: 3em; + + .parameter-name { + position: relative; + + &:hover { + .parameter-info { + display: inline; + } + } + + .parameter-info { + display: none; + } + } } .credentials-info {