happyz
/
fastapi
mirror of https://github.com/tiangolo/fastapi.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

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

Co-authored-by: Sebastián Ramírez <tiangolo@gmail.com>
This commit is contained in:
Marcelo Trylesinski 2022-09-02 14:43:21 +02:00 committed by GitHub
parent b1d0f1e970
commit 30b3905ef3
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 2 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
fastapi/utils.py
View File

@ -37,6 +37,8 @@ def get_model_definitions(
) )
definitions.update(m_definitions) definitions.update(m_definitions)
model_name = model_name_map[model] 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 definitions[model_name] = m_schema
return definitions return definitions