api-ref: add missing os-server-groups parameters
The os-server-groups endpoint has supported paging using optional 'limit' & 'offset' query parameters for years now, but they aren't documented in the api-ref. This patch adds those query parameters to the nova api documentation. Change-Id: Ifc234da617c31f1f22674b306fdd6e398041973a
This commit is contained in:
parent
54482fde22
commit
dba04d511c
@ -25,6 +25,8 @@ Request
|
||||
.. rest_parameters:: parameters.yaml
|
||||
|
||||
- all_projects: all_projects
|
||||
- limit: limit_simple
|
||||
- offset: offset_simple
|
||||
|
||||
Response
|
||||
--------
|
||||
|
@ -521,6 +521,15 @@ limit:
|
||||
in: query
|
||||
required: false
|
||||
type: integer
|
||||
limit_simple:
|
||||
description: |
|
||||
Used in conjunction with ``offset`` to return a slice of items. ``limit``
|
||||
is the maximum number of items to return. If ``limit`` is not specified,
|
||||
or exceeds the configurable ``osapi_max_limit``, then ``osapi_max_limit``
|
||||
will be used instead.
|
||||
in: query
|
||||
required: false
|
||||
type: integer
|
||||
marker:
|
||||
description: |
|
||||
The ID of the last-seen item. Use the ``limit`` parameter to make an initial limited
|
||||
@ -595,6 +604,13 @@ not_tags_query:
|
||||
match all tags in this list will be returned. Boolean expression in this
|
||||
case is 'NOT (t1 AND t2)'. Tags in query must be separated by comma.
|
||||
min_version: 2.26
|
||||
offset_simple:
|
||||
description: |
|
||||
Used in conjunction with ``limit`` to return a slice of items. ``offset``
|
||||
is where to start in the list.
|
||||
in: query
|
||||
required: false
|
||||
type: integer
|
||||
reservation_id_query:
|
||||
in: query
|
||||
required: false
|
||||
|
Loading…
x
Reference in New Issue
Block a user