With cells v2, we need to be clear about what is cells v1 and
what is cells v2 in our documentation. This makes a note in the
os-cells api-ref about that being for cells v1 and also adds a
line saying the entire API is admin-only by default.
Change-Id: I2a06e2c4921ce7172aab33818054dd37b5ef9a65
A number of endpoints enable pagination via 'limit' & 'offset' query
parameters, but don't document or test this functionality.
- os-cells
- os-security-groups
- os-server-groups
- os-snapshots
- os-virtual-interfaces
- os-volume-attachments
- os-volumes
Change-Id: I5b0ad25f7282f4a13bbb6f21b76e986e1008936a
Confirm and correct list methods and response codes in os-cells.
This is mostly just checking, correcting and adding methods, but
in the process of doing that it became clear that there was quite
a bit missing so several TODO notes have been left in place so that
the next stages of work are a bit more obvious.
* 405 has been removed everywhere as we don't send that response
* 400 badRequest is required anywhere, as that's what you'll get if
tenant_id does not match the context's project_id
* 503 does not happen as there's no application controlled proxying
in this api
* the URL for listing cells with details was incorrect
* the example response for cells with details was an empty list,
this is now a todo suggesting an as yet non-existent file
* capacities was not listed, now is
* not clear what capacities really are, so a TODO
* creating a new cell (via POST) was not there, so that is now added
as a method
* for that POST, request and response bodies, parameters currently a
TODO
* Update (PUT) and DELETE of a cell has been added, but details are TODO
Part of bp:api-ref-in-rst
Change-Id: I3f123f821820e5a5a4deff61fb716d43dc486142
As discussed at summit, the version part of the URL is not really
relevant, or a thing a user should be filling out themselves, this
should instead be set by the service catalog and extracted from the
token.
This removes it's reference in all documented REST urls, and adds a
new section describing how one gets the base URL for all calls.
Change-Id: I4306b8c3de0225e54f3909dd8a1fb293c4e5944c
This adds a set of tags in comments to the beginning of files so that
we can process them according to the documentation here:
https://wiki.openstack.org/wiki/NovaAPIRef
Part of bp:api-ref-in-rst
Change-Id: I17cf584dafb5bd969c12f51b7e7185d92365bf93
This patch fix API ref for correct sample files and status code
for below APIs
- os-cells
- os-cloudpipe
- server-action-shelve
Part of bp:api-ref-in-rst
Change-Id: I6292f78742d7bb50882e186c97e7966721037ba4
Heading for json response example is wrong,
it is json request instead of json response.
Part of bp:api-ref-in-rst
Change-Id: I709b2bf19520eb76e0264c358a2146bb0dbcee2b
In the sphinx document h3 is supposed to be '-' not '^':
=, for sections
-, for subsections
^, for subsubsections
We have to enforce consistency here because we're processing included
files which all have to agree, otherwise it's a sphinx error.
Part of bp:api-ref-in-rst
Change-Id: Ic6eef5cacb07870f161b04b031e332f2b87aeedc
This is the results of the RST conversion from WADL. It creates a
single index plus a bunch of included files which represent sections
of the API document. This is the starting point for fixing the
documentation.
Change-Id: I7d561c2ecdcd864172dedb54a551f17ad3bdfe26