Mirror
/
zulip
mirror of https://github.com/zulip/zulip.git
1
0
Fork 0
Code Issues Projects Releases Wiki Activity

api-docs: Tweak newly documented invites endpoints documentation. 

Makes a few small tweaks on the newly documented invites endpoints
for current API documentation conventions that were missed in the
review process.
This commit is contained in:
Lauryn Menard 2024-04-21 13:13:08 +02:00 committed by Tim Abbott
parent cc5b846410
commit 02e98f7fa2
2 changed files with 10 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
api_docs/include/rest-endpoints.md
View File

@ -92,7 +92,7 @@
* [Get all invitations](/api/get-invites) * [Get all invitations](/api/get-invites)
* [Send invitations](/api/send-invites) * [Send invitations](/api/send-invites)
* [Create reusable invitation link](/api/create-invite-link) * [Create a reusable invitation link](/api/create-invite-link)
* [Revoke an email invitation](/api/revoke-email-invite) * [Revoke an email invitation](/api/revoke-email-invite)
#### Server & organizations #### Server & organizations

12
zerver/openapi/zulip.yaml
View File

@ -12060,7 +12060,7 @@ paths:
/invites/multiuse: /invites/multiuse:
post: post:
operationId: create-invite-link operationId: create-invite-link
summary: Create reusable invitation link summary: Create a reusable invitation link
tags: ["invites"] tags: ["invites"]
description: | description: |
Create a [reusable invitation link](/help/invite-new-users#create-a-reusable-invitation-link) Create a [reusable invitation link](/help/invite-new-users#create-a-reusable-invitation-link)
@ -12207,7 +12207,7 @@ paths:
"code": "BAD_REQUEST", "code": "BAD_REQUEST",
} }
description: | description: |
A typical failed JSON response for an invalid `invite_id`: A typical failed JSON response for an invalid email invitation ID:
/register: /register:
post: post:
operationId: register-queue operationId: register-queue
@ -19836,7 +19836,13 @@ components:
id: id:
type: integer type: integer
description: | description: |
The unique ID of the invitation. The ID of the invitation.
Note that email invitations and reusable invitation links are stored
in different database tables on the server, so each ID is guaranteed
to be unique in combination with the boolean value of `is_multiuse`,
e.g. there can only be one invitation with `id: 1` and `is_multiuse:
true`.
invited_by_user_id: invited_by_user_id:
type: integer type: integer
description: | description: |