<html>
<head>
<meta content="text/html; charset=ISO-8859-1"
http-equiv="Content-Type">
</head>
<body text="#000000" bgcolor="#FFFFFF">
<div class="moz-cite-prefix">On 09/13/2013 08:28 AM, Mike Asthalter
wrote:<br>
</div>
<blockquote cite="mid:CE578CEC.29F37%25mike.asthalter@rackspace.com"
type="cite">
<meta http-equiv="Content-Type" content="text/html;
charset=ISO-8859-1">
<div>Hello,</div>
<div><br>
</div>
<div>Can someone please explain the plans for our 2 wadls moving
forward:</div>
<ul>
<li>wadl in original heat repo: <span class="Apple-style-span"
style="font-family: Cambria; font-size: 12px; color: rgb(27,
57, 245); "><span style="text-decoration: underline"><a
moz-do-not-send="true"
href="%22https://github.com/openstack/heat/blob/master/doc/docbkx/api-ref/src/wadls/heat-api/src/heat-api-1.">https://github.com/openstack/heat/blob/master/doc/docbkx/api-ref/src/wadls/heat-api/src/heat-api-1.0.wadl</a></span></span></li>
<li><font class="Apple-style-span" size="3" color="#0000EE"
face="Cambria"><span class="Apple-style-span"
style="font-size: 12px;"><span class="Apple-style-span"
style="color: rgb(0, 0, 0);
-webkit-text-decorations-in-effect: none; font-size:
14px; font-family: Calibri, sans-serif; ">wadl in
api-site repo: </span></span></font><span
class="Apple-style-span" style="font-family: Cambria;
font-size: 12px; color: rgb(27, 57, 245); "><span
style="text-decoration: underline"><a
moz-do-not-send="true"
href="https://github.com/openstack/api-site/blob/master/api-ref/src/wadls/orchestration-api/src/v1/orchestration-api.wadl">https://github.com/openstack/api-site/blob/master/api-ref/src/wadls/orchestration-api/src/v1/orchestration-api.wadl</a></span></span></li>
</ul>
</blockquote>
The original intention was to delete the heat wadl when the api-site
one became merged.<br>
<blockquote cite="mid:CE578CEC.29F37%25mike.asthalter@rackspace.com"
type="cite">
<div><font class="Apple-style-span" size="3" color="#0000EE"
face="Cambria"><span class="Apple-style-span"
style="font-size: 12px;"><span class="Apple-style-span"
style="color: rgb(0, 0, 0);
-webkit-text-decorations-in-effect: none; font-size: 14px;
font-family: Calibri, sans-serif; ">1. Is there a need to
maintain 2 wadls moving forward, with the wadl in the
original heat repo containing calls that may not be
implemented, and the wadl in the api-site repo containing
implemented calls only? </span></span></font></div>
<blockquote style="margin:0 0 0 40px; border:none; padding:0px;">
<div><font class="Apple-style-span" size="3" color="#0000EE"
face="Cambria"><span class="Apple-style-span"
style="font-size: 12px;"><span class="Apple-style-span"
style="color: rgb(0, 0, 0);
-webkit-text-decorations-in-effect: none; font-size:
14px; font-family: Calibri, sans-serif; ">Anne Gentle
advises as follows in regard to these 2 wadls:</span></span></font></div>
<div><font class="Apple-style-span" size="3" color="#0000EE"
face="Cambria"><span class="Apple-style-span"
style="font-size: 12px;"><span class="Apple-style-span"
style="color: rgb(0, 0, 0);
-webkit-text-decorations-in-effect: none; font-size:
14px; font-family: Calibri, sans-serif; "><br>
</span></span></font></div>
<div><font class="Apple-style-span" size="3" color="#0000EE"
face="Cambria"><span class="Apple-style-span"
style="font-size: 12px;"><span class="Apple-style-span"
style="color: rgb(0, 0, 0);
-webkit-text-decorations-in-effect: none; font-size:
14px; font-family: Calibri, sans-serif; ">"I'd like the
WADL in api-site repo to be user-facing. The other WADL
can be truth if it needs to be a specification that's
not yet implemented. If the WADL in api-site repo is
true and implemented, please just maintain one going
forward."</span></span></font></div>
</blockquote>
<div><font class="Apple-style-span" size="3" color="#0000EE"
face="Cambria"><span class="Apple-style-span"
style="font-size: 12px;"><span class="Apple-style-span"
style="color: rgb(0, 0, 0);
-webkit-text-decorations-in-effect: none; font-size: 14px;
font-family: Calibri, sans-serif; "><br>
</span></span></font></div>
<div><font class="Apple-style-span" size="3" color="#0000EE"
face="Cambria"><span class="Apple-style-span"
style="font-size: 12px;"><span class="Apple-style-span"
style="color: rgb(0, 0, 0);
-webkit-text-decorations-in-effect: none; font-size: 14px;
font-family: Calibri, sans-serif; ">2. If we maintain 2
wadls, what are the consequences (gerrit reviews, docs out
of sync, etc.)?</span></span></font></div>
<div><span style="color: rgb(0, 0, 0); font-size: 14px;
font-style: normal; font-weight: normal; text-decoration:
none; font-family: Calibri, sans-serif; "><br>
</span></div>
<div><span style="color: rgb(0, 0, 0); font-size: 14px;
font-style: normal; font-weight: normal; text-decoration:
none; font-family: Calibri, sans-serif; ">3. If we maintain
only the 1 orchestration wadl, how do we want to pull in the
wadl content to the api-ref doc (<span
class="Apple-style-span" style="font-family: Cambria;
font-size: 12px; color: rgb(27, 57, 245); "><span
style="text-decoration: underline"><a
moz-do-not-send="true"
href="%22https://github.com/openstack/heat/blob/master/doc/docbkx/api-ref/src/docb">https://github.com/openstack/heat/blob/master/doc/docbkx/api-ref/src/docbkx/api-ref.xml</a></span></span><span
style="color: rgb(0, 0, 0); font-size: 14px; font-style:
normal; font-weight: normal; text-decoration: none;
font-family: Calibri, sans-serif; ">) from the </span>orchestration
wadl in the api-site repo: subtree merge, other?</span></div>
<div><br>
</div>
<br>
</blockquote>
These are good questions, and could apply equally to other
out-of-tree docs as features get added during the development cycle.<br>
<br>
I still think that our wadl should live only in api-site. If
api-site has no branching policy to maintain separate Havana and
Icehouse versions then maybe Icehouse changes should be posted as
WIP reviews until they can be merged.<br>
</body>
</html>