6 Commits

Author SHA1 Message Date
jichenjc
205a91a772 Complete method Verification of consoles
verified the API doc for os-consoles and os-console-auth-token,
Adjust GET/POST sequence in the doc Also,
remove some common error code like 500, 503 etc

Part of bp:api-ref-in-rst

Change-Id: If03d3b23246cc8af639c4a08bb22129937efeaeb
2016-04-25 04:00:05 +08:00
Sean Dague
d929b9fc76 add tags to files for the content verification phase
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
2016-04-20 16:21:58 -04:00
Sean Dague
f208917c52 Fix remaining json reference warnings
This fixes the last json reference warning which exist. It also trims
out the baremetal API calls that we don't support any more (we only
have the readonly proxy). That was erroneously added to the compute
API docs in refactors of api-site last cycle.

Change-Id: I08be639b610304049b0959902ed8876559111274
2016-04-20 08:42:24 -04:00
ghanshyam
90d64f229c Fix sample path for aggregate, certificate, console
This fix all sample file path for
-os-aggregates
-os-certificates
-os-consoles

Part of bp:api-ref-in-rst

Change-Id: I949f3625b7bad4f316ee4b5723fba8e95a205afd
2016-04-20 10:35:37 +09:00
Sean Dague
9526462326 move sphinx h3 to '-' instead of '^'
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
2016-04-15 07:43:06 -04:00
Sean Dague
d4e2771440 Import RST files for documentation
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
2016-04-13 07:34:45 -04:00