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.

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

Remove aliases from /publicRooms response #3624

Merged
merged 2 commits into from Jan 18, 2022

Conversation

turt2live
Copy link
Member

@turt2live turt2live commented Jan 5, 2022

Note: This is pointing at the Spaces branch to have a readable diff. This will be changed to main prior to merging, which is dependent on #3610


Fixes #3056

Through attempting to land Synapse#11667 it was found that Synapse doesn't return the aliases property on /publicRooms as it was removed by a tracking issue referencing MSC2432 as its base. Though MSC2432 does not make mention of this, the document 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 for diff clarity.

Preview: https://pr3624--matrix-org-previews.netlify.app

@@ -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.

@turt2live turt2live requested a review from a team January 5, 2022 19:47
turt2live added a commit to matrix-org/synapse that referenced this pull request Jan 5, 2022
@turt2live turt2live force-pushed the travis/spec/spaces-1-1772-3288-2946 branch from 51bbc2e to e68dc2f Compare January 5, 2022 20:02
@turt2live turt2live force-pushed the travis/remove-aliases-publicrooms branch from 8d15952 to a7e7e92 Compare January 5, 2022 20:03
@richvdh richvdh force-pushed the travis/spec/spaces-1-1772-3288-2946 branch from 6616a5e to 493f730 Compare January 11, 2022 19:30
@richvdh richvdh force-pushed the travis/remove-aliases-publicrooms branch from a7e7e92 to 4a67c58 Compare January 11, 2022 20:11
@turt2live turt2live changed the base branch from travis/spec/spaces-1-1772-3288-2946 to main January 17, 2022 17:04
@turt2live turt2live removed the request for review from a team January 17, 2022 17:05
@turt2live turt2live marked this pull request as draft January 17, 2022 17:05
@turt2live turt2live self-assigned this Jan 17, 2022
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.
@turt2live turt2live force-pushed the travis/remove-aliases-publicrooms branch from 4a67c58 to e5509f5 Compare January 17, 2022 20:11
@turt2live turt2live marked this pull request as ready for review January 17, 2022 20:13
@turt2live turt2live requested a review from a team January 17, 2022 20:14
@turt2live turt2live removed their assignment Jan 17, 2022
Copy link
Member

@richvdh richvdh left a comment

Choose a reason for hiding this comment

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

lgtm

@turt2live turt2live merged commit fc3f7d6 into main Jan 18, 2022
@turt2live turt2live deleted the travis/remove-aliases-publicrooms branch January 18, 2022 15:54
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Remove aliases field from /publicRooms
2 participants