7 Commits

Author SHA1 Message Date
Steve Baker
50657a87df Complete the REST API POST documentation
This change adds missing POST request parameters and makes other minor
corrections to the REST API documentation.

Its possible that some of the parameters for /v1/nodes were never
intended to be available for the POST call, but this docs change is to
document what has been implemented, not the original intention.

Change-Id: I1e35586d20bd3eda4d727931235340dd408c7508
2020-12-16 11:14:37 +13:00
Dongcan Ye
e2899de09d Fix list node vifs api error
The node_ident param should in Request, this patch fix it.

Change-Id: Id70533ff75e0f7b7930725fd74428c390321b98d
2018-07-03 11:23:25 +00:00
shuangyang.qian
d0dca903df Modify the Ironic api-ref's parameters in parameters.yaml
Separate parameter identifiers in case when a parameter
is required in the request or response.
This patch adjusts the relevant *.nic file to fix the problem.

Change-Id: Ie2c8cae2280fc1e92a5e6f3fef4f2783a12a2c3f
Story: #1651775
Task: #10160
2018-06-14 10:45:48 +08:00
shuangyang.qian
ff0970f308 Make the api format correctly
make the format of the api:"Detach VIF from
a node" normally and add the Request header
of the parameters' table.

Change-Id: Ica77a99439d9819f629c7f64c2906e5aa2cb5ddc
2017-11-08 19:00:39 +08:00
Sam Betts
bca44bcefc Switch API ref to use versionadded syntax throughout
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
2017-09-05 17:27:24 +01:00
Jim Rollenhagen
eae8e07132 Fix api-ref warnings
A few missing parameters breaking the build on latest api-ref package,
fix them.

Change-Id: I7769844b8a766c78418c28991b97827014886ec4
Closes-Bug: #1658187
2017-01-20 20:30:09 +00: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