mirror of
https://github.com/matrix-org/matrix-spec
synced 2026-06-10 18:27:47 +02:00
2b68fd935c
Some checks failed
Spec / 🔎 Validate OpenAPI specifications (push) Has been cancelled
Spec / 🔎 Check Event schema examples (push) Has been cancelled
Spec / 🔎 Check OpenAPI definitions examples (push) Has been cancelled
Spec / 🔎 Check JSON Schemas inline examples (push) Has been cancelled
Spec / ⚙️ Calculate baseURL for later jobs (push) Has been cancelled
Spec / 📢 Run towncrier for changelog (push) Has been cancelled
Spell Check / Spell Check with Typos (push) Has been cancelled
Spec / 🐍 Build OpenAPI definitions (push) Has been cancelled
Spec / 📖 Build the spec (push) Has been cancelled
Spec / 🔎 Validate generated HTML (push) Has been cancelled
Spec / 📖 Build the historical backup spec (push) Has been cancelled
Spec / Create release (push) Has been cancelled
Signed-off-by: Logan Devine <logan@zirco.dev> Co-authored-by: Kévin Commaille <76261501+zecakeh@users.noreply.github.com> Co-authored-by: Richard van der Hoff <1389908+richvdh@users.noreply.github.com>
20 lines
964 B
Markdown
20 lines
964 B
Markdown
### 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.
|