openstack
/
nova
Code Issues Proposed changes

api-ref: fix GET /flavors?is_public description 

A couple of things are fixed here:

1. The type in the schema for the is_public query param
   is string, not boolean.

2. Since it's a string, the normal 1/yes/0/no types of
   "booleans" are allowed so document that along with
   the default.

3. Also mention that is_public='None' must be passed for
   an admin user to list both public and private flavors
   in a single request.

Change-Id: Idcb700b69f13217f68434fd6a54439cc277f8998
Partial-Bug: #1784782
This commit is contained in:
Matt Riedemann 2018-08-01 18:15:07 -04:00
parent d4dbb42593
commit eff376b9fc
1 changed files with 10 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

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

@ -626,11 +626,17 @@ exclude:
flavor_is_public_query:
in: query
required: false
type: boolean
type: string
description: |
Filters the flavor list by only public flavors. By default ``non
admin`` users only see public flavors, and ``admin`` users can see
additional non public flavors.
This parameter is only applicable to users with the administrative role.
For all other non-admin users, the parameter is ignored and only public
flavors will be returned. Filters the flavor list based on whether the
flavor is public or private. If the value of this parameter is not
specified, it is treated as ``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``
(they are case-insensitive). If the value is ``None`` (case-insensitive)
both public and private flavors will be listed in a single request.
flavor_query:
description: |
Filters the response by a flavor, as a UUID. A flavor is a combination of memory,