diff --git a/api-ref/source/parameters.yaml b/api-ref/source/parameters.yaml index 128d983383..decc4d8b7c 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 diff --git a/ironic/api/controllers/v1/chassis.py b/ironic/api/controllers/v1/chassis.py index f5ebab2d3c..a8234fc576 100644 --- a/ironic/api/controllers/v1/chassis.py +++ b/ironic/api/controllers/v1/chassis.py @@ -203,6 +203,9 @@ class ChassisController(rest.RestController): :param marker: pagination marker for large data sets. :param limit: maximum number of resources to return in a single result. + This value cannot be larger than the value of max_limit + in the [api] section of the ironic configuration, or only + max_limit resources will be returned. :param sort_key: column to sort results by. Default: id. :param sort_dir: direction to sort. "asc" or "desc". Default: asc. :param fields: Optional, a list with a specified set of fields @@ -225,6 +228,9 @@ class ChassisController(rest.RestController): :param marker: pagination marker for large data sets. :param limit: maximum number of resources to return in a single result. + This value cannot be larger than the value of max_limit + in the [api] section of the ironic configuration, or only + max_limit resources will be returned. :param sort_key: column to sort results by. Default: id. :param sort_dir: direction to sort. "asc" or "desc". Default: asc. """ diff --git a/ironic/api/controllers/v1/node.py b/ironic/api/controllers/v1/node.py index 6792340090..96a39b2548 100644 --- a/ironic/api/controllers/v1/node.py +++ b/ironic/api/controllers/v1/node.py @@ -1203,6 +1203,9 @@ class NodesController(rest.RestController): that provision state. :param marker: pagination marker for large data sets. :param limit: maximum number of resources to return in a single result. + This value cannot be larger than the value of max_limit + in the [api] section of the ironic configuration, or only + max_limit resources will be returned. :param sort_key: column to sort results by. Default: id. :param sort_dir: direction to sort. "asc" or "desc". Default: asc. :param driver: Optional string value to get only nodes using that @@ -1254,6 +1257,9 @@ class NodesController(rest.RestController): that provision state. :param marker: pagination marker for large data sets. :param limit: maximum number of resources to return in a single result. + This value cannot be larger than the value of max_limit + in the [api] section of the ironic configuration, or only + max_limit resources will be returned. :param sort_key: column to sort results by. Default: id. :param sort_dir: direction to sort. "asc" or "desc". Default: asc. :param driver: Optional string value to get only nodes using that diff --git a/ironic/api/controllers/v1/port.py b/ironic/api/controllers/v1/port.py index e2899815d0..c3e553c431 100644 --- a/ironic/api/controllers/v1/port.py +++ b/ironic/api/controllers/v1/port.py @@ -303,6 +303,9 @@ class PortsController(rest.RestController): this MAC address. :param marker: pagination marker for large data sets. :param limit: maximum number of resources to return in a single result. + This value cannot be larger than the value of max_limit + in the [api] section of the ironic configuration, or only + max_limit resources will be returned. :param sort_key: column to sort results by. Default: id. :param sort_dir: direction to sort. "asc" or "desc". Default: asc. :param fields: Optional, a list with a specified set of fields @@ -351,6 +354,9 @@ class PortsController(rest.RestController): this MAC address. :param marker: pagination marker for large data sets. :param limit: maximum number of resources to return in a single result. + This value cannot be larger than the value of max_limit + in the [api] section of the ironic configuration, or only + max_limit resources will be returned. :param sort_key: column to sort results by. Default: id. :param sort_dir: direction to sort. "asc" or "desc". Default: asc. :raises: NotAcceptable, HTTPNotFound