diff --git a/bec_lib/bec_lib/metadata_schema.py b/bec_lib/bec_lib/metadata_schema.py index 67ea2a63..fe36f505 100644 --- a/bec_lib/bec_lib/metadata_schema.py +++ b/bec_lib/bec_lib/metadata_schema.py @@ -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( diff --git a/bec_lib/util_scripts/plugin_setup_files/metadata_schema_registry.py b/bec_lib/util_scripts/plugin_setup_files/metadata_schema_registry.py index a5547a33..deb6ef42 100644 --- a/bec_lib/util_scripts/plugin_setup_files/metadata_schema_registry.py +++ b/bec_lib/util_scripts/plugin_setup_files/metadata_schema_registry.py @@ -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.