Skip to content

Clarify endpoint descriptions for "Respond Invite" and "Respond Invite with Photo" #464

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
jellejurre merged 1 commit into from
May 13, 2025
Merged

Clarify endpoint descriptions for "Respond Invite" and "Respond Invite with Photo" #464

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 10 additions & 2 deletions openapi/components/paths/invite.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -234,7 +234,11 @@ paths:
operationId: respondInvite
security:
- authCookie: []
description: 'Respond to an invite request by sending a world invite to the requesting user. `:notificationId` is the ID of the requesting notification.'
description: |-
Respond to an invite or invite request without accepting it. `:notificationId` is the ID of the requesting notification.

In case the notification being replied to is an invite, the `responseSlot` refers to a response message from the the `message` collection.
In case the notification is an invite request, it will refer to one from the `requestResponse` collection instead.
requestBody:
required: true
content:
Expand All @@ -259,7 +263,11 @@ paths:
operationId: respondInviteWithPhoto
security:
- authCookie: []
description: 'Respond with photo to an invite request by sending a world invite to the requesting user. `:notificationId` is the ID of the requesting notification.'
description: |-
Respond with photo to an invite or invite request without accepting it. `:notificationId` is the ID of the requesting notification.

In case the notification being replied to is an invite, the `responseSlot` refers to a response message from the the `message` collection.
In case the notification is an invite request, it will refer to one from the `requestResponse` collection instead.'
requestBody:
required: true
content:
Expand Down