From 40e0578683d9bcd866076d48ed1d682ee21dbe9d Mon Sep 17 00:00:00 2001 From: Stephen Finucane Date: Fri, 15 Jan 2021 15:15:47 +0000 Subject: [PATCH] api-ref: Clarify 'all_tenants' command An empty value for the 'all_tenants' query parameter of '/servers' and '/servers/detail' means the value defaults to 'True', i.e. requesting '/servers?all_tenants' is the same as '/servers?all_tenants=1'. Clarify this, since the current wording is confusing. Change-Id: Ib5fdd3b73aa5179e0379ee8f465e4118107786be Signed-off-by: Stephen Finucane Closes-Bug: #1909745 --- api-ref/source/parameters.yaml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/api-ref/source/parameters.yaml b/api-ref/source/parameters.yaml index 13fbc541aa87..16b040bcf989 100644 --- a/api-ref/source/parameters.yaml +++ b/api-ref/source/parameters.yaml @@ -396,7 +396,7 @@ all_tenants_query: description: | Specify the ``all_tenants`` query parameter to list all instances for all projects. By default this is only allowed by administrators. - If the value of this parameter is not specified, it is treated as + If this parameter is specified without a value, the value defaults to ``True``. If the value is specified, ``1``, ``t``, ``true``, ``on``, ``y`` and ``yes`` are treated as ``True``. ``0``, ``f``, ``false``, ``off``, ``n`` and ``no`` are treated as ``False``.