Skip to content

Commit 801d07e

Browse files
authored
Clarify invite/request response descriptions. (#464)
1 parent fa5e220 commit 801d07e

1 file changed

Lines changed: 10 additions & 2 deletions

File tree

openapi/components/paths/invite.yaml

Lines changed: 10 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -234,7 +234,11 @@ paths:
234234
operationId: respondInvite
235235
security:
236236
- authCookie: []
237-
description: 'Respond to an invite request by sending a world invite to the requesting user. `:notificationId` is the ID of the requesting notification.'
237+
description: |-
238+
Respond to an invite or invite request without accepting it. `:notificationId` is the ID of the requesting notification.
239+
240+
In case the notification being replied to is an invite, the `responseSlot` refers to a response message from the the `message` collection.
241+
In case the notification is an invite request, it will refer to one from the `requestResponse` collection instead.
238242
requestBody:
239243
required: true
240244
content:
@@ -259,7 +263,11 @@ paths:
259263
operationId: respondInviteWithPhoto
260264
security:
261265
- authCookie: []
262-
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.'
266+
description: |-
267+
Respond with photo to an invite or invite request without accepting it. `:notificationId` is the ID of the requesting notification.
268+
269+
In case the notification being replied to is an invite, the `responseSlot` refers to a response message from the the `message` collection.
270+
In case the notification is an invite request, it will refer to one from the `requestResponse` collection instead.'
263271
requestBody:
264272
required: true
265273
content:

0 commit comments

Comments
 (0)