From ff1e229e7e1c8d1833ff4ca90497efdc85c9d104 Mon Sep 17 00:00:00 2001 From: Raphiiko Date: Tue, 13 May 2025 23:38:51 +0200 Subject: [PATCH] Clarify invite/request response descriptions. --- openapi/components/paths/invite.yaml | 12 ++++++++++-- 1 file changed, 10 insertions(+), 2 deletions(-) diff --git a/openapi/components/paths/invite.yaml b/openapi/components/paths/invite.yaml index b58f0981..50cf6b66 100644 --- a/openapi/components/paths/invite.yaml +++ b/openapi/components/paths/invite.yaml @@ -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: @@ -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: