Skip to content

Commit 28fa5c6

Browse files
klardotshalexmv
klardotsh
authored and
alexmv
committed
docs: Clarify required state of topic parameter.
1 parent 69671b1 commit 28fa5c6

File tree

1 file changed

+9
-9
lines changed

1 file changed

+9
-9
lines changed

‎send-message/README.md‎

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

55
## Inputs
66

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. If using a bot, this should be the bot's email address, not the owning user's! |
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. |
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. If using a bot, this should be the bot's email address, not the owning user's! |
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` | If `type="stream"` | The topic of the message. Maximum length of 60 characters. Ignored if `type="private"`. |
15+
| `type` | Yes | The type of message to be sent. Must be either `private`, for a private message, or `stream`, for a stream message. |
1616

1717
## Example usage
1818

0 commit comments

Comments
 (0)