SQLModel JSON schema missing relationship fields

[imrnck]

First Check

• I added a very descriptive title here.
• I used the GitHub search to find a similar question and didn't find it.
• I searched the SQLModel documentation, with the integrated search.
• I already searched in Google "How to X in SQLModel" and didn't find any information.
• I already read and followed all the tutorial in the docs and didn't find an answer.
• I already checked if it is not related to SQLModel but to Pydantic.
• I already checked if it is not related to SQLModel but to SQLAlchemy.

Commit to Help

• I commit to help with one of those options 👆

Example Code

class Team(SQLModel, table=True): id: int | None = Field(default=None, primary_key=True) name: str class Hero(SQLModel, table=True): id: int | None = Field(default=None, primary_key=True) name: str team_id: int = Field(foreign_key="team.id") team: Team = Relationship() sqlite_file_name = "database.db" sqlite_url = f"sqlite:///{sqlite_file_name}" engine = create_engine(sqlite_url, echo=True) SQLModel.metadata.create_all(engine) print(Hero.model_json_schema())

Description

I'm running into a limitation with SQLModel and would appreciate some clarification or guidance.

When I call Hero.model_json_schema(), the generated JSON schema doesn't include the team relationship field. Since Team is a SQLModel (and therefore a valid Pydantic model), I'd naturally expect it to appear in the schema.

Questions

• Is there currently a way to include relationship fields like team in the generated schema without duplicating or separating model definitions (e.g., by creating separate "response" models)?
• If not, could you share the reasoning behind this design decision?

Operating System

Linux

Operating System Details

No response

SQLModel Version

0.0.24

Python Version

3.12.1

Additional Context

No response

[YuriiMotov]

The solution is to create new model (use inheritance to reduce duplication) and use it as response model:

class HeroBase(SQLModel): id: int | None = Field(default=None, primary_key=True) name: str class Hero(HeroBase, table=True): team_id: int = Field(foreign_key="team.id") team: Team = Relationship() class HeroPublic(HeroBase): team: Team

Read more: https://sqlmodel.tiangolo.com/tutorial/fastapi/relationships/#dont-include-all-the-data