[openstack-dev] [Keystone] Documenting the V2 API

Adam Young ayoung at redhat.com
Mon Mar 4 13:56:03 UTC 2013


On 03/01/2013 11:04 PM, Dolph Mathews wrote:
>
>
> On Friday, March 1, 2013, Adam Young wrote:
>
>     We currently list the V2 API as Beta.  Its time to change that.
>
>     What do we need to do in order to make this legit?   Biggest thing
>     I know of is to document the token API.
>
>
> 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.
Stable for Grizzly, Deprecated for Havana.

V3 Should be Stable as well.

>
>     I have a task to document the additional calls for the PKI tokens.
>     Those are:
>
>     GET /certificates/signing
>     and
>     GET /certificates/ca
>
>     But I am not quite certain where to put the docs.
>
>     The docs in keystone/docs/source Seem to be lacking.  There is the
>     curl example page:
>
>     http://docs.openstack.org/developer/keystone/api_curl_examples.html#id3
>
>
> Curl examples were originally written before there was a client. I 
> think they can be killed soon.
No, lets plan on keeping them.  They are extremely valuable.  Many 
people are doing direct web integration, from Javascript and other 
languages that are not Python.


>     I don't think what that returns is accurate.  We have a slew of
>     Metatdata things in the token now-a-days.
>
>
>     There is also the Identity API docs
>
>     https://github.com/openstack/identity-api/tree/master/openstack-identity-api/src/docbkx
>
>
>     I have not yet identified what the state of the WADL is:
>
>     https://github.com/openstack/identity-api/blob/master/openstack-identity-api/src/docbkx/admin/identity-admin.wadl
>
>
>
>
> The official documentation for v2 is this WADL and the referenced 
> XSD's. there's a separate WADL for the public API.
>
>     What do we need to do documentation wise before Grizzly Goes GA?
>
>     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?
>
>
> Anne asked us to write markdown because she had a plan for rendering 
> it to either docs.openstack.org <http://docs.openstack.org> or 
> api.openstack.org <http://api.openstack.org> -- I assume the style 
> sheets would live in one of those projects, not ours.
>
>
>
>
>
>     _______________________________________________
>     OpenStack-dev mailing list
>     OpenStack-dev at lists.openstack.org
>     http://lists.openstack.org/cgi-bin/mailman/listinfo/openstack-dev
>
>
>
> -- 
>
> -Dolph
>
>
> _______________________________________________
> OpenStack-dev mailing list
> OpenStack-dev at lists.openstack.org
> http://lists.openstack.org/cgi-bin/mailman/listinfo/openstack-dev

-------------- next part --------------
An HTML attachment was scrubbed...
URL: <http://lists.openstack.org/pipermail/openstack-dev/attachments/20130304/c51f3480/attachment.html>


More information about the OpenStack-dev mailing list