Skip to content

feat(metadata_schema): add scan_name and comment fields to basic schema #727

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Draft
wakonig wants to merge 2 commits into
base: main
Choose a base branch
from
+6 −2
Draft

feat(metadata_schema): add scan_name and comment fields to basic schema #727

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
0faea8a
feat(metadata_schema): add scan_name and comment fields to basic schema
wakonig Jan 10, 2026
ac0c6f9
fix(metadata_schema): standardize field titles in BasicScanMetadata
wakonig Jan 12, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 6 additions & 2 deletions bec_lib/bec_lib/metadata_schema.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,13 +13,17 @@


class BasicScanMetadata(BaseModel):
"""Basic scan metadata class. Only requires a sample name. Accepts any additional
"""Basic scan metadata class. Accepts any additional
metadata that the user wishes to provide. Can be extended to add required fields
for specific scans."""

model_config = ConfigDict(extra="allow", validate_assignment=True)
scan_name: str = Field(
"", title="Scan Name", description="A human-friendly identifier for the scan"
)
comment: str = Field("", title="Comment", description="A comment about the scan")
sample_name: str = Field(
"", title="Sample name", description="A human-friendly identifier for the sample"
"", title="Sample Name", description="A human-friendly identifier for the sample"
)


Expand Down
Loading