14 Commits

Author SHA1 Message Date
zhoujunqiang
04de167e37 api-ref: body verification of os-agents
part of bp:api-ref-in-rst

Change-Id: Ie82a63b0544c155e1e262f0f775f3da1bc412a06
2016-07-08 02:03:07 +00:00
Takashi NATSUME
ba71b8d9ab api-ref: Example verification for os-agents.inc
Currently only 'xen' is supported for the 'hypervisor'
parameter. So examples are changed to 'xen'
instead of 'hypervisor'.

Change-Id: Ibd40dcfd3801c7a4165e299a1232ea46f2f17cf4
Implements: blueprint api-ref-in-rst
2016-06-27 21:29:26 +09:00
Ronald Bradford
0d450c4695 api-ref: parameter verification os-agents
Change-Id: I7e319ec05489d87cdd5b4a486f3981fc8d8f90a9
2016-06-21 13:48:58 -04: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
Ronald Bradford
a91d24e536 Complete method verification of os-agents
Verified the API document for os-agents with source for methods
available and response codes used.
Recorded HTTP methods to match wiki.

Part of bp:api-ref-in-rst

Change-Id: Ia601f26741ebb4b60e9e9ea4c9b8ba5c260896fe
2016-05-06 13:45:46 -04: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
1555736e3c Final warnings removals for api-ref
This removes the final warnings from the api-ref code base, and flips
the sphinx switch to enforce warnings as errors.

It also adds code to the rest_parameters extension to make it more
clear where a problem is when it comes to included parameters. This
puts us in a place where we can start doing the file per file look at
content.

Part of bp:api-ref-in-rst

Change-Id: Ic2c99d96d6addcafa00b9f16785c2fe59b1798d3
2016-04-20 11:25:30 -04:00
He Jie Xu
469771a3b5 Fix the parameters for os-agents API
* Add notes for API bug: update return string type's agent id
* Fix the parameters for create agent
* Fix the description of agent id in the update url.

Part of bp:api-ref-in-rst

Change-Id: I5c102ef8a08123089ec4a85dde5716eda12fb8c7
2016-04-20 10:23:47 +08:00
Jenkins
66d38b1692 Merge "Fix api ref for ips, limits, metdata and agent" 2016-04-19 22:29:53 +00:00
ghanshyam
d8f9d2328e Fix api ref for ips, limits, metdata and agent
This patch fix API ref for correct sample files and status code
for below APIs
- ips
- limits
- server metadata
- agents

Part of bp:api-ref-in-rst

Change-Id: I91b769eefde78381dc0feb6b5c8c6cf753203732
2016-04-19 19:32:48 +09: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
93e3784a6e Fix "Creates an agent build" parameters
"Creates an agent build" API supports multiple parameters on a request,
but api-ref doesn.t contain them at all This patch adds them.

The following JSON-Schema is for the API.
https://github.com/openstack/nova/blob/master/nova/api/openstack/compute/schemas/agents.py#L21

Part of bp:api-ref-in-rst

Change-Id: I4b026f691711b11c1918785dff89bf5196c7177d
2016-04-15 14:33:53 -07: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