Skip to content

Commit fc3f7d6

Browse files
authored
Remove aliases from /publicRooms response (#3624)
Through attempting to land [Synapse#11667](matrix-org/synapse#11667) it was found that Synapse doesn't return the `aliases` property on `/publicRooms` as it was [removed](matrix-org/synapse#6970) by a [tracking issue](matrix-org/synapse#6898) referencing [MSC2432](#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](#3610) for diff clarity.
1 parent 97a8b0b commit fc3f7d6

File tree

9 files changed

+8
-17
lines changed

9 files changed

+8
-17
lines changed
Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
The `aliases` property from the chunks returned by `/publicRooms`, as per [MSC2432](https://github.com/matrix-org/matrix-doc/pull/2432).

data/api/client-server/definitions/public_rooms_chunk.yaml

Lines changed: 0 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -15,12 +15,6 @@
1515
type: object
1616
title: "PublicRoomsChunk"
1717
properties:
18-
aliases:
19-
type: array
20-
description: Aliases of the room. May be empty.
21-
items:
22-
type: string
23-
example: ["#general:example.org"]
2418
canonical_alias:
2519
type: string
2620
description: The canonical alias of the room, if any.

data/api/client-server/definitions/public_rooms_response.yaml

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -55,7 +55,6 @@ properties:
5555
example: {
5656
"chunk": [
5757
{
58-
"aliases": ["#murrays:cheese.bar"],
5958
"avatar_url": "mxc://bleecker.street/CHEDDARandBRIE",
6059
"guest_can_join": false,
6160
"name": "CHEESE",

data/api/client-server/space_hierarchy.yaml

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -100,7 +100,6 @@ paths:
100100
"join_rule": "public",
101101
"room_type": "m.space",
102102
"num_joined_members": 42,
103-
"aliases": ["#general:example.org"],
104103
"canonical_alias": "#general:example.org",
105104
"children_state": [
106105
{

data/api/server-server/public_rooms.yaml

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -178,7 +178,6 @@ paths:
178178
application/json: {
179179
"chunk": [
180180
{
181-
"aliases": ["#murrays:cheese.bar"],
182181
"avatar_url": "mxc://bleecker.street/CHEDDARandBRIE",
183182
"guest_can_join": false,
184183
"name": "CHEESE",

data/api/server-server/space_hierarchy.yaml

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -74,7 +74,6 @@ paths:
7474
"join_rule": "public",
7575
"room_type": "m.space",
7676
"num_joined_members": 42,
77-
"aliases": ["#general:example.org"],
7877
"canonical_alias": "#general:example.org",
7978
"allowed_room_ids": [],
8079
"children_state": [
@@ -103,7 +102,6 @@ paths:
103102
"join_rule": "restricted",
104103
"room_type": "m.space",
105104
"num_joined_members": 42,
106-
"aliases": ["#general:example.org"],
107105
"canonical_alias": "#general:example.org",
108106
"allowed_room_ids": [
109107
"!upstream:example.org"

proposals/2403-knock.md

Lines changed: 2 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -196,9 +196,6 @@ contain this information:
196196

197197
```json
198198
{
199-
"aliases": [
200-
"#murrays:cheese.bar"
201-
],
202199
"avatar_url": "mxc://bleecker.street/CHEDDARandBRIE",
203200
"guest_can_join": false,
204201
"name": "CHEESE",
@@ -436,7 +433,7 @@ The room is unknown to the remote server. Example reply:
436433

437434
## Restrictions
438435
There are restrictions to being able to set this membership, as well as
439-
accepting or denying the knock. A formal description of the changes to the auth rules is given below;
436+
accepting or denying the knock. A formal description of the changes to the auth rules is given below;
440437
first we summarise the semantics of the proposed changes.
441438

442439
### Current membership
@@ -604,7 +601,7 @@ partake in. That is why this proposal enables the `knock` join rule, in
604601
order to allow room admins to opt in to this behaviour.
605602

606603
# Alternatives
607-
The possibility of initiating a knock by sending EDUs between users instead of sending
604+
The possibility of initiating a knock by sending EDUs between users instead of sending
608605
a membership state event into a room has been raised. This is an ongoing discussion
609606
occurring at https://github.com/matrix-org/matrix-doc/pull/2403/files#r573180627.
610607

proposals/2432-revised-alias-publishing.md

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -148,6 +148,11 @@ rules](https://matrix.org/docs/spec/rooms/v1#authorization-rules) and
148148
Servers might also choose to allow access to other users such as server
149149
administrators.
150150

151+
* [`GET /_matrix/client/r0/publicRooms`](https://matrix.org/docs/spec/client_server/r0.6.0#get-matrix-client-r0-publicrooms)
152+
(and the `POST` variant) no longer return `aliases` as part of `PublicRoomsChunk`.
153+
Clients do not appear to make use of this field, and `canonical_alias` is maintained
154+
to provide similar information.
155+
151156
Various APIs are currently subject to implementation-defined access
152157
restrictions. No change to the specification is introduced in this regard
153158
(implementations will continue to be free to impose their own

proposals/2946-spaces-summary.md

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -125,7 +125,6 @@ GET /_matrix/client/v1/rooms/%21ol19s%3Ableecker.street/hierarchy?
125125
"world_readable": true,
126126
"join_rule": "public",
127127
"canonical_alias": "#cheese:bleecker.street",
128-
"aliases": ["#cheese:bleecker.street"],
129128

130129
// Added fields
131130
"room_type": "m.space",

0 commit comments

Comments
 (0)