sqlmodel: adding an example to a Field()
In pydantic we can add an example to Fields, such as:
Field(default=None, example="A very nice Item")
Which will then be displayed in the swagger API docs:
How do we do this in sqlmodel? Adding the key example to the Field class in sqlmodel returns error:
Field() got an unexpected keyword argument 'example'
Thank you!
Solution
Can be accomplished using schema_extra:
Field(default=None, schema_extra={'example': "A very nice Item"})
Can be found in code:
- Imposing uniqueness constraint of column values between multiple tables in SQLModel
- FastAPI SQLModel and Pydantic: flatten out an object into a table
- sqlmodel: adding an example to a Field()
- How to get Alembic to recognise SQLModel database model?
- Changing SQLModel instance does not affect database table
- FastAPI, SQLModel - Pydantic not serializing datetime
- sqlmodel: filter by null
- SQLModel how to find foreign_key information while introspecting SQLModel classes?
- Perform an SQL 'database.exec()' search in a function not under a FastAPI decorator
- How to relate new SQL table row to an existing row in a related SQL table without creating a duplicate new row
- Cannot dump SQLModel entity
- SQLModel: sqlalchemy.exc.ArgumentError: Column expression or FROM clause expected,
- Can't get validation to work for non-table SQLModel
- How to change a pydantic list of objects into list of strings?
- When using SQLModel and Pydantic create_model how do you specify the database schema and tablename?
- Why FastAPI isn't validating POST body?
- Auto increment string primary key with custom logic in sqlmodel
- MissingGreenlet: greenlet_spawn has not been called
- Get tree structure from database sqlmodel/fastapi
- How to create table fields using char(N) instead of varchar using sqlmodel in python/postgresql
- SqlModel - specify index type (B-Tree, Hash, etc.)
- How to define an Optional[Decimal] field in python sqlmodel library that yields to constrained JSON schema
- Insert many-to-many relationship objects using SQLModel when one side of the relationship already exists in the database
- SQLModel and Pydantic data validation
- by_alias parameter on model_dump() is being ignored
- TypeError with Datetimes in SQLModel
- Python/SQLModel; nice syntax to add a method call to `__init__` and `update`?
- How can I use alias in Sqlmodel library?
- SQLModel / SQLAlchemy Problem with model mapper while querying in empty tables
- How to use async properly with SQLModel and FastAPI