openstack/nova - nova - OpenDev: Free Software Needs Free Tools

Found that docs about server metadata is quite
hard to understand, made some modifications to
be more readable.
Change-Id: If74dc383149068f2c568482c78e6db1e19f7d3af

- Update server_id params to be of type path.
- Cleaned up os-getConsoleOutput action string.
- Made empty response body description more consistent.
 Review and change as needed.
Implements: bp/api-ref-in-rst-ocata
Change-Id: Ie1e299d2b93188240b18138eba9f5b908a1078a4

TrivialFix
Change-Id: Icd7cd923522b6d97e19c89ad417eb5560649f6ba

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

verify metadata.inc include its reposne, sample
and body.
Part of bp:api-ref-in-rst
Change-Id: I8221fa29b9a2649ec4266c9ab60bf3398d9f91b2

verified the API doc for server-metadata,
remove some common error code like 500, 503 etc
Part of bp:api-ref-in-rst
Change-Id: Ice8776d559b7f8770a86039d1ce0f316fd55899c

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
- ips
- limits
- server metadata
- agents
Part of bp:api-ref-in-rst
Change-Id: I91b769eefde78381dc0feb6b5c8c6cf753203732

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