10 Commits

Author SHA1 Message Date
Hironori Shiina
7317c17e4e Add API for volume resources to api-ref
This patch adds API for volume resources to api-ref.

Partial-Bug: 1526231
Change-Id: I986860cffd344f5cea9f8f5a2f845f77bf6e9e54
2017-08-02 12:46:36 +00:00
Mark Goddard
02fff930fb Expose ports' physical network attribute in API
In change Ib22753aa6ae0fedce7fb9ecf63f135fda0185c5b the port data model
was updated to include a physical_network field, but this was not
exposed to the user by the REST API. This change exposes the
physical_network field in the REST API.

The port CRUD notification object has been updated to include the
physical_network field.

The API reference and user guide have been updated to include
information about the ports' physical network field.

The API microversion has been bumped to 1.34. During a rolling upgrade
from Ocata when the API service is pinned, the port physical network
field is hidden from API responses, and API requests including the field
are rejected.

Change-Id: I7023a1d6618608c867c31396fa677d3016ca493e
Partial-Bug: #1666009
2017-07-19 17:29:20 +01:00
Ruby Loo
24006badee Remove remaining vendor passthru lookup/heartbeat
Vendor-passthru lookup and heartbeat was mostly removed (in
5eb4ba26ddbde97758511c9b61046e5a879ab66c). This removes the
remaining code and references to them.

Change-Id: I6b214503999ce1892f10f4507a6063b6e8d604bc
Related-Bug: #1640533
2017-05-17 15:03:39 -04:00
wangkf
72abce14b0 Fix typos of filename in api-ref
Typo is fixed and port-list-response.json is updated.

Closes-Bug: 1672358

Change-Id: Iffe385d705e607966ac00455d56aaac85a1a1e69
2017-03-14 19:35:53 +08:00
Mario Villaplana
d33faedbac Update api-ref for dynamic drivers
Updates reference for drivers API as well as nodes API to match the
merged driver composition reform work.

Change-Id: I89a7b1998a858d5c39f21c6653893aa8d7ad15bd
Partial-Bug: 1524745
2017-02-09 19:51:03 +00:00
Naohiro Tamura
3a91dafb1a Add Inject NMI to api-ref
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
2017-01-30 13:59:56 +09:00
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