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
Sean Dague
8f4e803634 api-ref: complete verification for diagnostics.inc
This completes the verification for the diagnostics API. As the
response is still dumping out raw hypervisor stats (for compatibility
7529b94f4a/nova/api/openstack/compute/server_diagnostics.py (L38-L44))
the best we can say about the response is it's hypervisor specific and
don't use it.

In future we should use the standardized format that was defined
during the v3 effort.

Part of bp:api-ref-in-rst

Change-Id: Id2cca6a2f79542bec17a34aa3d31924e8ed7b9e5
2016-05-09 16:23:17 -04:00
jichenjc
4478ce8233 Complet Method Verification of server diag
This complete the Method Verification of server diagnostics,
as this is the only method supported.
http://paste.openstack.org/show/495198/ has the method call and return
sample value.

also, clean default policy value and correct some error return code.

Part of bp:api-ref-in-rst

Change-Id: I8e63cdb30e5da34522790f110ecaff79f7577eb1
2016-04-22 15:37:01 +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
jichenjc
17c09561f4 Fix diagnostics, extensions api ref
update those files api-ref

Part of bp:api-ref-in-rst

Change-Id: Id68dbc77011a7414edda5a4855ccbddb204031ac
2016-03-23 19:17:40 +08: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