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

api_documentation: Document "/invites/{prereg_id}" endpoint.

Browse Source
This commit is contained in:
Vector73
2024-04-20 12:11:38 +05:30
committed by Tim Abbott
parent eba0097c7f
commit 0f97733687
6 changed files with 62 additions and 4 deletions
Download Patch File Download Diff File Expand all files Collapse all files

20
zerver/openapi/python_examples.py
View File

@@ -344,6 +344,25 @@ def create_reusable_invitation_link(client: Client) -> None:
validate_against_openapi_schema(result, "/invites/multiuse", "post", "200")
@openapi_test_function("/invites/{invite_id}:delete")
def revoke_email_invitation(client: Client) -> None:
request = {
"invitee_emails": "delete-invite@zulip.com",
"invite_expires_in_minutes": 14400, # 10 days
"invite_as": 400,
"stream_ids": [1, 8, 9],
}
result = client.call_endpoint(url="/invites", method="POST", request=request)
# {code_example|start}
# Revoke email invitation
invite_id = 3
result = client.call_endpoint(url=f"/invites/{invite_id}", method="DELETE")
# {code_example|end}
validate_against_openapi_schema(result, "/invites/{invite_id}", "delete", "200")
@openapi_test_function("/users/{user_id}:get")
def get_single_user(client: Client) -> None:
ensure_users([8], ["cordelia"])
@@ -1701,6 +1720,7 @@ def test_errors(client: Client) -> None:
def test_invitations(client: Client) -> None:
send_invitations(client)
revoke_email_invitation(client)
create_reusable_invitation_link(client)
get_invitations(client)