Remove aliases from /publicRooms response (#3624)

Through attempting to land [Synapse#11667](https://github.com/matrix-org/synapse/pull/11667) it was found that Synapse doesn't return the `aliases` property on `/publicRooms` as it was [removed](https://github.com/matrix-org/synapse/pull/6970) by a [tracking issue](https://github.com/matrix-org/synapse/issues/6898) referencing [MSC2432](https://github.com/matrix-org/matrix-doc/pull/2432) as its base. Though MSC2432 does not make mention of this, the [document](https://docs.google.com/document/d/1NNDkobiFLeUkJtyj0H6qvKIedgvIkZnFKo78-03cGEk/edit) the MSC is based upon makes deliberate effort to mention the endpoint and the removal of `aliases`. Thus, it is determined as a likely accidental omission from the formal MSC and therefore the formal spec.

This has been corrected here by amending the MSC (per the process) and removing the field, basing itself off of the [spec PR for spaces](https://github.com/matrix-org/matrix-doc/pull/3610) for diff clarity.
This commit is contained in:
Travis Ralston 2022-01-18 08:54:28 -07:00 committed by GitHub
parent 97a8b0bb13
commit fc3f7d60eb
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
9 changed files with 8 additions and 17 deletions

View file

@ -0,0 +1 @@
The `aliases` property from the chunks returned by `/publicRooms`, as per [MSC2432](https://github.com/matrix-org/matrix-doc/pull/2432).

View file

@ -15,12 +15,6 @@
type: object type: object
title: "PublicRoomsChunk" title: "PublicRoomsChunk"
properties: properties:
aliases:
type: array
description: Aliases of the room. May be empty.
items:
type: string
example: ["#general:example.org"]
canonical_alias: canonical_alias:
type: string type: string
description: The canonical alias of the room, if any. description: The canonical alias of the room, if any.

View file

@ -55,7 +55,6 @@ properties:
example: { example: {
"chunk": [ "chunk": [
{ {
"aliases": ["#murrays:cheese.bar"],
"avatar_url": "mxc://bleecker.street/CHEDDARandBRIE", "avatar_url": "mxc://bleecker.street/CHEDDARandBRIE",
"guest_can_join": false, "guest_can_join": false,
"name": "CHEESE", "name": "CHEESE",

View file

@ -100,7 +100,6 @@ paths:
"join_rule": "public", "join_rule": "public",
"room_type": "m.space", "room_type": "m.space",
"num_joined_members": 42, "num_joined_members": 42,
"aliases": ["#general:example.org"],
"canonical_alias": "#general:example.org", "canonical_alias": "#general:example.org",
"children_state": [ "children_state": [
{ {

View file

@ -178,7 +178,6 @@ paths:
application/json: { application/json: {
"chunk": [ "chunk": [
{ {
"aliases": ["#murrays:cheese.bar"],
"avatar_url": "mxc://bleecker.street/CHEDDARandBRIE", "avatar_url": "mxc://bleecker.street/CHEDDARandBRIE",
"guest_can_join": false, "guest_can_join": false,
"name": "CHEESE", "name": "CHEESE",

View file

@ -74,7 +74,6 @@ paths:
"join_rule": "public", "join_rule": "public",
"room_type": "m.space", "room_type": "m.space",
"num_joined_members": 42, "num_joined_members": 42,
"aliases": ["#general:example.org"],
"canonical_alias": "#general:example.org", "canonical_alias": "#general:example.org",
"allowed_room_ids": [], "allowed_room_ids": [],
"children_state": [ "children_state": [
@ -103,7 +102,6 @@ paths:
"join_rule": "restricted", "join_rule": "restricted",
"room_type": "m.space", "room_type": "m.space",
"num_joined_members": 42, "num_joined_members": 42,
"aliases": ["#general:example.org"],
"canonical_alias": "#general:example.org", "canonical_alias": "#general:example.org",
"allowed_room_ids": [ "allowed_room_ids": [
"!upstream:example.org" "!upstream:example.org"

View file

@ -196,9 +196,6 @@ contain this information:
```json ```json
{ {
"aliases": [
"#murrays:cheese.bar"
],
"avatar_url": "mxc://bleecker.street/CHEDDARandBRIE", "avatar_url": "mxc://bleecker.street/CHEDDARandBRIE",
"guest_can_join": false, "guest_can_join": false,
"name": "CHEESE", "name": "CHEESE",

View file

@ -148,6 +148,11 @@ rules](https://matrix.org/docs/spec/rooms/v1#authorization-rules) and
Servers might also choose to allow access to other users such as server Servers might also choose to allow access to other users such as server
administrators. administrators.
* [`GET /_matrix/client/r0/publicRooms`](https://matrix.org/docs/spec/client_server/r0.6.0#get-matrix-client-r0-publicrooms)
(and the `POST` variant) no longer return `aliases` as part of `PublicRoomsChunk`.
Clients do not appear to make use of this field, and `canonical_alias` is maintained
to provide similar information.
Various APIs are currently subject to implementation-defined access Various APIs are currently subject to implementation-defined access
restrictions. No change to the specification is introduced in this regard restrictions. No change to the specification is introduced in this regard
(implementations will continue to be free to impose their own (implementations will continue to be free to impose their own

View file

@ -125,7 +125,6 @@ GET /_matrix/client/v1/rooms/%21ol19s%3Ableecker.street/hierarchy?
"world_readable": true, "world_readable": true,
"join_rule": "public", "join_rule": "public",
"canonical_alias": "#cheese:bleecker.street", "canonical_alias": "#cheese:bleecker.street",
"aliases": ["#cheese:bleecker.street"],
// Added fields // Added fields
"room_type": "m.space", "room_type": "m.space",