placement/releasenotes/notes/placement-rest-api-nested-resource-providers-552a923a96d7adca.yaml
Stephen Finucane 5734d078fc placement: adds REST API for nested providers
Adds a new microversion (1.14) to the placement REST API for supporting
nested resource providers.

For POST /resource_providers and PUT /resource_providers/{uuid}, a new
optional 'parent_provider_uuid' field is added to the request payload.

For GET /resource_providers/{uuid} responses, the
'parent_provider_uuid' field and a convenience field called
'root_provider_uuid' are provided.

For GET /resource_providers, a new '?in_tree=<rp_uuid>' parameter is
supported. This parameter accepts a UUID of a resource provider. This
will cause the resulting list of resource providers to be only the
providers within the same "provider tree" as the provider identified by
<rp_uuid>

Clients for the placement REST API can specify either
'OpenStack-API-Version: placement 1.14' or 'placement latest' to handle
the new 'parent_provider_uuid' attribute and to query for resource
providers in a provider tree.

Change-Id: I4db74e4dc682bc03df6ec94cd1c3a5f5dc927a7b
blueprint: nested-resource-providers
APIImpact
2017-12-06 10:48:09 -06:00

14 lines
809 B
YAML

---
features:
- New placement REST API microversion 1.14 is added to support nested
resource providers. Users of the placement REST API can now pass a
``in_tree=<UUID>`` parameter to the ``GET /resource_providers`` REST API
call. This will trigger the placement service to return all resource
provider records within the "provider tree" of the resource provider with
the supplied UUID value. The resource provider representation now includes
a ``parent_provider_uuid`` value that indicates the UUID of the immediate
parent resource provider, or ``null`` if the provider has no parent. For
convenience, the resource provider resource also contains a
``root_provider_uuid`` field that is populated with the UUID of the
top-most resource provider in the provider tree.