Skip to content

Commit 365934f

Browse files
docs: Document per-call request overrides in client configuration
- Added a new section in `client-configuration.md` detailing per-call request override options for `PdfRestClient` and `AsyncPdfRestClient`. - Explained new arguments like `extra_query`, `extra_headers`, `extra_body`, and `timeout` with example usage. - Clarified behavior notes, including merging and overriding logic for query parameters, headers, and timeouts. Assisted-by: Codex
1 parent 0eaa09b commit 365934f

1 file changed

Lines changed: 35 additions & 0 deletions

File tree

docs/client-configuration.md

Lines changed: 35 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -113,6 +113,41 @@ with PdfRestClient(headers={"X-App-Name": "my-service"}) as client:
113113
info = client.up(extra_headers={"X-Request-ID": "req-123"})
114114
```
115115

116+
## Per-call request overrides
117+
118+
Most endpoint helpers on `PdfRestClient` and `AsyncPdfRestClient` accept the
119+
same request-affecting keyword arguments so you can tune one call without
120+
changing client-wide configuration.
121+
122+
| Argument | Type | Purpose | Default |
123+
| --- | --- | --- | --- |
124+
| `extra_query` | `Query \| None` | Additional query parameters merged into the request URL. | `None` |
125+
| `extra_headers` | `AnyMapping \| None` | Additional HTTP headers merged into the request headers. | `None` |
126+
| `extra_body` | `Body \| None` | Additional request body fields merged into JSON payloads. | `None` |
127+
| `timeout` | `TimeoutTypes \| None` | Per-call timeout override (float seconds or `httpx.Timeout`). | `None` |
128+
129+
Behavior notes:
130+
131+
- `timeout=None` means “use the client default timeout profile.”
132+
- `extra_headers` values override same-name default headers for that request.
133+
- `extra_query` is merged with method-provided query params.
134+
- `extra_body` is merged only for JSON requests.
135+
For multipart/form-data endpoint calls, `extra_body` is rejected by the SDK.
136+
137+
Example:
138+
139+
```python
140+
from pdfrest import PdfRestClient
141+
142+
with PdfRestClient() as client:
143+
result = client.query_pdf_info(
144+
file=my_file,
145+
extra_query={"trace": "true"},
146+
extra_headers={"X-Request-ID": "req-123"},
147+
timeout=30.0,
148+
)
149+
```
150+
116151
## `no-id-prefix` header
117152

118153
pdfRest supports a `no-id-prefix: true` request header used for

0 commit comments

Comments
 (0)