paulmataruso/zulip
1
0
Fork 0
mirror of https://github.com/zulip/zulip.git synced 2025-11-04 05:53:43 +00:00
Code Issues Packages Projects Releases Wiki Activity

api_docs: Improve topic parameter docs to list restricted values.

Browse Source 
This commit updates the docs to specify that when topics are
required in an organization, the `topic` parameter in
`POST /messages` and `PATCH /messages/{message_id}` cannot be
* "(no topic)"
* an empty string
* `realm_empty_topic_display_name`.
This commit is contained in:
Prakhar Pratyush
2025-02-05 16:52:18 +05:30
committed by Tim Abbott
parent d4ae480985
commit 46f518fdbf
1 changed files with 6 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

6
zerver/openapi/zulip.yaml
View File

@@ -7220,6 +7220,9 @@ paths:
the [POST /register](/api/register-queue) response is used for this
parameter, it is interpreted as an empty string.
When [topics are required](/help/require-topics), this parameter can't
be `"(no topic)"`, an empty string, or `realm_empty_topic_display_name`.
**Changes**: Before Zulip 10.0 (feature level 334), empty string
was not a valid topic name for channel messages.
@@ -8561,6 +8564,9 @@ paths:
the [POST /register](/api/register-queue) response is used for this
parameter, it is interpreted as an empty string.
When [topics are required](/help/require-topics), this parameter can't
be `"(no topic)"`, an empty string, or `realm_empty_topic_display_name`.
You can [resolve topics](/help/resolve-a-topic) by editing the topic to
`✔ {original_topic}` with the `propagate_mode` parameter set to
`"change_all"`. The empty string topic cannot be marked as resolved.