5 Commits

Author SHA1 Message Date
jichenjc
ffee1b3444 Complet Method Verification of availability-zone
verified the API doc for os-availability-zone, Added
one description for default policy
Also, remove some common error code like 500, 503 etc

detail log: http://paste.openstack.org/show/495423/

Part of bp:api-ref-in-rst

Change-Id: Icb898f0482e8a17289cd5047ef1c64a2481ccabb
2016-04-23 01:56:55 +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
jichenjc
fb7b7e7f95 Fix hosts and az api samples
Those 2 files has incorrect api samples, this patch fixs it.

Part of bp:api-ref-in-rst

Change-Id: I71033531fefdb27b191a3a5abb3cba6fbb48b6c1
2016-03-23 13:58:30 +08: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