aboutsummaryrefslogtreecommitdiffstats
path: root/docs/scripting/api.rst
diff options
context:
space:
mode:
Diffstat (limited to 'docs/scripting/api.rst')
-rw-r--r--docs/scripting/api.rst40
1 files changed, 40 insertions, 0 deletions
diff --git a/docs/scripting/api.rst b/docs/scripting/api.rst
new file mode 100644
index 00000000..abc9ff3e
--- /dev/null
+++ b/docs/scripting/api.rst
@@ -0,0 +1,40 @@
+.. _api:
+
+
+API
+===
+
+- Errors
+ - `mitmproxy.models.flow.Error <#mitmproxy.models.flow.Error>`_
+- 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>`_
+- Logging
+ - `mitmproxy.controller.Log <#mitmproxy.controller.Log>`_
+ - `mitmproxy.controller.LogEntry <#mitmproxy.controller.LogEntry>`_
+
+
+Errors
+------
+
+.. autoclass:: mitmproxy.models.flow.Error
+ :inherited-members:
+
+HTTP
+----
+
+.. autoclass:: mitmproxy.models.http.HTTPRequest
+ :inherited-members:
+
+.. autoclass:: mitmproxy.models.http.HTTPResponse
+ :inherited-members:
+
+.. autoclass:: mitmproxy.models.http.HTTPFlow
+ :inherited-members:
+
+Logging
+--------
+
+.. autoclass:: mitmproxy.controller.Log
+ :inherited-members: