api-docs: Update POST /invites for channel.

Updates the API doc for POST /invites 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 14:04:21 +02:00 committed by Tim Abbott
parent a4f4e61eef
commit 8161bc16c8

View File

@ -12189,7 +12189,7 @@ paths:
**Changes**: New in Zulip 9.0 (feature level 261). Previous versions
of Zulip behaved as though this parameter was always `false`; clients
needed to include the organization's default streams in the
needed to include the organization's default channels in the
`stream_ids` parameter for a newly created user to be automatically
subscribed to them.
@ -12278,9 +12278,9 @@ paths:
"result": "error",
}
description: |
An example JSON error response for when any of the specified streams
An example JSON error response for when any of the specified channels
does not exist or the user does not have permission to access one of
the targeted streams.
the targeted channels.
- allOf:
- $ref: "#/components/schemas/CodedError"
- example:
@ -12291,7 +12291,7 @@ paths:
}
description: |
An example JSON error response for when the user doesn't have permission
to subscribe other users to streams and `stream_ids` is not empty.
to subscribe other users to channels and `stream_ids` is not empty.
/invites/multiuse:
post:
operationId: create-invite-link