placement/releasenotes/notes/negative-aggregate-membership-1dde3cbe27c69279.yaml
Tetsuro Nakamura e6f234fe44 FUP on negative-aggregate-membership series
This is a follow up patch on negative-aggregate-membership series.

 - Remove allocation candidate related words in the
   `GET /resource_providers` API reference
 - Fix several typos in the API reference
 - Additionaly write in the release note that the forbidden aggregate
   is also supported in granular requests.

Change-Id: Idb187d7ef83ad65aaaa5dbf968a15c41d73057d1
2019-04-02 12:22:42 +00:00

35 lines
1.0 KiB
YAML

---
features:
- |
Add support for forbidden aggregates in ``member_of`` queryparam
in ``GET /resource_providers`` and ``GET /allocation_candidates``.
Forbidden aggregates are prefixed with a ``!`` from microversion
``1.32``.
This negative expression can also be used in multiple ``member_of``
parameters::
?member_of=in:<agg1>,<agg2>&member_of=<agg3>&member_of=!<agg4>
would translate logically to
"Candidate resource providers must be at least one of agg1 or agg2,
definitely in agg3 and definitely *not* in agg4."
We do NOT support ``!`` within the ``in:`` list::
?member_of=in:<agg1>,<agg2>,!<agg3>
but we support ``!in:`` prefix::
?member_of=!in:<agg1>,<agg2>,<agg3>
which is equivalent to::
?member_of=!<agg1>&member_of=!<agg2>&member_of=!<agg3>
where returned resource providers must not be in agg1, agg2, or agg3.
Specifying forbidden aggregates in granular requests, ``member_of<N>``
is also supported from the same microversion, ``1.32``.