cinder/api-ref/source
Stephen Finucane a32e0b2aa6 api-ref: Improve sort, pagination parameter docs
The various index APIs (e.g. 'GET /volumes') support two forms of sort
parameter: the legacy 'sort_key'/'sort_dir' parameters and the combined
'sort' parameter. We were documenting different parameters in different
APIs despite the fact all APIs support all parameters.

In a similar vein, the various index APIs support the same three
pagination parameters: 'offset', 'limit', and 'marker'. Once again, we
were documenting these inconsistently.

Correct both issues.

Change-Id: Ia3300a8852825f7da830f7b1ed37b27625e267e9
Signed-off-by: Stephen Finucane <stephenfin@redhat.com>
2023-08-28 15:56:03 +01:00
..
v2 Remove multiatttach request parameter 2023-03-06 08:58:59 +00:00
v3 api-ref: Improve sort, pagination parameter docs 2023-08-28 15:56:03 +01:00
api_microversion_history.rst Add microversion history to api-ref 2018-09-18 14:59:37 -05:00
conf.py Switch to newer openstackdocstheme and reno versions 2020-05-27 12:28:24 +00:00
index.rst Add microversion history to api-ref 2018-09-18 14:59:37 -05:00
status.yaml Use rest_status_code for api-ref response codes 2018-03-08 21:59:37 -06:00