diff options
| author | Alexander Fechler <141915399+afechler@users.noreply.github.com> | 2024-06-19 12:45:48 +0200 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2024-06-19 11:45:48 +0100 |
| commit | 9104a9f0d05fef9718ae4611b164b6dd1d85243c (patch) | |
| tree | 8d95b96c78fa7e2e55dea2c77eb2153f5b6aaf24 /docs | |
| parent | Update the README with Element branding and a few fixes (#17324) (diff) | |
| download | synapse-9104a9f0d05fef9718ae4611b164b6dd1d85243c.tar.xz | |
Filter added to Admin-API GET /rooms (#17276)
Diffstat (limited to 'docs')
| -rw-r--r-- | docs/admin_api/rooms.md | 4 |
1 files changed, 4 insertions, 0 deletions
diff --git a/docs/admin_api/rooms.md b/docs/admin_api/rooms.md index 6935ec4a45..8e3a367e90 100644 --- a/docs/admin_api/rooms.md +++ b/docs/admin_api/rooms.md @@ -36,6 +36,10 @@ The following query parameters are available: - the room's name, - the local part of the room's canonical alias, or - the complete (local and server part) room's id (case sensitive). +* `public_rooms` - Optional flag to filter public rooms. If `true`, only public rooms are queried. If `false`, public rooms are excluded from + the query. When the flag is absent (the default), **both** public and non-public rooms are included in the search results. +* `empty_rooms` - Optional flag to filter empty rooms. A room is empty if joined_members is zero. If `true`, only empty rooms are queried. If `false`, empty rooms are excluded from + the query. When the flag is absent (the default), **both** empty and non-empty rooms are included in the search results. Defaults to no filtering. |