4.5 KiB

Raw Permalink Blame History

MSC3827: Filtering of `/publicRooms` by room type

MSC1772 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. 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 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:

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.

{
    "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.

The same API shape is added to the Server-Server API for the public room directory, allowing servers to proxy the request over federation if needed. Note that the remote server might not support this filtering mechanism - the local server should further filter the results if needed/possible.

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 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`

Clients should check for server support before using the features proposed by this MSC.

Once this MSC gets merged and once it becomes a part of a spec version, clients should update their implementations as fast as possible to accommodate the fact that the way of detecting server support will change.

While the MSC is unstable

During this period, to detect server support, clients should check for the presence of the org.matrix.msc3827 flag in unstable_features on /versions. Clients are also required to use the unstable prefixes (see unstable prefix) during this time.

Once the MSC is merged but not in a spec version

Once this MSC is merged, but is not yet part of the spec, clients should rely on the presence of the org.matrix.msc3827.stable flag in unstable_features to determine server support. If the flag is present, clients are required to use stable prefixes (see unstable prefix).

Once the MSC is in a spec version

Once this MSC becomes a part of a spec version, clients should rely on the presence of the spec version, that supports the MSC, in versions on /versions, to determine support. Servers are encouraged to keep the org.matrix.msc3827.stable flag around for a reasonable amount of time to help smooth over the transition for clients. "Reasonable" is intentionally left as an implementation detail, however the MSC process currently recommends at most 2 months from the date of spec release.

4.5 KiB Raw Permalink Blame History

MSC3827: Filtering of /publicRooms by room type