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

api_documentation: Document "/invites/multiuse" endpoint.

Browse Source 
Adds "/invites/multiuse" endpoint to the API documentation.

Creates a shared schema for the invite_as and invite_expires_in_minutes
parameters that are the same for the "POST /invites" endpoint.

Also, updates the response documented for the "GET /invites" endpoint
to match the information in the "POST /invites" and "/invites/multiuse"
documentation.
This commit is contained in:
Vector73
2024-04-09 21:06:23 +05:30
committed by Tim Abbott
parent 619f85fac7
commit 2734a9483b
5 changed files with 195 additions and 51 deletions
Download Patch File Download Diff File Expand all files Collapse all files

16
zerver/openapi/python_examples.py
View File

@@ -329,6 +329,21 @@ def send_invitations(client: Client) -> None:
validate_against_openapi_schema(result, "/invites", "post", "200")
@openapi_test_function("/invites/multiuse:post")
def create_reusable_invitation_link(client: Client) -> None:
# {code_example|start}
# Create reusable invitation link
request = {
"invite_expires_in_minutes": 60 * 24 * 10, # 10 days
"invite_as": 400,
"stream_ids": [1, 8, 9],
}
result = client.call_endpoint(url="/invites/multiuse", method="POST", request=request)
# {code_example|end}
validate_against_openapi_schema(result, "/invites/multiuse", "post", "200")
@openapi_test_function("/users/{user_id}:get")
def get_single_user(client: Client) -> None:
ensure_users([8], ["cordelia"])
@@ -1686,6 +1701,7 @@ def test_errors(client: Client) -> None:
def test_invitations(client: Client) -> None:
send_invitations(client)
create_reusable_invitation_link(client)
get_invitations(client)