From e8e7012265c2fa86444c187e1927ad2ebc47f76f Mon Sep 17 00:00:00 2001 From: Dirk Klimpel <5740567+dklimpel@users.noreply.github.com> Date: Thu, 18 Feb 2021 15:05:41 +0100 Subject: [PATCH] Deprecate old admin API `GET /_synapse/admin/v1/users/` (#9429) This API was undocumented and nonsensical. --- CHANGES.md | 15 +++++++++++++++ changelog.d/9429.removal | 1 + 2 files changed, 16 insertions(+) create mode 100644 changelog.d/9429.removal diff --git a/CHANGES.md b/CHANGES.md index d9afcaa52b..309c34f90b 100644 --- a/CHANGES.md +++ b/CHANGES.md @@ -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/` with `GET /_synapse/admin/v2/users`. + + Synapse 1.27.0 (2021-02-16) =========================== diff --git a/changelog.d/9429.removal b/changelog.d/9429.removal new file mode 100644 index 0000000000..1ff9089a20 --- /dev/null +++ b/changelog.d/9429.removal @@ -0,0 +1 @@ +Deprecate old admin API `GET /_synapse/admin/v1/users/`. \ No newline at end of file