mirror of
https://github.com/matrix-org/matrix-spec
synced 2026-08-05 07:27:52 +02:00
Compare commits
No commits in common. "2b68fd935c6c81e96eb5c63d88454c3c47106e96" and "19fbee984247d7053c89238d37fb2d02fa60ac6a" have entirely different histories.
2b68fd935c
...
19fbee9842
|
|
@ -1 +0,0 @@
|
||||||
Add `GET /_matrix/client/v1/mutual_rooms`, as per [MSC2666](https://github.com/matrix-org/matrix-spec-proposals/pull/2666).
|
|
||||||
|
|
@ -1 +0,0 @@
|
||||||
Update link from whispersystems.org to signal.org in the olm documentation
|
|
||||||
|
|
@ -4302,7 +4302,6 @@ that profile.
|
||||||
| [Third-party Networks](#third-party-networks) | Optional | Optional | Optional | Optional | Optional |
|
| [Third-party Networks](#third-party-networks) | Optional | Optional | Optional | Optional | Optional |
|
||||||
| [Threading](#threading) | Optional | Optional | Optional | Optional | Optional |
|
| [Threading](#threading) | Optional | Optional | Optional | Optional | Optional |
|
||||||
| [Invite permission](#invite-permission) | 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
|
*Please see each module for more details on what clients need to
|
||||||
implement.*
|
implement.*
|
||||||
|
|
@ -4393,4 +4392,3 @@ systems.
|
||||||
{{% cs-module name="Recently used emoji" filename="recent_emoji" %}}
|
{{% cs-module name="Recently used emoji" filename="recent_emoji" %}}
|
||||||
{{% cs-module name="Threading" filename="threading" %}}
|
{{% cs-module name="Threading" filename="threading" %}}
|
||||||
{{% cs-module name="Reference relations" filename="reference_relations" %}}
|
{{% cs-module name="Reference relations" filename="reference_relations" %}}
|
||||||
{{% cs-module name="Mutual Rooms" filename="mutual_rooms" %}}
|
|
||||||
|
|
|
||||||
|
|
@ -1,19 +0,0 @@
|
||||||
### 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.
|
|
||||||
|
|
@ -5,7 +5,7 @@ type: docs
|
||||||
---
|
---
|
||||||
|
|
||||||
An implementation of the double cryptographic ratchet described by
|
An implementation of the double cryptographic ratchet described by
|
||||||
https://signal.org/docs/specifications/doubleratchet/.
|
https://whispersystems.org/docs/specifications/doubleratchet/.
|
||||||
|
|
||||||
## Notation
|
## Notation
|
||||||
|
|
||||||
|
|
@ -320,11 +320,11 @@ Can be sent to olm at matrix.org.
|
||||||
## Acknowledgements
|
## Acknowledgements
|
||||||
|
|
||||||
The ratchet that Olm implements was designed by Trevor Perrin and Moxie
|
The ratchet that Olm implements was designed by Trevor Perrin and Moxie
|
||||||
Marlinspike - details at https://signal.org/docs/specifications/doubleratchet/. Olm is
|
Marlinspike - details at https://whispersystems.org/docs/specifications/doubleratchet/. Olm is
|
||||||
an entirely new implementation written by the Matrix.org team.
|
an entirely new implementation written by the Matrix.org team.
|
||||||
|
|
||||||
[Curve25519]: http://cr.yp.to/ecdh.html
|
[Curve25519]: http://cr.yp.to/ecdh.html
|
||||||
[Triple Diffie-Hellman]: https://signal.org/blog/simplifying-otr-deniability/
|
[Triple Diffie-Hellman]: https://whispersystems.org/blog/simplifying-otr-deniability/
|
||||||
[HMAC-based key derivation function]: https://tools.ietf.org/html/rfc5869
|
[HMAC-based key derivation function]: https://tools.ietf.org/html/rfc5869
|
||||||
[HKDF-SHA-256]: https://tools.ietf.org/html/rfc5869
|
[HKDF-SHA-256]: https://tools.ietf.org/html/rfc5869
|
||||||
[HMAC-SHA-256]: https://tools.ietf.org/html/rfc2104
|
[HMAC-SHA-256]: https://tools.ietf.org/html/rfc2104
|
||||||
|
|
|
||||||
|
|
@ -1,127 +0,0 @@
|
||||||
# Copyright 2026 Logan Devine <logan@zirco.dev>
|
|
||||||
#
|
|
||||||
# Licensed under the Apache License, Version 2.0 (the "License");
|
|
||||||
# you may not use this file except in compliance with the License.
|
|
||||||
# You may obtain a copy of the License at
|
|
||||||
#
|
|
||||||
# http://www.apache.org/licenses/LICENSE-2.0
|
|
||||||
#
|
|
||||||
# Unless required by applicable law or agreed to in writing, software
|
|
||||||
# distributed under the License is distributed on an "AS IS" BASIS,
|
|
||||||
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
||||||
# See the License for the specific language governing permissions and
|
|
||||||
# limitations under the License.
|
|
||||||
openapi: 3.1.0
|
|
||||||
info:
|
|
||||||
title: Matrix Client-Server Mutual Rooms API
|
|
||||||
version: 1.0.0
|
|
||||||
paths:
|
|
||||||
/mutual_rooms:
|
|
||||||
get:
|
|
||||||
summary: Get the list of rooms that the user shares with another user.
|
|
||||||
description: |-
|
|
||||||
Get the list of rooms that the user shares with another user. The
|
|
||||||
server will return a list of room IDs that the user shares with the
|
|
||||||
specified `user_id`.
|
|
||||||
operationId: getMutualRooms
|
|
||||||
security:
|
|
||||||
- accessTokenQuery: []
|
|
||||||
- accessTokenBearer: []
|
|
||||||
parameters:
|
|
||||||
- in: query
|
|
||||||
name: user_id
|
|
||||||
required: true
|
|
||||||
description: The MXID of the user to check for mutual rooms with.
|
|
||||||
example: "@alice:example.com"
|
|
||||||
schema:
|
|
||||||
type: string
|
|
||||||
format: mx-user-id
|
|
||||||
pattern: "^@"
|
|
||||||
- in: query
|
|
||||||
name: from
|
|
||||||
required: false
|
|
||||||
description: |-
|
|
||||||
A pagination token from a previous result. This should be a `next_batch` result from
|
|
||||||
a previous call to this endpoint. If not provided, the server will return the first
|
|
||||||
batch of results.
|
|
||||||
example: next_batch_token
|
|
||||||
schema:
|
|
||||||
type: string
|
|
||||||
responses:
|
|
||||||
"200":
|
|
||||||
description: |-
|
|
||||||
A list of room IDs that the user shares with the specified user.
|
|
||||||
If the provided `user_id` is not a valid user, the server MUST return an empty list of rooms.
|
|
||||||
content:
|
|
||||||
application/json:
|
|
||||||
schema:
|
|
||||||
type: object
|
|
||||||
required:
|
|
||||||
- joined
|
|
||||||
- count
|
|
||||||
properties:
|
|
||||||
joined:
|
|
||||||
type: array
|
|
||||||
description: |-
|
|
||||||
A list of room IDs where both the authenticated user and `user_id` have a
|
|
||||||
membership of type `join`.
|
|
||||||
items:
|
|
||||||
type: string
|
|
||||||
format: mx-room-id
|
|
||||||
pattern: "^!"
|
|
||||||
example: "!OGEhHVWSdvArJzumhm:matrix.org"
|
|
||||||
count:
|
|
||||||
type: integer
|
|
||||||
description: |-
|
|
||||||
The number of such rooms. This is the total count even if the response is
|
|
||||||
batched and `joined` doesn't include all rooms. This MAY be inaccurate
|
|
||||||
if the server is unable to calculate the exact number of rooms.
|
|
||||||
example: 1
|
|
||||||
next_batch:
|
|
||||||
type: string
|
|
||||||
description: |-
|
|
||||||
A pagination token to retrieve the next batch of results. This will be absent
|
|
||||||
if there are no more results to return.
|
|
||||||
example: next_batch_token
|
|
||||||
|
|
||||||
"400":
|
|
||||||
description: |-
|
|
||||||
Part of the request was invalid. The `from` token provided was invalid or expired,
|
|
||||||
the `user_id` parameter was missing, [non-compliant](/appendices/#historical-user-ids),
|
|
||||||
or was the sender's own user ID.
|
|
||||||
content:
|
|
||||||
application/json:
|
|
||||||
schema:
|
|
||||||
$ref: definitions/errors/error.yaml
|
|
||||||
examples:
|
|
||||||
response:
|
|
||||||
value: {
|
|
||||||
"errcode": "M_INVALID_PARAM",
|
|
||||||
"error": "The user ID provided was invalid"
|
|
||||||
}
|
|
||||||
"429":
|
|
||||||
description: This request was rate-limited.
|
|
||||||
content:
|
|
||||||
application/json:
|
|
||||||
schema:
|
|
||||||
$ref: definitions/errors/rate_limited.yaml
|
|
||||||
tags:
|
|
||||||
- Mutual Rooms
|
|
||||||
servers:
|
|
||||||
- url: "{protocol}://{hostname}{basePath}"
|
|
||||||
variables:
|
|
||||||
protocol:
|
|
||||||
enum:
|
|
||||||
- http
|
|
||||||
- https
|
|
||||||
default: https
|
|
||||||
hostname:
|
|
||||||
default: localhost:8008
|
|
||||||
basePath:
|
|
||||||
default: /_matrix/client/v1
|
|
||||||
components:
|
|
||||||
securitySchemes:
|
|
||||||
accessTokenQuery:
|
|
||||||
$ref: definitions/security.yaml#/accessTokenQuery
|
|
||||||
accessTokenBearer:
|
|
||||||
$ref: definitions/security.yaml#/accessTokenBearer
|
|
||||||
Loading…
Reference in a new issue