Skip to content

Commit 9e8ab40

Browse files
authored
Docs: Add httpx.Proxy to api.md (#3512)
1 parent ce7a6e9 commit 9e8ab40

File tree

1 file changed

+15
-0
lines changed

1 file changed

+15
-0
lines changed

docs/api.md

+15
Original file line numberDiff line numberDiff line change
@@ -159,3 +159,18 @@ what gets sent over the wire.*
159159
* `def delete(name, [domain], [path])`
160160
* `def clear([domain], [path])`
161161
* *Standard mutable mapping interface*
162+
163+
## `Proxy`
164+
165+
*A configuration of the proxy server.*
166+
167+
```pycon
168+
>>> proxy = Proxy("http://proxy.example.com:8030")
169+
>>> client = Client(proxy=proxy)
170+
```
171+
172+
* `def __init__(url, [ssl_context], [auth], [headers])`
173+
* `.url` - **URL**
174+
* `.auth` - **tuple[str, str]**
175+
* `.headers` - **Headers**
176+
* `.ssl_context` - **SSLContext**

0 commit comments

Comments
 (0)