6 Commits

Author SHA1 Message Date
jichenjc
5b9a51af72 Complete method Verification of os-hypervisors
verified the API doc for os-hypervisors,
added policy description as this is admin action by default,
Also, remove some common error code like 500, 503 etc

Part of bp:api-ref-in-rst

Change-Id: Ic81eac06cb238d0940feac41940433f9e3befc29
2016-04-25 19:58:53 +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
f03a3a5be4 Update 'os-hypervisors.inc' in api-ref
some changes including:
1) update the wrong reference link to json file
2) Add /v2.1/{tenant_id}/os-hypervisors/detail
3) Add /v2.1/{tenant_id}/os-hypervisors/{hypervisor_id}/search
4) Add /v2.1/{tenant_id}/os-hypervisors/{hypervisor_id}/servers

Part of bp:api-ref-in-rst

Change-Id: I73fbf4583cd75afb2f60c57acd1bdb179f86a9e9
2016-03-24 02:42:03 +08:00
ghanshyam
6f8cda2f39 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
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