10 Commits

Author SHA1 Message Date
Takashi NATSUME
fc529deaa4 api-ref: Example verification for os-interface.inc
Add an example creating an interface with net_id
and fixed_ips in addition to an example with port_id.
The example and the sample test have been added in
I6b2567db82d000e4b1cdf46020ce1b57103c3f46.

Change-Id: Ia71ecf3dd633409f9bb5156c5e68f6bb878eee71
Implements: blueprint api-ref-in-rst
2016-05-30 10:25:09 +09:00
Takashi NATSUME
0c183948f4 api-ref: Parameter verification for os-interface.inc
Change-Id: I5c72c685b6cb39151e9d0c6c563ef6919a79e249
Implements: blueprint api-ref-in-rst
2016-05-23 12:34:49 +09:00
jichenjc
0e5000887b Complete Method Verification of os-interface
verified the API doc for os-interface, changes sequence of
POST/GET and remove some common error code like 500, 503 etc

Part of bp:api-ref-in-rst

Change-Id: I9d825e278a3f02e397b6258f193e3236f9f499da
2016-04-23 22:54:22 +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
ghanshyam
aa0bb597c6 Fix sample file path for os-i* API
This patch fix sample files path for os-i* APIs

Part of bp:api-ref-in-rst

Change-Id: I0d8de9aaef7ffe5e0dfe09f38246b1f57ac814cb
2016-04-20 11:38:31 +09: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
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