<div dir="ltr"><br><div class="gmail_extra"><br><div class="gmail_quote">2015-11-06 20:46 GMT+08:00 John Garbutt <span dir="ltr"><<a href="mailto:john@johngarbutt.com" target="_blank">john@johngarbutt.com</a>></span>:<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"><div class=""><div class="h5">On 6 November 2015 at 03:31, Alex Xu <<a href="mailto:soulxu@gmail.com">soulxu@gmail.com</a>> wrote:<br>
> Hi, folks<br>
><br>
> Nova API sub-team is working on the swagger generation. And there is PoC<br>
> <a href="https://review.openstack.org/233446" rel="noreferrer" target="_blank">https://review.openstack.org/233446</a><br>
><br>
> But before we are going to next step, I really hope we can get agreement<br>
> with how to support Microversions and Actions. The PoC have demo about<br>
> Microversions. It generates min version action as swagger spec standard, for<br>
> the other version actions, it named as extended attribute, like:<br>
><br>
> {<br>
>     '/os-keypairs': {<br>
>         "get": {<br>
>             'x-start-version': '2.1',<br>
>             'x-end-version': '2.1',<br>
>             'description': '....',<br>
>            ....<br>
>         },<br>
>         "x-get-2.2-2.9": {<br>
>             'x-start-version': '2.2',<br>
>             'x-end-version': '2.9',<br>
>             'description': '....',<br>
>             .....<br>
>         }<br>
>     }<br>
> }<br>
><br>
> x-start-version and x-end-version are the metadata for Microversions, which<br>
> should be used by UI code to parse.<br>
><br>
> This is just based on my initial thought, and there is another thought is<br>
> generating a set full swagger specs for each Microversion. But I think how<br>
> to show Microversions and Actions should be depended how the doc UI to parse<br>
> that also.<br>
><br>
> As there is doc project to turn swagger to UI:<br>
> <a href="https://github.com/russell/fairy-slipper" rel="noreferrer" target="_blank">https://github.com/russell/fairy-slipper</a>  But it didn't support<br>
> Microversions. So hope doc team can work with us and help us to find out<br>
> format to support Microversions and Actions which good for UI parse and<br>
> swagger generation.<br>
><br>
> Any thoughts folks?<br>
<br>
</div></div>I can't find the URL to the example, but I though the plan was each<br>
microversion generates a full doc tree.<br></blockquote><div><br></div><div>yea, we said that in nova api meeting. and this is the example what we expect UI looks like <a href="https://libgit2.github.com/libgit2/#HEAD" target="_blank">https://libgit2.github.com/libgit2/#HEAD</a></div><div><br></div><div>I just want to ensure with doc team and Russell this is good for them on the implementation of fairy-slipper.</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>
It also notes the changes between the versions, so you look at the<br>
latest version, you can tell between which versions the API was<br>
modified.<br>
<br>
I remember annegentle had a great example of this style, will try ping<br>
here about that next week.<br></blockquote><div><br></div><div><br></div><div>yea, let's talk about it in the meeting.</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>
Thanks,<br>
John<br>
<br>
__________________________________________________________________________<br>
OpenStack Development Mailing List (not for usage questions)<br>
Unsubscribe: <a href="http://OpenStack-dev-request@lists.openstack.org?subject:unsubscribe" rel="noreferrer" target="_blank">OpenStack-dev-request@lists.openstack.org?subject:unsubscribe</a><br>
<a href="http://lists.openstack.org/cgi-bin/mailman/listinfo/openstack-dev" rel="noreferrer" target="_blank">http://lists.openstack.org/cgi-bin/mailman/listinfo/openstack-dev</a><br>
</blockquote></div><br></div></div>