From 5c90bd64fe775753a54b45e640e0adf2693b1edd Mon Sep 17 00:00:00 2001 From: TommyLike Date: Mon, 15 May 2017 11:25:38 +0800 Subject: [PATCH] Add documentation for invalid filter keys Now cinder will raise 400 if invalid filter keys are specified, Update the corresponding list APIs. DocImpact Depends-On: ff3d41b15abb2915de87830980147be51e5da971 Change-Id: I8419b374d7f743e7e9fc88e31c8c4f7d9470059b --- api-ref/source/v3/attachments.inc | 10 ++++++---- api-ref/source/v3/ext-backups.inc | 12 ++++++++---- api-ref/source/v3/group-snapshots.inc | 10 ++++++---- api-ref/source/v3/groups.inc | 10 ++++++---- api-ref/source/v3/messages.inc | 5 +++-- api-ref/source/v3/os-vol-pool-v3.inc | 5 +++-- api-ref/source/v3/volumes-v3-snapshots.inc | 12 ++++++++---- api-ref/source/v3/volumes-v3-volumes.inc | 14 +++++++++----- 8 files changed, 49 insertions(+), 29 deletions(-) diff --git a/api-ref/source/v3/attachments.inc b/api-ref/source/v3/attachments.inc index 64dc8c3fee6..93c349067a3 100644 --- a/api-ref/source/v3/attachments.inc +++ b/api-ref/source/v3/attachments.inc @@ -74,11 +74,12 @@ List attachments with details .. 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 -Error response codes: +Error response codes: badRequest(400) Request ------- @@ -118,11 +119,12 @@ List 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 -Error response codes: +Error response codes: badRequest(400) Request diff --git a/api-ref/source/v3/ext-backups.inc b/api-ref/source/v3/ext-backups.inc index 78da6a2d312..0572e70e5c6 100644 --- a/api-ref/source/v3/ext-backups.inc +++ b/api-ref/source/v3/ext-backups.inc @@ -42,11 +42,13 @@ List backups with 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 -Error response codes: +Error response codes: badRequest(400) Request @@ -242,10 +244,12 @@ List backups for project .. 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 -Error response codes: +Error response codes: badRequest(400) Request ------- diff --git a/api-ref/source/v3/group-snapshots.inc b/api-ref/source/v3/group-snapshots.inc index 229a6e15c67..a84791c38bb 100644 --- a/api-ref/source/v3/group-snapshots.inc +++ b/api-ref/source/v3/group-snapshots.inc @@ -72,11 +72,12 @@ List group snapshots with details .. 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 -Error response codes: +Error response codes: badRequest(400) Request ------- @@ -114,11 +115,12 @@ List 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 -Error response codes: +Error response codes: badRequest(400) Request diff --git a/api-ref/source/v3/groups.inc b/api-ref/source/v3/groups.inc index bb1d6e0e26d..a83b8ab0b44 100644 --- a/api-ref/source/v3/groups.inc +++ b/api-ref/source/v3/groups.inc @@ -22,11 +22,12 @@ List 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 -Error response codes: +Error response codes: badRequest(400) Request @@ -187,11 +188,12 @@ List groups with details .. 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 -Error response codes: +Error response codes: badRequest(400) Request diff --git a/api-ref/source/v3/messages.inc b/api-ref/source/v3/messages.inc index cf902dce87c..74a6ed65343 100644 --- a/api-ref/source/v3/messages.inc +++ b/api-ref/source/v3/messages.inc @@ -75,11 +75,12 @@ List 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 -Error response codes: +Error response codes: badRequest(400) Request diff --git a/api-ref/source/v3/os-vol-pool-v3.inc b/api-ref/source/v3/os-vol-pool-v3.inc index 1345ea3473b..87324f9c923 100644 --- a/api-ref/source/v3/os-vol-pool-v3.inc +++ b/api-ref/source/v3/os-vol-pool-v3.inc @@ -12,11 +12,12 @@ List all back-end storage 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 -Error response codes: +Error response codes: badRequest(400) Request ------- diff --git a/api-ref/source/v3/volumes-v3-snapshots.inc b/api-ref/source/v3/volumes-v3-snapshots.inc index deb34f8bf15..777a463a172 100644 --- a/api-ref/source/v3/volumes-v3-snapshots.inc +++ b/api-ref/source/v3/volumes-v3-snapshots.inc @@ -31,11 +31,13 @@ List snapshots and details .. 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 -Error response codes: +Error response codes: badRequest(400) Request @@ -123,11 +125,13 @@ List accessible 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 -Error response codes: +Error response codes: badRequest(400) Request diff --git a/api-ref/source/v3/volumes-v3-volumes.inc b/api-ref/source/v3/volumes-v3-volumes.inc index 2f516df00e0..cbb22ecff1d 100644 --- a/api-ref/source/v3/volumes-v3-volumes.inc +++ b/api-ref/source/v3/volumes-v3-volumes.inc @@ -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 -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 -Error response codes: +Error response codes: badRequest(400) Request @@ -234,11 +236,13 @@ List accessible 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 -Error response codes: +Error response codes: badRequest(400) Request