9 Commits

Author SHA1 Message Date
Takashi NATSUME
319656dd11 api-ref: Verify parameters in os-migrations.inc
Change-Id: I6baeecc4c2d62c3c39d856f5b659cb986a00b724
Implements: blueprint api-ref-in-rst-pike
Closes-Bug: #1668747
2017-07-18 00:38:40 +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
a7dde84ba1 verify api-ref os-migrations.inc
verify the parameters of os-migrations.inc including response and
request. And, add warning for deprecation and incorrect wording of
policy default rule.

looks like the new migration is missing in doc, follow up patch will
add it.

Part of bp:api-ref-in-rst

Change-Id: I8fed7374c34c5c857c8c55f56f86ad4c744844e9
2016-06-01 11:12:08 +00:00
Sujitha
f8870c6d26 Complete method verification of os-migrations
Corrects the error status responses for os-migrations

Part of bp:api-ref-in-rst

Change-Id: Ia4aa0e6378e1b327fb75b2f630279b35835ba095
2016-05-09 22:10:24 +00: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
ghanshyam
1d6cd1277b Fix content and sample file for keypair, migration, networks
This fix some content and sample file path for:
-os-keypairs
-os-migrations
-os-networks

Part of bp:api-ref-in-rst

Change-Id: I6ae6d38207c5a9552bab9a42b2800449e4ad040a
2016-04-20 12:03:04 +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