openstack/placement
Code Issues Proposed changes

placement: Document in: prefix for ?member_of=

Browse Source 
The documentation for the member_of query parameter for GET
/resource_providers [1] claims that it accepts a "comma-separated list
of strings representing aggregate uuids".  But it turns out the code [2]
is expecting a single UUID unless the prefix 'in:' is specified.

This change set updates the documentation accordingly.

[1] https://developer.openstack.org/api-ref/placement/#resource-providers
[2] 57728836f2/nova/api/openstack/placement/handlers/resource_provider.py (L229-L233)

Change-Id: I2ec46d767ded5be02cfc73136f2d217f1347662a
Closes-Bug: #1733030
This commit is contained in:
Eric Fried 2017-11-17 20:02:40 -06:00
parent 70adc7400b
commit e4189d1251
1 changed files with 7 additions and 3 deletions

10
placement-api-ref/source/parameters.yaml

@ -30,9 +30,13 @@ member_of:
in: query in: query
required: false required: false
description: > description: >
A comma-separated list of strings representing aggregate uuids. A string representing an aggregate uuid; or the prefix ``in:`` followed by
The returned resource providers must be associated with at a comma-separated list of strings representing aggregate uuids. The
least one of the aggregates identified by uuid. returned resource providers must be associated with at least one of the
aggregates identified by uuid::
member_of=5e08ea53-c4c6-448e-9334-ac4953de3cfa
member_of=in:42896e0d-205d-4fe3-bd1e-100924931787,5e08ea53-c4c6-448e-9334-ac4953de3cfa
min_version: 1.3 min_version: 1.3
project_id: &project_id project_id: &project_id
type: string type: string