[OpenStack-docs] [api] displaying useful docs from Swagger files

michael mccune msm at redhat.com
Tue Feb 23 21:34:58 UTC 2016


On 02/23/2016 11:49 AM, Anne Gentle wrote:
> As an idea of what I would consider "code complete" for the migration:
> 1. All services WADL files migrate without any errors in the
> gate-build-swagger
> <http://logs.openstack.org/57/281657/1/check/gate-build-swagger/993145e/> job.
> Currently the Networking API files have the most errors and the team is
> looking into it. I've been logging bugs when the tool finds errors when
> migrating WADL.
> 2. All current HTML pages on developer.openstack.org/api-ref.html
> <http://developer.openstack.org/api-ref.html> can be redirected.

this sounds reasonable to me.

>
> However, defining "good enough" for the fairy-slipper display and
> interaction piece is more complex. So I believe an interim solution that
> migrates the WADL and gets off of WADL and clouddocs-maven-plugin for
> builds is a good way forward.
>
> What do you all think? Karen, Russell, and Mike McCune I'd definitely
> like your input.

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.

thanks for all the work on this Anne!

regards,
mike



More information about the OpenStack-docs mailing list