Commit Graph

10 Commits

Author SHA1 Message Date
Takashi NATSUME 9d41696515 Fix white spaces in api-ref
TrivialFix
Change-Id: Icd7cd923522b6d97e19c89ad417eb5560649f6ba
2016-06-06 12:04:54 +09: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
jichenjc 6a06c62c43 verify api-ref metadata.inc
verify metadata.inc include its reposne, sample
and body.

Part of bp:api-ref-in-rst

Change-Id: I8221fa29b9a2649ec4266c9ab60bf3398d9f91b2
2016-04-29 18:42:28 +08:00
jichenjc b6fed91bdc Complete Verification of server-metadata
verified the API doc for server-metadata,
remove some common error code like 500, 503 etc

Part of bp:api-ref-in-rst

Change-Id: Ice8776d559b7f8770a86039d1ce0f316fd55899c
2016-04-25 20:09:31 +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
Jenkins 66d38b1692 Merge "Fix api ref for ips, limits, metdata and agent" 2016-04-19 22:29:53 +00:00
ghanshyam d8f9d2328e Fix api ref for ips, limits, metdata and agent
This patch fix API ref for correct sample files and status code
for below APIs
- ips
- limits
- server metadata
- agents

Part of bp:api-ref-in-rst

Change-Id: I91b769eefde78381dc0feb6b5c8c6cf753203732
2016-04-19 19:32:48 +09: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