Clarify that the event field of the send_join is only required when p…

…erforming a restricted join (#1834)
matrix-org · Jun 3, 2024 · 7ff785f · 7ff785f
1 parent a175506
commit 7ff785f
Show file tree

Hide file tree

Showing 2 changed files with 4 additions and 3 deletions.
diff --git a/changelogs/server_server/newsfragments/1834.clarification b/changelogs/server_server/newsfragments/1834.clarification
@@ -0,0 +1 @@
+Clarify that the `event` field of the `/v2/send_join` response is only required when `join_authorised_via_users_server` was present in the `content` field of the request.
diff --git a/data/api/server-server/joins-v2.yaml b/data/api/server-server/joins-v2.yaml
@@ -207,9 +207,9 @@ paths:
                     title: SignedMembershipEvent
                     x-addedInMatrixVersion: "1.2"
                     description: |-
-                      Required if the room version [supports restricted join rules](/rooms/#feature-matrix). The signed
-                      copy of the membership event sent to other servers by the resident server, including the resident
-                      server's signature.
+                      Required if the `content` of the event in the request contained the `join_authorised_via_users_server`
+                        field. The signed copy of the membership event sent to other servers by the resident server,
+                        including the resident server's signature.
                   servers_in_room:
                     type: array
                     x-addedInMatrixVersion: "1.6"
Original file line number	Diff line number	Diff line change
		@@ -0,0 +1 @@
		Clarify that the `event` field of the `/v2/send_join` response is only required when `join_authorised_via_users_server` was present in the `content` field of the request.