Sphinx provides the versionadded syntax for indicating version related
changes in documentation, the OpenStack doc theme is designed to handle
this and render it nicely. This patch switches our inconsistent
references to API version related change in the API ref to use this
syntax so that it standardised through out the docs, and is more obvious
in the documentation itself.
Change-Id: Ied6f22deecebd71042d2230b81e057543db3d3f4
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
This updates the API root documentation, which was non-existent,
and the Node documentation significantly, replacing many of the samples
and adding more verbiage to each property.
It's not perfect, but this is vastly more correct than the current docs.
Change-Id: Iaeb1c80ac0655fc0d73fa495ed43e3c02b345495
