tileradotorg/synapse
1
0
Fork 0
forked from MirrorHub/synapse
Code Pull requests Activity

Add the topic and avatar to the room details admin API (#8305)

Browse source
This commit is contained in:
Tulir Asokan 2020-09-14 17:07:04 +03:00 committed by GitHub
parent 6605470bfb
commit b82d68c0bd
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
4 changed files with 9 additions and 1 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

1
changelog.d/8305.feature Normal file
View file

@ -0,0 +1 @@
Add the room topic and avatar to the room details admin API.

4
docs/admin_api/rooms.md
View file

@ -275,6 +275,8 @@ The following fields are possible in the JSON response body:
* `room_id` - The ID of the room. * `room_id` - The ID of the room.
* `name` - The name 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. * `canonical_alias` - The canonical (main) alias address of the room.
* `joined_members` - How many users are currently in the room. * `joined_members` - How many users are currently in the room.
* `joined_local_members` - How many local 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", "room_id": "!mscvqgqpHYjBGDxNym:matrix.org",
"name": "Music Theory", "name": "Music Theory",
"avatar": "mxc://matrix.org/AQDaVFlbkQoErdOgqWRgiGSV",
"topic": "Theory, Composition, Notation, Analysis",
"canonical_alias": "#musictheory:matrix.org", "canonical_alias": "#musictheory:matrix.org",
"joined_members": 127 "joined_members": 127
"joined_local_members": 2, "joined_local_members": 2,

3
synapse/storage/databases/main/room.py
View file

@ -104,7 +104,8 @@ class RoomWorkerStore(SQLBaseStore):
curr.local_users_in_room AS joined_local_members, rooms.room_version AS version, curr.local_users_in_room AS joined_local_members, rooms.room_version AS version,
rooms.creator, state.encryption, state.is_federatable AS federatable, rooms.creator, state.encryption, state.is_federatable AS federatable,
rooms.is_public AS public, state.join_rules, state.guest_access, rooms.is_public AS public, state.join_rules, state.guest_access,
state.history_visibility, curr.current_state_events AS state_events state.history_visibility, curr.current_state_events AS state_events,
state.avatar, state.topic
FROM rooms FROM rooms
LEFT JOIN room_stats_state state USING (room_id) LEFT JOIN room_stats_state state USING (room_id)
LEFT JOIN room_stats_current curr USING (room_id) LEFT JOIN room_stats_current curr USING (room_id)

2
tests/rest/admin/test_room.py
View file

@ -1174,6 +1174,8 @@ class RoomTestCase(unittest.HomeserverTestCase):
self.assertIn("room_id", channel.json_body) self.assertIn("room_id", channel.json_body)
self.assertIn("name", channel.json_body) self.assertIn("name", channel.json_body)
self.assertIn("topic", channel.json_body)
self.assertIn("avatar", channel.json_body)
self.assertIn("canonical_alias", channel.json_body) self.assertIn("canonical_alias", channel.json_body)
self.assertIn("joined_members", channel.json_body) self.assertIn("joined_members", channel.json_body)
self.assertIn("joined_local_members", channel.json_body) self.assertIn("joined_local_members", channel.json_body)