<div dir="ltr">Hi guys, more below.<br><div><div class="gmail_extra"><br><br><div class="gmail_quote">On Fri, Mar 1, 2013 at 10:04 PM, Dolph Mathews <span dir="ltr"><<a href="mailto:dolph.mathews@gmail.com" target="_blank">dolph.mathews@gmail.com</a>></span> wrote:<br>
<blockquote class="gmail_quote" style="margin:0px 0px 0px 0.8ex;border-left:1px solid rgb(204,204,204);padding-left:1ex"><div class="im"><br><br>On Friday, March 1, 2013, Adam Young wrote:<br><blockquote class="gmail_quote" style="margin:0px 0px 0px 0.8ex;border-left:1px solid rgb(204,204,204);padding-left:1ex">
We currently list the V2 API as Beta. Its time to change that.<br>
<br>
What do we need to do in order to make this legit? Biggest thing I know of is to document the token API.</blockquote><div><br></div></div><div>Our 300 Multiple Choice response indicates it's beta. It should have been stable for both Essex and Folsom. In light of v3, it should be considered deprecated instead.</div>
<div class="im">
<blockquote class="gmail_quote" style="margin:0px 0px 0px 0.8ex;border-left:1px solid rgb(204,204,204);padding-left:1ex">
<br>
I have a task to document the additional calls for the PKI tokens. Those are:<br>
<br>
GET /certificates/signing<br>
and<br>
GET /certificates/ca<br>
<br>
But I am not quite certain where to put the docs.<br>
<br>
The docs in keystone/docs/source Seem to be lacking. There is the curl example page:<br>
<br>
<a href="http://docs.openstack.org/developer/keystone/api_curl_examples.html#id3" target="_blank">http://docs.openstack.org/<u></u>developer/keystone/api_curl_<u></u>examples.html#id3</a><br>
<br></blockquote><div><br></div></div><div>Curl examples were originally written before there was a client. I think they can be killed soon.</div><div class="im"><div> </div><blockquote class="gmail_quote" style="margin:0px 0px 0px 0.8ex;border-left:1px solid rgb(204,204,204);padding-left:1ex">
I don't think what that returns is accurate. We have a slew of Metatdata things in the token now-a-days.<br>
<br>
<br>
There is also the Identity API docs<br>
<br>
<a href="https://github.com/openstack/identity-api/tree/master/openstack-identity-api/src/docbkx" target="_blank">https://github.com/openstack/<u></u>identity-api/tree/master/<u></u>openstack-identity-api/src/<u></u>docbkx</a> <br>
<br>
I have not yet identified what the state of the WADL is:<br>
<br>
<a href="https://github.com/openstack/identity-api/blob/master/openstack-identity-api/src/docbkx/admin/identity-admin.wadl" target="_blank">https://github.com/openstack/<u></u>identity-api/blob/master/<u></u>openstack-identity-api/src/<u></u>docbkx/admin/identity-admin.<u></u>wadl</a> <br>
<br>
<br></blockquote><div><br></div></div><div>The official documentation for v2 is this WADL and the referenced XSD's. there's a separate WADL for the public API.</div><div class="im"><div> </div><blockquote class="gmail_quote" style="margin:0px 0px 0px 0.8ex;border-left:1px solid rgb(204,204,204);padding-left:1ex">
What do we need to do documentation wise before Grizzly Goes GA?<br>
<br>
Also, what will happen with the Markdown for the V3 API? I've run an HTML transform on it, and it looks very simplistic. I assume there is a style sheet, but where is it?</blockquote><div><br></div></div><div>Anne asked us to write markdown because she had a plan for rendering it to either <a href="http://docs.openstack.org" target="_blank">docs.openstack.org</a> or <a href="http://api.openstack.org" target="_blank">api.openstack.org</a> -- I assume the style sheets would live in one of <span></span>those projects, not ours.</div>
<div class=""><div class="h5">
<div> </div><blockquote class="gmail_quote" style="margin:0px 0px 0px 0.8ex;border-left:1px solid rgb(204,204,204);padding-left:1ex">
<br></blockquote></div></div></blockquote><div><br></div><div>It's fine to write in markdown or docbook, the build jobs can support markdown by turning it into docbook automatically. We have a script in openstack-infra/config:<br>
/modules/jenkins/files/slave_scripts/markdown-docbook.sh<br><br></div><div>But right now the 2 or 3 markdown files we have aren't using it, and that needs investigation. Other markdown files are the api programming guide and the Image API v2. Bug logged: <a href="https://bugs.launchpad.net/openstack-manuals/+bug/1139231">https://bugs.launchpad.net/openstack-manuals/+bug/1139231</a><br>
<br></div><div>A bit too tired from the book sprint to dig further but that might get you on the right track to build your v3 with more styling.<br>Anne<br></div><div> </div><blockquote class="gmail_quote" style="margin:0px 0px 0px 0.8ex;border-left:1px solid rgb(204,204,204);padding-left:1ex">
<div class=""><div class="h5"><blockquote class="gmail_quote" style="margin:0px 0px 0px 0.8ex;border-left:1px solid rgb(204,204,204);padding-left:1ex">
<br>
<br>
<br>
______________________________<u></u>_________________<br>
OpenStack-dev mailing list<br>
<a>OpenStack-dev@lists.openstack.org</a><br>
<a href="http://lists.openstack.org/cgi-bin/mailman/listinfo/openstack-dev" target="_blank">http://lists.openstack.org/<u></u>cgi-bin/mailman/listinfo/<u></u>openstack-dev</a><br>
</blockquote><br><br></div></div><span class=""><font color="#888888">-- <br><div><br></div>-Dolph<br>
</font></span><br>_______________________________________________<br>
OpenStack-dev mailing list<br>
<a href="mailto:OpenStack-dev@lists.openstack.org">OpenStack-dev@lists.openstack.org</a><br>
<a href="http://lists.openstack.org/cgi-bin/mailman/listinfo/openstack-dev" target="_blank">http://lists.openstack.org/cgi-bin/mailman/listinfo/openstack-dev</a><br>
<br></blockquote></div><br></div></div></div>