<html>
<head>
<meta http-equiv="content-type" content="text/html; charset=ISO-8859-1">
</head>
<body bgcolor="#FFFFFF" text="#000000">
Hello fellow Rudder developpers,<br>
<br>
I was thinking about the fact that our REST API, which is young and
needs-driven, has no established naming convention for method calls.<br>
<br>
Even if it is not directly a problem, it might become one in the
future and will certainly cause misunderstandings about methods
purpose because of people not understanding names the same way.<br>
<br>
We should (as soon as possible) establish a clear way of naming our
REST calls to prevent this.<br>
<br>
Here are some of the examples / leads I found on the vast and great
internet:<br>
<ul>
<li>The OVH french hosting provider, which uses a SOAP API for
machine automation needs.</li>
<ul>
<li>Syntax: service-function-action<br>
</li>
<ul>
<li>Example: telephonySmsSend</li>
</ul>
<li>This is not applicable to us (REST vs SOAP) but it gives
some hints about a possible naming scheme for URIs (
xxx/rest/core/techniques/reload ? )<br>
</li>
</ul>
<li>A complete introduction to this problem: <a
class="moz-txt-link-freetext"
href="http://www.restapitutorial.com/lessons/restfulresourcenaming.html">http://www.restapitutorial.com/lessons/restfulresourcenaming.html</a></li>
<li>The Atlassian Confluence REST documentation: <a
class="moz-txt-link-freetext"
href="http://docs.atlassian.com/atlassian-confluence/REST/latest/">http://docs.atlassian.com/atlassian-confluence/REST/latest/</a>
(note the use of versions in the REST URIs)</li>
</ul>
<p>I hope that these examples will help us to build a consistent
naming scheme that will enable us not to say one day: "Damn it why
should I be forced to read a documentation just to know what this
function does ..."<br>
</p>
Bye !
<div class="moz-signature">-- <br>
<meta content="text/html; charset=ISO-8859-1"
http-equiv="Content-Type">
<style type="text/css">
<!--
a.redlink:link { color: #962322; }
a.redlink:visited { color: #962322; }
.sig { font-family: sans-serif; font-size: small; }
.sigsmall { font-family: sans-serif; font-size: x-small; }
-->
</style>
<table border="0" width="380" cellpadding="0" cellspacing="2">
<tbody>
<tr>
<td colspan="2">
<hr></td>
</tr>
<tr>
<td colspan="2"><b><img alt=""
src="cid:part3.01040004.03050104@normation.com"
align="left" height="50" hspace="10" width="50">
<span class="sig">Matthieu CERDA</span></b><br>
<span class="sig"><i>Sysop - Netop</i></span><br>
<span class="sig"><a class="redlink"
href="http://www.normation.com">Normation</a></span> </td>
</tr>
<tr>
<td colspan="2">
<hr></td>
</tr>
<tr>
<td colspan="2"><span class="sigsmall"><b>87 rue de Turbigo,
75003 Paris, France</b></span></td>
</tr>
<tr>
<td><span class="sigsmall">Telephone:</span></td>
<td><span class="sigsmall">+33 (0)1 84 16 06 01</span></td>
</tr>
<!--<tr>
<td><span class="sigsmall">Mobile:</span></td>
<td><span class="sigsmall">+33 (0)6 XX XX XX XX</span></td>
</tr>--> <tr>
<td colspan="2">
<hr></td>
</tr>
</tbody>
</table>
</div>
</body>
</html>