28a399a13c
This commit does several things, which were just easier to do together. - Adds a new "misc" page describing the /v1/lookup and /v1/heartbeat resources. - Adds descriptions of the node.resource_class and node.network_interface fields that were introduced into the API but not into the documentation. - Introduces a new script, api-ref/regenerate-samples.sh, which can be used with Ironic to automate the generation of most of the sample files used in the api-ref documententation. - Corrects several errors in the sample JSON files that rendered errors when using them with curl for POST, PUT, or PATCH. - Uses the aforementioned regenerate-samples.sh script to regenerate most of the JSON result samples, ensuring that they are all up to date with the v1.22 API microversion. - Removes a few old/incorrect "Error Code" listings. - Updates the index page to remove extraneous wording. Change-Id: I764cbb43be15f05ba681de6ce1be1ae7c022173d
20 lines
525 B
ReStructuredText
20 lines
525 B
ReStructuredText
:tocdepth: 2
|
|
|
|
================
|
|
Bare Metal API
|
|
================
|
|
|
|
.. rest_expand_all::
|
|
|
|
.. include:: baremetal-api-versions.inc
|
|
.. include:: baremetal-api-v1-nodes.inc
|
|
.. include:: baremetal-api-v1-node-management.inc
|
|
.. include:: baremetal-api-v1-node-passthru.inc
|
|
.. include:: baremetal-api-v1-ports.inc
|
|
.. include:: baremetal-api-v1-nodes-ports.inc
|
|
.. include:: baremetal-api-v1-drivers.inc
|
|
.. include:: baremetal-api-v1-driver-passthru.inc
|
|
.. include:: baremetal-api-v1-chassis.inc
|
|
.. include:: baremetal-api-v1-misc.inc
|
|
|