diff options
| author | Till <2353100+S7evinK@users.noreply.github.com> | 2023-03-27 15:39:33 +0200 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2023-03-27 15:39:33 +0200 |
| commit | fa7710315a00f6e857bb9c315c0a7ba248288b79 (patch) | |
| tree | bab330b1538667f4d310570897d179cb7f333eef /docs | |
| parent | e8b2162a01bf0e735869d5a2b9be258cb380255e (diff) | |
Add tests for the Dendrite admin APIs (#3028)
Contains a breaking change, since the endpoints `/_dendrite/admin/evacuateRoom/{roomID}` and `/_dendrite/admin/evacuateUser/{userID}` are now using `POST` instead of `GET`
Diffstat (limited to 'docs')
| -rw-r--r-- | docs/administration/4_adminapi.md | 4 |
1 files changed, 2 insertions, 2 deletions
diff --git a/docs/administration/4_adminapi.md b/docs/administration/4_adminapi.md index 46cfac22..b11aeb1a 100644 --- a/docs/administration/4_adminapi.md +++ b/docs/administration/4_adminapi.md @@ -32,7 +32,7 @@ UPDATE userapi_accounts SET account_type = 3 WHERE localpart = '$localpart'; Where `$localpart` is the username only (e.g. `alice`). -## GET `/_dendrite/admin/evacuateRoom/{roomID}` +## POST `/_dendrite/admin/evacuateRoom/{roomID}` This endpoint will instruct Dendrite to part all local users from the given `roomID` in the URL. It may take some time to complete. A JSON body will be returned containing @@ -41,7 +41,7 @@ the user IDs of all affected users. If the room has an alias set (e.g. is published), the room's ID will not be visible in the URL, but it can be found as the room's "internal ID" in Element Web (Settings -> Advanced) -## GET `/_dendrite/admin/evacuateUser/{userID}` +## POST `/_dendrite/admin/evacuateUser/{userID}` This endpoint will instruct Dendrite to part the given local `userID` in the URL from all rooms which they are currently joined. A JSON body will be returned containing |