<html xmlns:v="urn:schemas-microsoft-com:vml" xmlns:o="urn:schemas-microsoft-com:office:office" xmlns:w="urn:schemas-microsoft-com:office:word" xmlns:m="http://schemas.microsoft.com/office/2004/12/omml" xmlns="http://www.w3.org/TR/REC-html40">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=us-ascii">
<meta name="Generator" content="Microsoft Word 12 (filtered medium)">
<style><!--
/* Font Definitions */
@font-face
{font-family:SimSun;
panose-1:2 1 6 0 3 1 1 1 1 1;}
@font-face
{font-family:"Cambria Math";
panose-1:2 4 5 3 5 4 6 3 2 4;}
@font-face
{font-family:Calibri;
panose-1:2 15 5 2 2 2 4 3 2 4;}
@font-face
{font-family:"\@SimSun";
panose-1:2 1 6 0 3 1 1 1 1 1;}
/* Style Definitions */
p.MsoNormal, li.MsoNormal, div.MsoNormal
{margin:0cm;
margin-bottom:.0001pt;
font-size:11.0pt;
font-family:"Calibri","sans-serif";}
a:link, span.MsoHyperlink
{mso-style-priority:99;
color:blue;
text-decoration:underline;}
a:visited, span.MsoHyperlinkFollowed
{mso-style-priority:99;
color:purple;
text-decoration:underline;}
p.MsoListParagraph, li.MsoListParagraph, div.MsoListParagraph
{mso-style-priority:34;
margin-top:0cm;
margin-right:0cm;
margin-bottom:0cm;
margin-left:36.0pt;
margin-bottom:.0001pt;
font-size:11.0pt;
font-family:"Calibri","sans-serif";}
span.EmailStyle17
{mso-style-type:personal-compose;
font-family:"Calibri","sans-serif";
color:windowtext;}
.MsoChpDefault
{mso-style-type:export-only;}
@page WordSection1
{size:612.0pt 792.0pt;
margin:72.0pt 72.0pt 72.0pt 72.0pt;}
div.WordSection1
{page:WordSection1;}
--></style><!--[if gte mso 9]><xml>
<o:shapedefaults v:ext="edit" spidmax="1026" />
</xml><![endif]--><!--[if gte mso 9]><xml>
<o:shapelayout v:ext="edit">
<o:idmap v:ext="edit" data="1" />
</o:shapelayout></xml><![endif]-->
</head>
<body lang="EN-CA" link="blue" vlink="purple">
<div class="WordSection1">
<p class="MsoNormal">Hi API working group,<o:p></o:p></p>
<p class="MsoNormal"><o:p> </o:p></p>
<p class="MsoNormal">I am from the Zun team and I wanted to consult with you about the API design. Our team was discussing what is the best API design for exposing different container operations [1]. There are two proposed options:<o:p></o:p></p>
<p class="MsoNormal"><o:p> </o:p></p>
<p class="MsoNormal">1. Expose multiple URLs for individual container operation. For example:<o:p></o:p></p>
<p class="MsoNormal">* POST /containers/<ID>/start: Start a container<o:p></o:p></p>
<p class="MsoNormal">* POST /containers/<ID>/stop: Stop a container<o:p></o:p></p>
<p class="MsoNormal">* POST /containers/<ID>/reboot: Reboot a container<o:p></o:p></p>
<p class="MsoNormal">* POST /containers/<ID>/pause: Pause a container<o:p></o:p></p>
<p class="MsoNormal">….<o:p></o:p></p>
<p class="MsoNormal"><o:p> </o:p></p>
<p class="MsoNormal">2. Expose a single URL for all operations. For example:<o:p></o:p></p>
<p class="MsoNormal">* POST /containers/<ID>/action<o:p></o:p></p>
<p class="MsoNormal">{‘start’: {…}}<o:p></o:p></p>
<p class="MsoNormal">* POST /containers/<ID>/action<o:p></o:p></p>
<p class="MsoNormal">{‘stop’: {…}}<o:p></o:p></p>
<p class="MsoNormal">* POST /containers/<ID>/action<o:p></o:p></p>
<p class="MsoNormal">{‘reboot’: {…}}<o:p></o:p></p>
<p class="MsoNormal">* POST /containers/<ID>/action<o:p></o:p></p>
<p class="MsoNormal">{‘pause’: {…}}<o:p></o:p></p>
<p class="MsoNormal">….<o:p></o:p></p>
<p class="MsoNormal"><o:p> </o:p></p>
<p class="MsoNormal">After a quick search, it looks option #1 was chosen by Ironic, and option #2 was chosen by Nova, Cinder, Senlin, etc. Some services use a mix of these two styles. I would like to know if there is a guidance from API working group in this
regards. Does API working group flavor one style over the other? Thanks in advance.<o:p></o:p></p>
<p class="MsoNormal"><o:p> </o:p></p>
<p class="MsoNormal">Best regards,<o:p></o:p></p>
<p class="MsoNormal">Hongbin<o:p></o:p></p>
<p class="MsoNormal"><o:p> </o:p></p>
<p class="MsoNormal">[1] https://etherpad.openstack.org/p/zun-core-api<o:p></o:p></p>
</div>
</body>
</html>