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

S2S: 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:37 +02:00
parent 17ec877386
commit fa3e1f3b69
2 changed files with 13 additions and 12 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

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

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

24
data/api/server-server/public_rooms.yaml
View file

@ -18,11 +18,11 @@ info:
paths: paths:
/publicRooms: /publicRooms:
get: get:
summary: Get all the public rooms for a homeserver summary: Get all the published rooms for a homeserver
description: |- description: |-
Gets all the public rooms for the homeserver. This should not return Gets all the rooms published to the room directory of the homeserver.
rooms that are listed on another homeserver's directory, just those This should not return rooms that are listed on another homeserver's directory,
listed on the receiving homeserver's directory. just those listed on the receiving homeserver's directory.
operationId: getPublicRooms operationId: getPublicRooms
security: security:
- signedRequest: [] - signedRequest: []
@ -62,15 +62,15 @@ paths:
type: string type: string
responses: responses:
"200": "200":
description: The public room list for the homeserver. description: The published rooms list for the homeserver.
content: content:
application/json: application/json:
schema: schema:
$ref: ../client-server/definitions/public_rooms_response.yaml $ref: ../client-server/definitions/public_rooms_response.yaml
post: post:
summary: Gets the public rooms on the server with optional filter. summary: Gets the published rooms on the server with optional filter.
description: |- description: |-
Lists the public rooms on the server, with optional filter. Gets all the rooms published to the room directory of the homeserver, with optional filter.
This API returns paginated responses. The rooms are ordered by the number This API returns paginated responses. The rooms are ordered by the number
of joined members, with the largest rooms first. of joined members, with the largest rooms first.
@ -147,19 +147,19 @@ paths:
required: true required: true
responses: responses:
"200": "200":
description: A list of the rooms on the server. description: A list of the published rooms on the server.
content: content:
application/json: application/json:
schema: schema:
type: object type: object
description: A list of the rooms on the server. description: A list of the published rooms on the server.
required: required:
- chunk - chunk
properties: properties:
chunk: chunk:
title: PublicRoomsChunks title: PublicRoomsChunks
type: array type: array
description: A paginated chunk of public rooms. description: A paginated chunk of published rooms.
items: items:
allOf: allOf:
- $ref: ../client-server/definitions/public_rooms_chunk.yaml - $ref: ../client-server/definitions/public_rooms_chunk.yaml
@ -188,8 +188,8 @@ paths:
total_room_count_estimate: total_room_count_estimate:
type: integer type: integer
description: |- description: |-
An estimate on the total number of public rooms, if the An estimate on the total number of rooms published in the room directory,
server has an estimate. if the server has an estimate.
examples: examples:
response: response:
value: { value: {