Skip to content

Commit

Permalink
update docstrings
Browse files Browse the repository at this point in the history
  • Loading branch information
ndamania00 committed Jan 10, 2025
1 parent 850b62f commit 8afea5a
Show file tree
Hide file tree
Showing 2 changed files with 22 additions and 0 deletions.
2 changes: 2 additions & 0 deletions liminal/base/properties/base_schema_properties.py
Original file line number Diff line number Diff line change
Expand Up @@ -57,6 +57,8 @@ class BaseSchemaProperties(BaseModel):
The prefix to use for the schema.
entity_type : BenchlingEntityType | None
The entity type of the schema.
naming_strategies : set[BenchlingNamingStrategy] | None
The naming strategies of the schema.
mixture_schema_config : MixtureSchemaConfig | None
The mixture schema config of the schema.
constraint_fields : set[str] | None
Expand Down
20 changes: 20 additions & 0 deletions liminal/orm/schema_properties.py
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,26 @@ class SchemaProperties(BaseSchemaProperties):
"""
This class is the validated class that is public facing and inherits from the BaseSchemaProperties class.
It has the same fields as the BaseSchemaProperties class, but it is validated to ensure that the fields are valid.
Parameters
----------
name : str
The name of the schema.
warehouse_name : str
The sql table name of the schema in the benchling warehouse.
prefix : str
The prefix to use for the schema.
entity_type : BenchlingEntityType
The entity type of the schema.
naming_strategies : set[BenchlingNamingStrategy]
The naming strategies of the schema.
mixture_schema_config : MixtureSchemaConfig | None
The mixture schema config of the schema.
constraint_fields : set[str] | None
Set of constraints of field values for the schema. Set of column names, that specify that their values must be a unique combination in their entities.
If the entity type is a Sequence, "bases" can be a constraint field.
_archived : bool | None
Whether the schema is archived in Benchling.
"""

name: str
Expand Down

0 comments on commit 8afea5a

Please sign in to comment.