Include limit-capped flag with search response

The server defines a `limit` value and search requests are capped to
this limit if their requested value exceeds it. If this happens it is
now returned with the search response (clients can print a warning).

Closes: #1358
This commit is contained in:
eikek
2022-05-26 22:24:56 +02:00
parent f8baf44c09
commit 50edf13f94
5 changed files with 106 additions and 35 deletions

View File

@ -8591,11 +8591,33 @@ components:
A list of item details.
required:
- groups
- limit
- offset
- limitCapped
properties:
groups:
type: array
items:
$ref: "#/components/schemas/ItemLightGroup"
limit:
type: integer
format: int32
description: |
Returns the `limit` value as used for this search. This
can deviate from the requested limit, if it exceeds the
server defined maximum. See `limitCapped`.
offset:
type: integer
format: int32
description: |
The `offset` value used for this search.
limitCapped:
type: boolean
description: |
The server defines a maximum `limit` value. If the
requested `limit` exceeds the server defined one, this
flag is set to true. The limit used for the query is
returned with this response.
ItemLightGroup:
description: |
A group of items.