Commit Graph

10 Commits

Author SHA1 Message Date
Chen Fan f27a0e7ccc api-ref: unify the no response output in delete operation
Change-Id: Ia90a5ef1cd1b432e68130313960a015b45fe63e0
Implements: blueprint api-ref-in-rst
2016-07-25 16:13:45 +08:00
Radoslav Gerganov 3c3925e71a Fix ConsoleAuthTokens to work for all console types
The current API allows getting connection info only for tokens which
correspond to RDP consoles. It should work for all types of tokens. This
patch introduces a new microversion which fixes this problem.

APIImpact

blueprint fix-console-auth-tokens

Change-Id: I27a65e0cd8b5eb51ecdc84cbf310ae107ff131dc
2016-06-22 17:11:09 +03: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
Karen Bradshaw a29c26308e api-ref: os-consoles.inc
-Verified methods, examples, parameters, body text.
-Added console, consoles parameters.

Part of blueprint api-ref-in-rst

Change-Id: Ifd0b751e521a96ec82c78cd6354055d315596038
2016-05-30 15:13:15 +08:00
jichenjc 205a91a772 Complete method Verification of consoles
verified the API doc for os-consoles and os-console-auth-token,
Adjust GET/POST sequence in the doc Also,
remove some common error code like 500, 503 etc

Part of bp:api-ref-in-rst

Change-Id: If03d3b23246cc8af639c4a08bb22129937efeaeb
2016-04-25 04:00:05 +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 f208917c52 Fix remaining json reference warnings
This fixes the last json reference warning which exist. It also trims
out the baremetal API calls that we don't support any more (we only
have the readonly proxy). That was erroneously added to the compute
API docs in refactors of api-site last cycle.

Change-Id: I08be639b610304049b0959902ed8876559111274
2016-04-20 08:42:24 -04:00
ghanshyam 90d64f229c Fix sample path for aggregate, certificate, console
This fix all sample file path for
-os-aggregates
-os-certificates
-os-consoles

Part of bp:api-ref-in-rst

Change-Id: I949f3625b7bad4f316ee4b5723fba8e95a205afd
2016-04-20 10:35:37 +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