<div dir="ltr"><br><div class="gmail_extra"><br><br><div class="gmail_quote">On Sat, Jul 6, 2013 at 5:41 AM, Tom Fifield <span dir="ltr"><<a href="mailto:tom@openstack.org" target="_blank">tom@openstack.org</a>></span> wrote:<br>

<blockquote class="gmail_quote" style="margin:0px 0px 0px 0.8ex;border-left-width:1px;border-left-color:rgb(204,204,204);border-left-style:solid;padding-left:1ex">Documentationeers,<br>
<br>
You have probably seen the discussions on the development mailing list regarding the nova v3 API. It brings some significant and exciting changes that we obviously need to document and share with the world :)<br>
<br>
Yesterday, I had the opportunity to chat with Chris Yeoh, who's been spearheading the effort, about what it's going to take to document nova V3 properly.<br>
<br>
Chris, like many, is a fan of our api reference (however, noting that incompleteness makes people sad :|), and is keen to see it succeed.<br></blockquote><div><br></div><div style>Incompleteness for Compute? Or is it that Identity v2 and v2 are in the process of being added? Or? Anything else missing? Need bug references. :)</div>

<div> </div><blockquote class="gmail_quote" style="margin:0px 0px 0px 0.8ex;border-left-width:1px;border-left-color:rgb(204,204,204);border-left-style:solid;padding-left:1ex">
<br>
After walking through how the API reference document is produced right now, our conclusion is that to properly write up the nova V3 API is going to be "a lot of work".<br>
<br>
As such, I'd like to start a discussion about our methodology for producing the API reference document, and possible ways we can improve it, potentially remove some of the manual steps, and integrate some of the changes nova has made in its sample file generation.<br>

</blockquote><div><br></div><div style>I've been liking the Swagger API standard. Is there interest in investigating? </div><div style><br></div><div style><a href="https://github.com/wordnik/swagger-core/wiki">https://github.com/wordnik/swagger-core/wiki</a><br>

</div><div> </div><blockquote class="gmail_quote" style="margin:0px 0px 0px 0.8ex;border-left-width:1px;border-left-color:rgb(204,204,204);border-left-style:solid;padding-left:1ex">
<br>
For your reference, Anne has a blog post on how the API site is made here: <a href="http://justwriteclick.com/2013/04/14/how-its-made-the-openstack-api-reference-page/" target="_blank">http://justwriteclick.com/<u></u>2013/04/14/how-its-made-the-<u></u>openstack-api-reference-page/</a><br>


<br>
Over to y'all - I will post collected thoughts in a while :)<br>
<br>
<br>
Regards,<br>
<br>
<br>
Tom<br>
<br>
______________________________<u></u>_________________<br>
Openstack-docs mailing list<br>
<a href="mailto:Openstack-docs@lists.openstack.org" target="_blank">Openstack-docs@lists.<u></u>openstack.org</a><br>
<a href="http://lists.openstack.org/cgi-bin/mailman/listinfo/openstack-docs" target="_blank">http://lists.openstack.org/<u></u>cgi-bin/mailman/listinfo/<u></u>openstack-docs</a><br>
</blockquote></div><br><br clear="all"><div><br></div>-- <br>Anne Gentle<br><a href="mailto:annegentle@justwriteclick.com" target="_blank">annegentle@justwriteclick.com</a>
</div></div>