<div dir="ltr">The most-complete project is nova, look here:<div><a href="http://developer.openstack.org/api-guide/compute/">http://developer.openstack.org/api-guide/compute/</a><br></div><div><a href="http://developer.openstack.org/api-ref/compute/">http://developer.openstack.org/api-ref/compute/</a><br></div><div><br></div><div>We definitely need more work on tying the information together across projects and for api-ref and api-guide. Looking for web dev/design help for that.</div><div><br></div><div>Anne</div></div><div class="gmail_extra"><br><div class="gmail_quote">On Thu, May 19, 2016 at 11:20 AM, 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:0 0 0 .8ex;border-left:1px #ccc solid;padding-left:1ex">
<div lang="EN-US" link="blue" vlink="purple">
<div>
<p class="MsoNormal"><span style="font-size:11.0pt;font-family:"Calibri","sans-serif";color:#1f497d">Anne,<u></u><u></u></span></p>
<p class="MsoNormal"><span style="font-size:11.0pt;font-family:"Calibri","sans-serif";color:#1f497d"> Done that. What I meant was API documentation for other projects I could look at.<u></u><u></u></span></p>
<p style="margin-left:20.4pt">
<u></u><span style="font-size:11.0pt;font-family:"Calibri","sans-serif";color:#1f497d"><span>-<span style="font:7.0pt "Times New Roman"">
</span></span></span><u></u><span style="font-size:11.0pt;font-family:"Calibri","sans-serif";color:#1f497d">Louis<u></u><u></u></span></p>
<p class="MsoNormal"><span style="font-size:11.0pt;font-family:"Calibri","sans-serif";color:#1f497d"><u></u> <u></u></span></p>
<div>
<div style="border:none;border-top:solid #b5c4df 1.0pt;padding:3.0pt 0in 0in 0in">
<p class="MsoNormal"><b><span style="font-size:10.0pt;font-family:"Tahoma","sans-serif"">From:</span></b><span style="font-size:10.0pt;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 7:13 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><div class="h5">
<p class="MsoNormal"><u></u> <u></u></p>
<div>
<p class="MsoNormal">You can build locally with tox -e api-ref. Copy the tox.ini config from the examples. Once you have a gate job you can see it with every patch. <br>
<br>
Thanks,<u></u><u></u></p>
<div>
<p class="MsoNormal">Anne<u></u><u></u></p>
<div>
<p class="MsoNormal"><u></u> <u></u></p>
</div>
</div>
</div>
<div>
<p class="MsoNormal" style="margin-bottom:12.0pt"><br>
On May 18, 2016, at 5:57 PM, Henry Fourie <<a href="mailto:louis.fourie@huawei.com" target="_blank">louis.fourie@huawei.com</a>> wrote:<u></u><u></u></p>
</div>
<blockquote style="margin-top:5.0pt;margin-bottom:5.0pt">
<div>
<p class="MsoNormal"><span style="font-size:11.0pt;font-family:"Calibri","sans-serif";color:#1f497d">Anne,</span><u></u><u></u></p>
<p class="MsoNormal"><span style="font-size:11.0pt;font-family:"Calibri","sans-serif";color:#1f497d"> Thanks. Is there an example of new API documentation I could inspect</span><u></u><u></u></p>
<p class="MsoNormal"><span style="font-size:11.0pt;font-family:"Calibri","sans-serif";color:#1f497d">to see if the API docs I create are on the right track?</span><u></u><u></u></p>
<p style="margin-left:20.4pt">
<u></u><span style="font-family:"Calibri","sans-serif""><span>-<span style="font:7.0pt "Times New Roman"">
</span></span></span><u></u><span style="font-size:11.0pt;font-family:"Calibri","sans-serif";color:#1f497d">Louis</span><u></u><u></u></p>
<p class="MsoNormal"><span style="font-size:11.0pt;font-family:"Calibri","sans-serif";color:#1f497d"> </span><u></u><u></u></p>
<div style="border:none;border-top:solid #b5c4df 1.0pt;padding:3.0pt 0in 0in 0in">
<p class="MsoNormal"><b><span style="font-size:10.0pt;font-family:"Tahoma","sans-serif"">From:</span></b><span style="font-size:10.0pt;font-family:"Tahoma","sans-serif""> Anne Gentle [<a href="mailto:annegentle@justwriteclick.com" target="_blank">mailto:annegentle@justwriteclick.com</a>]
<br>
<b>Sent:</b> Wednesday, May 18, 2016 3:17 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>
<p class="MsoNormal"> <u></u><u></u></p>
<div>
<p class="MsoNormal"> <u></u><u></u></p>
<div>
<p class="MsoNormal"> <u></u><u></u></p>
<div>
<p class="MsoNormal">On Wed, May 18, 2016 at 3:25 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:11.0pt;font-family:"Calibri","sans-serif";color:#1f497d">Anne,</span><u></u><u></u></p>
<p class="MsoNormal"><span style="font-size:11.0pt;font-family:"Calibri","sans-serif";color:#1f497d"> So for new APIs the procedure for API documentation is as described here?</span><u></u><u></u></p>
<p class="MsoNormal"><span style="font-size:11.0pt;font-family:"Calibri","sans-serif";color:#1f497d"><a href="http://docs.openstack.org/contributor-guide/api-guides.html" target="_blank">http://docs.openstack.org/contributor-guide/api-guides.html</a></span><u></u><u></u></p>
<p class="MsoNormal"><span style="font-size:11.0pt;font-family:"Calibri","sans-serif";color:#1f497d"> </span><u></u><u></u></p>
</div>
</div>
<div>
<p class="MsoNormal"> <u></u><u></u></p>
</div>
<div>
<p class="MsoNormal">Yes.<u></u><u></u></p>
</div>
<div>
<p class="MsoNormal"> <u></u><u></u></p>
</div>
<blockquote style="border:none;border-left:solid #cccccc 1.0pt;padding:0in 0in 0in 6.0pt;margin-left:4.8pt;margin-top:5.0pt;margin-right:0in;margin-bottom:5.0pt">
<div>
<div>
<p class="MsoNormal"><span style="font-size:11.0pt;font-family:"Calibri","sans-serif";color:#1f497d">When will the neutron API be converted to use parameters.yaml?</span><u></u><u></u></p>
<p class="MsoNormal"><span style="font-size:11.0pt;font-family:"Calibri","sans-serif";color:#1f497d"> </span><u></u><u></u></p>
</div>
</div>
</blockquote>
<div>
<p class="MsoNormal"> <u></u><u></u></p>
</div>
<div>
<p class="MsoNormal">Yes, the <a href="http://review.openstack.org" target="_blank">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.<u></u><u></u></p>
</div>
<div>
<p class="MsoNormal"> <u></u><u></u></p>
</div>
<blockquote style="border:none;border-left:solid #cccccc 1.0pt;padding:0in 0in 0in 6.0pt;margin-left:4.8pt;margin-top:5.0pt;margin-right:0in;margin-bottom:5.0pt">
<div>
<div>
<p class="MsoNormal"><span style="font-size:11.0pt;font-family:"Calibri","sans-serif";color:#1f497d">I am adding API documentation for networking-sfc. Once I have added the necessary files</span><u></u><u></u></p>
<pre><span style="font-size:11.0pt;font-family:"Calibri","sans-serif";color:#1f497d">to api-ref/source, and verified them with </span>tox -e api-ref <span style="font-size:11.0pt;font-family:"Calibri","sans-serif";color:#1f497d">what must I do to get the</span><u></u><u></u></pre>
<pre><span style="font-size:11.0pt;font-family:"Calibri","sans-serif";color:#1f497d">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:11.0pt;font-family:"Calibri","sans-serif";color:#1f497d"> </span><u></u><u></u></pre>
</div>
</div>
</blockquote>
<div>
<p class="MsoNormal"> <u></u><u></u></p>
</div>
<div>
<p class="MsoNormal">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/" target="_blank">https://review.openstack.org/#/c/313015/</a> that creates the infrastructure jobs to publish to
<a href="http://developer.openstack.org/api-ref/" target="_blank">developer.openstack.org/api-ref/</a><servicename>/ such as <a href="http://developer.openstack.org/api-ref/compute/" target="_blank">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.<u></u><u></u></p>
</div>
<div>
<p class="MsoNormal"> <u></u><u></u></p>
</div>
<div>
<p class="MsoNormal">Hope that helps -<u></u><u></u></p>
</div>
<div>
<p class="MsoNormal">Anne<u></u><u></u></p>
</div>
<div>
<p class="MsoNormal"> <u></u><u></u></p>
</div>
<blockquote style="border:none;border-left:solid #cccccc 1.0pt;padding:0in 0in 0in 6.0pt;margin-left:4.8pt;margin-top:5.0pt;margin-right:0in;margin-bottom:5.0pt">
<div>
<div>
<p class="MsoNormal"><span style="font-size:11.0pt;font-family:"Calibri","sans-serif";color:#1f497d"> </span><u></u><u></u></p>
<p style="margin-left:20.4pt"><span style="font-size:11.0pt;font-family:"Calibri","sans-serif";color:#1f497d">-</span><span style="font-size:7.0pt;color:#1f497d">
</span><span style="font-size:11.0pt;font-family:"Calibri","sans-serif";color:#1f497d">Louis</span><u></u><u></u></p>
<p class="MsoNormal"><span style="font-size:11.0pt;font-family:"Calibri","sans-serif";color:#1f497d"> </span><u></u><u></u></p>
<div style="border:none;border-top:solid #b5c4df 1.0pt;padding:3.0pt 0in 0in 0in">
<p class="MsoNormal"><b><span style="font-size:10.0pt;font-family:"Tahoma","sans-serif"">From:</span></b><span style="font-size:10.0pt;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><u></u><u></u></p>
<div>
<div>
<p class="MsoNormal"><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></p>
</div>
</div>
</div>
<div>
<div>
<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:11.0pt;font-family:"Calibri","sans-serif";color:#1f497d">Anne,</span><u></u><u></u></p>
<p class="MsoNormal"><span style="font-size:11.0pt;font-family:"Calibri","sans-serif";color:#1f497d"> 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:11.0pt;font-family:"Calibri","sans-serif";color:#1f497d">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:11.0pt;font-family:"Calibri","sans-serif";color:#1f497d">-</span><span style="font-size:7.0pt;color:#1f497d">
</span><span style="font-size:11.0pt;font-family:"Calibri","sans-serif";color:#1f497d">Louis</span><u></u><u></u></p>
<p class="MsoNormal"><span style="font-size:11.0pt;font-family:"Calibri","sans-serif";color:#1f497d"> </span><u></u><u></u></p>
<p class="MsoNormal"><span style="font-size:11.0pt;font-family:"Calibri","sans-serif";color:#1f497d"> </span><u></u><u></u></p>
<div style="border:none;border-top:solid #b5c4df 1.0pt;padding:3.0pt 0in 0in 0in">
<p class="MsoNormal"><b><span style="font-size:10.0pt;font-family:"Tahoma","sans-serif"">From:</span></b><span style="font-size:10.0pt;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:7.0pt"> </span>Louis<u></u><u></u></p>
<p class="MsoNormal"> <u></u><u></u></p>
</div>
</div>
<p class="MsoNormal" style="margin-bottom:12.0pt"><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>
<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>
</blockquote>
</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>