Deprecate old admin API GET /_synapse/admin/v1/users/<user_id> (#9429)

This API was undocumented and nonsensical.
This commit is contained in:
Dirk Klimpel 2021-02-18 15:05:41 +01:00 committed by GitHub
parent 8ec2217103
commit e8e7012265
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
2 changed files with 16 additions and 0 deletions

View file

@ -1,3 +1,18 @@
Synapse 1.xx.0 (2021-xx-xx)
===========================
Removal warning
---------------
The v1 list accounts API is deprecated and will be removed in a future release.
This API was undocumented and misleading. It can be replaced by the
[v2 list accounts API](https://github.com/matrix-org/synapse/blob/master/docs/admin_api/user_admin_api.rst#list-accounts),
which has been available since Synapse 1.7.0 (2019-12-13).
Please check if you're using any scripts which use the admin API and replace
`GET /_synapse/admin/v1/users/<user_id>` with `GET /_synapse/admin/v2/users`.
Synapse 1.27.0 (2021-02-16)
===========================

1
changelog.d/9429.removal Normal file
View file

@ -0,0 +1 @@
Deprecate old admin API `GET /_synapse/admin/v1/users/<user_id>`.