13 Commits

Author SHA1 Message Date
Karen Bradshaw
168a500570 API Ref: update server_id params
- Update server_id params to be of type path.
- Cleaned up os-getConsoleOutput action string.
- Made empty response body description more consistent.
  Review and change as needed.

Implements: bp/api-ref-in-rst-ocata

Change-Id: Ie1e299d2b93188240b18138eba9f5b908a1078a4
2016-11-11 14:01:51 -05:00
ghanshyam
b343e96fb4 Correct address, version parameter in ips.inc
'osapi_hide_server_address_states' does not hide the
address field in server/ips APIs so address paramater
for this API is wrong and this commit fis the same.

Also fixing the 'version' parameter.

Partially implements blueprint api-ref-in-rst

Change-Id: I22d6ab97d14779fe3a32c23a5148b4eb59f1034f
2016-09-13 05:52:39 +00:00
jichenjc
cdd5d44370 api-ref: body verification of ips.inc
this verify the ips.inc including some mior changes on blank lines.

part of bp:api-ref-in-rst

Change-Id: Ida6d4b354e4e17dc8bd1677149d0eecc6b82d7e1
2016-05-02 01:49:27 +08: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
Gage Hugo
22a7d30541 api-ref: ips.inc example verification
Part of bp:api-ref-in-rst

Change-Id: I922209101fdaf4a00ee22ffb028650f3426aa116
2016-05-13 11:07:18 -05:00
Augustina Ragwitz
f7e4018a96 api-ref: ips.inc parameter verification
Part of bp:api-ref-in-rst

Change-Id: I929c186c3681b15b7e4c488ce81685deffde7ef0
2016-05-11 14:20:55 -07:00
jichenjc
96e9d88026 Complete Method Verification of ips
This complete the Method Verification of ips,
also, clean and correct some error return code.

Part of bp:api-ref-in-rst

Change-Id: I7eaee7f373edbaa00fdd599a44b587b1a3f49552
2016-04-25 11:29:25 +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
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
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