a09defd661
The API reference for POST /allocations [1] and PUT
/allocations/{consumer_uuid} [2] specifically mentions that you can get
a 409 on provider/inventory conflict. In microversion 1.28, it also
became possible to get a 409 on an allocation (consumer generation)
conflict.
In the process of adding that information, it became evident that we
weren't doing a good job explaining the whole generation thing in
general, so this commit also adds a descriptive section to the front
matter of the API reference.
Links are included from the updated descriptions for the two affected
allocations operations. Future commits can add links from other
appropriate sections of the reference (e.g. the parameters.yaml entries
for resource provider and consumer generation fields). Future commits
could also enhance the descriptions of error codes for other operations
to (at least) the level of detail at which these have ended up.
[1] https://developer.openstack.org/api-ref/placement/?expanded=manage-allocations-detail#manage-allocations
[2] https://developer.openstack.org/api-ref/placement/?expanded=update-allocations-detail#update-allocations
Change-Id: I42e76785e0fe456b107fe843dbb242f2c5f5b9f7
Story: #2006180
Task: #35705
36 lines
1.1 KiB
ReStructuredText
36 lines
1.1 KiB
ReStructuredText
:tocdepth: 2
|
|
|
|
===============
|
|
Placement API
|
|
===============
|
|
|
|
This is a reference for the OpenStack Placement API. To learn more about
|
|
OpenStack Placement API concepts, please refer to the
|
|
:placement-doc:`Placement Introduction <>`.
|
|
|
|
The Placement API uses JSON for data exchange. As such, the ``Content-Type``
|
|
header for APIs sending data payloads in the request body (i.e. ``PUT`` and
|
|
``POST``) must be set to ``application/json`` unless otherwise noted.
|
|
|
|
.. rest_expand_all::
|
|
|
|
.. include:: request-ids.inc
|
|
.. include:: errors.inc
|
|
.. include:: generations.inc
|
|
.. include:: root.inc
|
|
.. include:: resource_providers.inc
|
|
.. include:: resource_provider.inc
|
|
.. include:: resource_classes.inc
|
|
.. include:: resource_class.inc
|
|
.. include:: inventories.inc
|
|
.. include:: inventory.inc
|
|
.. include:: aggregates.inc
|
|
.. include:: traits.inc
|
|
.. include:: resource_provider_traits.inc
|
|
.. include:: allocations.inc
|
|
.. include:: resource_provider_allocations.inc
|
|
.. include:: usages.inc
|
|
.. include:: resource_provider_usages.inc
|
|
.. include:: allocation_candidates.inc
|
|
.. include:: reshaper.inc
|