summary refs log tree commit diff
path: root/docs
diff options
context:
space:
mode:
authorThibF <thibaultferrante@hotmail.com>2021-04-29 09:31:45 +0000
committerGitHub <noreply@github.com>2021-04-29 10:31:45 +0100
commit0085dc5abc614579f3adbd9e6d2cbdd41facef00 (patch)
treee1f464d19b8a758816deb03e690adf76a022eee2 /docs
parentMerge remote-tracking branch 'origin/release-v1.33.0' into develop (diff)
downloadsynapse-0085dc5abc614579f3adbd9e6d2cbdd41facef00.tar.xz
Delete room endpoint (#9889)
Support the delete of a room through DELETE request and mark
previous request as deprecated through documentation.

Signed-off-by: Thibault Ferrante <thibault.ferrante@pm.me>
Diffstat (limited to 'docs')
-rw-r--r--docs/admin_api/rooms.md11
1 files changed, 10 insertions, 1 deletions
diff --git a/docs/admin_api/rooms.md b/docs/admin_api/rooms.md
index bc737b30f5..01d3882426 100644
--- a/docs/admin_api/rooms.md
+++ b/docs/admin_api/rooms.md
@@ -427,7 +427,7 @@ the new room. Users on other servers will be unaffected.
 The API is:
 
 ```
-POST /_synapse/admin/v1/rooms/<room_id>/delete
+DELETE /_synapse/admin/v1/rooms/<room_id>
 ```
 
 with a body of:
@@ -528,6 +528,15 @@ You will have to manually handle, if you so choose, the following:
 * Users that would have been booted from the room (and will have been force-joined to the Content Violation room).
 * Removal of the Content Violation room if desired.
 
+## Deprecated endpoint
+
+The previous deprecated API will be removed in a future release, it was:
+
+```
+POST /_synapse/admin/v1/rooms/<room_id>/delete
+```
+
+It behaves the same way than the current endpoint except the path and the method.
 
 # Make Room Admin API