Clarify when an event is returned from /send_join. (#1840)

matrix-org · Jun 11, 2024 · a7a7ead · a7a7ead
1 parent acec09f
commit a7a7ead
Show file tree

Hide file tree

Showing 3 changed files with 5 additions and 4 deletions.
diff --git a/changelogs/server_server/newsfragments/1834.clarification b/changelogs/server_server/newsfragments/1834.clarification
@@ -1 +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.
+Clarify that the `event` field of the `/v2/send_join` response is only required when the event is signed by the resident server.
diff --git a/changelogs/server_server/newsfragments/1840.clarification b/changelogs/server_server/newsfragments/1840.clarification
@@ -0,0 +1 @@
+Clarify that the `event` field of the `/v2/send_join` response is only required when the event is signed by the resident server.
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 `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.
+                      The membership event sent to other servers by the resident server including a signature
+                      from the resident server. Required if the room is [restricted](/client-server-api/#restricted-rooms)
+                      and the joining user is authorised by one of the conditions.
                   servers_in_room:
                     type: array
                     x-addedInMatrixVersion: "1.6"
Original file line number	Diff line number	Diff line change
		@@ -1 +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.
		Clarify that the `event` field of the `/v2/send_join` response is only required when the event is signed by the resident server.
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 the event is signed by the resident server.