zerver: Drop support for Zulip API emails in channel creation.

Also write the description a bit better.

Discussion:
https://chat.zulip.org/#narrow/channel/378-api-design/topic/Channel.20creation.20should.20return.20the.20channel.20ID/near/2240040.

Signed-off-by: apoorvapendse <apoorvavpendse@gmail.com>
This commit is contained in:
apoorvapendse
2025-08-12 03:19:07 +00:00
committed by Tim Abbott
parent 9adee70d8d
commit 8f14b717ff
3 changed files with 6 additions and 11 deletions

View File

@@ -1622,7 +1622,7 @@ Output:
def create_channel_via_post( def create_channel_via_post(
self, self,
user: UserProfile, user: UserProfile,
subscribers: list[str] | list[int] | None = None, subscribers: list[int] | None = None,
name: str | None = None, name: str | None = None,
extra_post_data: Mapping[str, Any] = {}, extra_post_data: Mapping[str, Any] = {},
invite_only: bool = False, invite_only: bool = False,

View File

@@ -23537,15 +23537,10 @@ paths:
example: "Channel for discussing all things music!" example: "Channel for discussing all things music!"
subscribers: subscribers:
description: | description: |
A list of user IDs (preferred) or Zulip API email A list of user IDs of the users to be subscribed to the new channel.
addresses of the users to be subscribed to the new channel specified in the `channel` parameter. type: array
oneOf: items:
- type: array type: integer
items:
type: string
- type: array
items:
type: integer
example: [16, 12] example: [16, 12]
announce: announce:
description: | description: |

View File

@@ -739,7 +739,7 @@ def create_channel(
message_retention_days: Json[str] | Json[int] = RETENTION_DEFAULT, message_retention_days: Json[str] | Json[int] = RETENTION_DEFAULT,
name: Annotated[str, StringConstraints(strip_whitespace=True, min_length=1)], name: Annotated[str, StringConstraints(strip_whitespace=True, min_length=1)],
send_new_subscription_messages: Json[bool] = True, send_new_subscription_messages: Json[bool] = True,
subscribers: Json[list[str] | list[int]], subscribers: Json[list[int]],
topics_policy: Json[TopicsPolicy] = None, topics_policy: Json[TopicsPolicy] = None,
) -> HttpResponse: ) -> HttpResponse:
realm = user_profile.realm realm = user_profile.realm