docs: Expand v3 upgrade guide to cover all breaking changes#698
Open
docs: Expand v3 upgrade guide to cover all breaking changes#698
Conversation
Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
vdusek
added
adhoc
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## master #698 +/- ##
==========================================
- Coverage 94.98% 94.96% -0.03%
==========================================
Files 45 45
Lines 4405 4405
==========================================
- Hits 4184 4183 -1
- Misses 221 222 +1
Flags with carried forward coverage won't be shown. Click here to find out more. ☔ View full report in Codecov by Sentry. 🚀 New features to boost your workflow:
|
janbuchar
approved these changes
Apr 7, 2026
| status = run.status | ||
| ``` | ||
|
|
||
| All model classes are generated from the Apify OpenAPI specification and live in `apify_client._models` module. They are configured with `extra='allow'`, so any new fields added to the API in the future are preserved on the model instance. Fields are accessed using their Python snake_case names: |
Contributor
There was a problem hiding this comment.
not really in the scope of this PR, but could we also add the camelCase field names as deprecated aliases?
|
|
||
| Not every method returns a Pydantic model. Methods whose payloads are user-defined or inherently unstructured still return plain types: | ||
|
|
||
| - <ApiLink to="class/DatasetClient#list_items">`DatasetClient.list_items()`</ApiLink> returns `DatasetItemsPage`, a dataclass whose `items` field is `list[dict[str, Any]]`, because dataset items are arbitrary JSON. |
Contributor
There was a problem hiding this comment.
Strictly speaking, the format is defined in the output schema, but we don't aim to handle that in the SDK.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
upgrading_to_v2,upgrading_to_v3) from.mdto.mdxand replaced plain markdown API references withApiLinkcomponents for consistent linking to the API reference docs.custom-http-client-httpxid.🤖 Generated with Claude Code