diff --git a/api/client-server/list_public_rooms.yaml b/api/client-server/list_public_rooms.yaml index a34f50b3..c6795426 100644 --- a/api/client-server/list_public_rooms.yaml +++ b/api/client-server/list_public_rooms.yaml @@ -32,6 +32,25 @@ paths: Lists the public rooms on the server. This API returns paginated responses. + parameters: + - in: query + name: limit + type: number + description: |- + Limit the number of results returned, ordered by number of + memebers in the room. Defaults to no limit. + - in: query + name: since + type: string + description: |- + A pagination token from a previous request, allowing clients to + get the next batch of rooms. + - in: query + name: server + type: string + description: |- + The server to fetch the public room lists from. Defaults to the + local server. responses: 200: description: A list of the rooms on the server. @@ -87,14 +106,18 @@ paths: avatar_url: type: string description: The URL for the room's avatar, if one is set. - start: + next_batch: type: string description: |- - A pagination token for the response. - end: + A pagination token for the response, if there are any more results. + prev_batch: type: string description: |- - A pagination token for the response. + A pagination token for the response, if there are any more results. + total_room_count_estimate: + type: number + description: |- + An estimate on the total number of public rooms. examples: application/json: |- { @@ -110,8 +133,9 @@ paths: "world_readable": true } ], - "start": "p190q", - "end": "p1902" + "next_batch": "p190q", + "prev_batch": "p1902", + "total_room_count_estimate": 115 } 400: description: >