mirror of https://github.com/zulip/zulip.git
api-docs: Update descriptions in POST /scheduled_message for channel.
Updates the API documentation for the POST /scheduled_message endpoint to use channel in descriptions instead of stream. Part of the stream to channel rename project.
This commit is contained in:
parent
3c11872ebd
commit
3d33490a32
|
@ -5688,7 +5688,7 @@ paths:
|
||||||
type:
|
type:
|
||||||
description: |
|
description: |
|
||||||
The type of scheduled message to be sent. `"direct"` for a direct
|
The type of scheduled message to be sent. `"direct"` for a direct
|
||||||
message and `"stream"` or `"channel"` for a stream message.
|
message and `"stream"` or `"channel"` for a channel message.
|
||||||
|
|
||||||
Note that, while `"private"` is supported for scheduling direct
|
Note that, while `"private"` is supported for scheduling direct
|
||||||
messages, clients are encouraged to use to the modern convention of
|
messages, clients are encouraged to use to the modern convention of
|
||||||
|
@ -5696,7 +5696,7 @@ paths:
|
||||||
`"private"` may eventually be removed.
|
`"private"` may eventually be removed.
|
||||||
|
|
||||||
**Changes**: In Zulip 9.0 (feature level 248), `"channel"` was added as
|
**Changes**: In Zulip 9.0 (feature level 248), `"channel"` was added as
|
||||||
an additional value for this parameter to indicate the type of a stream
|
an additional value for this parameter to indicate the type of a channel
|
||||||
message.
|
message.
|
||||||
type: string
|
type: string
|
||||||
enum:
|
enum:
|
||||||
|
@ -5709,7 +5709,7 @@ paths:
|
||||||
description: |
|
description: |
|
||||||
The scheduled message's tentative target audience.
|
The scheduled message's tentative target audience.
|
||||||
|
|
||||||
For stream messages, the integer ID of the stream.
|
For channel messages, the integer ID of the channel.
|
||||||
For direct messages, a list containing integer user IDs.
|
For direct messages, a list containing integer user IDs.
|
||||||
oneOf:
|
oneOf:
|
||||||
- type: integer
|
- type: integer
|
||||||
|
@ -5722,8 +5722,8 @@ paths:
|
||||||
$ref: "#/components/schemas/RequiredContent"
|
$ref: "#/components/schemas/RequiredContent"
|
||||||
topic:
|
topic:
|
||||||
description: |
|
description: |
|
||||||
The topic of the message. Only required for stream messages
|
The topic of the message. Only required for channel messages
|
||||||
(`"type": "stream"`), ignored otherwise.
|
(`"type": "stream"` or `"type": "channel"`), ignored otherwise.
|
||||||
|
|
||||||
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
|
||||||
|
@ -5792,8 +5792,8 @@ paths:
|
||||||
- allOf:
|
- allOf:
|
||||||
- $ref: "#/components/schemas/NonExistingChannelIdError"
|
- $ref: "#/components/schemas/NonExistingChannelIdError"
|
||||||
- description: |
|
- description: |
|
||||||
A typical failed JSON response for when a stream message is scheduled
|
A typical failed JSON response for when a channel message is scheduled
|
||||||
to be sent to a stream that does not exist:
|
to be sent to a channel that does not exist:
|
||||||
- allOf:
|
- allOf:
|
||||||
- $ref: "#/components/schemas/CodedError"
|
- $ref: "#/components/schemas/CodedError"
|
||||||
- example:
|
- example:
|
||||||
|
|
Loading…
Reference in New Issue