From ba9eaf27aff1a17f0cf3234302b44c7cfc9d5dbf Mon Sep 17 00:00:00 2001 From: lihaijing Date: Thu, 18 Jan 2018 15:06:15 +0800 Subject: [PATCH] Api-ref: add 'all_tenants' API query option Cinder REST API allows one to use a special query parameter named "all_tenants" to list resources from all projects (tenants) through the REST API: `/v3/{project_id}/volumes/detail?all_tenants=1` However, this option is hardly documented anywhere besides `/v3/{project_id}/volumes/summary`. So add them. Change-Id: Ia9cc9e20c3b333a054c90f07e952b61dfad8529e Closes-Bug: #1743800 --- api-ref/source/v2/consistencygroups-v2.inc | 2 ++ api-ref/source/v2/ext-backups.inc | 2 ++ api-ref/source/v2/os-cgsnapshots-v2.inc | 2 ++ api-ref/source/v2/os-vol-transfer-v2.inc | 2 ++ api-ref/source/v2/volumes-v2-snapshots.inc | 2 ++ api-ref/source/v2/volumes-v2-volumes.inc | 2 ++ api-ref/source/v3/attachments.inc | 2 ++ api-ref/source/v3/consistencygroups-v3.inc | 2 ++ api-ref/source/v3/ext-backups.inc | 2 ++ api-ref/source/v3/group-snapshots.inc | 2 ++ api-ref/source/v3/groups.inc | 2 ++ api-ref/source/v3/os-cgsnapshots-v3.inc | 2 ++ api-ref/source/v3/os-vol-transfer-v3.inc | 2 ++ api-ref/source/v3/volumes-v3-snapshots.inc | 2 ++ api-ref/source/v3/volumes-v3-volumes.inc | 4 +++- 15 files changed, 31 insertions(+), 1 deletion(-) diff --git a/api-ref/source/v2/consistencygroups-v2.inc b/api-ref/source/v2/consistencygroups-v2.inc index 0fe35a7675e..86a9ab614b0 100644 --- a/api-ref/source/v2/consistencygroups-v2.inc +++ b/api-ref/source/v2/consistencygroups-v2.inc @@ -31,6 +31,7 @@ Request .. rest_parameters:: parameters.yaml - project_id: project_id_path + - all_tenants: all-tenants - sort_key: sort_key - sort_dir: sort_dir - limit: limit @@ -209,6 +210,7 @@ Request .. rest_parameters:: parameters.yaml - project_id: project_id_path + - all_tenants: all-tenants - sort_key: sort_key - sort_dir: sort_dir - limit: limit diff --git a/api-ref/source/v2/ext-backups.inc b/api-ref/source/v2/ext-backups.inc index b3206d06a6a..4263c65cff3 100644 --- a/api-ref/source/v2/ext-backups.inc +++ b/api-ref/source/v2/ext-backups.inc @@ -54,6 +54,7 @@ Request .. rest_parameters:: parameters.yaml - project_id: project_id_path + - all_tenants: all-tenants - sort_key: sort_key - sort_dir: sort_dir - limit: limit @@ -270,6 +271,7 @@ Request .. rest_parameters:: parameters.yaml - project_id: project_id_path + - all_tenants: all-tenants - sort_key: sort_key - sort_dir: sort_dir - limit: limit diff --git a/api-ref/source/v2/os-cgsnapshots-v2.inc b/api-ref/source/v2/os-cgsnapshots-v2.inc index b4af4ae154b..7d136f65c10 100644 --- a/api-ref/source/v2/os-cgsnapshots-v2.inc +++ b/api-ref/source/v2/os-cgsnapshots-v2.inc @@ -81,6 +81,7 @@ Request .. rest_parameters:: parameters.yaml - project_id: project_id_path + - all_tenants: all-tenants Response Parameters @@ -118,6 +119,7 @@ Request .. rest_parameters:: parameters.yaml - project_id: project_id_path + - all_tenants: all-tenants Response Parameters diff --git a/api-ref/source/v2/os-vol-transfer-v2.inc b/api-ref/source/v2/os-vol-transfer-v2.inc index bc3b7f19cad..77599637e56 100644 --- a/api-ref/source/v2/os-vol-transfer-v2.inc +++ b/api-ref/source/v2/os-vol-transfer-v2.inc @@ -110,6 +110,7 @@ Request .. rest_parameters:: parameters.yaml - project_id: project_id_path + - all_tenants: all-tenants Response Parameters @@ -204,6 +205,7 @@ Request .. rest_parameters:: parameters.yaml - project_id: project_id_path + - all_tenants: all-tenants Response Parameters ------------------- diff --git a/api-ref/source/v2/volumes-v2-snapshots.inc b/api-ref/source/v2/volumes-v2-snapshots.inc index 2c4da7834a3..2d888bd20da 100644 --- a/api-ref/source/v2/volumes-v2-snapshots.inc +++ b/api-ref/source/v2/volumes-v2-snapshots.inc @@ -51,6 +51,7 @@ Request .. rest_parameters:: parameters.yaml - project_id: project_id_path + - all_tenants: all-tenants Response Parameters @@ -137,6 +138,7 @@ Request .. rest_parameters:: parameters.yaml - project_id: project_id_path + - all_tenants: all-tenants - sort_key: sort_key - sort_dir: sort_dir - limit: limit diff --git a/api-ref/source/v2/volumes-v2-volumes.inc b/api-ref/source/v2/volumes-v2-volumes.inc index a8bdff34f72..c7bf50841e2 100644 --- a/api-ref/source/v2/volumes-v2-volumes.inc +++ b/api-ref/source/v2/volumes-v2-volumes.inc @@ -76,6 +76,7 @@ Request .. rest_parameters:: parameters.yaml - project_id: project_id_path + - all_tenants: all-tenants - sort: sort - limit: limit - offset: offset @@ -247,6 +248,7 @@ Request .. rest_parameters:: parameters.yaml - project_id: project_id_path + - all_tenants: all-tenants - sort: sort - limit: limit - offset: offset diff --git a/api-ref/source/v3/attachments.inc b/api-ref/source/v3/attachments.inc index eaa5ae6b149..fde3cc47065 100644 --- a/api-ref/source/v3/attachments.inc +++ b/api-ref/source/v3/attachments.inc @@ -98,6 +98,7 @@ Request .. rest_parameters:: parameters.yaml - project_id: project_id_path + - all_tenants: all-tenants - sort: sort - limit: limit - offset: offset @@ -145,6 +146,7 @@ Request .. rest_parameters:: parameters.yaml - project_id: project_id_path + - all_tenants: all-tenants - sort: sort - limit: limit - offset: offset diff --git a/api-ref/source/v3/consistencygroups-v3.inc b/api-ref/source/v3/consistencygroups-v3.inc index 497de1aa1e4..6e5ee4180df 100644 --- a/api-ref/source/v3/consistencygroups-v3.inc +++ b/api-ref/source/v3/consistencygroups-v3.inc @@ -31,6 +31,7 @@ Request .. rest_parameters:: parameters.yaml - project_id: project_id_path + - all_tenants: all-tenants - sort: sort - limit: limit - marker: marker @@ -213,6 +214,7 @@ Request .. rest_parameters:: parameters.yaml - project_id: project_id_path + - all_tenants: all-tenants - sort: sort - limit: limit - marker: marker diff --git a/api-ref/source/v3/ext-backups.inc b/api-ref/source/v3/ext-backups.inc index 2770631648e..05a8305e159 100644 --- a/api-ref/source/v3/ext-backups.inc +++ b/api-ref/source/v3/ext-backups.inc @@ -58,6 +58,7 @@ Request .. rest_parameters:: parameters.yaml - project_id: project_id_path + - all_tenants: all-tenants - sort: sort - limit: limit - offset: offset @@ -334,6 +335,7 @@ Request .. rest_parameters:: parameters.yaml - project_id: project_id_path + - all_tenants: all-tenants - sort: sort - limit: limit - marker: marker diff --git a/api-ref/source/v3/group-snapshots.inc b/api-ref/source/v3/group-snapshots.inc index 2e7c8e0a9af..70f01e01338 100644 --- a/api-ref/source/v3/group-snapshots.inc +++ b/api-ref/source/v3/group-snapshots.inc @@ -90,6 +90,7 @@ Request .. rest_parameters:: parameters.yaml - project_id: project_id_path + - all_tenants: all-tenants - sort_key: sort_key_group_snapshot - sort_dir: sort_dir_group_snapshot - limit: limit_group_snapshot @@ -137,6 +138,7 @@ Request .. rest_parameters:: parameters.yaml - project_id: project_id_path + - all_tenants: all-tenants - sort_key: sort_key_group_snapshot - sort_dir: sort_dir_group_snapshot - limit: limit_group_snapshot diff --git a/api-ref/source/v3/groups.inc b/api-ref/source/v3/groups.inc index 3d24a8f0d6d..1274cdfd73a 100644 --- a/api-ref/source/v3/groups.inc +++ b/api-ref/source/v3/groups.inc @@ -37,6 +37,7 @@ Request .. rest_parameters:: parameters.yaml - project_id: project_id_path + - all_tenants: all-tenants - sort: sort - limit: limit - offset: offset @@ -213,6 +214,7 @@ Request .. rest_parameters:: parameters.yaml - project_id: project_id_path + - all_tenants: all-tenants - sort: sort - limit: limit - offset: offset diff --git a/api-ref/source/v3/os-cgsnapshots-v3.inc b/api-ref/source/v3/os-cgsnapshots-v3.inc index 4122bb12e38..9875a4eafd1 100644 --- a/api-ref/source/v3/os-cgsnapshots-v3.inc +++ b/api-ref/source/v3/os-cgsnapshots-v3.inc @@ -82,6 +82,7 @@ Request .. rest_parameters:: parameters.yaml - project_id: project_id_path + - all_tenants: all-tenants Response Parameters @@ -120,6 +121,7 @@ Request .. rest_parameters:: parameters.yaml - project_id: project_id_path + - all_tenants: all-tenants Response Parameters diff --git a/api-ref/source/v3/os-vol-transfer-v3.inc b/api-ref/source/v3/os-vol-transfer-v3.inc index cc6c8004fb5..1ee49d7c714 100644 --- a/api-ref/source/v3/os-vol-transfer-v3.inc +++ b/api-ref/source/v3/os-vol-transfer-v3.inc @@ -111,6 +111,7 @@ Request .. rest_parameters:: parameters.yaml - project_id: project_id_path + - all_tenants: all-tenants Response Parameters @@ -205,6 +206,7 @@ Request .. rest_parameters:: parameters.yaml - project_id: project_id_path + - all_tenants: all-tenants Response Parameters ------------------- diff --git a/api-ref/source/v3/volumes-v3-snapshots.inc b/api-ref/source/v3/volumes-v3-snapshots.inc index 96953b1cff1..8a50e513432 100644 --- a/api-ref/source/v3/volumes-v3-snapshots.inc +++ b/api-ref/source/v3/volumes-v3-snapshots.inc @@ -55,6 +55,7 @@ Request .. rest_parameters:: parameters.yaml - project_id: project_id_path + - all_tenants: all-tenants - sort: sort - limit: limit - offset: offset @@ -162,6 +163,7 @@ Request .. rest_parameters:: parameters.yaml - project_id: project_id_path + - all_tenants: all-tenants - sort: sort - limit: limit - offset: offset diff --git a/api-ref/source/v3/volumes-v3-volumes.inc b/api-ref/source/v3/volumes-v3-volumes.inc index 33a466d6b1e..2a96bca1196 100644 --- a/api-ref/source/v3/volumes-v3-volumes.inc +++ b/api-ref/source/v3/volumes-v3-volumes.inc @@ -82,6 +82,7 @@ Request .. rest_parameters:: parameters.yaml - project_id: project_id_path + - all_tenants: all-tenants - sort: sort - limit: limit - offset: offset @@ -260,6 +261,7 @@ Request .. rest_parameters:: parameters.yaml - project_id: project_id_path + - all_tenants: all-tenants - sort: sort - limit: limit - offset: offset @@ -717,7 +719,7 @@ Request .. rest_parameters:: parameters.yaml - project_id: project_id_path - - all_tenants: all_tenants + - all_tenants: all-tenants Response Parameters -------------------