placement/releasenotes/notes/placement-api-member-of-d8a08d0d0c5700d7.yaml
Chris Dent 8e797aad7c HTTP interface for resource providers by aggregates
In a new 1.3 microversion, the GET /resource_providers handler gains
support for a new query parameter 'member_of' which takes a value of
'in:' and a comma separated list of aggregate uuids, or a single
aggregate uuid.

The response is the list of resource providers that are associated
with any of those aggregates, or an empty list if there are none.

If in an old microversion, the query parameter is not accepted and a
400 is returned.

Change-Id: I82fc2003ce85dcadfecfea506e7d4adb47258c7a
2017-01-05 20:26:18 +00:00

15 lines
677 B
YAML

---
features:
- |
A new Placement API microversion 1.3 is added with support for filtering
the list of resource providers to include only those resource providers
which are members of any of the aggregates listed by uuid in the `member_of`
query parameter. The parameter is used when making a
`GET /resource_providers` request. The value of the parameter uses the
`in:` syntax to provide a list of aggregate uuids as follows::
/resource_providers?member_of=in:09c931b0-c0d7-4e80-8e01-9e6511db8259,f8ab4fa2-804f-402e-b675-7918bd04b173
If other filtering query parameters are present, the results are a boolean
AND of all the filters.