diff options
| author | Tulir Asokan <tulir@maunium.net> | 2020-09-14 17:07:04 +0300 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2020-09-14 10:07:04 -0400 |
| commit | b82d68c0bd952131836d00994c3c2a79b3d3a267 (patch) | |
| tree | 080d97b8fbb005caf2572316b3e2f426dd2ec198 /docs/admin_api | |
| parent | Improve SAML error messages (#8248) (diff) | |
| download | synapse-b82d68c0bd952131836d00994c3c2a79b3d3a267.tar.xz | |
Add the topic and avatar to the room details admin API (#8305)
Diffstat (limited to 'docs/admin_api')
| -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 0f267d2b7b..fa9b914fa7 100644 --- a/docs/admin_api/rooms.md +++ b/docs/admin_api/rooms.md @@ -275,6 +275,8 @@ The following fields are possible in the JSON response body: * `room_id` - The ID of the room. * `name` - The name of the room. +* `topic` - The topic of the room. +* `avatar` - The `mxc` URI to the avatar of the room. * `canonical_alias` - The canonical (main) alias address of the room. * `joined_members` - How many users are currently in the room. * `joined_local_members` - How many local users are currently in the room. @@ -304,6 +306,8 @@ Response: { "room_id": "!mscvqgqpHYjBGDxNym:matrix.org", "name": "Music Theory", + "avatar": "mxc://matrix.org/AQDaVFlbkQoErdOgqWRgiGSV", + "topic": "Theory, Composition, Notation, Analysis", "canonical_alias": "#musictheory:matrix.org", "joined_members": 127 "joined_local_members": 2, |