Add basic docs for request spec language.

This commit is contained in:
Aldo Cortesi 2012-07-24 21:45:05 +12:00
parent 94b491bb27
commit 97fe026c32

View File

@ -21,18 +21,14 @@
<table class="table table-bordered"> <table class="table table-bordered">
<tbody > <tbody >
<tr> <tr>
<td> <td> h<a href="#valuespec">VALUE</a>=<a href="#valuespec">VALUE</a> </td>
h<a href="#valuespec">VALUE</a>=<a href="#valuespec">VALUE</a>
</td>
<td> <td>
Set a header. Set a header.
</td> </td>
</tr> </tr>
<tr> <tr>
<td> <td> b<a href="#valuespec">VALUE</a> </td>
b<a href="#valuespec">VALUE</a>
</td>
<td> <td>
Set the body. When the body is set, pathod will Set the body. When the body is set, pathod will
automatically set the appropriate Content-Length header. automatically set the appropriate Content-Length header.
@ -40,9 +36,7 @@
</tr> </tr>
<tr> <tr>
<td> <td> c<a href="#valuespec">VALUE</a> </td>
c<a href="#valuespec">VALUE</a>
</td>
<td> <td>
A shortcut for setting the Content-Type header. Equivalent to A shortcut for setting the Content-Type header. Equivalent to
h"Content-Type"=VALUE h"Content-Type"=VALUE
@ -50,18 +44,14 @@
</tr> </tr>
<tr> <tr>
<td> <td> i<a href="#offsetspec">OFFSET</a>,<a href="#valuespec">VALUE</a> </td>
i<a href="#offsetspec">OFFSET</a>,<a href="#valuespec">VALUE</a>
</td>
<td> <td>
Inject the specified value at the offset. Inject the specified value at the offset.
</td> </td>
</tr> </tr>
<tr> <tr>
<td> <td> l<a href="#valuespec">VALUE</a> </td>
l<a href="#valuespec">VALUE</a>
</td>
<td> <td>
A shortcut for setting the Location header. Equivalent to A shortcut for setting the Location header. Equivalent to
h"Location"=VALUE h"Location"=VALUE
@ -69,18 +59,14 @@
</tr> </tr>
<tr> <tr>
<td> <td> d<a href="#offsetspec">OFFSET</a> </td>
d<a href="#offsetspec">OFFSET</a>
</td>
<td> <td>
Disconnect after OFFSET bytes. Disconnect after OFFSET bytes.
</td> </td>
</tr> </tr>
<tr> <tr>
<td> <td> pSECONDS,<a href="#offsetspec">OFFSET</a> </td>
pSECONDS,<a href="#offsetspec">OFFSET</a>
</td>
<td> <td>
Pause for SECONDS seconds after OFFSET bytes. SECONDS can Pause for SECONDS seconds after OFFSET bytes. SECONDS can
be an integer or "f" to pause forever. be an integer or "f" to pause forever.
@ -88,9 +74,7 @@
</tr> </tr>
<tr> <tr>
<td> <td> r </td>
r
</td>
<td> <td>
Set the "raw" flag on this response. Pathod will not Set the "raw" flag on this response. Pathod will not
calculate a Content-Length header if a body is set, or add calculate a Content-Length header if a body is set, or add
@ -106,6 +90,69 @@
<div class="page-header"> <div class="page-header">
<h1>Requests</h1> <h1>Requests</h1>
</div> </div>
<p>The general form of a request is as follows:</p>
<pre class="example">method:path:[colon-separated list of features]</pre></p>
<table class="table table-bordered">
<tbody >
<tr>
<td> h<a href="#valuespec">VALUE</a>=<a href="#valuespec">VALUE</a> </td>
<td>
Set a header.
</td>
</tr>
<tr>
<td> b<a href="#valuespec">VALUE</a> </td>
<td>
Set the body. When the body is set, pathod will
automatically set the appropriate Content-Length header.
</td>
</tr>
<tr>
<td> c<a href="#valuespec">VALUE</a> </td>
<td>
A shortcut for setting the Content-Type header. Equivalent to
h"Content-Type"=VALUE
</td>
</tr>
<tr>
<td> i<a href="#offsetspec">OFFSET</a>,<a href="#valuespec">VALUE</a> </td>
<td>
Inject the specified value at the offset.
</td>
</tr>
<tr>
<td> d<a href="#offsetspec">OFFSET</a> </td>
<td>
Disconnect after OFFSET bytes.
</td>
</tr>
<tr>
<td> pSECONDS,<a href="#offsetspec">OFFSET</a> </td>
<td>
Pause for SECONDS seconds after OFFSET bytes. SECONDS can
be an integer or "f" to pause forever.
</td>
</tr>
<tr>
<td> r </td>
<td>
Set the "raw" flag on this response. Pathod will not
calculate a Content-Length header if a body is set, or add
a Date header to the response.
</td>
</tr>
</tbody>
</table>
</section> </section>