Repository navigation
#809469 check the schema id - #40
Merged
Merged
Conversation
There was a problem hiding this comment.
🟡 Changes recommended
Existing tests omit the now-required schema_id, causing failures or bypassing intended validation, while README examples still describe an incompatible API contract.
2 open issues
What changed in this PR
This PR makes a schema ID mandatory when saving datasets to the Data Catalogue, enforcing the requirement before storage or registration begins.
Changes:
- Makes
schema_ida requireduuid.UUIDargument. - Adds runtime validation to reject missing values such as
Noneand incorrect types. - Updates the method’s documentation and example to use a UUID object.
| File | Description |
|---|---|
src/dataworkbench/datacatalogue.py |
Requires and validates schema IDs in save() and updates its documentation. |
Review effort: Balanced
| dataset_name: str, | ||
| dataset_description: str, | ||
| schema_id: uuid.UUID | None = None, | ||
| schema_id: uuid.UUID, |
| dataset_name: Name of the dataset for the catalog | ||
| dataset_description: Description of the dataset's purpose and contents | ||
| schema_id: Optional UUID for the dataset's schema | ||
| schema_id: UUID for the dataset's schema |
ronaldwu
approved these changes
Nov 9, 2026
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.


schema id should have a value