← Back to team overview

openstack team mailing list archive

Re: announcing api.openstack.org


*high fives* to Anne and everyone else involved!


On Thu, Feb 16, 2012 at 9:02 AM, Anne Gentle <anne@xxxxxxxxxxxxx> wrote:
> I'm pleased to point you to http://api.openstack.org.
> Collecting OpenStack APIs on one page, built with an API developer in mind.
> This design implementation fulfills a blueprint for the
> openstack-manuals project. Inspired by sites like
> https://dev.twitter.com/docs/api but with a scope that we could
> actually complete prior to Essex, the site shows Identity 2.0, Compute
> 1.1, and Image 1.0 APIs with Object Storage to follow. The API site
> aims to document the installation at http://trystack.org for starters.
> Different OpenStack deployments may choose different API extensions,
> for example, and extensions are not reflected on this site quite yet.
> The source for the page is three WADL files plus an index page that
> builds the HTML with a Maven plugin. There are JSON and XML samples
> for some of the methods, defaulting to JSON. A search box allows you
> to search the entire page whether the content is revealed or not.
> Click the details buttons to expand the content below each
> PUT/POST/GET/DELETE method. Click the close button to contract the
> content back to one line. Refresh the page to compress all expanded
> content.
> We welcome bug reports (and know of some bugs already) against the
> openstack-manuals project, tagged with api-site.
> Much appreciation and love for Joe Heck for cheerleading for the site
> and scope. A huge shout-out to the doc tools team at Rackspace
> especially David Cramer, Joe Savak, and Thu Doan for their efforts.
> Brian Waldon and Jorge Williams reviewed the site as we iterated on it
> and I appreciate it. Thanks y'all!
> I humbly hand it over to you all to keep improving it - the content
> needs additions for certain and we need to get the Object Storage WADL
> written. Patches welcome!
> Warmly,
> Anne
> _______________________________________________
> Mailing list: https://launchpad.net/~openstack
> Post to     : openstack@xxxxxxxxxxxxxxxxxxx
> Unsubscribe : https://launchpad.net/~openstack
> More help   : https://help.launchpad.net/ListHelp

Follow ups