From 5a5f9c89d46d07511e4eaa979f3d6ee4f72eafa4 Mon Sep 17 00:00:00 2001 From: chenaidong1 Date: Fri, 15 Sep 2017 14:06:11 +0800 Subject: [PATCH] List environments api document According to code implementation,'List environments' api include parameters 'all_tenants' and 'tenant'. Parameter 'tenant' is not described in document. Change-Id: Ie5ea72903202a6674f2de23de139665d3872d0ed --- api-ref/source/v1/environments.inc | 1 + api-ref/source/v1/parameters.yaml | 6 ++++++ .../appendix/articles/specification/murano-api.rst | 1 + 3 files changed, 8 insertions(+) diff --git a/api-ref/source/v1/environments.inc b/api-ref/source/v1/environments.inc index 657ab1bfc..f026f9ac2 100644 --- a/api-ref/source/v1/environments.inc +++ b/api-ref/source/v1/environments.inc @@ -39,6 +39,7 @@ Request Parameters .. rest_parameters:: parameters.yaml - all_tenants: all_tenants + - tenant: tenant Response Parameters ------------------- diff --git a/api-ref/source/v1/parameters.yaml b/api-ref/source/v1/parameters.yaml index fb7d5515f..5592899ea 100644 --- a/api-ref/source/v1/parameters.yaml +++ b/api-ref/source/v1/parameters.yaml @@ -215,6 +215,12 @@ search: in: query required: false type: string +tenant: + description: | + Indicates environments from specified tenant are listed. Admin user required. + in: query + required: false + type: string # variables in body acquired_by: diff --git a/doc/source/reference/appendix/articles/specification/murano-api.rst b/doc/source/reference/appendix/articles/specification/murano-api.rst index fcf46da20..d0bc505af 100644 --- a/doc/source/reference/appendix/articles/specification/murano-api.rst +++ b/doc/source/reference/appendix/articles/specification/murano-api.rst @@ -91,6 +91,7 @@ List environments *True* environments from all projects are listed. Admin user required. *False* environments only from current project are listed (default like option unspecified). +* `tenant` - indicates environments from specified tenant are listed. Admin user required. *Response*