From c5788be311179a0e8eae0fa3d28b014155c806df Mon Sep 17 00:00:00 2001 From: ndamania00 Date: Sun, 9 Feb 2025 10:00:58 -0500 Subject: [PATCH] update docs to show order matters for dropdown values and schema fields --- docs/reference/dropdowns.md | 3 +++ docs/reference/entity-schemas.md | 5 ++++- 2 files changed, 7 insertions(+), 1 deletion(-) diff --git a/docs/reference/dropdowns.md b/docs/reference/dropdowns.md index 1a2ee65..5d6ca90 100644 --- a/docs/reference/dropdowns.md +++ b/docs/reference/dropdowns.md @@ -12,6 +12,9 @@ class Toppings(BaseDropdown): __allowed_values__ = ["Pepperoni", "Mushroom", "Onion", "Sausage", "Bacon"] ``` +!!! tip + Liminal automatically detects the order of your dropdown values. To change the order of how the values appear in Benchling, define the dropdown values in the desired sequence. + ### Parameters - **benchling_name: str** diff --git a/docs/reference/entity-schemas.md b/docs/reference/entity-schemas.md index ee080ae..b77d268 100644 --- a/docs/reference/entity-schemas.md +++ b/docs/reference/entity-schemas.md @@ -4,7 +4,7 @@ Below is an example of a custom entity schema defined in code. All Liminal entity schema classes inherit from Liminal's [BaseModel](https://github.com/dynotx/liminal-orm/blob/main/liminal/orm/base_model.py) and uses [SQLAlchemy](https://www.sqlalchemy.org/) behind the scenes to create an ORM. Liminal provides base classes and clear abstractions to provide a standardized way to define entity schemas in code. However, you are still able to use raw SQLAlchemy to interact with the schemas when necessary. The properties defined in the `SchemaProperties` object and `Column` objects -align with the properties shown on the Benchling website. This is how Liminal defines your Benchling entity schema in code. Any of these properties +correspond with the properties shown on the Benchling website. This is how Liminal defines your Benchling entity schema in code. Any of these properties can be manipulated to change the definition of the entity schema. Updates to the schema or the addition/archival of schemas are automatically detected by Liminal's migration service, which is run using the `liminal autogenerate ...` command. Refer to the [First Migration](../getting-started/first-migration.md) page to run your first migration. @@ -123,6 +123,9 @@ All Liminal entity schema classes must inherit from one of the mixins in the [mi ## Column: [class](https://github.com/dynotx/liminal-orm/blob/main/liminal/orm/column.py) +!!! tip + Liminal also detects the ordering of your fields. Define columns on different lines in your schema class to change the ordering of the fields on the Benchling entity schema. + !!! warning If warehouse access is not enabled on your tenant, you will be unable to update the warehouse name for fields.