From 17ec8773862370e86f596dde8701eb186c9ef567 Mon Sep 17 00:00:00 2001 From: HarHarLinks <2803622+HarHarLinks@users.noreply.github.com> Date: Tue, 15 Apr 2025 13:31:24 +0200 Subject: [PATCH] C2S: Clarify wording around public room directory Signed-off-by: HarHarLinks <2803622+HarHarLinks@users.noreply.github.com> --- .../client_server/newsfragments/2133.clarification | 1 + data/api/client-server/list_public_rooms.yaml | 14 +++++++------- 2 files changed, 8 insertions(+), 7 deletions(-) create mode 100644 changelogs/client_server/newsfragments/2133.clarification diff --git a/changelogs/client_server/newsfragments/2133.clarification b/changelogs/client_server/newsfragments/2133.clarification new file mode 100644 index 00000000..511f15e5 --- /dev/null +++ b/changelogs/client_server/newsfragments/2133.clarification @@ -0,0 +1 @@ +Clarify wording around public room directory. Contributed by @HarHarLinks. diff --git a/data/api/client-server/list_public_rooms.yaml b/data/api/client-server/list_public_rooms.yaml index ffd202a4..dcbf73b1 100644 --- a/data/api/client-server/list_public_rooms.yaml +++ b/data/api/client-server/list_public_rooms.yaml @@ -129,9 +129,9 @@ paths: - Room discovery /publicRooms: get: - summary: Lists the public rooms on the server. + summary: Lists the published rooms on the server. description: |- - Lists the public rooms on the server. + Lists the rooms published to the room directory on the server. This API returns paginated responses. The rooms are ordered by the number of joined members, with the largest rooms first. @@ -154,7 +154,7 @@ paths: - in: query name: server description: |- - The server to fetch the public room lists from. Defaults to the + The server to fetch the published rooms list from. Defaults to the local server. Case sensitive. schema: type: string @@ -168,9 +168,9 @@ paths: tags: - Room discovery post: - summary: Lists the public rooms on the server with optional filter. + summary: Lists the published rooms on the server with optional filter. description: |- - Lists the public rooms on the server, with optional filter. + Lists the rooms published to the room directory on the server, with optional filter. This API returns paginated responses. The rooms are ordered by the number of joined members, with the largest rooms first. @@ -182,7 +182,7 @@ paths: - in: query name: server description: |- - The server to fetch the public room lists from. Defaults to the + The server to fetch the published rooms list from. Defaults to the local server. Case sensitive. schema: type: string @@ -277,4 +277,4 @@ components: accessTokenQuery: $ref: definitions/security.yaml#/accessTokenQuery accessTokenBearer: - $ref: definitions/security.yaml#/accessTokenBearer \ No newline at end of file + $ref: definitions/security.yaml#/accessTokenBearer