5ee95b324085bbbb7fbce3b4deb236a3e916a622
Commit Graph

8 Commits

Author SHA1 Message Date
ghanshyam
26d4c055cc api-ref: verify assisted-volume-snapshots.inc 
This completes the verification of os-assisted-volume-snapshots.inc
for all required area(parameter, example, body)
Part of bp:api-ref-in-rst
Change-Id: I9544e9681bcdd83ca5d2bf6b8722db0a71665b8b
 2016年07月01日 07:23:33 +00:00
csatari
32d45f15dc api-ref: console types. 
Documentation change in api-ref.
type is added to the parameter lists of Get RDP console, Get serial console,
Get SPICE console, Get VNC console.
Closes-Bug: 1587117
Closes-Bug: 1587118
Closes-Bug: 1587119
Closes-Bug: 1587121
Change-Id: I73823fd6fb0886e2fff0da4838fe868f578bba6d
Signed-off-by: csatari <gergely.csatari@nokia.com>
 2016年06月14日 15:58:32 +02: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
Sivasathurappan Radhakrishnan
fcce6781e2 method verification of os-assisted-volume-snapshots 
Verified the API document for os-assisted-volume-snapshots
with source for methods available and response codes.
Part of bp:api-ref-in-rst
Change-Id: I9357377750e7c373c283edd73cbf65ad42c22e66
 2016年05月10日 23:05:30 +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
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