[openstack-dev] [nova] Autogenerating the Nova v3 API specification

Doug Hellmann doug.hellmann at dreamhost.com
Mon Aug 12 13:45:31 UTC 2013

On Mon, Aug 5, 2013 at 10:36 AM, Christopher Yeoh <cbkyeoh at gmail.com> wrote:

> On Mon, 5 Aug 2013 14:55:15 +0100
> John Garbutt <john at johngarbutt.com> wrote:
> > Given we seem to be leaning towards WSME:
> >
> http://lists.openstack.org/pipermail/openstack-dev/2013-August/012954.html
> >
> > Could we not try to make WSME give us the documentation we need?
> >
> > Not sure if its feasible, but it seems like there is a good start to
> > that already available:
> > https://wsme.readthedocs.org/en/latest/document.html
> Hrm its not clear from there how the API samples are generated.

Each type declared for the API has a class method to instantiate a sample
object. That object is then passed through the appropriate serializer (XML
or JSON). reST directives embedded in our Sphinx docs trigger the
conversion and render to HTML now, but we'll need to build something
similar to generate standalone files for use with the DocBook-based


> But more generally I have a concern with making having a specification
> for the V3 API dependent on getting WSME merged - since I think its a
> reasonably big chunk of work and certainly won't land until sometime in
> the icehouse timeframe. In the meantime without some automation of the
> process its likely we won't have a V3 API spec as there are around 60
> extensions (with all their methods) to document.
> Regards,
> Chris
> _______________________________________________
> OpenStack-dev mailing list
> OpenStack-dev at lists.openstack.org
> http://lists.openstack.org/cgi-bin/mailman/listinfo/openstack-dev
-------------- next part --------------
An HTML attachment was scrubbed...
URL: <http://lists.openstack.org/pipermail/openstack-dev/attachments/20130812/5cfe4dbf/attachment.html>

More information about the OpenStack-dev mailing list