openstack team mailing list archive

[Lorin Hochstein <lorin@xxxxxxx>]

It would be great if we could do some kind of transform of the IDL to generate (some of) the human-consumable REST API documentation that lives at docs.openstack.org. That would simplify the task of keeping those docs up to date.

Lorin
--
Lorin Hochstein, Computer Scientist
USC Information Sciences Institute
703.812.3710
http://www.east.isi.edu/~lorin




On Oct 27, 2011, at 9:54 AM, Sandy Walsh wrote:

> Sounds awesome!
> 
> I've done an application like this in the past where an entire web UI was data driven using a custom IDL. It had to have presentation hints associated with it (acceptable values, display widget, etc). Not something WADL supports inherently I'm sure. But, I know from experience this can work.
> 
> I don't really care what the IDL is, so long as we don't have to write a parser for it in 10 different languages ... which is why XML/JSON hold such appeal (although JSON in C keeps me awake at night).
> 
> -S
> 
> 
> 
> ________________________________________
> From: Mark Nottingham [mnot@xxxxxxxx]
> Sent: Thursday, October 27, 2011 10:38 AM
> To: Sandy Walsh
> Cc: Mellquist, Peter; Joseph Heck; openstack@xxxxxxxxxxxxxxxxxxx
> Subject: Re: [Openstack] +1,  All services should have WADLs
> 
> I'm totally on board with having the interface being machine-consumable at runtime -- see the previous discussion on versioning and extensibility -- but WADL isn't really designed for this. I'm sketching up something more appropriate, and will be able to talk about it soon (hopefully).
> 
> 
> _______________________________________________
> Mailing list: https://launchpad.net/~openstack
> Post to     : openstack@xxxxxxxxxxxxxxxxxxx
> Unsubscribe : https://launchpad.net/~openstack
> More help   : https://help.launchpad.net/ListHelp