← Back to team overview

openstack team mailing list archive

Re: Guidelines for OpenStack APIs

 

It makes me very happy to see this.  I will try to keep up with this in realtime but would love it if there were periodic review points advertised pre-publishing of the standards.  Failing that, I would  ask some of the contributors whom know me to poke me in a timely manner re this.  Also, I will see about contributing our API standards for RESTful APIs.  

I've said this before: the API is the product. If OpenStack hopes to not turn into a heterogenous nightmare of mismatched APIs and provide operationally automatable and supportable frameworks then standards and some light governance are necessary... starting with common RESTful semantics and abstraction from provider specific semantics and stopping way short of component level  semantics as each project should supply that.

Jan Drake
Principal Cloud Architect
The Walt Disney Company

*poof* Jan disappears back into lurker mode in a puff of pixie dust and prioritization.





On Sep 18, 2011, at 5:38 PM, Jonathan Bryce <jbryce@xxxxxxxxxx> wrote:

> After the mailing list discussion around APIs a few weeks back, several community members asked the Project Policy Board to come up with a position on APIs. The conclusion of the PPB was that each project's PTL will own the definition and implementation of the project's official API, and APIs across all OpenStack projects should follow a set of guidelines that the PPB will approve. This will allow the APIs to be tied to the functionality in the project while ensuring a level of consistency and familiarity across all projects for API consumers.
> 
> We've started an Etherpad to collect input and comments on suggested guidelines. It's a little messy but proposed guidelines are set off with an asterisk (*):
> 
> http://etherpad.openstack.org/RFC-API-Guidelines
> 
> Feel free to add comments on the Etherpad, the list or give me feedback directly.
> 
> Jonathan.
> 
> _______________________________________________
> Mailing list: https://launchpad.net/~openstack
> Post to     : openstack@xxxxxxxxxxxxxxxxxxx
> Unsubscribe : https://launchpad.net/~openstack
> More help   : https://help.launchpad.net/ListHelp

Follow ups

References