<div dir="ltr"><div class="gmail_extra"><div class="gmail_quote"><blockquote class="gmail_quote" style="margin:0 0 0 .8ex;border-left:1px #ccc solid;padding-left:1ex"><div class="gmail_extra"><div class="gmail_quote"><blockquote class="gmail_quote" style="margin:0 0 0 .8ex;border-left:1px #ccc solid;padding-left:1ex"><div dir="ltr"><br></div></blockquote></div></div>---------- Forwarded message ----------<br>From: michael mccune <<a href="mailto:msm@redhat.com">msm@redhat.com</a>><br>To: <a href="mailto:openstack-docs@lists.openstack.org">openstack-docs@lists.openstack.org</a><br>Cc: <br>Date: Tue, 23 Feb 2016 16:34:58 -0500<br>Subject: Re: [OpenStack-docs] [api] displaying useful docs from Swagger files<br>On 02/23/2016 11:49 AM, Anne Gentle wrote:<br>
<blockquote class="gmail_quote" style="margin:0 0 0 .8ex;border-left:1px #ccc solid;padding-left:1ex">
As an idea of what I would consider "code complete" for the migration:<br>
1. All services WADL files migrate without any errors in the<br>
gate-build-swagger<br>
<<a href="http://logs.openstack.org/57/281657/1/check/gate-build-swagger/993145e/" rel="noreferrer" target="_blank">http://logs.openstack.org/57/281657/1/check/gate-build-swagger/993145e/</a>> job.<br>
Currently the Networking API files have the most errors and the team is<br>
looking into it. I've been logging bugs when the tool finds errors when<br>
migrating WADL.<br>
2. All current HTML pages on <a href="http://developer.openstack.org/api-ref.html" rel="noreferrer" target="_blank">developer.openstack.org/api-ref.html</a><br>
<<a href="http://developer.openstack.org/api-ref.html" rel="noreferrer" target="_blank">http://developer.openstack.org/api-ref.html</a>> can be redirected.<br>
</blockquote>
<br>
this sounds reasonable to me.<br></blockquote><div> </div><div>----- Do you plan to include, on <a href="http://developer.openstack.org">developer.openstack.org</a>, only services that have been migrated from WADL/DocBook or additional services that may have a valid swagger file? </div><div> </div><blockquote class="gmail_quote" style="margin:0 0 0 .8ex;border-left:1px #ccc solid;padding-left:1ex">
<blockquote class="gmail_quote" style="margin:0 0 0 .8ex;border-left:1px #ccc solid;padding-left:1ex">
<br>
However, defining "good enough" for the fairy-slipper display and<br>
interaction piece is more complex. So I believe an interim solution that<br>
migrates the WADL and gets off of WADL and clouddocs-maven-plugin for<br>
builds is a good way forward.<br>
<br>
What do you all think? Karen, Russell, and Mike McCune I'd definitely<br>
like your input.<br>
</blockquote>
<br>
i like this as an interim solution. getting the swagger converted to flat html which can be display will at least get us closer to the ultimate goal.<br>
<br></blockquote><div>----- Agreed.  I tried the node app that generates html files from swagger files.  It would provide an immediate path to generate static html.</div><div>Thanks!</div><div>Karen</div><div> </div><blockquote class="gmail_quote" style="margin:0 0 0 .8ex;border-left:1px #ccc solid;padding-left:1ex">
thanks for all the work on this Anne!<br>
<br>
regards,<br>
mike<br>
<br>
<br>
<br>_______________________________________________<br>
OpenStack-docs mailing list<br>
<a href="mailto:OpenStack-docs@lists.openstack.org">OpenStack-docs@lists.openstack.org</a><br>
<a href="http://lists.openstack.org/cgi-bin/mailman/listinfo/openstack-docs" rel="noreferrer" target="_blank">http://lists.openstack.org/cgi-bin/mailman/listinfo/openstack-docs</a><br>
<br></blockquote></div><br></div></div>