[openstack-dev] API changes [was: Re: [API] Standardizing status codes in the native API]

Mark McLoughlin markmc at redhat.com
Thu Jul 26 09:47:00 UTC 2012


On Thu, 2012-07-26 at 04:43 -0400, Eoghan Glynn wrote:
> > Context for others - Jay asked for feedback on some API change
> > guidelines which he and David have been working on. See here:
> > 
> >   http://etherpad.openstack.org/Hn8rKP7XgB
> > 
> > So ... kudos for kicking this off. I think it'll help a lot to get this
> > stuff written down - e.g. consistency in reviews and to give confidence
> > to users that we do care about API compat.
> 
> Agreed, the current version on etherpad is a *great* start, and will be
> an excellent resource if we continue to codify the group wisdom as it 
> evolves.
> 
> Just one suggestion, can we put the guidelines under version control,
> in the style of the HACKING.rst?
> 
> So, I've just added a small clarification to the etherpad, and there's
> nothing to stop anyone else adding their particular slant, without it
> necessarily reflecting the group consensus.
> 
> Whereas putting the thing in git at least ensures some oversight on
> changes. Obviously the guideline should apply across all projects, but
> I think it would be OK to just stick the file into the nova repo
> (with the understanding that there's broader applicability).

I think the next step is to put it on the wiki.

I'm not worried about people editing it - especially if they're adding
examples. Any major change in the guidelines that wasn't first discussed
could be easily reverted.

Cheers,
Mark.




More information about the OpenStack-dev mailing list