mitmproxy/libpathod/templates/docs_lang_requests.html

114 lines
3.5 KiB
HTML
Raw Normal View History

2015-06-22 11:11:40 +00:00
<pre class="example">method:path:[colon-separated list of features]</pre>
</p>
<table class="table table-bordered">
2015-06-22 11:11:40 +00:00
<tbody>
<tr>
2015-06-22 11:11:40 +00:00
<td>method</td>
<td>
2015-06-22 11:11:40 +00:00
<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>
2015-06-22 11:11:40 +00:00
<td>h<a href="#valuespec">VALUE</a>=<a href="#valuespec">VALUE</a></td>
<td>
2015-06-22 11:11:40 +00:00
Set a header.
</td>
</tr>
<tr>
2015-06-22 11:11:40 +00:00
<td>r</td>
<td>
2015-06-22 11:11:40 +00:00
Set the "raw" flag on this response. Pathod will not calculate a Content-Length header
if a body is set.
</td>
</tr>
<tr>
2015-06-22 11:11:40 +00:00
<td>c<a href="#valuespec">VALUE</a></td>
<td>
2015-06-22 11:11:40 +00:00
A shortcut for setting the Content-Type header. Equivalent to h"Content-Type"=VALUE
</td>
</tr>
<tr>
2015-06-22 11:11:40 +00:00
<td>u<a href="#valuespec">VALUE</a>
<br> uSHORTCUT
</td>
<td>
2015-06-22 11:11:40 +00:00
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>
2015-06-22 11:11:40 +00:00
<td>b<a href="#valuespec">VALUE</a></td>
<td>
2015-06-22 11:11:40 +00:00
Set the body. The appropriate Content-Length header is added automatically unless the
"r" flag is set.
</td>
</tr>
<tr>
2015-06-22 11:11:40 +00:00
<td>s<a href="#valuespec">VALUE</a></td>
<td>
2015-06-22 11:11:40 +00:00
An embedded Response specification, appended to the path of the request.
</td>
</tr>
<tr>
2015-06-22 11:11:40 +00:00
<td>x<a href="#valuespec">INTEGER</a></td>
<td>
2015-06-22 11:11:40 +00:00
Repeat this message N times.
</td>
</tr>
<tr>
2015-06-22 11:11:40 +00:00
<td>d<a href="#offsetspec">OFFSET</a></td>
<td>
2015-06-22 11:11:40 +00:00
<span class="badge badge-info">HTTP/1 only</span>
Disconnect after OFFSET bytes.
</td>
</tr>
<tr>
2015-06-22 11:11:40 +00:00
<td>i<a href="#offsetspec">OFFSET</a>,<a href="#valuespec">VALUE</a></td>
<td>
2015-06-22 11:11:40 +00:00
<span class="badge badge-info">HTTP/1 only</span>
Inject the specified value at the offset.
</td>
</tr>
2015-06-22 11:11:40 +00:00
<tr>
2015-06-22 11:11:40 +00:00
<td>p<a href="#offsetspec">OFFSET</a>,SECONDS</td>
<td>
2015-06-22 11:11:40 +00:00
<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>
</table>