Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

✨ Support Python internal description on Pydantic model's docstring #3032

Merged
merged 3 commits into from Sep 2, 2022
Merged

✨ Support Python internal description on Pydantic model's docstring #3032

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
00da79c
:sparkles: Support Python internal description on Pydantic model's do…
Kludex Apr 1, 2021
1c93179
:bug: Only add description if already exists
Kludex Apr 1, 2021
00becde
Merge branch 'master' into feat/comment-on-pydantic-models
tiangolo Sep 2, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
2 changes: 2 additions & 0 deletions fastapi/utils.py
View file
Open in desktop
Expand Up @@ -37,6 +37,8 @@ def get_model_definitions(
)
definitions.update(m_definitions)
model_name = model_name_map[model]
if "description" in m_schema:
m_schema["description"] = m_schema["description"].split("\f")[0]
definitions[model_name] = m_schema
return definitions

Expand Down