04de167e379bc47ea1bff07c98f0dd785cf328f3
Commit Graph

11 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
Jenkins
0cd418ed3e Merge "api-ref: Fix parameters in servers-action-shelve.inc" 2016年05月18日 13:25:18 +00:00
Takashi NATSUME
03c1161fcb api-ref: Example verification for servers-action-shelve.inc
The example string for each action (null) has been verified.
Change-Id: Id90ef732698ab2af800d7f2bcb1c766f1879e925
Implements: blueprint api-ref-in-rst
2016年05月18日 14:02:11 +09:00
Takashi NATSUME
7d56f8982c api-ref: Fix parameters in servers-action-shelve.inc
The server_id should be a path parameter instead of
a body parameter.
TrivialFix
Change-Id: Ic43b8cbbad580c77d02bebb2296e4cb8ed9acc80
2016年05月18日 11:16:16 +09:00
Karen Bradshaw
0d4127aac9 api-ref: servers-action-shelve.inc
-Fixed headers to match method names.
-Verified methods and content.
-Verified parameters in parameters.yaml.
-Removed empty response sections and added
 a line between request param table and example.
-Todo: verify the example string for each action (null).
Change-Id: I611cef4949856ceb9be19af670401cb90a4eddbf
2016年05月11日 08:45:51 -04:00
He Jie Xu
6939da33e3 Complete method verification of os-shevle
Correct the error status responses for os-shelve's methods
Part of bp:api-ref-in-rst
Change-Id: Id917c0a8bfde655ef4ca875eed5d54e82778b040
2016年05月09日 11:08:13 +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
11a79609e3 modify duplicate // to / in doc
Part of bp:api-ref-in-rst
Change-Id: I1da87f0e8f0a6b45d60be58af2d13c8a236469d3
2016年03月24日 05:01:06 +08:00
Kevin_Zheng
f774d03b6f Fix api ref for os-cells, os-cloudpipe and server-action-shelve
This patch fix API ref for correct sample files and status code
for below APIs
- os-cells
- os-cloudpipe
- server-action-shelve
Part of bp:api-ref-in-rst
Change-Id: I6292f78742d7bb50882e186c97e7966721037ba4
2016年04月19日 13:08:49 +00: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