backend: Add maxItems field to success-get-rooms response for pagination control
This commit is contained in:
parent
4671b579a2
commit
53a1ecf964
@ -17,6 +17,11 @@ content:
|
|||||||
nextPageToken:
|
nextPageToken:
|
||||||
type: [string, 'null']
|
type: [string, 'null']
|
||||||
description: The token to retrieve the next page of rooms.
|
description: The token to retrieve the next page of rooms.
|
||||||
|
maxItems:
|
||||||
|
type: integer
|
||||||
|
description: >
|
||||||
|
Maximum number of rooms returned in a single response page.
|
||||||
|
Corresponds to the `maxItems` query parameter in the request.
|
||||||
|
|
||||||
examples:
|
examples:
|
||||||
complete_room_details:
|
complete_room_details:
|
||||||
@ -51,6 +56,7 @@ content:
|
|||||||
publisherURL: 'http://localhost:6080/room/room-456/?secret=tok_789012'
|
publisherURL: 'http://localhost:6080/room/room-456/?secret=tok_789012'
|
||||||
pagination:
|
pagination:
|
||||||
isTruncated: false
|
isTruncated: false
|
||||||
|
maxItems: 10
|
||||||
roomId_fields_only:
|
roomId_fields_only:
|
||||||
summary: Response with only roomId for each room
|
summary: Response with only roomId for each room
|
||||||
value:
|
value:
|
||||||
@ -59,6 +65,7 @@ content:
|
|||||||
- roomId: 'room-456'
|
- roomId: 'room-456'
|
||||||
pagination:
|
pagination:
|
||||||
isTruncated: false
|
isTruncated: false
|
||||||
|
maxItems: 10
|
||||||
|
|
||||||
no_urls:
|
no_urls:
|
||||||
summary: Room details including preferences but no URLs
|
summary: Room details including preferences but no URLs
|
||||||
@ -89,6 +96,7 @@ content:
|
|||||||
pagination:
|
pagination:
|
||||||
isTruncated: true
|
isTruncated: true
|
||||||
nextPageToken: 'abc123'
|
nextPageToken: 'abc123'
|
||||||
|
maxItems: 10
|
||||||
|
|
||||||
urls_only:
|
urls_only:
|
||||||
summary: Response containing only moderator and publisher URLs
|
summary: Response containing only moderator and publisher URLs
|
||||||
@ -100,3 +108,4 @@ content:
|
|||||||
publisherURL: 'http://localhost:6080/room/room-456/?secret=tok_789012'
|
publisherURL: 'http://localhost:6080/room/room-456/?secret=tok_789012'
|
||||||
pagination:
|
pagination:
|
||||||
isTruncated: false
|
isTruncated: false
|
||||||
|
maxItems: 10
|
||||||
|
|||||||
Loading…
x
Reference in New Issue
Block a user