11 Commits

Author SHA1 Message Date
jichenjc
1e9d82ad20 api-ref: verify os-server-groups.inc
this verify the os-server-groups.inc for sample and body.
Added other minor update for better formatting.

Part of bp:api-ref-in-rst

Change-Id: I00e8c4025310d23244ef0f6a5ed276573ecaea7b
2016-05-02 11:13:20 +08:00
Sean Dague
c9f5ad3bcf remove /v2.1/{tenant_id} from all urls
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
2016-06-03 08:47:33 -04:00
Kevin_Zheng
e7d2a1d1a5 api-ref: parameter verification for os-server-groups
checked parameters

Part of bp:api-ref-in-rst

Change-Id: I32e2da99c797903333447afacd6dbccc89c75603
2016-05-18 09:48:47 +08:00
jichenjc
5ead13913f Complet Method Verification of server group
verified the API doc for os-server-groups,
Also, remove some common error code like 500, 503 etc

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

Part of bp:api-ref-in-rst

Change-Id: I0654ef2e1c937d1328b9ab4c434596035d53e0ee
2016-04-23 10:16: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
jichenjc
356aa087bb Fix os-server-groups.inc
some json reponse/request reference not correct
fix incorrect return value.
Also, change id reference to server_group_id.

Part of bp:api-ref-in-rst

Change-Id: Ia1fc10301dfa35087658d311bec684d43c8e0929
2016-03-24 02:30:28 +08:00
Jenkins
16cea9cdc5 Merge "Fix json response example heading in api ref" 2016-04-19 18:01:14 +00: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
Ken'ichi Ohmichi
05e9f0a0e0 Remove 40X and 50X from Normal response codes
HTTP 40X-50X are not normal response codes at all.
This patch removes them from api-ref.

Part of bp:api-ref-in-rst

Change-Id: I32a29c9e2a3d69720e3a88e17ba36fe45fa902d9
2016-04-18 16:56:11 -07: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