4 Commits

Author SHA1 Message Date
Vasyl Saienko
77d1537d40 Add VIFs attach/detach to api-ref
This patch updates api-ref documentation with VIF attach/detach
changes that were added in API microversion 1.28.

Closes-Bug: #1582188
Change-Id: I2950a1a356ccb3feb7a4c6335eb95a7a52b3266a
2017-01-18 18:47:38 +00:00
Vasyl Saienko
e7eb1e63c6 Update regenerate-samples.sh api-ref script
When regenerate-samples.sh called values like uuid, created_at,
updated_at, provision_state, power_state are updated automatically.
This patch ensures that they restored to original values to minimize
commit diff, as they are not related to change itself.

Add a waiter to wait for node state after update request to make sure
it was applied.

Removed unused anywhere files:
 * node-set-power-state.json
 * node-states-show-response.json

Change-Id: Iccff575990c9c06b6cc2cb60e93dd962bde46347
2016-12-26 14:21:18 +00:00
Vasyl Saienko
0335e81a87 Add portgroup to api-ref
This patch updates api-ref documentations to reflect
portgroup changes.

Related-Bug: #1618754
Co-Authored-By: Vladyslav Drok <vdrok@mirantis.com>
Change-Id: Id34344df9d3e68efe891c2be4a0b362be6557202
2016-11-16 12:13:53 +02:00
Devananda van der Veen
28a399a13c Update api-ref for v1.22
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
2016-08-21 11:43:30 -07:00