Filip/matrix-spec
1
0
Fork 0
mirror of https://github.com/matrix-org/matrix-spec synced 2025-12-27 19:38:37 +01:00
Code Issues Actions 1 Packages Projects Releases Wiki Activity

Spec new query params for /publicRooms

Browse source
This commit is contained in:
Erik Johnston 2016-09-29 10:47:37 +01:00
parent d81d0dbd1d
commit 877a6cfeb4
1 changed files with 30 additions and 6 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

36
api/client-server/list_public_rooms.yaml
View file

@ -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: >