Skip to content
This repository has been archived by the owner on Apr 26, 2024. It is now read-only.

deprecate /_matrix/client/*/admin #8177

Closed
richvdh opened this issue Aug 26, 2020 · 10 comments · Fixed by #8785
Closed

deprecate /_matrix/client/*/admin #8177

richvdh opened this issue Aug 26, 2020 · 10 comments · Fixed by #8785
Labels
A-Admin-API Z-Help-Wanted We know exactly how to fix this issue, and would be grateful for any contribution z-p2 (Deprecated Label)

Comments

@richvdh
Copy link
Member

richvdh commented Aug 26, 2020

Some of the admin API is exposed at various paths under /_matrix/client as well as /_synapse/admin. We should remove those paths to make it easier to lock down the admin api.

@richvdh
Copy link
Member Author

richvdh commented Aug 26, 2020

the other paths are:

  • /_matrix/client/api/v1/admin
  • /_matrix/client/unstable/admin
  • /_matrix/client/r0/admin

@clokep clokep added A-Admin-API Z-Help-Wanted We know exactly how to fix this issue, and would be grateful for any contribution z-p2 (Deprecated Label) labels Aug 26, 2020
@richvdh
Copy link
Member Author

richvdh commented Aug 26, 2020

The first step here is to announce our intention to remove the old paths in a changelog.

@anoadragon453
Copy link
Member

The first step here is to announce our intention to remove the old paths in a changelog.

Should we do so in v1.20.0?

@turt2live
Copy link
Member

note that at least one of those endpoints made it into the spec: https://matrix.org/docs/spec/client_server/r0.6.1#get-matrix-client-r0-admin-whois-userid

@richvdh
Copy link
Member Author

richvdh commented Sep 1, 2020

note that at least one of those endpoints made it into the spec: https://matrix.org/docs/spec/client_server/r0.6.1#get-matrix-client-r0-admin-whois-userid

feh. we should replace and deprecate that too.

@anoadragon453
Copy link
Member

I've added the release-blocker label to remind us to do put a note about this in v1.20.0.

@clokep
Copy link
Member

clokep commented Sep 16, 2020

Note that this essentially means removing historical_admin_path_patterns, which is an easy way to find them all. 👍

@anoadragon453
Copy link
Member

A deprecation warning for this has been added in the changelog for release v1.20.0: https://github.com/matrix-org/synapse/blob/v1.20.0/CHANGES.md#synapse-1200-2020-09-22

@clokep
Copy link
Member

clokep commented Sep 22, 2020

A deprecation warning for this has been added in the changelog for release v1.20.0: https://github.com/matrix-org/synapse/blob/v1.20.0/CHANGES.md#synapse-1200-2020-09-22

Thanks! Do we have any thoughts on how long before removing it? E.g. v1.21.0 seems fast?

@anoadragon453
Copy link
Member

We're aiming to get v1.21.0 in the not-too-far future, so I'd leave it a bit longer.

Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
A-Admin-API Z-Help-Wanted We know exactly how to fix this issue, and would be grateful for any contribution z-p2 (Deprecated Label)
Projects
None yet
Development

Successfully merging a pull request may close this issue.

4 participants