diff options
| author | Mario Villaplana <mario.villaplana@gmail.com> | 2016-07-05 21:09:03 +0000 |
|---|---|---|
| committer | Mario Villaplana <mario.villaplana@gmail.com> | 2016-07-07 15:52:28 +0000 |
| commit | 8458f9bccffd6ae33693986e28afa5c5dc5f977b (patch) | |
| tree | 1c05431d39f44a88f584e989325979911278cbe8 /api-ref | |
| parent | fc70b103aaac39a9d32b3a9566d9571b8d108fe3 (diff) | |
| download | ironic-8458f9bccffd6ae33693986e28afa5c5dc5f977b.tar.gz | |
Document API max_limit configuration option
The max_limit option in the [api] section of ironic.conf is not
obviously pointed out in API documentation. This may mislead a user into
believing that using the "limit" parameter when listing resources from
the API may return more resources than the API configuration actually
allows.
This change adds documentation regarding how the max_limit option
affects API usage.
Change-Id: Ic55b31758b144aa8ef8b048f3dd90a4ffeee6fa4
Closes-Bug: 1597834
Diffstat (limited to 'api-ref')
| -rw-r--r-- | api-ref/source/parameters.yaml | 12 |
1 files changed, 7 insertions, 5 deletions
diff --git a/api-ref/source/parameters.yaml b/api-ref/source/parameters.yaml index 20c9192ac..dde007698 100644 --- a/api-ref/source/parameters.yaml +++ b/api-ref/source/parameters.yaml @@ -86,11 +86,13 @@ fields: type: array limit: description: | - Requests a page size of items. Returns a number - of items up to a limit value. Use the ``limit`` parameter to make - an initial limited request and use the ID of the last-seen item - from the response as the ``marker`` parameter value in a - subsequent limited request. + Requests a page size of items. Returns a number of items up to a limit + value. Use the ``limit`` parameter to make an initial limited request and + use the ID of the last-seen item from the response as the ``marker`` + parameter value in a subsequent limited request. This value cannot be + larger than the ``max_limit`` option in the ``[api]`` section of the + configuration. If it is higher than ``max_limit``, only ``max-limit`` + resources will be returned. in: query required: false type: integer |