Commit Graph

7 Commits

Author SHA1 Message Date
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
703839142d api-ref verify servers-action-deferred-delete.inc
verify the parameters of servers-action-deferred-delete.inc
including response and request.

Part of bp:api-ref-in-rst

Change-Id: Ie91e80c6c8a66095c56b7ccb5bdf6b6e4e4ddc64
2016-05-27 23:57:35 +00:00
Pushkar Umaranikar
d4aeb86c0b Method verification for server-action-deferred-delete
Verify and update the response codes for the API document
servers-action-deferred-delete.inc based on what is in the
code.

part of blueprint: api-ref-in-rst

Change-Id: Id941b2dbdc5cb7aa7cedc9f7233a6bf10a61cf22
2016-05-11 19:41:55 +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
4d421c7151 Fix sample file path for 4 files
This fix sample file path and status code of evacuate

Part of bp:api-ref-in-rst

Change-Id: I3bec0fcf622c0a1c85bbfea53283bd73fd613c75
2016-04-20 15:34:02 +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