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
We currently support /[nodes, ports, portgroups, chassis]/detail as an
API endpoint for getting a detailed list of each object. This does not
fit the RESTful and resourceful API design principles of <resource
type>/<resource id> and makes it hard to consume the API from frameworks
that expect that structure. We can't remove the old endpoint, so that is
safeguarded by the restricted node names list. This patch adds a
?detail=[True, False] query string to the list API endpoints to allow
those consuming the API to use the expected URL form.
Change-Id: I694919b4a4eaa3419318bbee1cde79de15e19afa
Story: #1662921
Task: #10176
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
A portgroup can be identified by a UUID or a name, so we
should be consistent and use 'portgroup_ident' instead of
'portgroup_id' in the API ref. (Similar to how we use
'node_ident'.)
Change-Id: I5b2ddd7e47e02281d62ae90f0e7f4a32af802982
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 change fixes issues pointed out in the last patch set of the
referenced change request.
Apart from that, 406 error code is removed from expected error codes,
as currently .*/portgroups.* resources do not return it.
Change-Id: Ib5fccb3a4d1d2c1c7dd1095b86199536db87da4c
