From 03c96e505b08fae6d106f0fb3f6690e005deb969 Mon Sep 17 00:00:00 2001 From: Johannes Marbach Date: Thu, 20 Mar 2025 10:47:51 +0100 Subject: [PATCH] Mention knockable rooms in warning --- content/client-server-api/_index.md | 13 ++++++++++--- 1 file changed, 10 insertions(+), 3 deletions(-) diff --git a/content/client-server-api/_index.md b/content/client-server-api/_index.md index b8e7878f..da5ddecb 100644 --- a/content/client-server-api/_index.md +++ b/content/client-server-api/_index.md @@ -2848,9 +2848,16 @@ creation, clients can query and change a room's visibility in the directory thro the endpoints listed below, provided that the server permits this. {{% boxes/warning %}} -A visibility setting of `public` should not be confused with a `public` [join rule](#mroomjoin_rules) -or a `world_readable` [history visibility](#room-history-visibility). The visibility merely defines -whether a room is included in the published room directory or not. +The visibility setting merely defines whether a room is included in the published +room directory or not. It doesn't make any guarantees about the room's +[join rule](#mroomjoin_rules) or [history visibility](#room-history-visibility). + +In particular, a visibility setting of `public` should not be confused with a `public` +join rule. Rooms with a join rule of `knock`, for instance, could reasonably be published +in the directory, too. + +Similarly, a visibility setting of `public` does not necessarily imply a `world_readable` +history visibility. {{% /boxes/warning %}} {{% http-api spec="client-server" api="list_public_rooms" %}}