openstack/ironic
Code Issues Proposed changes

Merge "Document API max_limit configuration option"

Browse Source
This commit is contained in:
Jenkins 2016-08-05 23:22:03 +00:00 committed by Gerrit Code Review
commit 8220e40bba
4 changed files with 25 additions and 5 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

12
api-ref/source/parameters.yaml
View File

@ -86,11 +86,13 @@ fields:
type: array type: array
limit: limit:
description: | description: |
Requests a page size of items. Returns a number Requests a page size of items. Returns a number of items up to a limit
of items up to a limit value. Use the ``limit`` parameter to make value. Use the ``limit`` parameter to make an initial limited request and
an initial limited request and use the ID of the last-seen item use the ID of the last-seen item from the response as the ``marker``
from the response as the ``marker`` parameter value in a parameter value in a subsequent limited request. This value cannot be
subsequent limited request. 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 in: query
required: false required: false
type: integer type: integer

6
ironic/api/controllers/v1/chassis.py
View File

@ -203,6 +203,9 @@ class ChassisController(rest.RestController):
:param marker: pagination marker for large data sets. :param marker: pagination marker for large data sets.
:param limit: maximum number of resources to return in a single result. :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_key: column to sort results by. Default: id.
:param sort_dir: direction to sort. "asc" or "desc". Default: asc. :param sort_dir: direction to sort. "asc" or "desc". Default: asc.
:param fields: Optional, a list with a specified set of fields :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 marker: pagination marker for large data sets.
:param limit: maximum number of resources to return in a single result. :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_key: column to sort results by. Default: id.
:param sort_dir: direction to sort. "asc" or "desc". Default: asc. :param sort_dir: direction to sort. "asc" or "desc". Default: asc.
""" """

6
ironic/api/controllers/v1/node.py
View File

@ -1203,6 +1203,9 @@ class NodesController(rest.RestController):
that provision state. that provision state.
:param marker: pagination marker for large data sets. :param marker: pagination marker for large data sets.
:param limit: maximum number of resources to return in a single result. :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_key: column to sort results by. Default: id.
:param sort_dir: direction to sort. "asc" or "desc". Default: asc. :param sort_dir: direction to sort. "asc" or "desc". Default: asc.
:param driver: Optional string value to get only nodes using that :param driver: Optional string value to get only nodes using that
@ -1254,6 +1257,9 @@ class NodesController(rest.RestController):
that provision state. that provision state.
:param marker: pagination marker for large data sets. :param marker: pagination marker for large data sets.
:param limit: maximum number of resources to return in a single result. :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_key: column to sort results by. Default: id.
:param sort_dir: direction to sort. "asc" or "desc". Default: asc. :param sort_dir: direction to sort. "asc" or "desc". Default: asc.
:param driver: Optional string value to get only nodes using that :param driver: Optional string value to get only nodes using that

6
ironic/api/controllers/v1/port.py
View File

@ -303,6 +303,9 @@ class PortsController(rest.RestController):
this MAC address. this MAC address.
:param marker: pagination marker for large data sets. :param marker: pagination marker for large data sets.
:param limit: maximum number of resources to return in a single result. :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_key: column to sort results by. Default: id.
:param sort_dir: direction to sort. "asc" or "desc". Default: asc. :param sort_dir: direction to sort. "asc" or "desc". Default: asc.
:param fields: Optional, a list with a specified set of fields :param fields: Optional, a list with a specified set of fields
@ -351,6 +354,9 @@ class PortsController(rest.RestController):
this MAC address. this MAC address.
:param marker: pagination marker for large data sets. :param marker: pagination marker for large data sets.
:param limit: maximum number of resources to return in a single result. :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_key: column to sort results by. Default: id.
:param sort_dir: direction to sort. "asc" or "desc". Default: asc. :param sort_dir: direction to sort. "asc" or "desc". Default: asc.
:raises: NotAcceptable, HTTPNotFound :raises: NotAcceptable, HTTPNotFound