paulmataruso/zulip
1
0
Fork 0
mirror of https://github.com/zulip/zulip.git synced 2025-11-11 17:36:27 +00:00
Code Issues Packages Projects Releases Wiki Activity

api_docs: Fix "/invites" enpoint documentation.

Browse Source
This commit is contained in:
Vector73
2024-04-03 13:14:10 +05:30
committed by Tim Abbott
parent db8e130110
commit 6af9a6635c
2 changed files with 10 additions and 2 deletions
Download Patch File Download Diff File Expand all files Collapse all files

2
zerver/openapi/python_examples.py
View File

@@ -319,7 +319,7 @@ def send_invitations(client: Client) -> None:
# Send invitations # Send invitations
request = { request = {
"invitee_emails": "example@zulip.com, logan@zulip.com", "invitee_emails": "example@zulip.com, logan@zulip.com",
"invite_expires_in_minutes": 14400, "invite_expires_in_minutes": 60 * 24 * 10, # 10 days
"invite_as": 400, "invite_as": 400,
"stream_ids": [1, 8, 9], "stream_ids": [1, 8, 9],
} }

10
zerver/openapi/zulip.yaml
View File

@@ -11889,7 +11889,8 @@ paths:
description: | description: |
The number of minutes before the invitation will expire. If `null`, the The number of minutes before the invitation will expire. If `null`, the
invitation will never expire. If unspecified, the server will use a default invitation will never expire. If unspecified, the server will use a default
value (`INVITATION_LINK_VALIDITY_MINUTES`) for when the invitation will expire. value (based on the `INVITATION_LINK_VALIDITY_MINUTES` server setting, which
defaults to 10) for when the invitation will expire.
**Changes**: New in Zulip 6.0 (feature level 126). Previously, there was an **Changes**: New in Zulip 6.0 (feature level 126). Previously, there was an
`invite_expires_in_days` parameter, which specified the duration in days instead `invite_expires_in_days` parameter, which specified the duration in days instead
@@ -11901,6 +11902,13 @@ paths:
description: | description: |
The [organization-level role](/api/roles-and-permissions) of the user that is The [organization-level role](/api/roles-and-permissions) of the user that is
created when the invitation is accepted. created when the invitation is accepted.
Possible values are:
- 100 = Organization owner
- 200 = Organization administrator
- 300 = Organization moderator
- 400 = Member
- 600 = Guest
Users can only send invitations for Users can only send invitations for
[roles with equal or stricter restrictions](/api/roles-and-permissions#permission-levels) [roles with equal or stricter restrictions](/api/roles-and-permissions#permission-levels)