openstack team mailing list archive

[Greg DeRenne <greg.derenne@xxxxxxxxxxxxxx>]

Hi,

Seems to me there are two different use cases out there.  Auto-generated
docs should be complete/exhaustive "reference" material for what the API has
to offer.  Experienced developers will eventually use this only (quick check
of syntax for example).  Reference material does not negate the need for
useful API docs that get newer developers rolling... including how to use
the API, use cases, and practical examples.

My .02,
GregD

On Wed, Oct 26, 2011 at 9:39 AM, Kevin L. Mitchell <
kevin.mitchell@xxxxxxxxxxxxx> wrote:

> On Wed, 2011-10-26 at 12:14 -0400, Jay Pipes wrote:
> > That's fine for generating a WADL for existing APIs that are already
> > implemented. Not so good for proposed APIs ;)
>
> Oh, certainly, but there the auto-generation could be used to verify
> that the code implements the proposed API :)
> --
> Kevin L. Mitchell <kevin.mitchell@xxxxxxxxxxxxx>
>
>
> _______________________________________________
> Mailing list: https://launchpad.net/~openstack
> Post to     : openstack@xxxxxxxxxxxxxxxxxxx
> Unsubscribe : https://launchpad.net/~openstack
> More help   : https://help.launchpad.net/ListHelp
>



-- 
Regards,
Greg DeRenne
530/888-7784 (office)
530/613-8775 (cell)
greg.derenne  (skype)
- - -
Register today for the RightScale Conference!
November 8-9, 2011 in Santa Clara, CA
****
*Real Cloud Experience. Shared.
*
http://www.rightscale.com/conference