Filip/matrix-spec
1
0
Fork 0
mirror of https://github.com/matrix-org/matrix-spec synced 2026-03-13 06:54:10 +01:00
Code Issues Actions 1 Packages Projects Releases Wiki Activity

C2S: Clarify wording around public room directory

Browse source 
Signed-off-by: HarHarLinks <2803622+HarHarLinks@users.noreply.github.com>
This commit is contained in:
HarHarLinks 2025-04-15 13:31:24 +02:00
parent 23ff7f1343
commit 17ec877386
2 changed files with 8 additions and 7 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

1
changelogs/client_server/newsfragments/2133.clarification Normal file
View file

@ -0,0 +1 @@
Clarify wording around public room directory. Contributed by @HarHarLinks.

14
data/api/client-server/list_public_rooms.yaml
View file

@ -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
$ref: definitions/security.yaml#/accessTokenBearer