<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; color: rgb(0, 0, 0); font-size: 14px; font-family: Calibri, sans-serif; ">
<div>Hi Steve,</div>
<div><br>
</div>
<div>Note that the two api-ref.xml docs in the two repos have <i>different</i> purposes:</div>
<ul>
<li>Heat repo: the api-ref.xml doc in this repo is the source for the <b>Orchestration API Dev Guide
</b>(which I am planning to start working on), and provides detailed information and examples for each API call. You can see examples of these Dev Guides at docs.openstack.org, such as the OpenStack Compute API v2 and Extensions Reference at
<a href="http://docs.openstack.org/api/openstack-compute/2/content">http://docs.openstack.org/api/openstack-compute/2/content</a>/. I will be working on producing this doc for the Orchestration project.</li><li>Orchestration repo (api-site): the api-ref.xml doc in this repo is the source for the
<b>API Complete Reference</b>, which provides a summary of all the calls for all the OpenStack products (<a href="http://api.openstack.org/api-ref.html">http://api.openstack.org/api-ref.html</a>).</li></ul>
<div>We need to support both of these moving forward, so I would prefer if you don't delete the files listed in your review (<a href="https://review.openstack.org/#/c/46412">https://review.openstack.org/#/c/46412</a>/) — except please do delete the heat-api-1.0.wadl,
which is no longer needed, since we now have the orchestration-api.wadl in the api-site repo. We need the other files to remain, since they provide the infrastructure for the Orchestration Dev Guide (pom.xml, api-ref.xml, and example files) that we need to
produce.</div>
<div><br>
</div>
<div>Mike</div>
<span id="OLK_SRC_BODY_SECTION">
<div style="font-family:Calibri; font-size:11pt; text-align:left; color:black; BORDER-BOTTOM: medium none; BORDER-LEFT: medium none; PADDING-BOTTOM: 0in; PADDING-LEFT: 0in; PADDING-RIGHT: 0in; BORDER-TOP: #b5c4df 1pt solid; BORDER-RIGHT: medium none; PADDING-TOP: 3pt">
<span style="font-weight:bold">From: </span>Steve Baker <<a href="mailto:sbaker@redhat.com">sbaker@redhat.com</a>><br>
<span style="font-weight:bold">Reply-To: </span>OpenStack Development Mailing List <<a href="mailto:openstack-dev@lists.openstack.org">openstack-dev@lists.openstack.org</a>><br>
<span style="font-weight:bold">Date: </span>Wednesday, September 18, 2013 2:08 PM<br>
<span style="font-weight:bold">To: </span>"<a href="mailto:openstack-dev@lists.openstack.org">openstack-dev@lists.openstack.org</a>" <<a href="mailto:openstack-dev@lists.openstack.org">openstack-dev@lists.openstack.org</a>><br>
<span style="font-weight:bold">Subject: </span>Re: [openstack-dev] [Heat] Questions about plans for heat wadls moving forward<br>
</div>
<div><br>
</div>
<div>
<div text="#000000" bgcolor="#FFFFFF">
<div class="moz-cite-prefix">On 09/18/2013 08:09 AM, Mike Asthalter wrote:<br>
</div>
<blockquote cite="mid:CE5F2637.2A5AC%25mike.asthalter@rackspace.com" type="cite">
<div>We were successful yesterday in accessing the orchestration-api wadl in the api-site repo from the api-ref dev guide (<span style="font-family: Cambria; font-size: 12px;
color: rgb(27, 57, 245); "><span style="text-decoration:
underline; "><a moz-do-not-send="true">https://github.com/openstack/heat/blob/master/doc/docbkx/api-ref/src/docbkx/api-ref.xml</a></span></span><span style="font-style: normal; font-size: 14px; text-decoration: none; font-weight: normal; font-family: Calibri, sans-serif; ">)
in the original heat repo using the following syntax in the api-ref.xml doc:</span></div>
<div><span style="font-style: normal; font-size: 14px; text-decoration: none; font-weight: normal; font-family: Calibri, sans-serif; "><br>
</span></div>
<div><span style="font-style: normal; font-size: 14px; text-decoration: none; font-weight: normal; font-family: Calibri, sans-serif; ">
<p style="margin: 0.0px 0.0px 0.0px 0.0px; font: 12.0px
Helvetica; color: #b14314">
<span style="color: #0d21a0"><wadl:resources</span><span style="color: #000000"><br>
</span><span style="color: #ff9667"> href</span><span style="color: #ff925c">=</span><a class="moz-txt-link-rfc2396E" href="http://git.openstack.org/cgit/openstack/api-site/plain/api-ref/src/wadls/orchestration-api/src/v1/orchestration-api.wadl">"http://git.openstack.org/cgit/openstack/api-site/plain/api-ref/src/wadls/orchestration-api/src/v1/orchestration-api.wadl"</a><span style="color: #000000"><br>
</span><span style="color: #ff9667"> </span><span style="color: #00abd2">xmlns:wadl</span><span style="color: #ff925c">=</span><a class="moz-txt-link-rfc2396E" href="http://wadl.dev.java.net/2009/02">"http://wadl.dev.java.net/2009/02"</a><span style="color: #0d21a0">/></span></p>
</span></div>
<div><span style="font-style: normal; font-size: 14px; text-decoration: none; font-weight: normal; font-family: Calibri, sans-serif; "><br>
</span></div>
<div><span style="font-style: normal; font-size: 14px; text-decoration: none; font-weight: normal; font-family: Calibri, sans-serif; ">Therefore, as recommended in our discussion on this mailing list last week, I am planning to submit a patch to delete the
original heat wadl (heat-api-1.0.wadl) and to point the api-ref.xml doc at the orchestration-api.wadl in the api-site repo, as shown above. </span></div>
<div><span style="font-style: normal; font-size: 14px; text-decoration: none; font-weight: normal; font-family: Calibri, sans-serif; "><br>
</span></div>
<div><span style="font-style: normal; font-size: 14px;
text-decoration: none; font-weight: normal; font-family:
Calibri, sans-serif; "><span class="Apple-style-span" style="background-color: rgb(255, 255, 0);">Please let me know by tomorrow
if anyone has any objections to deleting the original heat wadl, heat-api-1.0.wadl.</span></span></div>
<div><span style="font-style: normal; font-size: 14px;
text-decoration: none; font-weight: normal; font-family:
Calibri, sans-serif; "><span class="Apple-style-span" style="background-color: rgb(255, 255, 0);"><br>
</span></span></div>
</blockquote>
There is already a change in progress to delete all of heat's api-ref<br>
<a href="https://review.openstack.org/#/c/46412/">https://review.openstack.org/#/c/46412/</a><br>
<br>
<blockquote cite="mid:CE5F2637.2A5AC%25mike.asthalter@rackspace.com" type="cite">
<div><span style="font-style: normal; font-size: 14px;
text-decoration: none; font-weight: normal; font-family:
Calibri, sans-serif; "><span class="Apple-style-span" style="background-color: rgb(255, 255, 0);"></span></span></div>
<div>On a related note, Anne Gentle has recommended the following:</div>
<div><br>
</div>
<div>"What we also need to build is logic in the build jobs so that any time the api-site WADL is updated, your dev guide is also updated. This is done in the Jenkins job in <a moz-do-not-send="true" href="https://github.com/openstack-infra/config/blob/master/modules/openstack_project/files/jenkins_job_builder/config/api-jobs.yaml">https://github.com/openstack-infra/config/blob/master/modules/openstack_project/files/jenkins_job_builder/config/api-jobs.yaml</a>.
I can either submit this patch for you, or I'll ask Steve or Zane to do so."</div>
<div><br>
</div>
<div>Steve or Zane, is submitting this patch for the build logic something you would like to do, or should we ask Anne to take care of it?</div>
<div><br>
</div>
<br>
</blockquote>
I would think that there is no need at all now for heat/doc/docbkx/api-ref since it is part of api.site. Does this mean there is no need for an update job?<br>
</div>
</div>
</span>
</body>
</html>