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

api_docs: Update scheduled_message docs to specify empty string topic.

Browse Source 
We missed to update this section of the docs while working
on feature level 334.
This commit is contained in:
Prakhar Pratyush
2025-02-05 18:09:08 +05:30
committed by Tim Abbott
parent 5f709245c0
commit d4ae480985
1 changed files with 20 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

20
zerver/openapi/zulip.yaml
View File

@@ -6353,6 +6353,16 @@ paths:
Clients should use the `max_topic_length` returned by the Clients should use the `max_topic_length` returned by the
[`POST /register`](/api/register-queue) endpoint to determine [`POST /register`](/api/register-queue) endpoint to determine
the maximum topic length. the maximum topic length.
Note: When the value of `realm_empty_topic_display_name` found in
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.
type: string type: string
example: Castle example: Castle
scheduled_delivery_timestamp: scheduled_delivery_timestamp:
@@ -6517,6 +6527,16 @@ paths:
Clients should use the `max_topic_length` returned by the Clients should use the `max_topic_length` returned by the
[`POST /register`](/api/register-queue) endpoint to determine [`POST /register`](/api/register-queue) endpoint to determine
the maximum topic length. the maximum topic length.
Note: When the value of `realm_empty_topic_display_name` found in
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.
type: string type: string
example: Castle example: Castle
scheduled_delivery_timestamp: scheduled_delivery_timestamp: