Filip/matrix-spec
1
0
Fork 0
mirror of https://github.com/matrix-org/matrix-spec synced 2026-06-10 02:07:48 +02:00
Code Issues Actions 2 Packages Projects Releases Wiki Activity

split mutual rooms into its own module, add added-in line

Browse source
This commit is contained in:
Logan Devine 2026-05-09 09:56:30 -07:00
parent edb68ea238
commit 7887d4628b
No known key found for this signature in database
GPG key ID: 6C154E1DBCF538F4
2 changed files with 21 additions and 17 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

19
content/client-server-api/_index.md
View file

@ -4233,23 +4233,6 @@ users, they should include the display name and avatar URL fields in
these events so that clients already have these details to hand, and do
not have to perform extra round trips to query it.
### Mutual Rooms
{{% http-api spec="client-server" api="mutual_rooms" %}}
#### Server behaviour
The server may decide that the response to this endpoint is too large, and only return a
subset of the results. In this case, the server should populate the optional field `next_batch`
with an [opaque identifier](/appendices/#opaque-identifiers). The client may then supply
the identifier as the `from` query parameter in a subsequent request, along with the original
`user_id`, to fetch the next batch of responses. This will continue until the server no longer
inserts `next_batch`, meaning there are no further results.
Batch tokens generated by this endpoint SHOULD be valid for at least 10 minutes, after which,
tokens can expire. Expired tokens SHOULD be handled similar to invalid tokens, and return
a 400 response.
## Modules
Modules are parts of the Client-Server API which are not universal to
@ -4319,6 +4302,7 @@ that profile.
| [Third-party Networks](#third-party-networks) | Optional | Optional | Optional | Optional | Optional |
| [Threading](#threading) | Optional | Optional | Optional | Optional | Optional |
| [Invite permission](#invite-permission) | Optional | Optional | Optional | Optional | Optional |
| [Mutual Rooms](#mutual-rooms) | Optional | Optional | Optional | Optional | Optional |
*Please see each module for more details on what clients need to
implement.*
@ -4409,3 +4393,4 @@ systems.
{{% cs-module name="Recently used emoji" filename="recent_emoji" %}}
{{% cs-module name="Threading" filename="threading" %}}
{{% cs-module name="Reference relations" filename="reference_relations" %}}
{{% cs-module name="Mutual Rooms" filename="mutual_rooms" %}}

19
content/client-server-api/modules/mutual_rooms.md Normal file
View file

@ -0,0 +1,19 @@
### Mutual Rooms
{{% added-in v="1.19" %}}
{{% http-api spec="client-server" api="mutual_rooms" %}}
#### Server behaviour
The server may decide that the response to this endpoint is too large, and only return a
subset of the results. In this case, the server should populate the optional field `next_batch`
with an [opaque identifier](/appendices/#opaque-identifiers). The client may then supply
the identifier as the `from` query parameter in a subsequent request, along with the original
`user_id`, to fetch the next batch of responses. This will continue until the server no longer
inserts `next_batch`, meaning there are no further results.
Batch tokens generated by this endpoint SHOULD be valid for at least 10 minutes, after which,
tokens can expire. Expired tokens SHOULD be handled similar to invalid tokens, and return
a 400 response. When a client uses batch tokens, servers MAY omit rooms that the user joined
after the first token was generated.