diff options
| author | Aldo Cortesi <aldo@corte.si> | 2016-10-16 20:50:09 +1300 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2016-10-16 20:50:09 +1300 |
| commit | e4a32d6844963c09a8d4488f46277e2dcbeda3ab (patch) | |
| tree | b1553be2db96b8717554db9c8449bada4c8648f7 /docs/scripting/api.rst | |
| parent | 26af9b29fc3fed60a003d097b3470e85115b2161 (diff) | |
| parent | 00603021d9d486e3e16511eee273d26f59a3ab10 (diff) | |
| download | mitmproxy-e4a32d6844963c09a8d4488f46277e2dcbeda3ab.tar.gz mitmproxy-e4a32d6844963c09a8d4488f46277e2dcbeda3ab.tar.bz2 mitmproxy-e4a32d6844963c09a8d4488f46277e2dcbeda3ab.zip | |
Merge pull request #1602 from cortesi/scriptdocs
docs: stub out new script documentation
Diffstat (limited to 'docs/scripting/api.rst')
| -rw-r--r-- | docs/scripting/api.rst | 40 |
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: |