openstack/cinder
Code Issues Proposed changes

Add documentation for invalid filter keys

Browse Source 
Now cinder will raise 400 if invalid filter
keys are specified, Update the corresponding
list APIs.

DocImpact
Depends-On: ff3d41b15a

Change-Id: I8419b374d7f743e7e9fc88e31c8c4f7d9470059b
This commit is contained in:
TommyLike 2017-05-15 11:25:38 +08:00
parent 120980bb16
commit 5c90bd64fe
8 changed files with 49 additions and 29 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

10
api-ref/source/v3/attachments.inc
View File

@ -74,11 +74,12 @@ List attachments with details
.. rest_method:: GET /v3/{project_id}/attachments/detail .. rest_method:: GET /v3/{project_id}/attachments/detail
Lists all attachments with details. Lists all attachments with details, since v3.31 if non-admin
users specify invalid filters in the url, API will return bad request.
Normal response codes: 200 Normal response codes: 200
Error response codes: Error response codes: badRequest(400)
Request Request
------- -------
@ -118,11 +119,12 @@ List attachments
.. rest_method:: GET /v3/{project_id}/attachments .. rest_method:: GET /v3/{project_id}/attachments
Lists all attachments. Lists all attachments, since v3.31 if non-admin users
specify invalid filters in the url, API will return bad request.
Normal response codes: 200 Normal response codes: 200
Error response codes: Error response codes: badRequest(400)
Request Request

12
api-ref/source/v3/ext-backups.inc
View File

@ -42,11 +42,13 @@ List backups with detail
.. rest_method:: GET /v3/{project_id}/backups/detail .. rest_method:: GET /v3/{project_id}/backups/detail
Lists Block Storage backups, with details, to which the project has access. Lists Block Storage backups, with details, to which the project has access,
since v3.31 if non-admin users specify invalid filters in the url,
API will return bad request.
Normal response codes: 200 Normal response codes: 200
Error response codes: Error response codes: badRequest(400)
Request Request
@ -242,10 +244,12 @@ List backups for project
.. rest_method:: GET /v3/{project_id}/backups .. rest_method:: GET /v3/{project_id}/backups
Lists Block Storage backups to which the project has access. Lists Block Storage backups to which the project has access,
since v3.31 if non-admin users specify invalid filters in the
url, API will return bad request.
Normal response codes: 200 Normal response codes: 200
Error response codes: Error response codes: badRequest(400)
Request Request
------- -------

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

@ -72,11 +72,12 @@ List group snapshots with details
.. rest_method:: GET /v3/{project_id}/group_snapshots/detail .. rest_method:: GET /v3/{project_id}/group_snapshots/detail
Lists all group snapshots with details. Lists all group snapshots with details, since v3.31 if non-admin
users specify invalid filters in the url, API will return bad request.
Normal response codes: 200 Normal response codes: 200
Error response codes: Error response codes: badRequest(400)
Request Request
------- -------
@ -114,11 +115,12 @@ List group snapshots
.. rest_method:: GET /v3/{project_id}/group_snapshots .. rest_method:: GET /v3/{project_id}/group_snapshots
Lists all group snapshots. Lists all group snapshots, since v3.31 if non-admin users
specify invalid filters in the url, API will return bad request.
Normal response codes: 200 Normal response codes: 200
Error response codes: Error response codes: badRequest(400)
Request Request

10
api-ref/source/v3/groups.inc
View File

@ -22,11 +22,12 @@ List groups
.. rest_method:: GET /v3/{project_id}/groups .. rest_method:: GET /v3/{project_id}/groups
Lists groups. Lists groups, since v3.31 if non-admin users specify
invalid filters in the url, API will return bad request.
Normal response codes: 200 Normal response codes: 200
Error response codes: Error response codes: badRequest(400)
Request Request
@ -187,11 +188,12 @@ List groups with details
.. rest_method:: GET /v3/{project_id}/groups/detail .. rest_method:: GET /v3/{project_id}/groups/detail
Lists groups with details. Lists groups with details, since v3.31 if non-admin
users specify invalid filters in the url, API will return bad request.
Normal response codes: 200 Normal response codes: 200
Error response codes: Error response codes: badRequest(400)
Request Request

5
api-ref/source/v3/messages.inc
View File

@ -75,11 +75,12 @@ List messages
.. rest_method:: GET /v3/{project_id}/messages .. rest_method:: GET /v3/{project_id}/messages
Lists all messages. Lists all messages, since v3.31 if non-admin users
specify invalid filters in the url, API will return bad request.
Normal response codes: 200 Normal response codes: 200
Error response codes: Error response codes: badRequest(400)
Request Request

5
api-ref/source/v3/os-vol-pool-v3.inc
View File

@ -12,11 +12,12 @@ List all back-end storage pools
.. rest_method:: GET /v3/{project_id}/scheduler-stats/get_pools .. rest_method:: GET /v3/{project_id}/scheduler-stats/get_pools
Lists all back-end storage pools. Lists all back-end storage pools, since v3.31 if non-admin users
specify invalid filters in the url, API will return bad request.
Normal response codes: 200 Normal response codes: 200
Error response codes: Error response codes: badRequest(400)
Request Request
------- -------

12
api-ref/source/v3/volumes-v3-snapshots.inc
View File

@ -31,11 +31,13 @@ List snapshots and details
.. rest_method:: GET /v3/{project_id}/snapshots/detail .. rest_method:: GET /v3/{project_id}/snapshots/detail
Lists all Block Storage snapshots, with details, that the project can access. Lists all Block Storage snapshots, with details, that the project can access,
since v3.31 if non-admin users specify invalid filters in the url, API will
return bad request.
Normal response codes: 200 Normal response codes: 200
Error response codes: Error response codes: badRequest(400)
Request Request
@ -123,11 +125,13 @@ List accessible snapshots
.. rest_method:: GET /v3/{project_id}/snapshots .. rest_method:: GET /v3/{project_id}/snapshots
Lists all Block Storage snapshots, with summary information, that the project can access. Lists all Block Storage snapshots, with summary information,
that the project can access, since v3.31 if non-admin users
specify invalid filters in the url, API will return bad request.
Normal response codes: 200 Normal response codes: 200
Error response codes: Error response codes: badRequest(400)
Request Request

14
api-ref/source/v3/volumes-v3-volumes.inc
View File

@ -59,16 +59,18 @@ status values are:
+------------------+--------------------------------------------------------+ +------------------+--------------------------------------------------------+
List accessbile volumes with details List accessible volumes with details
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.. rest_method:: GET /v3/{project_id}/volumes/detail .. rest_method:: GET /v3/{project_id}/volumes/detail
Lists all Block Storage volumes, with details, that the project can access. Lists all Block Storage volumes, with details, that the project can access,
since v3.31 if non-admin users specify invalid filters in the url, API will
return bad request.
Normal response codes: 200 Normal response codes: 200
Error response codes: Error response codes: badRequest(400)
Request Request
@ -234,11 +236,13 @@ List accessible volumes
.. rest_method:: GET /v3/{project_id}/volumes .. rest_method:: GET /v3/{project_id}/volumes
Lists summary information for all Block Storage volumes that the project can access. Lists summary information for all Block Storage volumes that the
project can access, since v3.31 if non-admin users specify invalid
filters in the url, API will return bad request.
Normal response codes: 200 Normal response codes: 200
Error response codes: Error response codes: badRequest(400)
Request Request