api-docs/models/Meta.json

36 lines
840 B
JSON
Raw Permalink Normal View History

2022-10-22 18:05:01 +02:00
{
2023-06-09 22:50:36 +02:00
"description": "Meta details for pagination.",
2022-10-22 18:05:01 +02:00
"type": "object",
2023-06-09 22:50:36 +02:00
"x-examples": {
"example-1": {
"total": 6,
"page": 1,
"limit": 20
}
},
2022-10-22 18:05:01 +02:00
"properties": {
"total": {
2023-06-09 22:50:36 +02:00
"type": "integer",
"description": "Shows the total amount of items of this kind that exist.",
"minimum": 0
2022-10-22 18:05:01 +02:00
},
"page": {
"type": "integer",
2023-06-09 22:50:36 +02:00
"default": 1,
"description": "A page denotes an amount of items, offset from the first item. Each page holds an amount of items equal to the `limit`.",
"minimum": 1
2022-10-22 18:05:01 +02:00
},
"limit": {
"type": "integer",
2023-06-09 22:50:36 +02:00
"default": 10,
"description": "The amount of items in each page. Limits how many items can be fetched at once.",
"minimum": 1,
"maximum": 20
2022-10-22 18:05:01 +02:00
}
},
"required": [
"total",
"page",
"limit"
2023-06-09 22:50:36 +02:00
]
2022-10-22 18:05:01 +02:00
}