diff --git a/changelogs/client_server/newsfragments/2204.clarification b/changelogs/client_server/newsfragments/2204.clarification new file mode 100644 index 00000000..9f2bc503 --- /dev/null +++ b/changelogs/client_server/newsfragments/2204.clarification @@ -0,0 +1 @@ +Clarify wording around the `world_readable` history visibility setting. Contributed by @HarHarLinks. diff --git a/content/client-server-api/modules/history_visibility.md b/content/client-server-api/modules/history_visibility.md index 04487bdb..a6acb874 100644 --- a/content/client-server-api/modules/history_visibility.md +++ b/content/client-server-api/modules/history_visibility.md @@ -16,8 +16,8 @@ The four options for the `m.room.history_visibility` event are: - `world_readable` - All events while this is the `m.room.history_visibility` value may be shared by any participating - homeserver with anyone, regardless of whether they have ever joined - the room. + homeserver with any authenticated user, regardless of whether they have + ever joined the room. This includes [guest users](#guest-access). - `shared` - Previous events are always accessible to newly joined members. All events in the room are accessible, even those sent when the member was not a part of the room. @@ -44,7 +44,7 @@ setting at that time was more restrictive. #### Client behaviour Clients may want to display a notice that events may be read by -non-joined people if the history visibility is set to `world_readable`. +non-joined users if the history visibility is set to `world_readable`. #### Server behaviour diff --git a/content/client-server-api/modules/room_previews.md b/content/client-server-api/modules/room_previews.md index fcb471ff..19cea459 100644 --- a/content/client-server-api/modules/room_previews.md +++ b/content/client-server-api/modules/room_previews.md @@ -6,7 +6,7 @@ It is sometimes desirable to offer a preview of a room, where a user can This can be particularly effective when combined with [Guest Access](#guest-access). Previews are implemented via the `world_readable` [Room History -Visibility](#room-history-visibility). setting, along with a special version of the [GET +Visibility](#room-history-visibility) setting, along with a special version of the [GET /events](#get_matrixclientv3events) endpoint. #### Client behaviour diff --git a/data/api/client-server/definitions/public_rooms_chunk.yaml b/data/api/client-server/definitions/public_rooms_chunk.yaml index 33276662..8521ed08 100644 --- a/data/api/client-server/definitions/public_rooms_chunk.yaml +++ b/data/api/client-server/definitions/public_rooms_chunk.yaml @@ -43,7 +43,7 @@ properties: example: "All things general" world_readable: type: boolean - description: Whether the room may be viewed by guest users without joining. + description: Whether the room may be viewed by users without joining. example: false guest_can_join: type: boolean