Commit Graph

6 Commits

Author SHA1 Message Date
Matt Riedemann ad739f8e13 api-ref: parameter validation for os-security-group-rules
Cleans up a bunch of the types and descriptions for the
parameters.

Removes some extraneous unused parameters.

Added descriptions for the request and response to point out
that group_id and cidr are optional but one or the other is
required and depending on what comes in the request influences
what comes back in the response.

Part of blueprint api-ref-in-rst

Change-Id: I1084fa7ec46373cc989d1d93bb667ac59a62e38a
2016-05-11 11:23:40 -04:00
Ronald Bradford 3860d7e671 Complete method verification of os-security-group-rules
Verified the API document with source for methods available and
response codes used.

Part of bp:api-ref-in-rst

Change-Id: I7e332f1b18083a7d5edb07d7fb65b3757bea131a
2016-05-10 10:12:48 +00: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 c52b7c6a9e fix samples references in security group files
This fixes the samples references in the security group files,
commenting out 2 that don't exist at all.

This drops the warnings to 145 against current master.

Part of bp:api-ref-in-rst

Change-Id: I0cb9932dc54cdffcbd9eda274a06d708e87409d8
2016-04-19 14:08:33 -04: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