Skip to content

Commit 5bac209

Browse files
committed
Clarify the meaning of "public rooms" for user directory queries
Relates to: #633 Signed-off-by: Johannes Marbach <[email protected]>
1 parent e283c35 commit 5bac209

File tree

2 files changed

+12
-4
lines changed

2 files changed

+12
-4
lines changed
Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
"Public" rooms in user directory queries are defined through their join rule and history visibility.

data/api/client-server/users.yaml

Lines changed: 11 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -20,10 +20,17 @@ paths:
2020
post:
2121
summary: Searches the user directory.
2222
description: |-
23-
Performs a search for users. The homeserver may
24-
determine which subset of users are searched, however the homeserver
25-
MUST at a minimum consider the users the requesting user shares a
26-
room with and those who reside in public rooms (known to the homeserver).
23+
Performs a search for users. The homeserver may determine which
24+
subset of users are searched. However, the homeserver MUST at a
25+
minimum consider users who are visible to the requester based
26+
on their membership in rooms known to the homeserver. This means:
27+
28+
- users that share a room with the requesting user
29+
- users who are joined to rooms known to the homeserver that have a
30+
`public` [join rule](#mroomjoin_rules)
31+
- users who are joined to rooms known to the homeserver that have a
32+
`world_readable` [history visibility](#room-history-visibility)
33+
2734
The search MUST consider local users to the homeserver, and SHOULD
2835
query remote users as part of the search.
2936

0 commit comments

Comments
 (0)