From ed51eee6c3f7a158afe3c622ea6d1a28a22e9f6e Mon Sep 17 00:00:00 2001 From: Eric Fried Date: Fri, 17 Nov 2017 20:02:40 -0600 Subject: [PATCH] placement: Document `in:` prefix for ?member_of= 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] https://github.com/openstack/nova/blob/57728836f25e9201ddec1e7790b552cfa840d572/nova/api/openstack/placement/handlers/resource_provider.py#L229-L233 Change-Id: I2ec46d767ded5be02cfc73136f2d217f1347662a Closes-Bug: #1733030 --- placement-api-ref/source/parameters.yaml | 10 +++++++--- 1 file changed, 7 insertions(+), 3 deletions(-) diff --git a/placement-api-ref/source/parameters.yaml b/placement-api-ref/source/parameters.yaml index 4744ab17f635..45e951e14eb4 100644 --- a/placement-api-ref/source/parameters.yaml +++ b/placement-api-ref/source/parameters.yaml @@ -30,9 +30,13 @@ member_of: in: query required: false description: > - A comma-separated list of strings representing aggregate uuids. - The returned resource providers must be associated with at - least one of the aggregates identified by uuid. + A string representing an aggregate uuid; or the prefix ``in:`` followed by + a comma-separated list of strings representing aggregate uuids. The + 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 project_id: &project_id type: string