diff options
| author | Richard van der Hoff <1389908+richvdh@users.noreply.github.com> | 2020-11-30 16:48:12 +0000 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2020-11-30 16:48:12 +0000 |
| commit | a090b86209c01e42415df7736eb26c8adbe2aba0 (patch) | |
| tree | aa750ab41d37c5a338769aebaba58b870ad59bb3 /docs/admin_api/rooms.md | |
| parent | Remove special case of pretty printing JSON responses for curl (#8833) (diff) | |
| download | synapse-a090b86209c01e42415df7736eb26c8adbe2aba0.tar.xz | |
Add `force_purge` option to delete-room admin api. (#8843)
Diffstat (limited to 'docs/admin_api/rooms.md')
| -rw-r--r-- | docs/admin_api/rooms.md | 6 |
1 files changed, 5 insertions, 1 deletions
diff --git a/docs/admin_api/rooms.md b/docs/admin_api/rooms.md index 0c05b0ed55..004a802e17 100644 --- a/docs/admin_api/rooms.md +++ b/docs/admin_api/rooms.md @@ -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 `{}`. |