data-api-builder
data-api-builder copied to clipboard
Added missing pagination properties
Closes #2333
Overview
{
"runtime": {
"host": {
"max-response-size-mb": 158
},
"pagination": {
"max-page-size": 100000,
"default-page-size": 100,
}
}
}
max-response-size-mb
Specifies the maximum size, in megabytes, of the database response allowed in a single result. This limit helps prevent large results (in size) from overwhelming the API.
{
"runtime": {
"host": {
"max-response-size-mb": 158
}
}
}
| Min | Max | Special | Optional | Default |
|---|---|---|---|---|
| 1 MB | 158 MB | N/A | Yes | 158 MB |
max-page-size
Defines the maximum number of records that can be returned in a single page of results. This limit helps prevent large results (in rows) from overwhelming the API.
{
"runtime": {
"pagination": {
"max-page-size": 100000
}
}
}
| Min | Max | Special | Optional | Default |
|---|---|---|---|---|
| 1 | 100,000 | -1 (unlimited) |
Yes | 100,000 |
default-page-size
Sets the default number of records returned in a single response when the result set exceeds this limit. When this limit is reached, a continuation token is provided to help users retrieve the next page.
{
"runtime": {
"pagination": {
"default-page-size": 100
}
}
}
| Min | Max | Special | Optional | Default |
|---|---|---|---|---|
| 1 | 100,000 | -1 (same as max-page-size) |
Yes | 100 |