Changeset 40f0d3b8319d0752d7379bcfa4463096db128e40

Show
Ignore:
Timestamp:
08/30/11 17:00:21 (3 years ago)
Author:
Theo Schlossnagle <jesus@omniti.com>
git-committer:
Theo Schlossnagle <jesus@omniti.com> 1314723621 -0400
git-parent:

[ca71d0e30d30a9ab13ba386e6ed165772a5ff30e]

git-author:
Theo Schlossnagle <jesus@omniti.com> 1314723621 -0400
Message:

propagate arbitrary sections through to the docbook

Files:

Legend:

Unmodified
Added
Removed
Modified
Copied
Moved
  • docs/config/modules/check_test.xml

    rca71d0e r40f0d3b  
    4040    </programlisting> 
    4141  </example> 
     42  <section> 
     43    <!-- Should this be moved to the wire protocol?  And then linked from here? --> 
     44    <title>REST Endpoint</title> 
     45    <section> 
     46      <title>/checks/test</title> 
     47      <variablelist> 
     48        <varlistentry> 
     49          <term>method</term> 
     50          <listitem> 
     51            <code>POST</code> 
     52          </listitem> 
     53        </varlistentry> 
     54        <varlistentry> 
     55          <term>uri</term> 
     56          <listitem> 
     57            <code>/checks/test</code> 
     58          </listitem> 
     59        </varlistentry> 
     60      </variablelist> 
     61      <para> 
     62                This call accepts a document describing a check.  In the same request, the check will   
     63                execute and return the results back to the user.  The check passes through the same validation 
     64                as the /check/set PUT REST call.  The check is marked as transient and won't appear  
     65                in any persistent log streams. 
     66            </para> 
     67      <para> 
     68                On success, a HTTP 200 is returned and an XML documented that matches the 
     69                format of the <code>/check/show</code> REST command. It is a simpler set of 
     70                output as some of the results wouldn't make sense in this context. 
     71            </para> 
     72      <example> 
     73        <title>REST /checks/test XML input.</title> 
     74        <programlisting> 
     75&lt;?xml version="1.0" encoding="utf8"?&gt; 
     76&lt;check&gt; 
     77  &lt;attributes&gt; 
     78    &lt;name&gt;http&lt;/name&gt; 
     79    &lt;module&gt;http&lt;/module&gt; 
     80    &lt;target&gt;8.8.38.5&lt;/target&gt; 
     81    &lt;period&gt;60000&lt;/period&gt; 
     82    &lt;timeout&gt;5000&lt;/timeout&gt; 
     83    &lt;filterset&gt;default&lt;/filterset&gt; 
     84  &lt;/attributes&gt; 
     85  &lt;config&gt; 
     86    &lt;code&gt;200&lt;/code&gt; 
     87    &lt;url&gt;https://labs.omniti.com/&lt;/url&gt; 
     88  &lt;/config&gt; 
     89&lt;/check&gt; 
     90    </programlisting> 
     91      </example> 
     92    </section> 
     93  </section> 
    4294</section> 
  • src/modules/module.xsl

    re0dc41c r40f0d3b  
    5555    <xsl:copy-of select="."/> 
    5656  </xsl:for-each> 
     57 
     58  <xsl:for-each select="module/section"> 
     59    <xsl:copy-of select="."/> 
     60  </xsl:for-each> 
     61 
    5762  </section> 
    5863</xsl:template>