← Back to team overview

openstack team mailing list archive

Re: Guidelines for OpenStack APIs

 

The etherpad thing is already somewhat hard to read. I wonder if we could try first to simply get a list of topics that we want guidelines on without first trying to say what the standard is. My experience trying to come up with such standards internally is that they will generate a huge amount of discussion.

Also, we should have some goals for *why* we are creating standards, so that we can push back if people go to far, or defend it if we get push back by people who just don't want any standards. We don't want standards for standards sake, but standards that delivery some specific tangible goals.

On 09/18/2011 10:38 PM, Jonathan Bryce 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

This email may include confidential information. If you received it in error, please delete it.



Follow ups

References