<div dir="ltr"><br><div class="gmail_extra"><br><div class="gmail_quote">On Wed, May 18, 2016 at 3:25 PM, Henry Fourie <span dir="ltr"><<a href="mailto:louis.fourie@huawei.com" target="_blank">louis.fourie@huawei.com</a>></span> wrote:<br><blockquote class="gmail_quote" style="margin:0px 0px 0px 0.8ex;border-left-width:1px;border-left-style:solid;border-left-color:rgb(204,204,204);padding-left:1ex">
<div lang="EN-US" link="blue" vlink="purple">
<div>
<p class="MsoNormal"><span style="font-size:11pt;font-family:Calibri,sans-serif;color:rgb(31,73,125)">Anne,<u></u><u></u></span></p>
<p class="MsoNormal"><span style="font-size:11pt;font-family:Calibri,sans-serif;color:rgb(31,73,125)"> So for new APIs the procedure for API documentation is as described here?<u></u><u></u></span></p>
<p class="MsoNormal"><span style="font-size:11pt;font-family:Calibri,sans-serif;color:rgb(31,73,125)"><a href="http://docs.openstack.org/contributor-guide/api-guides.html" target="_blank">http://docs.openstack.org/contributor-guide/api-guides.html</a><u></u><u></u></span></p>
<p class="MsoNormal"><span style="font-size:11pt;font-family:Calibri,sans-serif;color:rgb(31,73,125)"><u></u> </span></p></div></div></blockquote><div><br></div><div>Yes.</div><div> </div><blockquote class="gmail_quote" style="margin:0px 0px 0px 0.8ex;border-left-width:1px;border-left-style:solid;border-left-color:rgb(204,204,204);padding-left:1ex"><div lang="EN-US" link="blue" vlink="purple"><div><p class="MsoNormal"><span style="font-size:11pt;font-family:Calibri,sans-serif;color:rgb(31,73,125)"><u></u></span></p>
<p class="MsoNormal"><span style="font-size:11pt;font-family:Calibri,sans-serif;color:rgb(31,73,125)">When will the neutron API be converted to use parameters.yaml?<u></u><u></u></span></p>
<p class="MsoNormal"><span style="font-size:11pt;font-family:Calibri,sans-serif;color:rgb(31,73,125)"><u></u> </span></p></div></div></blockquote><div><br></div><div>Yes, the <a href="http://review.openstack.org">review.openstack.org</a> link at <a href="https://review.openstack.org/#/c/314819/" target="_blank">https://review.openstack.org/#/c/314819</a> is to the patch where the conversion is being reviewed now.</div><div> </div><blockquote class="gmail_quote" style="margin:0px 0px 0px 0.8ex;border-left-width:1px;border-left-style:solid;border-left-color:rgb(204,204,204);padding-left:1ex"><div lang="EN-US" link="blue" vlink="purple"><div><p class="MsoNormal"><span style="font-size:11pt;font-family:Calibri,sans-serif;color:rgb(31,73,125)"><u></u></span></p>
<p class="MsoNormal"><span style="font-size:11pt;font-family:Calibri,sans-serif;color:rgb(31,73,125)">I am adding API documentation for networking-sfc. Once I have added the necessary files<u></u><u></u></span></p>
<pre><span style="font-size:11pt;font-family:Calibri,sans-serif;color:rgb(31,73,125)">to api-ref/source, and verified them with </span>tox -e api-ref <span style="font-size:11pt;font-family:Calibri,sans-serif;color:rgb(31,73,125)">what must I do to get the<u></u><u></u></span></pre>
<pre><span style="font-size:11pt;font-family:Calibri,sans-serif;color:rgb(31,73,125)">resulting documentation published to say </span><a href="http://docs.openstack.org/mitaka/networking-sfc" target="_blank">http://docs.openstack.org/mitaka/networking-sfc</a><span style="font-size:11pt;font-family:Calibri,sans-serif;color:rgb(31,73,125)"> </span></pre></div></div></blockquote><div><br></div><div>You have the idea. There's a need for a second patch like this one for swift, <a href="https://review.openstack.org/#/c/313015/">https://review.openstack.org/#/c/313015/</a> that creates the infrastructure jobs to publish to <a href="http://developer.openstack.org/api-ref/">developer.openstack.org/api-ref/</a><servicename>/ such as <a href="http://developer.openstack.org/api-ref/compute/">http://developer.openstack.org/api-ref/compute/</a>. If you have a networking-sfc repo, then you'll need two patches to get your API ref publishing, one for the source code repo, one for the project-config repo.</div><div><br></div><div>Hope that helps -</div><div>Anne</div><div> </div><blockquote class="gmail_quote" style="margin:0px 0px 0px 0.8ex;border-left-width:1px;border-left-style:solid;border-left-color:rgb(204,204,204);padding-left:1ex"><div lang="EN-US" link="blue" vlink="purple"><div><pre><u></u><u></u></pre>
<p class="MsoNormal"><span style="font-size:11pt;font-family:Calibri,sans-serif;color:rgb(31,73,125)"><u></u> <u></u></span></p>
<p style="margin-left:20.4pt">
<u></u><span style="font-size:11pt;font-family:Calibri,sans-serif;color:rgb(31,73,125)"><span>-<span style="font-style:normal;font-variant:normal;font-weight:normal;font-stretch:normal;font-size:7pt;line-height:normal;font-family:'Times New Roman'">
</span></span></span><u></u><span style="font-size:11pt;font-family:Calibri,sans-serif;color:rgb(31,73,125)">Louis<u></u><u></u></span></p>
<p class="MsoNormal"><span style="font-size:11pt;font-family:Calibri,sans-serif;color:rgb(31,73,125)"><u></u> <u></u></span></p>
<div style="border-style:solid none none;border-top-width:1pt;border-top-color:rgb(181,196,223);padding:3pt 0in 0in">
<p class="MsoNormal"><b><span style="font-size:10pt;font-family:Tahoma,sans-serif">From:</span></b><span style="font-size:10pt;font-family:Tahoma,sans-serif"> Anne Gentle [mailto:<a href="mailto:annegentle@justwriteclick.com" target="_blank">annegentle@justwriteclick.com</a>]
<br>
<b>Sent:</b> Wednesday, May 18, 2016 1:14 PM</span></p><div><div class="h5"><br>
<b>To:</b> Henry Fourie<br>
<b>Cc:</b> <a href="mailto:openstack-docs@lists.openstack.org" target="_blank">openstack-docs@lists.openstack.org</a><br>
<b>Subject:</b> Re: [OpenStack-docs] Style column in OpenStack API docs<u></u><u></u></div></div><p></p>
</div><div><div class="h5">
<p class="MsoNormal"><u></u> <u></u></p>
<div>
<p class="MsoNormal">Thanks for the link.<u></u><u></u></p>
<div>
<p class="MsoNormal"><u></u> <u></u></p>
</div>
<div>
<p class="MsoNormal">That's from WADL, the style attribute. See this line in the source:<u></u><u></u></p>
</div>
<div>
<p class="MsoNormal"><a href="https://github.com/openstack/api-site/blob/master/api-ref/src/wadls/networking-api/src/wadl/networks.wadl#L93" target="_blank">https://github.com/openstack/api-site/blob/master/api-ref/src/wadls/networking-api/src/wadl/networks.wadl#L93</a><u></u><u></u></p>
</div>
<div>
<p class="MsoNormal"><u></u> <u></u></p>
</div>
<div>
<p class="MsoNormal">For the new parameters.yaml file, there aren't style attributes. Rather, there's these attributes per param, in, required, and type:<u></u><u></u></p>
</div>
<div>
<p class="MsoNormal">param-name:<u></u><u></u></p>
</div>
<div>
<div>
<p class="MsoNormal"> in: body<u></u><u></u></p>
</div>
<div>
<p class="MsoNormal"> required: true<u></u><u></u></p>
</div>
<div>
<p class="MsoNormal"> type: boolean<u></u><u></u></p>
</div>
</div>
<div>
<p class="MsoNormal"><u></u> <u></u></p>
</div>
<div>
<p class="MsoNormal">See <u></u><u></u></p>
</div>
<div>
<p class="MsoNormal"><a href="https://review.openstack.org/#/c/314819/1/api-ref/source/v2/parameters.yaml" target="_blank">https://review.openstack.org/#/c/314819/1/api-ref/source/v2/parameters.yaml</a> for the new format.<u></u><u></u></p>
</div>
<div>
<p class="MsoNormal"><u></u> <u></u></p>
</div>
<div>
<p class="MsoNormal">Hope this info helps - let me know what you're looking to do with the info.<u></u><u></u></p>
</div>
<div>
<p class="MsoNormal">Anne<u></u><u></u></p>
</div>
</div>
<div>
<p class="MsoNormal"><u></u> <u></u></p>
<div>
<p class="MsoNormal">On Wed, May 18, 2016 at 3:05 PM, Henry Fourie <<a href="mailto:louis.fourie@huawei.com" target="_blank">louis.fourie@huawei.com</a>> wrote:<u></u><u></u></p>
<div>
<div>
<p class="MsoNormal"><span style="font-size:11pt;font-family:Calibri,sans-serif;color:rgb(31,73,125)">Anne,</span><u></u><u></u></p>
<p class="MsoNormal"><span style="font-size:11pt;font-family:Calibri,sans-serif;color:rgb(31,73,125)"> See for example
<a href="http://developer.openstack.org/api-ref-networking-v2.html" target="_blank">
http://developer.openstack.org/api-ref-networking-v2.html</a></span><u></u><u></u></p>
<p class="MsoNormal"><span style="font-size:11pt;font-family:Calibri,sans-serif;color:rgb(31,73,125)">Click on Detail for Networks to see Request or Response parameter tables.</span><u></u><u></u></p>
<p style="margin-left:20.4pt"><span style="font-size:11pt;font-family:Calibri,sans-serif;color:rgb(31,73,125)">-</span><span style="font-size:7pt;color:rgb(31,73,125)">
</span><span style="font-size:11pt;font-family:Calibri,sans-serif;color:rgb(31,73,125)">Louis</span><u></u><u></u></p>
<p class="MsoNormal"><span style="font-size:11pt;font-family:Calibri,sans-serif;color:rgb(31,73,125)"> </span><u></u><u></u></p>
<p class="MsoNormal"><span style="font-size:11pt;font-family:Calibri,sans-serif;color:rgb(31,73,125)"> </span><u></u><u></u></p>
<div style="border-style:solid none none;border-top-width:1pt;border-top-color:rgb(181,196,223);padding:3pt 0in 0in">
<p class="MsoNormal"><b><span style="font-size:10pt;font-family:Tahoma,sans-serif">From:</span></b><span style="font-size:10pt;font-family:Tahoma,sans-serif"> Anne Gentle [mailto:<a href="mailto:annegentle@justwriteclick.com" target="_blank">annegentle@justwriteclick.com</a>]
<br>
<b>Sent:</b> Wednesday, May 18, 2016 1:01 PM<br>
<b>To:</b> Henry Fourie<br>
<b>Cc:</b> <a href="mailto:openstack-docs@lists.openstack.org" target="_blank">openstack-docs@lists.openstack.org</a><br>
<b>Subject:</b> Re: [OpenStack-docs] Style column in OpenStack API docs</span><u></u><u></u></p>
</div>
<div>
<div>
<p class="MsoNormal"> <u></u><u></u></p>
<div>
<p class="MsoNormal">Hi Louis,<u></u><u></u></p>
<div>
<p class="MsoNormal">Can you send a link or screenshot of what you mean by the Style column? I'm not sure what you're looking at and the API docs are transitioning to RST + YAML, built with Sphinx.
So, let me know more about where you see this column and what you'd like to do once you learn more.<u></u><u></u></p>
</div>
<div>
<p class="MsoNormal">Thanks,<u></u><u></u></p>
</div>
<div>
<p class="MsoNormal">Anne<u></u><u></u></p>
</div>
</div>
<div>
<p class="MsoNormal"> <u></u><u></u></p>
<div>
<p class="MsoNormal">On Wed, May 18, 2016 at 2:35 PM, Henry Fourie <<a href="mailto:louis.fourie@huawei.com" target="_blank">louis.fourie@huawei.com</a>> wrote:<u></u><u></u></p>
<div>
<div>
<p class="MsoNormal">What is the usage of the Style column in OpenStack API docs?<u></u><u></u></p>
<p class="MsoNormal">How is this column created?<u></u><u></u></p>
<p style="margin-left:20.4pt">-<span style="font-size:7pt"> </span>Louis<u></u><u></u></p>
<p class="MsoNormal"> <u></u><u></u></p>
</div>
</div>
<p class="MsoNormal" style="margin-bottom:12pt"><br>
_______________________________________________<br>
OpenStack-docs mailing list<br>
<a href="mailto:OpenStack-docs@lists.openstack.org" target="_blank">OpenStack-docs@lists.openstack.org</a><br>
<a href="http://lists.openstack.org/cgi-bin/mailman/listinfo/openstack-docs" target="_blank">http://lists.openstack.org/cgi-bin/mailman/listinfo/openstack-docs</a><u></u><u></u></p>
</div>
<p class="MsoNormal"><br>
<br clear="all">
<u></u><u></u></p>
<div>
<p class="MsoNormal"> <u></u><u></u></p>
</div>
<p class="MsoNormal">--
<u></u><u></u></p>
<div>
<div>
<div>
<div>
<div>
<p class="MsoNormal">Anne Gentle<u></u><u></u></p>
</div>
<div>
<p class="MsoNormal"><a href="http://www.justwriteclick.com" target="_blank"><span style="font-size:7.5pt">www.justwriteclick.com</span></a><u></u><u></u></p>
</div>
</div>
</div>
</div>
</div>
</div>
</div>
</div>
</div>
</div>
</div>
<p class="MsoNormal"><br>
<br clear="all">
<u></u><u></u></p>
<div>
<p class="MsoNormal"><u></u> <u></u></p>
</div>
<p class="MsoNormal">-- <u></u><u></u></p>
<div>
<div>
<div>
<div>
<div>
<p class="MsoNormal">Anne Gentle<u></u><u></u></p>
</div>
<div>
<p class="MsoNormal"><a href="http://www.justwriteclick.com" target="_blank"><span style="font-size:7.5pt">www.justwriteclick.com</span></a><u></u><u></u></p>
</div>
</div>
</div>
</div>
</div>
</div>
</div></div></div>
</div>
</blockquote></div><br><br clear="all"><div><br></div>-- <br><div class="gmail_signature"><div dir="ltr"><div><div dir="ltr"><div>Anne Gentle</div><div><a href="http://www.justwriteclick.com" style="font-size:12.8px" target="_blank">www.justwriteclick.com</a><br></div></div></div></div></div>
</div></div>