wholetrans/docs-matrix-spec
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity

Final public_rooms clarifications

Browse source 
* order by *joined* members
 * clarify pagination direction behaviour
This commit is contained in:
Richard van der Hoff 2016-11-21 13:08:41 +00:00
parent dca1d0c745
commit c175039a08
1 changed files with 6 additions and 6 deletions
Download patch file Download diff file Expand all files Collapse all files

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

@ -32,7 +32,7 @@ paths:
Lists the public rooms on the server. Lists the public rooms on the server.
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 members, with the largest rooms first. of joined members, with the largest rooms first.
parameters: parameters:
- in: query - in: query
name: limit name: limit
@ -158,7 +158,7 @@ paths:
Lists the public rooms on the server, with optional filter. Lists the public rooms on the server, 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 members, with the largest rooms first. of joined members, with the largest rooms first.
security: security:
- accessToken: [] - accessToken: []
parameters: parameters:
@ -183,8 +183,10 @@ paths:
since: since:
type: string type: string
description: |- description: |-
A pagination token from a previous request, allowing clients to A pagination token from a previous request, allowing clients
get the next or previous batch of rooms. to get the next (or previous) batch of rooms. The direction
of pagination is specified solely by which token is supplied,
rather than via an explicit flag.
filter: filter:
type: object type: object
title: "Filter" title: "Filter"
@ -271,8 +273,6 @@ paths:
A pagination token that allows fetching previous results. The A pagination token that allows fetching previous results. The
absence of this token means there are no results before this absence of this token means there are no results before this
batch, i.e. this is the first batch. batch, i.e. this is the first batch.
The direction of pagination is specified solely by which token
is supplied, rather than via an explicit flag.
total_room_count_estimate: total_room_count_estimate:
type: number type: number
description: |- description: |-