feat(metadata_schema): add scan_name and comment fields to basic schema#727
Open
feat(metadata_schema): add scan_name and comment fields to basic schema#727
Conversation
Codecov Report✅ All modified and coverable lines are covered by tests. 📢 Thoughts on this report? Let us know! |
1 task
Contributor
There was a problem hiding this comment.
Pull request overview
This PR adds two new optional metadata fields to the BasicScanMetadata schema: scan_name (for a human-friendly scan identifier) and comment (for scan annotations). The docstring is updated to reflect that no fields are strictly required, and the sample_name field title is capitalized for consistency.
Changes:
- Added
scan_namefield with empty string default for identifying individual scans - Added
commentfield with empty string default for scan annotations - Updated docstring to remove "Only requires a sample name" phrasing
- Standardized field titles to title case
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
cappel89
approved these changes
Jan 15, 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
2 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.
This PR adds two new fields to the default scan metadata schema: scan name and comment. Need to be merged together with
bec-project/bec_widgets#1002