Expand on description of pagination tokens

This commit is contained in:
Erik Johnston 2016-09-29 16:58:00 +01:00
parent c05ee18f58
commit 0dc94d5c14

View file

@ -109,11 +109,15 @@ paths:
next_batch: next_batch:
type: string type: string
description: |- description: |-
A pagination token for the response, if there are any more results. A pagination token for the response. The absence of this token
means there are no more results to fetch and the client should
stop paginating.
prev_batch: prev_batch:
type: string type: string
description: |- description: |-
A pagination token for the response, if there are any more results. A pagination token that allows fetching previous results. The
absence of this token means there are no results before this
batch, i.e. this is the first batch.
total_room_count_estimate: total_room_count_estimate:
type: number type: number
description: |- description: |-
@ -244,11 +248,15 @@ paths:
next_batch: next_batch:
type: string type: string
description: |- description: |-
A pagination token for the response, if there are any more results. A pagination token for the response. The absence of this token
means there are no more results to fetch and the client should
stop paginating.
prev_batch: prev_batch:
type: string type: string
description: |- description: |-
A pagination token for the response, if there are any more results. A pagination token that allows fetching previous results. The
absence of this token means there are no results before this
batch, i.e. this is the first batch.
total_room_count_estimate: total_room_count_estimate:
type: number type: number
description: |- description: |-