This is an automated email from the ASF dual-hosted git repository. acosentino pushed a commit to branch main in repository https://gitbox.apache.org/repos/asf/camel-kamelets.git
commit 1ee1250600014eff3202120831f36768e7ceb564 Author: MelissaFlinn <[email protected]> AuthorDate: Mon Jul 11 11:21:35 2022 -0400 doc-config-descriptions-edit social --- kamelets/slack-sink.kamelet.yaml | 4 ++-- kamelets/slack-source.kamelet.yaml | 6 +++--- kamelets/telegram-sink.kamelet.yaml | 10 +++++----- kamelets/telegram-source.kamelet.yaml | 6 +++--- 4 files changed, 13 insertions(+), 13 deletions(-) diff --git a/kamelets/slack-sink.kamelet.yaml b/kamelets/slack-sink.kamelet.yaml index b3d44e3c..f7273acb 100644 --- a/kamelets/slack-sink.kamelet.yaml +++ b/kamelets/slack-sink.kamelet.yaml @@ -55,11 +55,11 @@ spec: type: string iconUrl: title: Icon URL - description: The avatar that the component will use when sending message to a channel or user. + description: The avatar to use when sending a message to a channel or user. type: string username: title: Username - description: This is the username that the bot will have when sending messages to a channel or user. + description: The username for the bot when it sends messages to a channel or user. type: string types: out: diff --git a/kamelets/slack-source.kamelet.yaml b/kamelets/slack-source.kamelet.yaml index 2985b26d..7260f2d7 100644 --- a/kamelets/slack-source.kamelet.yaml +++ b/kamelets/slack-source.kamelet.yaml @@ -38,12 +38,12 @@ spec: properties: channel: title: Channel - description: The Slack channel to receive messages from + description: The Slack channel to receive messages from. type: string example: "#myroom" token: title: Token - description: The token to access Slack. A Slack app is needed. The token to access Slack. This app needs to have channels:history, groups:history, im:history, mpim:history, channels:read, groups:read, im:read and mpim:read permissions. The User OAuth Token is the kind of token needed. + description: The Bot User OAuth Access Token to access Slack. A Slack app that has the following permissions is required: `channels:history`, `groups:history`, `im:history`, `mpim:history`, `channels:read`, `groups:read`, `im:read`, and `mpim:read`. type: string format: password x-descriptors: @@ -51,7 +51,7 @@ spec: - urn:camel:group:credentials delay: title: Delay - description: The delay between polls + description: The delay between polls. type: string example: "1s" types: diff --git a/kamelets/telegram-sink.kamelet.yaml b/kamelets/telegram-sink.kamelet.yaml index bcd39cee..8df4568e 100644 --- a/kamelets/telegram-sink.kamelet.yaml +++ b/kamelets/telegram-sink.kamelet.yaml @@ -30,9 +30,9 @@ spec: definition: title: "Telegram Sink" description: |- - Send a message to a Telegram chat using your Telegram bot as sender. + Send a message to a Telegram chat by using your Telegram bot as sender. - To create a bot, contact the @botfather account using the Telegram app. + To create a bot, use your Telegram app to contact the @botfather account. This sink supports the following message types: @@ -40,10 +40,10 @@ spec: - PNG images (`Content-Type` must be set to `image/png`) - JPEG images (`Content-Type` must be set to `image/jpeg`) - This following message headers are also supported: + This sink also supports the following message headers: - `text` / `ce-text`: when sending an image, the image caption - - `chat-id` / `ce-chatid`: to override the default chat where messages are sent to + - `chat-id` / `ce-chatid`: overrides the default chat where messages are sent to required: - authorizationToken type: object @@ -58,7 +58,7 @@ spec: - urn:camel:group:credentials chatId: title: Chat ID - description: The Chat ID where messages should be sent by default + description: The Chat ID to where you want to send messages by default. type: string types: out: diff --git a/kamelets/telegram-source.kamelet.yaml b/kamelets/telegram-source.kamelet.yaml index 81661444..9ad07e4f 100644 --- a/kamelets/telegram-source.kamelet.yaml +++ b/kamelets/telegram-source.kamelet.yaml @@ -32,11 +32,11 @@ spec: description: |- Receive all messages that people send to your Telegram bot. - To create a bot, contact the @botfather account using the Telegram app. + To create a bot, contact the @botfather account by using the Telegram app. - The source attaches the following headers to the messages: + The source attaches the following header to the messages: - - `chat-id` / `ce-chatid`: the ID of the chat where the message comes from + - `chat-id` / `ce-chatid`: The ID of the chat where the message comes from. required: - authorizationToken
