<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;">
On Feb 12, 2015, at 9:29 AM, Ryan Brown <<a href="mailto:rybrown@redhat.com">rybrown@redhat.com</a>> wrote:<br>
<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;">
On 02/10/2015 08:01 AM, Everett Toews wrote:<br>
<blockquote type="cite">On Feb 9, 2015, at 9:28 PM, Jay Pipes <<a href="mailto:jaypipes@gmail.com">jaypipes@gmail.com</a><br>
<<a href="mailto:jaypipes@gmail.com">mailto:jaypipes@gmail.com</a>>> wrote:<br>
<br>
<blockquote type="cite">On 02/02/2015 02:51 PM, Stefano Maffulli wrote:<br>
<blockquote type="cite">On Fri, 2015-01-30 at 23:05 +0000, Everett Toews wrote:<br>
<blockquote type="cite">To converge the OpenStack APIs to a consistent and pragmatic RESTful<br>
design by creating guidelines that the projects should follow. The<br>
intent is not to create backwards incompatible changes in existing<br>
APIs, but to have new APIs and future versions of existing APIs<br>
converge.<br>
</blockquote>
<br>
It's looking good already. I think it would be good also to mention the<br>
end-recipients of the consistent and pragmatic RESTful design so that<br>
whoever reads the mission is reminded why that's important. Something<br>
like:<br>
<br>
To improve developer experience converging the OpenStack API to<br>
a consistent and pragmatic RESTful design. The working group<br>
creates guidelines that all OpenStack projects should follow,<br>
avoids introducing backwards incompatible changes in existing<br>
APIs and promotes convergence of new APIs and future versions of<br>
existing APIs.<br>
</blockquote>
<br>
After reading all the mails in this thread, I've decided that Stef's<br>
suggested mission statement above is the one I think best represents<br>
what we're trying to do.<br>
<br>
That said, I think it should begin "To improve developer experience<br>
*by* converging" ... :)<br>
</blockquote>
<br>
+1<span class="Apple-converted-space"> </span><br>
<br>
I think we could be even more explicit about the audience.<span class="Apple-converted-space"> </span><br>
<br>
To improve developer experience *of API consumers by* converging the<br>
OpenStack API to a consistent and pragmatic RESTful design. The working<br>
group creates guidelines that all OpenStack projects should<br>
follow, avoids introducing backwards incompatible changes in<br>
existing APIs, and promotes convergence of new APIs and future versions<br>
of existing APIs.<br>
<br>
I’m not crazy about the term "API consumer" and could bike shed a bit on<br>
it. The problem being that alternative terms for "API consumer" have<br>
been taken in OpenStack land. “developer” is used for contributor<br>
developers building OpenStack itself, “user” is used for operators<br>
deploying OpenStack, and “end user” has too many meanings. “API<br>
consumer” makes it clear what side of the API the working group audience<br>
falls on.<br>
</blockquote>
<br>
I wouldn't mind "API user", I think it conveys intent but doesn't sound<br>
as stilted as "API consumer”.<br>
</div>
</blockquote>
<div><br>
</div>
<div>I read through the "#topic mission statement” [1] of the last API WG meeting. There is a lot of support for Stefano’s take on the mission statement. As such I’ve proposed the following patch to the api-wg repo with the tweak from “API consumer” to “API
user”.</div>
<div><br>
</div>
<div><a href="https://review.openstack.org/#/c/155911/">https://review.openstack.org/#/c/155911/</a></div>
<div><br>
</div>
<div>We’ve had a lot of discussion on it already so I think it’s time for people to have their final say. Let us know what you think!</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-12-16.00.log.html#l-17">http://eavesdrop.openstack.org/meetings/api_wg/2015/api_wg.2015-02-12-16.00.log.html#l-17</a></div>
<div><br>
</div>
</div>
</body>
</html>