5 Commits

Author SHA1 Message Date
Sean Dague
549fe62bba api-ref: perform all 4 phases of verification for action console output
This provides the verification of the action console output.

* Return codes updated based on what's in the code
* Parameters fixed (length -1 is not actually a thing, it's suggestion
  for future enhancement; console output described; server_id should be in path).
* Add preamble for request example
* Clean up language on preamble

Part of bp:api-ref-in-rst

Change-Id: I7071a1e528b0aa8df16589facee4ed4fd62f7b4b
2016-05-09 16:48:34 -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
Kevin_Zheng
f6592c94fd Fix api sample references in 2 more files.
The api sample reference is not correct
fix incorrect return value.

1. servers-action-console-output.inc
2. servers-action-crash-dump.inc

Part of bp:api-ref-in-rst

Change-Id: Id0d946478a6a59f63f22117944309d3eb66013d3
2016-04-19 20:32:58 +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