Clarify send_join response (matrix-org#3703)

richvdh · web-flow · commit 1913812a908b · 2022-02-07T12:13:44.000Z
diff --git a/changelogs/server_server/3703.clarification b/changelogs/server_server/3703.clarification
@@ -0,0 +1 @@
+Correct misleading text for `/send_join` response.
diff --git a/data/api/server-server/joins-v1.yaml b/data/api/server-server/joins-v1.yaml
@@ -324,7 +324,7 @@ paths:
       responses:
         200:
           description: |-
-            The full state for the room, having accepted the join event.
+            The join event has been accepted into the room.
           schema:
             type: array
             minItems: 2
diff --git a/data/api/server-server/joins-v2.yaml b/data/api/server-server/joins-v2.yaml
@@ -184,7 +184,7 @@ paths:
             }
         200:
           description: |-
-            The full state for the room, having accepted the join event.
+            The join event has been accepted into the room.
           schema:
             $ref: "./definitions/send_join_response.yaml"
           examples:

Original file line number	Diff line number	Diff line change
`@@ -0,0 +1 @@`
	`1`	+Correct misleading text for `/send_join` response.
Original file line number	Diff line number	Diff line change
`@@ -184,7 +184,7 @@ paths:`
`184`	`184`	`}`
`185`	`185`	`200:`
`186`	`186`	`description: \|-`
`187`		`- The full state for the room, having accepted the join event.`
	`187`	`+ The join event has been accepted into the room.`
`188`	`188`	`schema:`
`189`	`189`	`$ref: "./definitions/send_join_response.yaml"`
`190`	`190`	`examples:`