aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
Diffstat
-rw-r--r--libpathod/templates/docs_lang_requests.html113
-rw-r--r--libpathod/templates/docs_lang_responses.html70
2 files changed, 90 insertions, 93 deletions
diff --git a/libpathod/templates/docs_lang_requests.html b/libpathod/templates/docs_lang_requests.html
index fe73f0af..92921ec4 100644
--- a/libpathod/templates/docs_lang_requests.html
+++ b/libpathod/templates/docs_lang_requests.html
@@ -1,113 +1,112 @@
-
-<pre class="example">method:path:[colon-separated list of features]</pre></p>
+<pre class="example">method:path:[colon-separated list of features]</pre>
+</p>
<table class="table table-bordered">
- <tbody >
-
+ <tbody>
<tr>
- <td> method </td>
+ <td>method</td>
<td>
-
- <p>A <a href="#valuespec">VALUE</a> specifying the HTTP
- method to use. Standard methods do not need to be
- enclosed in quotes, while non-standard methods can be
- specified as quoted strings.</p>
-
- <p>The special method <b>ws</b> creates a valid
- websocket upgrade GET request, and signals to pathoc to
- switch to websocket recieve mode if the server responds
- correctly. Apart from that, websocket requests are just
- like any other, and all aspects of the request can be
- over-ridden.</p>
+ <p>
+ A <a href="#valuespec">VALUE</a> specifying the HTTP method to use. Standard
+ methods do not need to be enclosed in quotes, while non-standard methods
+ can be specified as quoted strings.
+ </p>
+
+ <p>
+ The special method <b>ws</b> creates a valid websocket upgrade GET
+ request, and signals to pathoc to switch to websocket recieve mode
+ if the server responds correctly. Apart from that, websocket requests
+ are just like any other, and all aspects of the request can be over-ridden.
+ </p>
</td>
</tr>
<tr>
- <td> b<a href="#valuespec">VALUE</a> </td>
+ <td>h<a href="#valuespec">VALUE</a>=<a href="#valuespec">VALUE</a></td>
<td>
- Set the body. The appropriate Content-Length header is
- added automatically unless the "r" flag is set.
+ Set a header.
</td>
</tr>
<tr>
- <td> c<a href="#valuespec">VALUE</a> </td>
+ <td>r</td>
<td>
- A shortcut for setting the Content-Type header. Equivalent to
- h"Content-Type"=VALUE
+ Set the "raw" flag on this response. Pathod will not calculate a Content-Length header
+ if a body is set.
</td>
</tr>
<tr>
- <td> d<a href="#offsetspec">OFFSET</a> </td>
+ <td>c<a href="#valuespec">VALUE</a></td>
<td>
- Disconnect after OFFSET bytes.
+ A shortcut for setting the Content-Type header. Equivalent to h"Content-Type"=VALUE
</td>
</tr>
<tr>
- <td> h<a href="#valuespec">VALUE</a>=<a href="#valuespec">VALUE</a> </td>
+ <td>u<a href="#valuespec">VALUE</a>
+ <br> uSHORTCUT
+ </td>
+
<td>
- Set a header.
+ Set a User-Agent header on this request. You can specify either a complete
+ <a href="#valuespec">VALUE</a>, or a User-Agent shortcut:
+
+ <table class="table table-condensed">
+ {% for i in uastrings %}
+ <tr>
+ <td><b>{{ i[1] }}</b></td>
+ <td>{{ i[0] }}</td>
+ </tr>
+ {% endfor %}
+ </table>
</td>
</tr>
<tr>
- <td> i<a href="#offsetspec">OFFSET</a>,<a href="#valuespec">VALUE</a> </td>
+ <td>b<a href="#valuespec">VALUE</a></td>
<td>
- Inject the specified value at the offset.
+ Set the body. The appropriate Content-Length header is added automatically unless the
+ "r" flag is set.
</td>
</tr>
<tr>
- <td> p<a href="#offsetspec">OFFSET</a>,SECONDS </td>
+ <td>s<a href="#valuespec">VALUE</a></td>
<td>
- Pause for SECONDS seconds after OFFSET bytes. SECONDS can
- be an integer or "f" to pause forever.
+ An embedded Response specification, appended to the path of the request.
</td>
</tr>
<tr>
- <td> r </td>
+ <td>x<a href="#valuespec">INTEGER</a></td>
<td>
- Set the "raw" flag on this response. Pathod will not
- calculate a Content-Length header if a body is set.
+ Repeat this message N times.
</td>
</tr>
<tr>
- <td> s<a href="#valuespec">VALUE</a> </td>
+ <td>d<a href="#offsetspec">OFFSET</a></td>
<td>
- An embedded Response specification, appended to the path
- of the request.
+ <span class="badge badge-info">HTTP/1 only</span>
+ Disconnect after OFFSET bytes.
</td>
</tr>
<tr>
- <td> u<a href="#valuespec">VALUE</a> <br> uSHORTCUT </td>
-
+ <td>i<a href="#offsetspec">OFFSET</a>,<a href="#valuespec">VALUE</a></td>
<td>
-
- Set a User-Agent header on this request. You can
- specify either a complete <a
- href="#valuespec">VALUE</a>, or a User-Agent shortcut:
-
- <table class="table table-condensed">
- {% for i in uastrings %}
- <tr>
- <td><b>{{ i[1] }}</b></td>
- <td>{{ i[0] }}</td>
- </tr>
- {% endfor %}
- </table>
-
+ <span class="badge badge-info">HTTP/1 only</span>
+ Inject the specified value at the offset.
</td>
</tr>
-
+
<tr>
- <td> x<a href="#valuespec">INTEGER</a> </td>
+ <td>p<a href="#offsetspec">OFFSET</a>,SECONDS</td>
<td>
- Repeat this message N times.
+ <span class="badge badge-info">HTTP/1 only</span>
+ Pause for SECONDS seconds after OFFSET bytes. SECONDS can be an integer or "f" to pause
+ forever.
</td>
</tr>
</tbody>
diff --git a/libpathod/templates/docs_lang_responses.html b/libpathod/templates/docs_lang_responses.html
index e8590add..8939ab26 100644
--- a/libpathod/templates/docs_lang_responses.html
+++ b/libpathod/templates/docs_lang_responses.html
@@ -1,89 +1,87 @@
-
-<pre class="example">code:[colon-separated list of features]</pre></p>
+<pre class="example">code:[colon-separated list of features]</pre>
<table class="table table-bordered">
- <tbody >
+ <tbody>
<tr>
- <td> code </td>
+ <td>code</td>
<td>
<p>An integer specifying the HTTP response code.</p>
-
- <p>The special method <b>ws</b> creates a valid
- websocket upgrade response (code 101), and moves pathod
- to websocket mode. Apart from that, websocket responses
- are just like any other, and all aspects of the
- response can be over-ridden.</p>
+ <p>
+ The special method <b>ws</b> creates a valid websocket upgrade response
+ (code 101), and moves pathod to websocket mode. Apart from that, websocket
+ responses are just like any other, and all aspects of the response
+ can be over-ridden.
+ </p>
</td>
</tr>
<tr>
- <td> b<a href="#valuespec">VALUE</a> </td>
+ <td>m<a href="#valuespec">VALUE</a></td>
<td>
- Set the body. The appropriate Content-Length header is
- added automatically unless the "r" flag is set.
+ <span class="badge badge-info">HTTP/1 only</span>
+ HTTP Reason message. Automatically chosen according to the response code if not specified.
</td>
</tr>
<tr>
- <td> c<a href="#valuespec">VALUE</a> </td>
+ <td>h<a href="#valuespec">VALUE</a>=<a href="#valuespec">VALUE</a></td>
<td>
- A shortcut for setting the Content-Type header. Equivalent to
- h"Content-Type"=VALUE
+ Set a header.
</td>
</tr>
<tr>
- <td> d<a href="#offsetspec">OFFSET</a> </td>
+ <td>r</td>
<td>
- Disconnect after OFFSET bytes.
+ 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>
<tr>
- <td> h<a href="#valuespec">VALUE</a>=<a href="#valuespec">VALUE</a> </td>
+ <td>l<a href="#valuespec">VALUE</a></td>
<td>
- Set a header.
+ A shortcut for setting the Location header. Equivalent to h"Location"=VALUE
</td>
</tr>
-
<tr>
- <td> i<a href="#offsetspec">OFFSET</a>,<a href="#valuespec">VALUE</a> </td>
+ <td>c<a href="#valuespec">VALUE</a></td>
<td>
- Inject the specified value at the offset.
+ A shortcut for setting the Content-Type header. Equivalent to h"Content-Type"=VALUE
</td>
</tr>
<tr>
- <td> l<a href="#valuespec">VALUE</a> </td>
+ <td>b<a href="#valuespec">VALUE</a></td>
<td>
- A shortcut for setting the Location header. Equivalent to
- h"Location"=VALUE
+ Set the body. The appropriate Content-Length header is added automatically unless the
+ "r" flag is set.
</td>
</tr>
<tr>
- <td> m<a href="#valuespec">VALUE</a> </td>
+ <td>d<a href="#offsetspec">OFFSET</a></td>
<td>
- HTTP Reason message. Automatically chosen according to
- the response code if not specified.
+ <span class="badge badge-info">HTTP/1 only</span>
+ Disconnect after OFFSET bytes.
</td>
</tr>
<tr>
- <td> p<a href="#offsetspec">OFFSET</a>,SECONDS </td>
+ <td>i<a href="#offsetspec">OFFSET</a>,<a href="#valuespec">VALUE</a></td>
<td>
- Pause for SECONDS seconds after OFFSET bytes. SECONDS can
- be an integer or "f" to pause forever.
+ <span class="badge badge-info">HTTP/1 only</span>
+ Inject the specified value at the offset.
</td>
</tr>
<tr>
- <td> r </td>
+ <td>p<a href="#offsetspec">OFFSET</a>,SECONDS</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.
+ <span class="badge badge-info">HTTP/1 only</span>
+ Pause for SECONDS seconds after OFFSET bytes. SECONDS can be an integer or "f" to pause
+ forever.
</td>
</tr>
</tbody>
generated by cgit v1.2.3 (git 2.25.1) at 2025-06-18 00:10:54 +0000