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 |
||
---|---|---|
.. | ||
api-root-response.json | ||
api-v1-root-response.json | ||
chassis-create-request.json | ||
chassis-list-details-response.json | ||
chassis-list-response.json | ||
chassis-show-response.json | ||
chassis-update-request.json | ||
chassis-update-response.json | ||
driver-get-response.json | ||
driver-logical-disk-properties-response.json | ||
driver-passthru-methods-response.json | ||
driver-property-response.json | ||
drivers-list-response.json | ||
lookup-node-response.json | ||
node-create-request.json | ||
node-create-response.json | ||
node-get-boot-device-response.json | ||
node-get-state-response.json | ||
node-get-supported-boot-devices-response.json | ||
node-maintenance-request.json | ||
node-port-detail-response.json | ||
node-port-list-response.json | ||
node-set-active-state.json | ||
node-set-available-state.json | ||
node-set-boot-device.json | ||
node-set-clean-state.json | ||
node-set-manage-state.json | ||
node-set-power-off.json | ||
node-set-power-state.json | ||
node-set-raid-request.json | ||
node-show-response.json | ||
node-states-show-response.json | ||
node-update-driver-info-request.json | ||
node-update-driver-info-response.json | ||
node-update-driver.json | ||
node-validate-response.json | ||
node-vendor-passthru-response.json | ||
nodes-list-details-response.json | ||
nodes-list-response.json | ||
port-create-request.json | ||
port-create-response.json | ||
port-list-detail-response.json | ||
port-list-respone.json | ||
port-list-response.json | ||
port-update-request.json | ||
port-update-response.json |