From 4d84d75bb60bf9dd42fe67714a377cf2f5d0011e Mon Sep 17 00:00:00 2001 From: Andrew Morgan Date: Tue, 28 Jan 2025 19:02:09 +0000 Subject: [PATCH] Add a note to the federation invite endpoints that invites can be sent twice As this may be non-obvious when implementing behaviour that is triggered by an incoming invite event. See https://github.com/matrix-org/matrix-spec/issues/2062 for more context. --- data/api/server-server/invites-v1.yaml | 6 +++++- data/api/server-server/invites-v2.yaml | 6 +++++- 2 files changed, 10 insertions(+), 2 deletions(-) diff --git a/data/api/server-server/invites-v1.yaml b/data/api/server-server/invites-v1.yaml index c328f05e..d58102ad 100644 --- a/data/api/server-server/invites-v1.yaml +++ b/data/api/server-server/invites-v1.yaml @@ -20,7 +20,7 @@ paths: put: summary: Invites a remote user to a room description: |- - Invites a remote user to a room. Once the event has been signed by both the inviting + Invites a remote user to a room. Once the event has been signed by both the inviting homeserver and the invited homeserver, it can be sent to all of the servers in the room by the inviting homeserver. @@ -32,6 +32,10 @@ paths: [room version specification](/rooms) for precise event formats. **The request and response bodies here describe the common event fields in more detail and may be missing other required fields for a PDU.** + + Also note that if the remote homeserver is already in the room, it will receive the + invite event twice; once through this endpoint, and again through a [federation + transaction](https://spec.matrix.org/v1.13/server-server-api/#transactions). operationId: sendInviteV1 security: - signedRequest: [] diff --git a/data/api/server-server/invites-v2.yaml b/data/api/server-server/invites-v2.yaml index 8984b6d1..505968c7 100644 --- a/data/api/server-server/invites-v2.yaml +++ b/data/api/server-server/invites-v2.yaml @@ -24,7 +24,7 @@ paths: This API is nearly identical to the v1 API with the exception of the request body being different, and the response format fixed. - Invites a remote user to a room. Once the event has been signed by both the inviting + Invites a remote user to a room. Once the event has been signed by both the inviting homeserver and the invited homeserver, it can be sent to all of the servers in the room by the inviting homeserver. @@ -36,6 +36,10 @@ paths: [room version specification](/rooms) for precise event formats. **The request and response bodies here describe the common event fields in more detail and may be missing other required fields for a PDU.** + + Also note that if the remote homeserver is already in the room, it will receive the + invite event twice; once through this endpoint, and again through a [federation + transaction](https://spec.matrix.org/v1.13/server-server-api/#transactions). operationId: sendInviteV2 security: - signedRequest: []