<div dir="ltr">Tricky. First, I am new to OpenStack, and as such tend to want to shut-up and listen.<div><br></div><div>Second, I have done APIs for distributed systems for over 30 years. Yes, I got in very early. As such I am guilty of or saw lots of bad examples. Also I found patterns that worked very well.</div><div><br></div><div>That said, the approach to APIs and versioning in OpenStack ... does not make sense, to me. Seems a mess. Maybe I am wrong. Or not.<br><br>The notion of a group that offers living advice to the various OpenStack projects on APIs is - I think - a good notion. Written guidelines are good, to a point, but only that. Interpreting static documents has limits.</div><div><br></div><div>My current impression is the folk offering APIs need help. So if this offering evaluates in the end as help, this is a good idea. :)</div><div><br></div><div><br></div></div><div class="gmail_extra"><br><div class="gmail_quote">On Fri, Oct 10, 2014 at 9:09 AM, Jay Pipes <span dir="ltr"><<a href="mailto:jaypipes@gmail.com" target="_blank">jaypipes@gmail.com</a>></span> wrote:<br><blockquote class="gmail_quote" style="margin:0 0 0 .8ex;border-left:1px #ccc solid;padding-left:1ex">Thanks for getting this going, Everett! Comments inline...<span class=""><br>
<br>
On 10/08/2014 07:05 PM, Everett Toews wrote:<br>
<blockquote class="gmail_quote" style="margin:0 0 0 .8ex;border-left:1px #ccc solid;padding-left:1ex">
<a href="https://wiki.openstack.org/wiki/API_Working_Group" target="_blank">https://wiki.openstack.org/<u></u>wiki/API_Working_Group</a><br>
<br>
This is the start of the API Working Group (API WG).<br>
</blockquote>
<br></span>
yay! :)<span class=""><br>
<br>
<blockquote class="gmail_quote" style="margin:0 0 0 .8ex;border-left:1px #ccc solid;padding-left:1ex">
To avoid bike shedding over the name of the working group, I decided<br>
to title the wiki page API Working Group. Simple, to the point, and<br>
avoids loaded terms like standards, best practices, guidelines,<br>
conventions, etc.<br>
</blockquote>
<br></span>
Yup, ++<span class=""><br>
<br>
<blockquote class="gmail_quote" style="margin:0 0 0 .8ex;border-left:1px #ccc solid;padding-left:1ex">
The point isn’t what we name it. The point is what action we take<br>
about it. I propose the deliverables in the API WG wiki page.<br>
<br>
Speaking of the wiki page, I wrote it very matter-of-factly. As if<br>
this is the way things are. They’re not. The wiki page is just a<br>
starting point. If something was missed, add it. If something can be<br>
improved, improve it. Let’s try to keep it simple though.<br>
</blockquote>
<br></span>
The wiki content looks fine, with the exception that I really do feel the working group needs to have some ability to review and enforce consistency within proposed REST APIs. The wording right now is:<br>
<br>
"The API WG is focused on creating guidelines for the APIs"<br>
<br>
which of course is fine, but I think that the Technical Committee should essentially grant the working group the power to enforce guidelines and consistency for proposed new REST APIs -- whether it's a new REST API version in an existing project or a REST APi for a newly-proposed OpenStack server project.<span class=""><br>
<br>
<blockquote class="gmail_quote" style="margin:0 0 0 .8ex;border-left:1px #ccc solid;padding-left:1ex">
I invite everyone who chimed in on the original thread [1] that<br>
kicked this off to add themselves as a member committed to making the<br>
OpenStack APIs better. I’ve Cc’d everyone who asked to be kept in the<br>
loop.<br>
<br>
I already see some cross project summit topics [2] on APIs. But<br>
frankly, with the number of people committed to this topic, I’d<br>
expect there to be more. I encourage everyone to submit more API<br>
related sessions with better descriptions and goals about what you<br>
want to achieve in those sessions.<br>
</blockquote>
<br></span>
Will do.<br>
<br>
Best,<br>
-jay<div class="HOEnZb"><div class="h5"><br>
<br>
<blockquote class="gmail_quote" style="margin:0 0 0 .8ex;border-left:1px #ccc solid;padding-left:1ex">
Regards, Everett<br>
<br>
[1]<br>
<a href="http://lists.openstack.org/pipermail/openstack-dev/2014-September/046850.html" target="_blank">http://lists.openstack.org/<u></u>pipermail/openstack-dev/2014-<u></u>September/046850.html</a><br>
[2] <a href="https://etherpad.openstack.org/p/kilo-crossproject-summit-topics" target="_blank">https://etherpad.openstack.<u></u>org/p/kilo-crossproject-<u></u>summit-topics</a><br>
</blockquote>
<br>
______________________________<u></u>_________________<br>
OpenStack-dev mailing list<br>
<a href="mailto:OpenStack-dev@lists.openstack.org" target="_blank">OpenStack-dev@lists.openstack.<u></u>org</a><br>
<a href="http://lists.openstack.org/cgi-bin/mailman/listinfo/openstack-dev" target="_blank">http://lists.openstack.org/<u></u>cgi-bin/mailman/listinfo/<u></u>openstack-dev</a><br>
</div></div></blockquote></div><br></div>