diff options
| author | Dirk Klimpel <5740567+dklimpel@users.noreply.github.com> | 2022-08-17 11:42:01 +0200 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2022-08-17 09:42:01 +0000 |
| commit | d75512d19ebea6c0f9e38e9f55474fdb6da02b46 (patch) | |
| tree | 2a284edb7a9c16b1040c6ca3a8966716a81234e8 /docs/admin_api | |
| parent | Add metrics to track rate limiter queue timing (#13544) (diff) | |
| download | synapse-d75512d19ebea6c0f9e38e9f55474fdb6da02b46.tar.xz | |
Add forgotten status to Room Details API (#13503)
Diffstat (limited to 'docs/admin_api')
| -rw-r--r-- | docs/admin_api/rooms.md | 5 |
1 files changed, 4 insertions, 1 deletions
diff --git a/docs/admin_api/rooms.md b/docs/admin_api/rooms.md index 9aa489e4a3..ac7c54c20e 100644 --- a/docs/admin_api/rooms.md +++ b/docs/admin_api/rooms.md @@ -302,6 +302,8 @@ The following fields are possible in the JSON response body: * `state_events` - Total number of state_events of a room. Complexity of the room. * `room_type` - The type of the room taken from the room's creation event; for example "m.space" if the room is a space. If the room does not define a type, the value will be `null`. +* `forgotten` - Whether all local users have + [forgotten](https://spec.matrix.org/latest/client-server-api/#leaving-rooms) the room. The API is: @@ -330,7 +332,8 @@ A response body like the following is returned: "guest_access": null, "history_visibility": "shared", "state_events": 93534, - "room_type": "m.space" + "room_type": "m.space", + "forgotten": false } ``` |