Changeset 40f0d3b8319d0752d7379bcfa4463096db128e40
- Timestamp:
- 08/30/11 17:00:21
(7 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
rca71d0e |
r40f0d3b |
|
40 | 40 | </programlisting> |
---|
41 | 41 | </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 | <?xml version="1.0" encoding="utf8"?> |
---|
| 76 | <check> |
---|
| 77 | <attributes> |
---|
| 78 | <name>http</name> |
---|
| 79 | <module>http</module> |
---|
| 80 | <target>8.8.38.5</target> |
---|
| 81 | <period>60000</period> |
---|
| 82 | <timeout>5000</timeout> |
---|
| 83 | <filterset>default</filterset> |
---|
| 84 | </attributes> |
---|
| 85 | <config> |
---|
| 86 | <code>200</code> |
---|
| 87 | <url>https://labs.omniti.com/</url> |
---|
| 88 | </config> |
---|
| 89 | </check> |
---|
| 90 | </programlisting> |
---|
| 91 | </example> |
---|
| 92 | </section> |
---|
| 93 | </section> |
---|
42 | 94 | </section> |
---|
re0dc41c |
r40f0d3b |
|
55 | 55 | <xsl:copy-of select="."/> |
---|
56 | 56 | </xsl:for-each> |
---|
| 57 | |
---|
| 58 | <xsl:for-each select="module/section"> |
---|
| 59 | <xsl:copy-of select="."/> |
---|
| 60 | </xsl:for-each> |
---|
| 61 | |
---|
57 | 62 | </section> |
---|
58 | 63 | </xsl:template> |
---|