<div dir="ltr">Copying the list so others may look up the answer later.<div class="gmail_extra"><br><div class="gmail_quote">On Wed, Dec 3, 2014 at 10:26 AM, Waines, Greg <span dir="ltr"><<a href="mailto:Greg.Waines@windriver.com" target="_blank">Greg.Waines@windriver.com</a>></span> wrote:<br><blockquote class="gmail_quote" style="margin:0px 0px 0px 0.8ex;border-left-width:1px;border-left-color:rgb(204,204,204);border-left-style:solid;padding-left:1ex">
<div lang="EN-US" link="blue" vlink="purple">
<div>
<p class="MsoNormal">Anne / Andreas,<u></u><u></u></p>
<p class="MsoNormal"><u></u> <u></u></p>
<p class="MsoNormal">First … I apologize for using your personal emails rather than the mailing list, but I dropped off the<br>
mailing list a month or so ago because most of the emails did not apply to what I was up to.<u></u><u></u></p>
<p class="MsoNormal"><u></u> <u></u></p>
<p class="MsoNormal">Anyways, what I wanted to ask you …<u></u><u></u></p>
<p class="MsoNormal">So I basically cloned the REST API DOC structure that you guys have … i.e. using the maven tool<br>
and the same directory layout etc … in order to support the writing of ‘Incremental REST API Docs’<br>
for extensions that we are doing on top of OpenStack.<u></u><u></u></p>
<p class="MsoNormal"><u></u> <u></u></p>
<p class="MsoNormal">A somewhat minor (but annoying) behavior that I’ve noticed in the PDF output is:</p></div></div></blockquote><div><br></div><div>Wanted to point out that there are two PDF outputs, one for the API Reference, one for the longer "Developer Guides." It looks like you're talking about the longer "Developer Guide" which we do not produce for OpenStack any more for various reasons I don't need to go into to answer your question. Just wanted to be sure you have some context.</div><blockquote class="gmail_quote" style="margin:0px 0px 0px 0.8ex;border-left-width:1px;border-left-color:rgb(204,204,204);border-left-style:solid;padding-left:1ex"><div lang="EN-US" link="blue" vlink="purple"><div><p class="MsoNormal"><u></u><u></u></p>
<p><u></u><span style="font-family:Symbol"><span>·<span style="font-style:normal;font-variant:normal;font-weight:normal;font-stretch:normal;font-size:7pt;line-height:normal;font-family:'Times New Roman'">
</span></span></span><u></u>for both Request and Response sections<u></u><u></u></p>
<p><u></u><span style="font-family:Symbol"><span>·<span style="font-style:normal;font-variant:normal;font-weight:normal;font-stretch:normal;font-size:7pt;line-height:normal;font-family:'Times New Roman'">
</span></span></span><u></u>even though I define a Table for the request/response parameters and
<br>
provide a JSON example<u></u><u></u></p>
<p><u></u><span style="font-family:Symbol"><span>·<span style="font-style:normal;font-variant:normal;font-weight:normal;font-stretch:normal;font-size:7pt;line-height:normal;font-family:'Times New Roman'">
</span></span></span><u></u>…<u></u><u></u></p>
<p><u></u><span style="font-family:Symbol"><span>·<span style="font-style:normal;font-variant:normal;font-weight:normal;font-stretch:normal;font-size:7pt;line-height:normal;font-family:'Times New Roman'">
</span></span></span><u></u><b><i>I always get the line<br>
“This operation does not accept a request body.”</i></b></p></div></div></blockquote><div><br></div><div>This line is found in the xsl transforms that are in clouddocs-maven-plugin. </div><div><a href="https://github.com/stackforge/clouddocs-maven-plugin/blob/a0c4efad86d03d263bb6d02977d088f8a9ee5eb0/src/main/resources/cloud/apipage/apipage-main.xsl#L29">https://github.com/stackforge/clouddocs-maven-plugin/blob/a0c4efad86d03d263bb6d02977d088f8a9ee5eb0/src/main/resources/cloud/apipage/apipage-main.xsl#L29</a><br></div><div><a href="https://github.com/stackforge/clouddocs-maven-plugin/blob/adff7d1c8018e6e4d3dc249f7210d99836584342/src/main/resources/cloud/process-embedded-wadl-3.xsl#L17">https://github.com/stackforge/clouddocs-maven-plugin/blob/adff7d1c8018e6e4d3dc249f7210d99836584342/src/main/resources/cloud/process-embedded-wadl-3.xsl#L17</a><br></div><blockquote class="gmail_quote" style="margin:0px 0px 0px 0.8ex;border-left-width:1px;border-left-color:rgb(204,204,204);border-left-style:solid;padding-left:1ex"><div lang="EN-US" link="blue" vlink="purple"><div><p><b><i><u></u><u></u></i></b></p>
<p><u></u><span style="font-family:Symbol"><span>·<span style="font-style:normal;font-variant:normal;font-weight:normal;font-stretch:normal;font-size:7pt;line-height:normal;font-family:'Times New Roman'">
</span></span></span><u></u>see below<u></u><u></u></p>
<p style="margin-left:1in">
<u></u><span style="font-family:'Courier New'"><span>o<span style="font-style:normal;font-variant:normal;font-weight:normal;font-stretch:normal;font-size:7pt;line-height:normal;font-family:'Times New Roman'">
</span></span></span><u></u>I’ve cut & paste a section from the PDF<u></u><u></u></p>
<p style="margin-left:1in">
<u></u><span style="font-family:'Courier New'"><span>o<span style="font-style:normal;font-variant:normal;font-weight:normal;font-stretch:normal;font-size:7pt;line-height:normal;font-family:'Times New Roman'">
</span></span></span><u></u>and provided the applicable portion of the WADL file<u></u><u></u></p>
<p><u></u><span style="font-family:Symbol"><span>·<span style="font-style:normal;font-variant:normal;font-weight:normal;font-stretch:normal;font-size:7pt;line-height:normal;font-family:'Times New Roman'">
</span></span></span><u></u> <u></u><u></u></p>
<p><u></u><span style="font-family:Symbol"><span>·<span style="font-style:normal;font-variant:normal;font-weight:normal;font-stretch:normal;font-size:7pt;line-height:normal;font-family:'Times New Roman'">
</span></span></span><u></u>NOTE<u></u><u></u></p>
<p style="margin-left:1in">
<u></u><span style="font-family:'Courier New'"><span>o<span style="font-style:normal;font-variant:normal;font-weight:normal;font-stretch:normal;font-size:7pt;line-height:normal;font-family:'Times New Roman'">
</span></span></span><u></u>in order to reduce the size of the overall document,<br>
I was only providing ‘samples’ for JSON … and NOT XML<u></u><u></u></p>
<p class="MsoNormal"><u></u> </p></div></div></blockquote><div><br></div><div>OpenStack APIs are moving away from XML requests and responses as well. </div><div> </div><blockquote class="gmail_quote" style="margin:0px 0px 0px 0.8ex;border-left-width:1px;border-left-color:rgb(204,204,204);border-left-style:solid;padding-left:1ex"><div lang="EN-US" link="blue" vlink="purple"><div><p class="MsoNormal"><u></u></p>
<p class="MsoNormal">Any ideas how I can get rid of the incorrect statement above ?<br>
(when I actually have specified a request body)<u></u><u></u></p>
<p class="MsoNormal"><u></u> </p></div></div></blockquote><div><br></div><div>Those PDFs are riddled with these types of issues. You can certainly edit the message itself in the maven plugin and rebuild it. Or you could figure out the logic where the maven plugin assumes the presence of an XML request and fix that. In the OpenStack docs we don't intend to use this output going forward. </div><div><br></div><div>Hope this helps - </div><div>Anne</div><div> </div><blockquote class="gmail_quote" style="margin:0px 0px 0px 0.8ex;border-left-width:1px;border-left-color:rgb(204,204,204);border-left-style:solid;padding-left:1ex"><div lang="EN-US" link="blue" vlink="purple"><div><p class="MsoNormal"><u></u></p>
<p class="MsoNormal">Greg.<u></u><u></u></p>
<p class="MsoNormal"><u></u> <u></u></p>
<p class="MsoNormal"><u></u> <u></u></p>
<p class="MsoNormal"><u></u> <u></u></p>
<p class="MsoNormal"><u></u> <u></u></p>
<p class="MsoNormal"><img width="663" height="408" src="cid:image003.png@01D00EEC.00F9DC70"><u></u><u></u></p>
<p class="MsoNormal"><u></u> <u></u></p>
<p class="MsoNormal"><u></u> <u></u></p>
<p class="MsoNormal">… excerpt from the WADL file:<u></u><u></u></p>
<p class="MsoNormal"><u></u> <u></u></p>
<p class="MsoNormal"><span style="font-size:8pt;font-family:'Courier New'"> <method name="PATCH" id="modifyHost"><u></u><u></u></span></p>
<p class="MsoNormal"><span style="font-size:8pt;font-family:'Courier New'"> <wadl:doc xmlns="<a href="http://docbook.org/ns/docbook" target="_blank">http://docbook.org/ns/docbook</a>" xml:lang="EN"<u></u><u></u></span></p>
<p class="MsoNormal"><span style="font-size:8pt;font-family:'Courier New'"> title="Modify host"><u></u><u></u></span></p>
<p class="MsoNormal"><span style="font-size:8pt;font-family:'Courier New'"> <para role="shortdesc">Modifies a specific host.</para><u></u><u></u></span></p>
<p class="MsoNormal"><span style="font-size:8pt;font-family:'Courier New'"> <para>The atrributes of a Host which are modifiable:</para><u></u><u></u></span></p>
<p class="MsoNormal"><span style="font-size:8pt;font-family:'Courier New'"> <itemizedlist><u></u><u></u></span></p>
<p class="MsoNormal"><span style="font-size:8pt;font-family:'Courier New'"> <listitem><para>personality,</para></listitem><u></u><u></u></span></p>
<p class="MsoNormal"><span style="font-size:8pt;font-family:'Courier New'"> <listitem><para>hostname,</para></listitem><u></u><u></u></span></p>
<p class="MsoNormal"><span style="font-size:8pt;font-family:'Courier New'"> <listitem><para>bm_type,</para></listitem><u></u><u></u></span></p>
<p class="MsoNormal"><span style="font-size:8pt;font-family:'Courier New'"> <listitem><para>bm_mac,</para></listitem><u></u><u></u></span></p>
<p class="MsoNormal"><span style="font-size:8pt;font-family:'Courier New'"> <listitem><para>bm_username,</para></listitem><u></u><u></u></span></p>
<p class="MsoNormal"><span style="font-size:8pt;font-family:'Courier New'"> <listitem><para>serialid,</para></listitem><u></u><u></u></span></p>
<p class="MsoNormal"><span style="font-size:8pt;font-family:'Courier New'"> <listitem><para>location.</para></listitem><u></u><u></u></span></p>
<p class="MsoNormal"><span style="font-size:8pt;font-family:'Courier New'"> </itemizedlist><u></u><u></u></span></p>
<p class="MsoNormal"><span style="font-size:8pt;font-family:'Courier New'"> </wadl:doc><u></u><u></u></span></p>
<p class="MsoNormal"><span style="font-size:8pt;font-family:'Courier New'"> <request><u></u><u></u></span></p>
<p class="MsoNormal"><span style="font-size:8pt;font-family:'Courier New'"> <representation mediaType="application/xml"><u></u><u></u></span></p>
<p class="MsoNormal"><span style="font-size:8pt;font-family:'Courier New'"> <wadl:doc xmlns="<a href="http://docbook.org/ns/docbook" target="_blank">http://docbook.org/ns/docbook</a>" xml:lang="EN"><u></u><u></u></span></p>
<p class="MsoNormal"><span style="font-size:8pt;font-family:'Courier New'"> </wadl:doc><u></u><u></u></span></p>
<p class="MsoNormal"><span style="font-size:8pt;font-family:'Courier New'"> <param xmlns="<a href="http://wadl.dev.java.net/2009/02" target="_blank">http://wadl.dev.java.net/2009/02</a>"<u></u><u></u></span></p>
<p class="MsoNormal"><span style="font-size:8pt;font-family:'Courier New'"> name="firstParameter" style="plain" type="xsd:string" ><u></u><u></u></span></p>
<p class="MsoNormal"><span style="font-size:8pt;font-family:'Courier New'"> <wadl:doc xmlns="<a href="http://docbook.org/ns/docbook" target="_blank">http://docbook.org/ns/docbook</a>"<u></u><u></u></span></p>
<p class="MsoNormal"><span style="font-size:8pt;font-family:'Courier New'"> xmlns:wadl="<a href="http://wadl.dev.java.net/2009/02" target="_blank">http://wadl.dev.java.net/2009/02</a>" xml:lang="EN"><u></u><u></u></span></p>
<p class="MsoNormal"><span style="font-size:8pt;font-family:'Courier New'"> <para>This parameter specifies ... .<u></u><u></u></span></p>
<p class="MsoNormal"><span style="font-size:8pt;font-family:'Courier New'"> Valid values are: <code>value1</code>, <code>value2</code> or<u></u><u></u></span></p>
<p class="MsoNormal"><span style="font-size:8pt;font-family:'Courier New'"> <code>value3</code>.<u></u><u></u></span></p>
<p class="MsoNormal"><span style="font-size:8pt;font-family:'Courier New'"> </para><u></u><u></u></span></p>
<p class="MsoNormal"><span style="font-size:8pt;font-family:'Courier New'"> </wadl:doc><u></u><u></u></span></p>
<p class="MsoNormal"><span style="font-size:8pt;font-family:'Courier New'"> </param><u></u><u></u></span></p>
<p class="MsoNormal"><span style="font-size:8pt;font-family:'Courier New'"> <param xmlns="<a href="http://wadl.dev.java.net/2009/02" target="_blank">http://wadl.dev.java.net/2009/02</a>"<u></u><u></u></span></p>
<p class="MsoNormal"><span style="font-size:8pt;font-family:'Courier New'"> name="secondParameter" style="plain" type="xsd:string" ><u></u><u></u></span></p>
<p class="MsoNormal"><span style="font-size:8pt;font-family:'Courier New'"> <wadl:doc xmlns="<a href="http://docbook.org/ns/docbook" target="_blank">http://docbook.org/ns/docbook</a>"<u></u><u></u></span></p>
<p class="MsoNormal"><span style="font-size:8pt;font-family:'Courier New'"> xmlns:wadl="<a href="http://wadl.dev.java.net/2009/02" target="_blank">http://wadl.dev.java.net/2009/02</a>" xml:lang="EN"><u></u><u></u></span></p>
<p class="MsoNormal"><span style="font-size:8pt;font-family:'Courier New'"> <para>This parameter specifies ... .<u></u><u></u></span></p>
<p class="MsoNormal"><span style="font-size:8pt;font-family:'Courier New'"> Valid values are: <code>value1</code>, <code>value2</code> or<u></u><u></u></span></p>
<p class="MsoNormal"><span style="font-size:8pt;font-family:'Courier New'"> <code>value3</code>.</para><u></u><u></u></span></p>
<p class="MsoNormal"><span style="font-size:8pt;font-family:'Courier New'"> </wadl:doc><u></u><u></u></span></p>
<p class="MsoNormal"><span style="font-size:8pt;font-family:'Courier New'"> </param><u></u><u></u></span></p>
<p class="MsoNormal"><span style="font-size:8pt;font-family:'Courier New'"> </representation><u></u><u></u></span></p>
<p class="MsoNormal"><span style="font-size:8pt;font-family:'Courier New'"> <representation mediaType="application/json"><u></u><u></u></span></p>
<p class="MsoNormal"><span style="font-size:8pt;font-family:'Courier New'"> <wadl:doc xmlns="<a href="http://docbook.org/ns/docbook" target="_blank">http://docbook.org/ns/docbook</a>" xml:lang="EN"><u></u><u></u></span></p>
<p class="MsoNormal"><span style="font-size:8pt;font-family:'Courier New'"> <xsdxt:code href="api_samples/host_modify-request.json"/><u></u><u></u></span></p>
<p class="MsoNormal"><span style="font-size:8pt;font-family:'Courier New'"> </wadl:doc><u></u><u></u></span></p>
<p class="MsoNormal"><span style="font-size:8pt;font-family:'Courier New'"> </representation><u></u><u></u></span></p>
<p class="MsoNormal"><span style="font-size:8pt;font-family:'Courier New'"> </request><u></u><u></u></span></p>
<p class="MsoNormal"><span style="font-size:8pt;font-family:'Courier New'"> <response status="200"><u></u><u></u></span></p>
<p class="MsoNormal"><span style="font-size:8pt;font-family:'Courier New'"> <representation mediaType="application/xml"><u></u><u></u></span></p>
<p class="MsoNormal"><span style="font-size:8pt;font-family:'Courier New'"> <wadl:doc xmlns="<a href="http://docbook.org/ns/docbook" target="_blank">http://docbook.org/ns/docbook</a>" xml:lang="EN"><u></u><u></u></span></p>
<p class="MsoNormal"><span style="font-size:8pt;font-family:'Courier New'"> </wadl:doc><br>
&hostListShowParameters;<u></u><u></u></span></p>
<p class="MsoNormal"><span style="font-size:8pt;font-family:'Courier New'"> </representation><u></u><u></u></span></p>
<p class="MsoNormal"><span style="font-size:8pt;font-family:'Courier New'"> <representation mediaType="application/json"><u></u><u></u></span></p>
<p class="MsoNormal"><span style="font-size:8pt;font-family:'Courier New'"> <wadl:doc xmlns="<a href="http://docbook.org/ns/docbook" target="_blank">http://docbook.org/ns/docbook</a>" xml:lang="EN"><u></u><u></u></span></p>
<p class="MsoNormal"><span style="font-size:8pt;font-family:'Courier New'"> <xsdxt:code href="api_samples/host_modify-response.json"/><u></u><u></u></span></p>
<p class="MsoNormal"><span style="font-size:8pt;font-family:'Courier New'"> </wadl:doc><u></u><u></u></span></p>
<p class="MsoNormal"><span style="font-size:8pt;font-family:'Courier New'"> </representation><u></u><u></u></span></p>
<p class="MsoNormal"><span style="font-size:8pt;font-family:'Courier New'"> </response><u></u><u></u></span></p>
<p class="MsoNormal"><span style="font-size:8pt;font-family:'Courier New'"> &postPutFaults;<u></u><u></u></span></p>
<p class="MsoNormal"><span style="font-size:8pt;font-family:'Courier New'"> </method><u></u><u></u></span></p>
<p class="MsoNormal"><u></u> <u></u></p>
</div>
</div>
</blockquote></div><br><br clear="all"><div><br></div>-- <br><div class="gmail_signature">Anne Gentle<br><a href="mailto:annegentle@justwriteclick.com" target="_blank">annegentle@justwriteclick.com</a></div>
</div></div>