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
The Show Server Details returns fault field in the failed
responses. This patch adds the fault field to the response
parameter table.
Change-Id: I413a098061eb58ba70b3a18d646398dfdac590aa
Closes-Bug: #1545972
Just found when the marker can't be found, we won't return 404,
instead of we will return 400. This patch removes the 404 code from
list and details doc.
Part of bp:api-ref-in-rst
Change-Id: I03e76a3a45f2d59c8fb01610cbd751d5b91f5964
This updates all the v2.1 parameters for servers, as well as some of
the microversions added parameters. It makes us more accurate than the
existing api-site.
This specificially *does not* include the additional response
parameters for microversions > 2.1 (tags, ext attrs for ec2, etc).
Part of bp:api-ref-in-rst
Change-Id: Ic03c0e6486a300c3cd724b798850dedeae014faf
Update the response codes for the methods based on what is in the
code. This follows the pattern of updating these error codes when
doing method verification that jichen has been doing.
Some notes are left for the body_verification phase later, as that is
going to take a while for this file.
Part of bp:api-ref-in-rst
Change-Id: I8d8bd09f72572caed1a45fa23f95a15d330c2f26
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
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
This updates servers.inc which had a rough path during conversion. The
GET servers/details was lost entirely.
It updates a number of parameters to distinguish ones that are only in
the queries, as well as fixes references to short names that collided.
It updates the UPDATE call to only specify request parameters which
you can actually update.
It introduces the notation object.field for parameters that are
embedded in other objects. This is a new concept, but one way we can
clear up that the uuid in the parameter list is really networks.uuid.
It also deletes the old hand rolled servers.rst, which drops the
warnings count by nearly 100.
Part of bp:api-ref-in-rst
Change-Id: Ie7693a5888efa913118244a0837e6c0177965d48
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
Sean Dague