7 Commits

Author SHA1 Message Date
Sean Dague
e86dd6ae91 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
ghanshyam
863ab31f73 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
Jenkins
6a9e664ac0 Merge "Fix json response example heading in api ref" 2016-04-19 18:01:14 +00:00
ghanshyam
c8d73cc0be Fix json response example heading in api ref
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
2016-04-19 17:56:20 +09:00
Ken'ichi Ohmichi
9ea364321e Fix "Creates an aggregate" parameters
"Creates an aggregate" API supports multiple parameters on a request,
but api-ref doesn.t contain them at all This patch adds them.

The following JSON-Schema is for the API.
https://github.com/openstack/nova/blob/master/nova/api/openstack/compute/schemas/aggregates.py#L32

Part of bp:api-ref-in-rst

Change-Id: I3a58568662d21059bccdcf64cc30dbf3b706db58
2016-04-18 14:25:24 -07:00
Sean Dague
fea8e01552 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
1b0c6559e3 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