foster/forgejo-docs
0
0
Fork 0
mirror of https://codeberg.org/forgejo/docs.git synced 2025-01-22 02:15:25 -05:00
Code Issues Activity

user: api: explain how to obtain pagination defaults

Browse source
This commit is contained in:
Earl Warren 2023-09-10 10:50:00 +02:00 • committed by Loïc Dachary
parent 62d6fc9754
commit ab5076eea3
1 changed files with 12 additions and 0 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

12
docs/user/api-usage.md
View file

@ -93,6 +93,18 @@ curl -v "http://localhost/api/v1/repos/search?limit=1"
< x-total-count: 5252 < x-total-count: 5252
``` ```
The default and maximum values for the `page` parameter can be obtained from the `https://forgejo.your.host/api/v1/settings/api` endpoint.
```sh
$ curl https://codeberg.org/api/v1/settings/api
{
"max_response_items": 50,
"default_paging_num": 30,
"default_git_trees_per_page": 1000,
"default_max_blob_size": 10485760
}
```
## API Guide: ## API Guide:
API Reference guide is auto-generated by swagger and available on: API Reference guide is auto-generated by swagger and available on: