Skip to content

Commit 85e01b5

Browse files
klardotshalexmv
klardotsh
authored and
alexmv
committed
docs: Reformat send-message documentation into a condensed table.
1 parent b9eb27a commit 85e01b5

File tree

1 file changed

+9
-32
lines changed

1 file changed

+9
-32
lines changed

‎send-message/README.md‎

Lines changed: 9 additions & 32 deletions
Original file line numberDiff line numberDiff line change
@@ -4,38 +4,15 @@ This action sends a message to [Zulip](https://zulip.com/).
44

55
## Inputs
66

7-
### `api-key`
8-
9-
**Required** [API key](https://zulip.com/api/api-keys) used to interact with the Zulip API. You can get an API key through Zulip's web interface.
10-
You should store the API key [as a secret](https://docs.github.com/en/actions/security-guides/encrypted-secrets#creating-encrypted-secrets-for-a-repository).
11-
12-
### `email`
13-
14-
**Required** Email address of the user who owns the API key mentioned above.
15-
16-
### `organization-url`
17-
18-
**Required** Zulip organization canonical URL.
19-
20-
### `to`
21-
22-
**Required** For stream messages, either the name or integer ID of the stream.
23-
For private messages, either a list containing integer user IDs or a list containing string email addresses.
24-
25-
### `type`
26-
27-
**Required** The type of message to be sent. `private` for a private message and `stream` for a stream message.
28-
Must be one of: `private`, `stream`.
29-
30-
### `topic`
31-
32-
**Optional** The topic of the message. Only required for stream messages (`type="stream"`), ignored otherwise.
33-
Maximum length of 60 characters.
34-
35-
### `content`
36-
37-
**Required** The content of the message. Maximum message size of 10000 bytes.
38-
Format your message using [Zulip Markdown](https://zulip.com/help/format-your-message-using-markdown).
7+
| Name | Required? | Details |
8+
| ------------------ | --------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
9+
| `api-key` | Yes | [API key](https://zulip.com/api/api-keys) used to interact with the Zulip API. You can get an API key through Zulip's web interface. You should store the API key [as a secret](https://docs.github.com/en/actions/security-guides/encrypted-secrets#creating-encrypted-secrets-for-a-repository). |
10+
| `content` | Yes | The content of the message, formatted using [Zulip Markdown](https://zulip.com/help/format-your-message-using-markdown). Maximum message size of 10000 bytes. |
11+
| `email` | Yes | Email address of the user who owns the API key mentioned above. |
12+
| `organization-url` | Yes | Zulip organization canonical URL. |
13+
| `to` | Yes | For stream messages, either the name or integer ID of the stream. For private messages, either a list containing integer user IDs or a list containing string email addresses. |
14+
| `topic` | No | The topic of the message. Only required for stream messages (`type="stream"`), ignored otherwise. Maximum length of 60 characters. |
15+
| `type` | Yes | The type of message to be sent. Must be either `private`, for a private message, or `stream`, for a stream message. |
3916

4017
## Example usage
4118

0 commit comments

Comments
 (0)