8 Commits

Author SHA1 Message Date
Takashi NATSUME
8e0b98f54e api-ref: Parameter verification for os-simple-tenant-usage.inc
Change-Id: I20adb72e928e8d21696699975953021b38fd31dc
Implements: blueprint api-ref-in-rst
2016-08-04 22:00:26 +00: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
35b0a1236a Complet Method Verification of simple tenant usage
verified the API doc for os-simple-tenant-usage,
remove some common error code like 500, 503 etc

Part of bp:api-ref-in-rst

Change-Id: I90d6899cdb9dc9983fdbfd5156b369ab2fb88226
2016-04-23 01:48:40 +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
Sean Dague
516bd072bc Fix api samples references in 3 more files
This fixes more api samples references which were autogenerated
incorrectly, and brings our api-ref warnings down to 175.

It also removes the os-volume-types API references, which turns out to
be a complete work of fiction, and never existed.

Part of bp:api-ref-in-rst

Change-Id: I1395c5e5986d8810ed91e9c9f132ec04f620497c
2016-04-19 14:08:33 -04: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