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

api-docs: Improve rendering of create channel python example.

Browse Source
This commit is contained in:
Lauryn Menard
2025-08-28 16:07:35 +02:00
committed by Tim Abbott
parent 224499b58f
commit 910ca975ab
1 changed files with 7 additions and 2 deletions
Download Patch File Download Diff File Expand all files Collapse all files

9
zerver/openapi/python_examples.py
View File

@@ -1907,12 +1907,17 @@ def update_user_group_members(client: Client, user_group_id: int) -> None:
@openapi_test_function("/channels/create:post") @openapi_test_function("/channels/create:post")
def add_channel(client: Client) -> None: def add_channel(client: Client) -> None:
# {code_example|start} # {code_example|start}
# Create a new channel.
request = { request = {
"name": "music_group", "name": "music_group",
"description": "Channel for discussing and learning about music.", "description": "Channel for discussing and learning about music.",
"subscribers": [], "subscribers": [12],
} }
result = client.call_endpoint(url="channels/create", method="POST", request=request) result = client.call_endpoint(
url="channels/create",
method="POST",
request=request,
)
# {code_example|end} # {code_example|end}
assert_success_response(result) assert_success_response(result)
validate_against_openapi_schema(result, "/channels/create", "post", "200") validate_against_openapi_schema(result, "/channels/create", "post", "200")