16b29024c2
Add a section to the api-ref describing the error codes that some responses produce. Note in the contributor docs that this should be updated when one is added. The reshaper docs is adjusted so a ref can be made to it from the errors. The implicit link to the header that would be the norm there doesn't work as there are two headers named "Reshaper". Change-Id: I89bbd383ba102fdd707ccc9f2fc973c6dd841fa8 Closes-Bug: #1794712
35 lines
1.0 KiB
ReStructuredText
35 lines
1.0 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:: 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
|