openstack/cinder
Code Issues Proposed changes
9927bdc9b3
cinder/api-ref/source/v3
History
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
..
samples Merge "Automate generation of backups api-ref samples" 2023-07-27 08:52:53 +00:00
api-versions.inc Automate generation of API versions api-ref samples 2019-01-10 19:48:18 +05:30
attachments.inc api-ref: Improve sort, pagination parameter docs 2023-08-28 15:56:03 +01:00
capabilities-v3.inc Improve/Clean api-ref parameters 2018-11-05 10:47:14 +05:30
clusters.inc api-ref: Add docs for clusters 2022-08-31 10:02:20 +01:00
consistencygroups-v3.inc api-ref: Improve sort, pagination parameter docs 2023-08-28 15:56:03 +01:00
default-types.inc Default type overrides 2020-09-16 14:05:31 +00:00
ext-backups-actions-v3.inc Improve/Clean api-ref parameters 2018-11-05 10:47:14 +05:30
ext-backups.inc api-ref: Improve sort, pagination parameter docs 2023-08-28 15:56:03 +01:00
group-replication.inc Update api-ref 2020-02-04 18:41:30 -05:00
group-snapshots.inc api-ref: Improve sort, pagination parameter docs 2023-08-28 15:56:03 +01:00
group-type-specs.inc Update api-ref 2020-02-04 18:41:30 -05:00
group-types.inc api-ref: Improve sort, pagination parameter docs 2023-08-28 15:56:03 +01:00
groups.inc api-ref: Improve sort, pagination parameter docs 2023-08-28 15:56:03 +01:00
hosts.inc [api-ref]Fix values of service-status in list-hosts 2019-08-23 09:41:37 +08:00
index.rst api-ref: Fix indentation, case 2023-07-17 11:21:56 +01:00
limits.inc Automate generation of qos specs api-ref samples 2019-09-27 17:43:40 +05:30
messages.inc api-ref: Improve sort, pagination parameter docs 2023-08-28 15:56:03 +01:00
os-cgsnapshots-v3.inc Improve/Clean api-ref parameters 2018-11-05 10:47:14 +05:30
os-services.inc api-ref: Add docs for clusters 2022-08-31 10:02:20 +01:00
os-vol-pool-v3.inc Improve/Clean api-ref parameters 2018-11-05 10:47:14 +05:30
os-vol-transfer-v3.inc api-ref: Fix "id" parameter 2021-03-25 09:14:32 -04:00
parameters.yaml api-ref: Improve sort, pagination parameter docs 2023-08-28 15:56:03 +01:00
qos-specs-v3-qos-specs.inc api-ref: Improve sort, pagination parameter docs 2023-08-28 15:56:03 +01:00
quota-classes.inc Automate generation of quotas api-ref samples 2019-09-30 16:29:49 +05:30
quota-sets.inc Remove NestedQuotaDriver 2021-01-19 17:43:29 +00:00
resource-filters.inc Expose volume & snapshot use_quota field 2021-08-26 19:04:12 +02:00
snapshot-manage.inc api-ref: Improve sort, pagination parameter docs 2023-08-28 15:56:03 +01:00
valid-boolean-values.inc Include .inc files in doc8 linting 2019-02-19 11:33:05 -06:00
vol-transfer-v3.inc api-ref: Improve sort, pagination parameter docs 2023-08-28 15:56:03 +01:00
volume-manage.inc api-ref: Improve sort, pagination parameter docs 2023-08-28 15:56:03 +01:00
volume-type-access.inc Update api-ref 2020-02-04 18:41:30 -05:00
volumes-v3-extensions.inc api-ref: Remove non-existent attribute 2023-06-02 14:15:21 +01:00
volumes-v3-snapshots-actions.inc Improve/Clean api-ref parameters 2018-11-05 10:47:14 +05:30
volumes-v3-snapshots.inc api-ref: Improve sort, pagination parameter docs 2023-08-28 15:56:03 +01:00
volumes-v3-types.inc api-ref: Improve sort, pagination parameter docs 2023-08-28 15:56:03 +01:00
volumes-v3-versions.inc Automate generation of API versions api-ref samples 2019-01-10 19:48:18 +05:30
volumes-v3-volumes-actions.inc Reject unsafe delete attachment calls 2023-05-10 19:51:33 +02:00
volumes-v3-volumes.inc api-ref: Improve sort, pagination parameter docs 2023-08-28 15:56:03 +01:00
worker-cleanup.inc Improve/Clean api-ref parameters 2018-11-05 10:47:14 +05:30