Update the api-ref documentation for the /v1/lookup API, so that
it mentions the node fields that are returned. It does not return
the configdrive value (that is bleeped out in the response).
Change-Id: I24a47a2cfefc582bd0b5f1f0068e89a3091cf397
This patch enables receiving agent_version as part of heartbeat, and
stores this information on driver_internal_info. This is so that Ironic
can dynamically adjust which features and parameters it uses based on
which version of the agent is being used.
Change-Id: I400adba5d908b657751a83971811e8586f46c673
Partial-Bug: #1602265
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
Vendor-passthru lookup and heartbeat have been removed (in
5eb4ba26ddbde97758511c9b61046e5a879ab66c). This removes references
to them.
Change-Id: I3565999f129cf88c2aa5f04bbf27eaa0da6dc588
Related-Bug: #1640533
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
