aboutsummaryrefslogtreecommitdiffstats
path: root/docs/scripting
diff options
context:
space:
mode:
authorAldo Cortesi <aldo@nullcube.com>2016-10-14 12:18:56 +1300
committerAldo Cortesi <aldo@nullcube.com>2016-10-16 20:26:06 +1300
commit61040a7bcd46c057e34fe4671ef20b9111649e74 (patch)
tree8d8e9a8ea430fcb66e97867cf6166c6741882333 /docs/scripting
parentc8f2f1019dbd0e07ad6178b68bd32d88fb32a0cb (diff)
downloadmitmproxy-61040a7bcd46c057e34fe4671ef20b9111649e74.tar.gz
mitmproxy-61040a7bcd46c057e34fe4671ef20b9111649e74.tar.bz2
mitmproxy-61040a7bcd46c057e34fe4671ef20b9111649e74.zip
docs: improve external source links, tweak code docs
Diffstat (limited to 'docs/scripting')
-rw-r--r--docs/scripting/api.rst20
1 files changed, 17 insertions, 3 deletions
diff --git a/docs/scripting/api.rst b/docs/scripting/api.rst
index 03d35920..a1769329 100644
--- a/docs/scripting/api.rst
+++ b/docs/scripting/api.rst
@@ -1,8 +1,22 @@
.. _api:
+
API
-====
+===
+
+- HTTP
+ - `mitmproxy.models.http.HTTPRequest <#mitmproxy.models.http.HTTPRequest>`_
+ - `mitmproxy.models.http.HTTPResponse <#mitmproxy.models.http.HTTPResponse>`_
+ - `mitmproxy.models.http.HTTPFlow <#mitmproxy.models.http.HTTPFlow>`_
+
+HTTP
+----
+
+.. autoclass:: mitmproxy.models.http.HTTPRequest
+ :inherited-members:
+
+.. autoclass:: mitmproxy.models.http.HTTPResponse
+ :inherited-members:
-.. automodule:: mitmproxy.models.http
+.. autoclass:: mitmproxy.models.http.HTTPFlow
:inherited-members:
- :members: HTTPFlow, HTTPRequest, HTTPResponse