diff options
| author | Dirk Klimpel <5740567+dklimpel@users.noreply.github.com> | 2020-12-10 12:42:48 +0100 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2020-12-10 11:42:48 +0000 |
| commit | a5f7aff5e5a840c53e79d185d40b22d67dad2ea1 (patch) | |
| tree | 30a0e251dff5edb2ddd9aad1c53e75d2a91f579e /docs/admin_api/purge_room.md | |
| parent | Default to blacklisting reserved IP ranges and add a whitelist. (#8870) (diff) | |
| download | synapse-a5f7aff5e5a840c53e79d185d40b22d67dad2ea1.tar.xz | |
Deprecate Shutdown Room and Purge Room Admin API (#8829)
Deprecate both APIs in favour of the Delete Room API. Related: #8663 and #8810
Diffstat (limited to 'docs/admin_api/purge_room.md')
| -rw-r--r-- | docs/admin_api/purge_room.md | 9 |
1 files changed, 5 insertions, 4 deletions
diff --git a/docs/admin_api/purge_room.md b/docs/admin_api/purge_room.md index ae01a543c6..54fea2db6d 100644 --- a/docs/admin_api/purge_room.md +++ b/docs/admin_api/purge_room.md @@ -1,12 +1,13 @@ -Purge room API -============== +Deprecated: Purge room API +========================== + +**The old Purge room API is deprecated and will be removed in a future release. +See the new [Delete Room API](rooms.md#delete-room-api) for more details.** This API will remove all trace of a room from your database. All local users must have left the room before it can be removed. -See also: [Delete Room API](rooms.md#delete-room-api) - The API is: ``` |