From d66792d5cae131bdc7310d7469210dde05279617 Mon Sep 17 00:00:00 2001 From: Erik Johnston Date: Fri, 14 Oct 2016 10:31:06 +0100 Subject: [PATCH] Mention order of returned results --- api/client-server/list_public_rooms.yaml | 14 +++++++------- 1 file changed, 7 insertions(+), 7 deletions(-) diff --git a/api/client-server/list_public_rooms.yaml b/api/client-server/list_public_rooms.yaml index fbdf3fde..d2d6eb17 100644 --- a/api/client-server/list_public_rooms.yaml +++ b/api/client-server/list_public_rooms.yaml @@ -31,14 +31,14 @@ paths: description: |- Lists the public rooms on the server. - This API returns paginated responses. + This API returns paginated responses. The rooms are ordered by the number + of members, with the largest rooms first. 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. + Limit the number of results returned. - in: query name: since type: string @@ -157,7 +157,8 @@ paths: description: |- Lists the public rooms on the server, with optional filter. - This API returns paginated responses. + This API returns paginated responses. The rooms are ordered by the number + of members, with the largest rooms first. security: - accessToken: [] parameters: @@ -178,13 +179,12 @@ paths: limit: type: number description: |- - Limit the number of results returned, ordered by number of - memebers in the room. Defaults to no limit. + Limit the number of results returned. since: type: string description: |- A pagination token from a previous request, allowing clients to - get the next batch of rooms. + get the next or previous batch of rooms. filter: type: object title: "Filter"