openstack/nova
Code Issues Proposed changes

api-ref: Clarify 'all_tenants' command

Browse Source 
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 <stephenfin@redhat.com>
Closes-Bug: #1909745
This commit is contained in:
Stephen Finucane 2021-01-15 15:15:47 +00:00
parent 7527fdf6ea
commit 40e0578683
1 changed files with 1 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
api-ref/source/parameters.yaml
View File

@ -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``.