Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Remove aliases from /publicRooms response #3624

Merged
merged 2 commits into from
Jan 18, 2022
Merged

Remove aliases from /publicRooms response #3624

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
e5509f5
Remove `aliases` from `/publicRooms` response
turt2live Jan 5, 2022
3d083cb
Merge branch 'main' into travis/remove-aliases-publicrooms
turt2live Jan 17, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions changelogs/client_server/newsfragments/3624.breaking
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
The `aliases` property from the chunks returned by `/publicRooms`, as per [MSC2432](https://github.com/matrix-org/matrix-doc/pull/2432).
Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I've listed this as breaking because while it doesn't appear to affect anyone, it is a removal without deprecation.

6 changes: 0 additions & 6 deletions data/api/client-server/definitions/public_rooms_chunk.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,12 +15,6 @@
type: object
title: "PublicRoomsChunk"
properties:
aliases:
type: array
description: Aliases of the room. May be empty.
items:
type: string
example: ["#general:example.org"]
canonical_alias:
type: string
description: The canonical alias of the room, if any.
Expand Down
1 change: 0 additions & 1 deletion data/api/client-server/definitions/public_rooms_response.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -55,7 +55,6 @@ properties:
example: {
"chunk": [
{
"aliases": ["#murrays:cheese.bar"],
"avatar_url": "mxc://bleecker.street/CHEDDARandBRIE",
"guest_can_join": false,
"name": "CHEESE",
Expand Down
1 change: 0 additions & 1 deletion data/api/client-server/space_hierarchy.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -100,7 +100,6 @@ paths:
"join_rule": "public",
"room_type": "m.space",
"num_joined_members": 42,
"aliases": ["#general:example.org"],
"canonical_alias": "#general:example.org",
"children_state": [
{
Expand Down
1 change: 0 additions & 1 deletion data/api/server-server/public_rooms.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -178,7 +178,6 @@ paths:
application/json: {
"chunk": [
{
"aliases": ["#murrays:cheese.bar"],
"avatar_url": "mxc://bleecker.street/CHEDDARandBRIE",
"guest_can_join": false,
"name": "CHEESE",
Expand Down
2 changes: 0 additions & 2 deletions data/api/server-server/space_hierarchy.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -74,7 +74,6 @@ paths:
"join_rule": "public",
"room_type": "m.space",
"num_joined_members": 42,
"aliases": ["#general:example.org"],
"canonical_alias": "#general:example.org",
"allowed_room_ids": [],
"children_state": [
Expand Down Expand Up @@ -103,7 +102,6 @@ paths:
"join_rule": "restricted",
"room_type": "m.space",
"num_joined_members": 42,
"aliases": ["#general:example.org"],
"canonical_alias": "#general:example.org",
"allowed_room_ids": [
"!upstream:example.org"
Expand Down
7 changes: 2 additions & 5 deletions proposals/2403-knock.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -196,9 +196,6 @@ contain this information:

```json
{
"aliases": [
"#murrays:cheese.bar"
],
"avatar_url": "mxc://bleecker.street/CHEDDARandBRIE",
"guest_can_join": false,
"name": "CHEESE",
Expand Down Expand Up @@ -436,7 +433,7 @@ The room is unknown to the remote server. Example reply:

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

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

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

Expand Down
5 changes: 5 additions & 0 deletions proposals/2432-revised-alias-publishing.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
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
restrictions. No change to the specification is introduced in this regard
(implementations will continue to be free to impose their own
Expand Down
1 change: 0 additions & 1 deletion proposals/2946-spaces-summary.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -125,7 +125,6 @@ GET /_matrix/client/v1/rooms/%21ol19s%3Ableecker.street/hierarchy?
"world_readable": true,
"join_rule": "public",
"canonical_alias": "#cheese:bleecker.street",
"aliases": ["#cheese:bleecker.street"],

// Added fields
"room_type": "m.space",
Expand Down