dandri/synapse
1
0
Fork 0
mirror of https://github.com/element-hq/synapse.git synced 2026-05-15 05:55:21 +00:00
Code Issues Packages Projects Releases Wiki Activity

Add force_purge option to delete-room admin api. (#8843)

Browse Source
This commit is contained in:
Richard van der Hoff
2020-11-30 16:48:12 +00:00
committed by GitHub
parent 856eab606b
commit a090b86209
4 changed files with 34 additions and 12 deletions
Download Patch File Download Diff File Expand all files Collapse all files
docs/admin_api/rooms.md
+5 -1
View File
@@ -382,7 +382,7 @@ the new room. Users on other servers will be unaffected.
The API is:
```json
```
POST /_synapse/admin/v1/rooms/<room_id>/delete
```
@@ -439,6 +439,10 @@ The following JSON body parameters are available:
future attempts to join the room. Defaults to `false`.
* `purge` - Optional. If set to `true`, it will remove all traces of the room from your database.
Defaults to `true`.
* `force_purge` - Optional, and ignored unless `purge` is `true`. If set to `true`, it
will force a purge to go ahead even if there are local users still in the room. Do not
use this unless a regular `purge` operation fails, as it could leave those users'
clients in a confused state.
The JSON body must not be empty. The body must be at least `{}`.