<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=Windows-1252">
</head>
<body style="word-wrap: break-word; -webkit-nbsp-mode: space; -webkit-line-break: after-white-space;">
Top posting to wrap this up.
<div><br>
</div>
<div>During the last API WG meeting [1] we discussed this topic. Of the 8 people who voted, it was unanimous and we agreed [2] to use the api-wg repo to write our guidelines.</div>
<div><br>
</div>
<div>This email thread wasn’t conclusive on the subject so we’ll be moving forward with the result of the vote at the meeting.</div>
<div><br>
</div>
<div>Unless there’s a strong objection or disagreement with my analysis of the above, the API WG will move forward and use the api-wg repo.<br>
</div>
<div><br>
</div>
<div>Thanks,</div>
<div>Everett</div>
<div><br>
</div>
<div>[1] <a href="http://eavesdrop.openstack.org/meetings/api_wg/2015/api_wg.2015-02-05-00.00.html">http://eavesdrop.openstack.org/meetings/api_wg/2015/api_wg.2015-02-05-00.00.html</a></div>
<div>[2] <a href="http://eavesdrop.openstack.org/meetings/api_wg/2015/api_wg.2015-02-05-00.00.log.html#l-205">http://eavesdrop.openstack.org/meetings/api_wg/2015/api_wg.2015-02-05-00.00.log.html#l-205</a></div>
<div><br>
</div>
<div><br>
<div>
<div>On Jan 31, 2015, at 10:36 AM, James E. Blair <<a href="mailto:corvus@inaugust.com">corvus@inaugust.com</a>> wrote:</div>
<br class="Apple-interchange-newline">
<blockquote type="cite">
<div style="font-size: 12px; font-style: normal; font-variant: normal; font-weight: normal; letter-spacing: normal; line-height: normal; orphans: auto; text-align: start; text-indent: 0px; text-transform: none; white-space: normal; widows: auto; word-spacing: 0px; -webkit-text-stroke-width: 0px;">
"Kevin L. Mitchell" <<a href="mailto:kevin.mitchell@rackspace.com">kevin.mitchell@rackspace.com</a>> writes:<br>
<br>
<blockquote type="cite">On Fri, 2015-01-30 at 22:33 +0000, Everett Toews wrote:<br>
<blockquote type="cite">It was suggested that the API WG use the openstack-specs [1] and/or<br>
the api-wg [2] repo to publish its guidelines. We’ve already arrived<br>
at the consensus that we should only use 1 repo [3]. So the purpose of<br>
this thread is to decide...<br>
<br>
Should the API WG use the openstack-specs repo or the api-wg repo?<br>
<br>
Let’s discuss.<br>
</blockquote>
<br>
Well, the guidelines are just that: guidelines. They don't implicitly<br>
propose changes to any OpenStack projects, just provide guidance for<br>
future API changes. Thus, I think they should go in a repo separate<br>
from any of our *-specs repos; to me, a spec provides documentation of a<br>
change, and is thus independent of the guidelines.<br>
</blockquote>
<br>
Hi,<br>
<br>
As a user of OpenStack I find the APIs inconsistent with each other. My<br>
understanding is that the API wg hopes to change this (thanks!). As the<br>
current reality is almost certainly not going to be completely in<br>
alignment with the result of the wg, I think that necessarily there will<br>
be a change in some software.<br>
<br>
Consider the logging spec -- it says "logs should look like this and use<br>
these levels under these circumstances". Many projects do not match<br>
that at the moment, and will need changes. I can imagine something<br>
similar with the API wg.<br>
<br>
Perhaps with APIs, things are a bit more complex and in addition to a<br>
cross-project spec, we would need individual project specs to say "in<br>
order to get foo's API consistent with the guidelines, we will need to<br>
make these changes and support these behaviors during a deprecation<br>
period". If that's the case, we can certainly put that level of detail<br>
in an individual project spec repo while keeping the cross-project spec<br>
focused on what things _should_ look like.<br>
<br>
At any rate, I think it is important that eventually the result of the<br>
API wg causes technical change to happen, and as such, I think the<br>
openstack-specs repo seems like a good place. I believe that<br>
openstack-specs also provides a good place for reference documentation<br>
like this (and logging guidelines, etc) to be published indefinitely for<br>
current and new projects.<br>
<br>
-Jim<br>
<br>
__________________________________________________________________________<br>
OpenStack Development Mailing List (not for usage questions)<br>
Unsubscribe:<span class="Apple-converted-space"> </span><a href="mailto:OpenStack-dev-request@lists.openstack.org">OpenStack-dev-request@lists.openstack.org</a>?subject:unsubscribe<br>
<a href="http://lists.openstack.org/cgi-bin/mailman/listinfo/openstack-dev">http://lists.openstack.org/cgi-bin/mailman/listinfo/openstack-dev</a></div>
</blockquote>
</div>
<br>
</div>
</body>
</html>