usov_i-org/bec
1
0
Fork 0
mirror of https://github.com/ivan-usov-org/bec.git synced 2025-04-20 01:40:02 +02:00
Code Issues Actions Packages Projects Releases Wiki Activity

fix: docstrings in metadata schema class and template

Browse Source
This commit is contained in:
perl_d 2025-02-10 12:14:16 +01:00
parent 2ba5cfcca5
commit 7efdbbf6d4
2 changed files with 4 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

6
bec_lib/bec_lib/metadata_schema.py
View File

@ -13,9 +13,9 @@ _METADATA_SCHEMA_REGISTRY = {}
class BasicScanMetadata(BaseModel):
"""Scan metadata base class which behaves like a dict, and will accept any keys,
like the existing metadata field in messages, but can be extended to add required
fields for specific scans."""
"""Basic scan metadata class. Only requires a sample name. 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)
sample_name: str = Field(

2
bec_lib/util_scripts/plugin_setup_files/metadata_schema_registry.py
View File

@ -1,4 +1,4 @@
# from .schema_template import ExampleSchema
# from .metadata_schema_template import ExampleSchema
METADATA_SCHEMA_REGISTRY = {
# Add models which should be used to validate scan metadata here.