<div dir="ltr"><br><div class="gmail_extra"><br><div class="gmail_quote">On Wed, Oct 15, 2014 at 7:44 AM, Christopher Yeoh <span dir="ltr"><<a href="mailto:cbkyeoh@gmail.com" target="_blank">cbkyeoh@gmail.com</a>></span> wrote:<br><blockquote class="gmail_quote" style="margin:0 0 0 .8ex;border-left:1px #ccc solid;padding-left:1ex">On Tue, 14 Oct 2014 09:45:44 -0400<br>
Jay Pipes <<a href="mailto:jaypipes@gmail.com">jaypipes@gmail.com</a>> wrote:<br>
<br>
> On 10/14/2014 12:52 AM, Christopher Yeoh wrote:<br>
> > On Mon, 13 Oct 2014 22:20:32 -0400<br>
> > Jay Pipes <<a href="mailto:jaypipes@gmail.com">jaypipes@gmail.com</a>> wrote:<br>
> ><br>
> >> On 10/13/2014 07:11 PM, Christopher Yeoh wrote:<br>
> >>> On Mon, 13 Oct 2014 10:52:26 -0400<br>
> > And whilst I don't have a problem with having some guidelines which<br>
> > suggest a future standard for APIs, I don't think we should be<br>
> > requiring any type of feature which has not yet been implemented in<br>
> > at least one, preferably two openstack projects and released and<br>
> > tested for a cycle. Eg standards should be lagging rather than<br>
> > leading.<br>
><br>
> What about "features" in some of our APIs that are *not* preferable?<br>
> For instance: API extensions.<br>
><br>
> I think we've seen where API extensions leads us. And it isn't<br>
> pretty. Would you suggest we document what a Nova API extension or a<br>
> Neutron API extension looks like and then propose, for instance, not<br>
> to ever do it again in future APIs and instead use schema<br>
> discoverability?<br>
<br>
So if we had standards leading development rather than lagging in the<br>
past then API extensions would have ended up in the standard because we<br>
once thought they were a good idea.<br>
<br>
Perhaps we should distinguish in the documentation between<br>
recommendations (future looking) and standards (proven it works well<br>
for us). The latter would be potentially enforced a lot more strictly<br>
than the former.<br></blockquote><div><br></div><div style>That will be great to have classification in guidelines (Strict , recommended etc ) and step by step those can be moved to higher classification as project start consuming those.</div><div> </div><blockquote class="gmail_quote" style="margin:0 0 0 .8ex;border-left:1px #ccc solid;padding-left:1ex">
In the case of extensions I think we should have a section documenting<br>
why we think they're a bad idea and new projects certainly shouldn't<br>
use them. But also give some advice around if they are used what<br>
features they should have (eg version numbers!). Given the time that it<br>
takes to make major API infrastructure changes it is inevitable that<br>
there will be api extensions added in the short to medium term. Because<br>
API development will not just stop while API infrastructure is improved.<br>
<br>
> > I think it will be better in git (but we also need it in gerrit)<br>
> > when it comes to resolving conflicts and after we've established a<br>
> > decent document (eg when we have more content). I'm just looking to<br>
> > make it as easy as possible for anyone to add any guidelines now.<br>
> > Once we've actually got something to discuss then we use git/gerrit<br>
> > with patches proposed to resolve conflicts within the document.<br>
><br>
> Of course it would be in Gerrit. I just put it up on GitHub first<br>
> because I can't just add a repo into the openstack/ code<br>
> namespace... :)<br>
<br>
I've submitted a patch to add an api-wg project using your repository<br>
as the initial content for the git repository.<br>
<br>
<a href="https://review.openstack.org/#/c/128466/" target="_blank">https://review.openstack.org/#/c/128466/</a><br>
<br>
Regards,<br>
<br>
Chris<br>
<br>
_______________________________________________<br>
OpenStack-dev mailing list<br>
<a href="mailto:OpenStack-dev@lists.openstack.org">OpenStack-dev@lists.openstack.org</a><br>
<a href="http://lists.openstack.org/cgi-bin/mailman/listinfo/openstack-dev" target="_blank">http://lists.openstack.org/cgi-bin/mailman/listinfo/openstack-dev</a><br>
</blockquote></div><br><br clear="all"><div><br></div>-- <br><div dir="ltr"><div>Thanks & Regards</div><div>Ghanshyam Mann</div><div><br></div></div>
</div></div>