Unified interface for create/update/delete#16
Merged
zhaodongwang-msft merged 2 commits intomainfrom Oct 11, 2025
Merged
Conversation
zhaodongwang-msft
approved these changes
Oct 11, 2025
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
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.
Copilot summary:
This pull request introduces a unified and simplified CRUD API for the Python SDK, focusing on making single and bulk operations consistent and easier to use. The changes update the documentation, examples, and core implementation so that
create,update, anddeletemethods now have unified signatures and return types. Bulk operations are now handled through these unified methods, and return semantics are consistent (e.g.,createalways returns a list of GUIDs, andupdate/deletealways returnNone). The documentation and quickstart examples have been updated to reflect these changes.Unified CRUD API and documentation updates:
DataverseClientclass now exposes unifiedcreate,update, anddeletemethods that handle both single and bulk operations, replacing the previousupdate_multipleand changing return types for consistency. (src/dataverse_sdk/client.py)README.mdhas been extensively revised to describe the new API, including updated method signatures, return types, usage guidelines, and examples for single and bulk operations. (README.md) [1] [2] [3] [4] [5] [6] [7] [8]Example and quickstart updates:
examples/quickstart.pyhas been updated to use the new API, demonstrating the unifiedcreate,update, and bulk update patterns, and reflecting the new return types and workflows. (examples/quickstart.py) [1] [2] [3]Implementation details and internal consistency:
ODataClient.createmethod now returns only GUID strings for single creates, not full entity representations, aligning with the new API contract. (src/dataverse_sdk/odata.py) [1] [2]src/dataverse_sdk/odata.py)These changes make the SDK easier to use for both single and bulk operations, improve performance by avoiding unnecessary data fetching, and ensure the documentation and examples are aligned with the updated API.