openstack/cinder
Code Issues Proposed changes

[Doc] Add missing parameter in v3 resource documentation

Browse Source 
We have introduced a filter, sorter and pagination
in listing APIs. Adding the missing parameters
in api-ref.

Change-Id: Id32fb09ba659e2ba83910d37018de9e18302d5b6
This commit is contained in:
TommyLike 2017-03-20 12:37:33 +08:00
parent 3a6c184d52
commit 0059340be0
8 changed files with 34 additions and 2 deletions

1
api-ref/source/v3/ext-backups.inc

@ -58,6 +58,7 @@ Request
- sort_key: sort_key
- sort_dir: sort_dir
- limit: limit
- offset: offset
- marker: marker

10
api-ref/source/v3/group-snapshots.inc

@ -84,6 +84,11 @@ Request
.. rest_parameters:: parameters.yaml
- project_id: project_id_path
- sort_key: sort_key
- sort_dir: sort_dir
- limit: limit
- offset: offset
- marker: marker
Response Parameters
@ -122,6 +127,11 @@ Request
.. rest_parameters:: parameters.yaml
- project_id: project_id_path
- sort_key: sort_key
- sort_dir: sort_dir
- limit: limit
- offset: offset
- marker: marker
Response Parameters

1
api-ref/source/v3/group-types.inc

@ -181,6 +181,7 @@ Request
- sort_key: sort_key
- sort_dir: sort_dir
- limit: limit
- offset: offset
- marker: marker

2
api-ref/source/v3/groups.inc

@ -38,6 +38,7 @@ Request
- sort_key: sort_key
- sort_dir: sort_dir
- limit: limit
- offset: offset
- marker: marker
@ -202,6 +203,7 @@ Request
- sort_key: sort_key
- sort_dir: sort_dir
- limit: limit
- offset: offset
- marker: marker

7
api-ref/source/v3/parameters.yaml

@ -211,6 +211,13 @@ name_volume:
in: query
required: false
type: string
offset:
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
sort:
description: |
Comma-separated list of sort keys and optional

6
api-ref/source/v3/volumes-v3-snapshots.inc

@ -44,6 +44,11 @@ Request
.. rest_parameters:: parameters.yaml
- project_id: project_id_path
- sort_key: sort_key
- sort_dir: sort_dir
- limit: limit
- offset: offset
- marker: marker
Response Parameters
@ -134,6 +139,7 @@ Request
- sort_key: sort_key
- sort_dir: sort_dir
- limit: limit
- offset: offset
- marker: marker

1
api-ref/source/v3/volumes-v3-types.inc

@ -192,6 +192,7 @@ Request
- sort_key: sort_key
- sort_dir: sort_dir
- limit: limit
- offset: offset
- marker: marker

8
api-ref/source/v3/volumes-v3-volumes.inc

@ -61,8 +61,10 @@ Request
.. rest_parameters:: parameters.yaml
- project_id: project_id_path
- sort: sort
- sort_key: sort_key
- sort_dir: sort_dir
- limit: limit
- offset: offset
- marker: marker
@ -229,8 +231,10 @@ Request
.. rest_parameters:: parameters.yaml
- project_id: project_id_path
- sort: sort
- sort_key: sort_key
- sort_dir: sort_dir
- limit: limit
- offset: offset
- marker: marker