mirror of
https://github.com/SpaceTradersAPI/api-docs.git
synced 2024-11-14 22:30:51 +01:00
36 lines
840 B
JSON
36 lines
840 B
JSON
{
|
|
"description": "Meta details for pagination.",
|
|
"type": "object",
|
|
"x-examples": {
|
|
"example-1": {
|
|
"total": 6,
|
|
"page": 1,
|
|
"limit": 20
|
|
}
|
|
},
|
|
"properties": {
|
|
"total": {
|
|
"type": "integer",
|
|
"description": "Shows the total amount of items of this kind that exist.",
|
|
"minimum": 0
|
|
},
|
|
"page": {
|
|
"type": "integer",
|
|
"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
|
|
},
|
|
"limit": {
|
|
"type": "integer",
|
|
"default": 10,
|
|
"description": "The amount of items in each page. Limits how many items can be fetched at once.",
|
|
"minimum": 1,
|
|
"maximum": 20
|
|
}
|
|
},
|
|
"required": [
|
|
"total",
|
|
"page",
|
|
"limit"
|
|
]
|
|
} |