Mirror
/
zulip
mirror of https://github.com/zulip/zulip.git
1
0
Fork 0
Code Issues Projects Releases Wiki Activity

api-docs: Update POST /typing for channel. 

Updates the API doc for POST /typing endpoint to
use channel in descriptions instead of stream.

Part of the stream to channel rename project.
This commit is contained in:
Lauryn Menard 2024-05-20 15:31:05 +02:00 committed by Tim Abbott
parent 427b86aff6
commit c219136e4c
1 changed files with 18 additions and 15 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

33
zerver/openapi/zulip.yaml
View File

@ -18533,12 +18533,12 @@ paths:
for additional design details on Zulip's typing notifications protocol. for additional design details on Zulip's typing notifications protocol.
**Changes**: Clients shouldn't care about the APIs prior to Zulip 8.0 (feature level 215) **Changes**: Clients shouldn't care about the APIs prior to Zulip 8.0 (feature level 215)
for stream typing notifications, as no client actually implemented for channel typing notifications, as no client actually implemented
the previous API for those. the previous API for those.
Support for displaying stream typing notifications was new Support for displaying channel typing notifications was new
in Zulip 4.0 (feature level 58). Clients should indicate they support in Zulip 4.0 (feature level 58). Clients should indicate they support
processing stream typing notifications via the `stream_typing_notifications` processing channel typing notifications via the `stream_typing_notifications`
value in the `client_capabilities` parameter of the value in the `client_capabilities` parameter of the
[`POST /register`][client-capabilities] endpoint. [`POST /register`][client-capabilities] endpoint.
@ -18566,7 +18566,7 @@ paths:
Type of the message being composed. Type of the message being composed.
**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 a stream message is an additional value for this parameter to indicate a channel message is
being composed. being composed.
In Zulip 8.0 (feature level 215), stopped supporting In Zulip 8.0 (feature level 215), stopped supporting
@ -18597,15 +18597,18 @@ paths:
to: to:
description: | description: |
User IDs of the recipients of the message being typed. Required for the User IDs of the recipients of the message being typed. Required for the
`"direct"` type. Ignored in the case of `"stream"` type. Send a JSON-encoded `"direct"` type. Ignored in the case of `"stream"` or `"channel"` type.
list of user IDs. (Use a list even if there is only one recipient.)
Clients should send a JSON-encoded list of user IDs, even if there is only
one recipient.
**Changes**: In Zulip 8.0 (feature level 215), stopped using this parameter **Changes**: In Zulip 8.0 (feature level 215), stopped using this parameter
for the `"stream"` type. Previously, in the case of the `"stream"` type, it for the `"stream"` type. Previously, in the case of the `"stream"` type, it
accepted a single-element list containing the ID of the stream. A new parameter, accepted a single-element list containing the ID of the channel. A new parameter,
`stream_id`, is now used for this. `stream_id`, is now used for this. Note that the `"channel"` type did not
exist at this feature level.
Support for typing notifications for stream messages Support for typing notifications for channel' messages
is new in Zulip 4.0 (feature level 58). Previously, typing is new in Zulip 4.0 (feature level 58). Previously, typing
notifications were only for direct messages. notifications were only for direct messages.
@ -18619,17 +18622,17 @@ paths:
example: [9, 10] example: [9, 10]
stream_id: stream_id:
description: | description: |
ID of the stream in which the message is being typed. Required for the `"stream"` ID of the channel in which the message is being typed. Required for the `"stream"`
type. Ignored in the case of `"direct"` type. or `"channel"` type. Ignored in the case of `"direct"` type.
**Changes**: New in Zulip 8.0 (feature level 215). Previously, a single-element **Changes**: New in Zulip 8.0 (feature level 215). Previously, a single-element
list containing the ID of the stream was passed in `to` parameter. list containing the ID of the channel was passed in `to` parameter.
type: integer type: integer
example: 7 example: 7
topic: topic:
description: | description: |
Topic to which message is being typed. Required for the `"stream"` type. Topic to which message is being typed. Required for the `"stream"` or `"channel"`
Ignored in the case of `"direct"` type. type. Ignored in the case of `"direct"` type.
**Changes**: New in Zulip 4.0 (feature level 58). Previously, typing **Changes**: New in Zulip 4.0 (feature level 58). Previously, typing
notifications were only for direct messages. notifications were only for direct messages.
@ -18659,7 +18662,7 @@ paths:
"result": "error", "result": "error",
} }
description: | description: |
An example JSON error response when the user composes a stream message An example JSON error response when the user composes a channel message
and `stream_id` is not specified: and `stream_id` is not specified:
/user_groups/create: /user_groups/create:
post: post: