Skip to content
Closed
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
Clarify wording around public room directory. Contributed by @HarHarLinks.
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
Clarify wording around public room directory. Contributed by @HarHarLinks.
14 changes: 7 additions & 7 deletions data/api/client-server/list_public_rooms.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand All @@ -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
Expand All @@ -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.
Expand All @@ -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
Expand Down Expand Up @@ -277,4 +277,4 @@ components:
accessTokenQuery:
$ref: definitions/security.yaml#/accessTokenQuery
accessTokenBearer:
$ref: definitions/security.yaml#/accessTokenBearer
$ref: definitions/security.yaml#/accessTokenBearer
24 changes: 12 additions & 12 deletions data/api/server-server/public_rooms.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -18,11 +18,11 @@ info:
paths:
/publicRooms:
get:
summary: Get all the public rooms for a homeserver
summary: Get all the published rooms for a homeserver
description: |-
Gets all the public rooms for the homeserver. This should not return
rooms that are listed on another homeserver's directory, just those
listed on the receiving homeserver's directory.
Gets all the rooms published to the room directory of the homeserver.
This should not return rooms that are listed on another homeserver's directory,
just those listed on the receiving homeserver's directory.
operationId: getPublicRooms
security:
- signedRequest: []
Expand Down Expand Up @@ -62,15 +62,15 @@ paths:
type: string
responses:
"200":
description: The public room list for the homeserver.
description: The published rooms list for the homeserver.
content:
application/json:
schema:
$ref: ../client-server/definitions/public_rooms_response.yaml
post:
summary: Gets the public rooms on the server with optional filter.
summary: Gets the published rooms on the server with optional filter.
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
of joined members, with the largest rooms first.
Expand Down Expand Up @@ -147,19 +147,19 @@ paths:
required: true
responses:
"200":
description: A list of the rooms on the server.
description: A list of the published rooms on the server.
content:
application/json:
schema:
type: object
description: A list of the rooms on the server.
description: A list of the published rooms on the server.
required:
- chunk
properties:
chunk:
title: PublicRoomsChunks
type: array
description: A paginated chunk of public rooms.
description: A paginated chunk of published rooms.
items:
allOf:
- $ref: ../client-server/definitions/public_rooms_chunk.yaml
Expand Down Expand Up @@ -188,8 +188,8 @@ paths:
total_room_count_estimate:
type: integer
description: |-
An estimate on the total number of public rooms, if the
server has an estimate.
An estimate on the total number of rooms published in the room directory,
if the server has an estimate.
examples:
response:
value: {
Expand Down