Skip to content

Commit b19b500

Browse files
vdusekclaude
andcommitted
docs: document snake_case sort_by change in v3 upgrading guide
Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
1 parent fdfe6ad commit b19b500

1 file changed

Lines changed: 20 additions & 0 deletions

File tree

docs/04_upgrading/upgrading_to_v3.mdx

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -185,3 +185,23 @@ On retries, the timeout doubles with each attempt (exponential backoff) up to `t
185185
The default timeout tier assigned to each method on non-storage resource clients has been revised to better match the expected latency of the underlying API endpoint. For example, a simple `get()` call now defaults to `short` (5 s), while `start()` defaults to `medium` (30 s) and `call()` defaults to `no_timeout`.
186186

187187
If your code relied on the previous global timeout behavior, review the timeout tier on the methods you use and adjust via the `timeout` parameter or by overriding tier defaults on the <ApiLink to="class/ApifyClient">`ApifyClient`</ApiLink> constructor (see [Tiered timeout system](#tiered-timeout-system) above).
188+
189+
## Snake_case `sort_by` values on `actors().list()`
190+
191+
The `sort_by` parameter of <ApiLink to="class/ActorCollectionClient#list">`ActorCollectionClient.list()`</ApiLink> and <ApiLink to="class/ActorCollectionClientAsync#list">`ActorCollectionClientAsync.list()`</ApiLink> now accepts pythonic snake_case values instead of the raw camelCase values used by the API.
192+
193+
Before (v2):
194+
195+
```python
196+
client.actors().list(sort_by='createdAt')
197+
client.actors().list(sort_by='stats.lastRunStartedAt')
198+
```
199+
200+
After (v3):
201+
202+
```python
203+
client.actors().list(sort_by='created_at')
204+
client.actors().list(sort_by='last_run_started_at')
205+
```
206+
207+
The default value also changed from `'createdAt'` to `'created_at'` (behavior is unchanged). The client translates the snake_case value to the form expected by the API internally.

0 commit comments

Comments
 (0)