grassrootseconomics
/
cic-dw
mirror of https://github.com/GrassrootsEconomics/cic-dw.git
5
0
Fork 0
Code Issues Projects Releases Wiki Activity

docs: update pagination spec

This commit is contained in:
Mohamed Sohail 2022-06-16 12:30:40 +03:00
parent b59c0ba3fc
commit b6e8898705
Signed by: kamikazechaser
GPG Key ID: 7DD45520C01CD85D
1 changed files with 1 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
docs/api.md
View File

@ -15,5 +15,5 @@ Some API endpoints use a modified cursor pagination. This is to avaoid uncessary
The pagination expects the following query string:
- `?per_page=` (int) - No. of items to return. Has a hard limit of 100
- `?forward=` (boolean) - If true, scrolls forward else backwards
- `?next=` (boolean) - If true, scrolls forward else backwards
- `?cursor=` (id:int) - Used with the forward query. If pagination forwards, pass in the id of the last result i.e. `results[length(results) - 1]`. If paginating backwards pass the id of the first element of the current result set i.e. `results[0]`.