1) Use https instead of http for docs links
2) Update doc links according to OpenStack document migration
Change-Id: Ib9b2fa3b699de361d47aa80d07cdf76b7a1eb143
This patch adds following:
- Updates ironic state documentation with rescue related states
- Updates api-ref with rescue interface fields introduced in
API version 1.38
Co-Authored-By: Mario Villaplana <mario.villaplana@gmail.com>
Co-Authored-By: Aparna <aparnavtce@gmail.com>
Co-Authored-By: Shivanand Tendulker <stendulker@gmail.com>
Partial-Bug: 1526449
Change-Id: Ifcfa52ede62894b1990aaa640944be3431ddfe8f
This updates the description of the
'PUT /v1/nodes/{node_ident}/states/power' request to mention that
Bare Metal API version 1.27 was when:
- the 'timeout' parameter was added
- the 'soft power off' and 'soft rebooting' values were made available
for the 'target' parameter
Change-Id: I1c720a2dd15eab1246ad672b9d7f2b8708ceec0b
Previously, the configdrive could only be set when setting
the node's provisioning state to "active". When rebuilding,
the old configdrive was used and therefore was never updated
with latest content.
This change introduces the API microversion 1.35 which will allow
configdrive to be provided when setting the node's provisioning state
to "rebuild".
Closes-bug: #1575935
Change-Id: I9a5529f9fa796c75621e9f4354886bf3032cc248
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 patch updates api-ref documentation with soft reboot, soft power
off and power timeout that were added in API microversion 1.27.
Partial-Bug: #1526226
Change-Id: I9b17da3e5e02f7e3de0c5c2b3dec1e81bf642391
This patch updates api-ref documentation with Inject NMI (Non-Masking
Interrupts) that were added in API microversion 1.29.
Partial-Bug: #1526226
Change-Id: I5003abcfd9a79751f40964c5bd5cb0bd550ba89d
This patch is removing a trailing backtick (`) from the
baremetal-api-v1-node-management.inc document.
Change-Id: Ie1a8c0d15f169287d5b5d6b7cd5b190e87345869
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
