5ee95b324085bbbb7fbce3b4deb236a3e916a622
Commit Graph

10 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
ff00644cbd Complete Verification of os-virtual-interfaces 
verified the API doc for os-virtual-interfaces,
Also, remove some common error code like 500, 503 etc
Part of bp:api-ref-in-rst
Change-Id: Iaaae9932d27d8fe7db529d101536bcd3dacb33cb
 2016年04月23日 22:31:48 +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
Jenkins
9619136e31 Merge "Fix os-virtual-interfaces and flavors api-ref" 2016年04月20日 02:02:01 +00:00
Jenkins
16cea9cdc5 Merge "Fix json response example heading in api ref" 2016年04月19日 18:01:14 +00: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
Ken'ichi Ohmichi
05e9f0a0e0 Remove 40X and 50X from Normal response codes 
HTTP 40X-50X are not normal response codes at all.
This patch removes them from api-ref.
Part of bp:api-ref-in-rst
Change-Id: I32a29c9e2a3d69720e3a88e17ba36fe45fa902d9
 2016年04月18日 16:56:11 -07:00
jichenjc
6bc51e4d2e Fix os-virtual-interfaces and flavors api-ref 
fix api-sample reference to flavors
make some changes to os-virtual-interfaces so don't talk
about microversion in contents(will add microversion later)
also, fix id param reference
Part of bp:api-ref-in-rst
Change-Id: I6eb8a14fce1c1048506cd5b990576ca5ecf44b6c
 2016年03月23日 22:03:57 +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