MSC3827: Filtering of `/publicRooms` by room type (#3827)
parent
1bfa09cc2a
commit
129e5e982e
@ -0,0 +1,78 @@
|
||||
# MSC3827: Filtering of `/publicRooms` by room type
|
||||
|
||||
[MSC1772](https://github.com/matrix-org/matrix-doc/pull/1772) defines Spaces as
|
||||
rooms with `type` of `m.space`. One of the most requested features for Spaces is
|
||||
to have [a way to to discover
|
||||
them](https://github.com/vector-im/element-web/issues/17264). To solve this
|
||||
issue, this MSC proposes a mechanism for filtering the response of
|
||||
`/publicRooms` by room type.
|
||||
|
||||
## Proposal
|
||||
|
||||
This MSC proposes adding a `room_types` filter to the [`POST /publicRooms`](https://spec.matrix.org/v1.3/client-server-api/#post_matrixclientv3publicrooms) endpoint.
|
||||
The value of `room_types` is an array of room types - possible values of the
|
||||
`type` field in the `m.room.create` state event's `content` dictionary - which should be returned.
|
||||
|
||||
An example request could look like this:
|
||||
|
||||
```HTTP
|
||||
POST /_matrix/client/v3/publicRooms
|
||||
{
|
||||
"filter": {
|
||||
"room_types": ["m.space"]
|
||||
},
|
||||
"limit": 10
|
||||
}
|
||||
```
|
||||
|
||||
The response for both `POST /publicRooms` and `GET /publicRooms` is also modified to include a `room_type` field, so that clients can show
|
||||
the room type metadata.
|
||||
|
||||
```json
|
||||
{
|
||||
"chunk": [{
|
||||
"avatar_url": "mxc://bleecker.street/CHEDDARandBRIE",
|
||||
"guest_can_join": false,
|
||||
"join_rule": "public",
|
||||
"name": "CHEESE",
|
||||
"num_joined_members": 37,
|
||||
"room_id": "!ol19s:bleecker.street",
|
||||
"topic": "Tasty tasty cheese",
|
||||
"world_readable": true,
|
||||
"room_type": "m.space"
|
||||
}],
|
||||
"next_batch": "p190q",
|
||||
"prev_batch": "p1902",
|
||||
"total_room_count_estimate": 115
|
||||
}
|
||||
```
|
||||
|
||||
If the client wants to get rooms of the default type, it should include `null`
|
||||
in the `room_types` array. If the `room_types` filter is not specified or the
|
||||
`room_types` array is empty, the server should return _all_ rooms no matter the
|
||||
type.
|
||||
|
||||
## Alternatives
|
||||
|
||||
### Using a special endpoint
|
||||
|
||||
A special endpoint for spaces and other room types could be used. Then each new
|
||||
room type would require a special MSC and there would be no way to filter by
|
||||
custom room types. Filtering by multiple types would be impossible.
|
||||
|
||||
### Replacing the room directory with a server-wide space
|
||||
|
||||
[A matrix-spec issue](https://github.com/matrix-org/matrix-spec/issues/830)
|
||||
suggests replacing the room directory with a server-wide space; while this
|
||||
solution certainly has benefits, it would require a lot of changes both on the
|
||||
client and the server side.
|
||||
|
||||
## Unstable prefix
|
||||
|
||||
While this MSC is not considered stable, implementations should use
|
||||
`org.matrix.msc3827` as a namespace.
|
||||
|
||||
|Release |Development |
|
||||
|------------|-------------------------------|
|
||||
|`room_type` |`org.matrix.msc3827.room_type` |
|
||||
|`room_types`|`org.matrix.msc3827.room_types`|
|
Loading…
Reference in New Issue