mirror/fastapi
1
0
Fork 0
mirror of https://github.com/fastapi/fastapi.git synced 2026-05-25 00:37:44 -04:00
Code Issues Packages Projects Releases Wiki Activity

✨ Allow docstrings to be truncated before being used for OpenAPI (#556)

Browse Source
This commit is contained in:
svalouch
2019-10-04 22:02:40 +02:00
committed by Sebastián Ramírez
parent f5ccb3c35d
commit c7dc26b760
4 changed files with 157 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

12
docs/tutorial/path-operation-advanced-configuration.md
View File

@@ -18,3 +18,15 @@ To exclude a path operation from the generated OpenAPI schema (and thus, from th
```Python hl_lines="6"
{!./src/path_operation_advanced_configuration/tutorial002.py!}
```
## Advanced description from docstring
You can limit the lines used from the docstring of a *path operation function* for OpenAPI.
Adding an `\f` (an escaped "form feed" character) causes **FastAPI** to truncate the output used for OpenAPI at this point.
It won't show up in the documentation, but other tools (such as Sphinx) will be able to use the rest.
```Python hl_lines="19 20 21 22 23 24 25 26 27 28 29"
{!./src/path_operation_advanced_configuration/tutorial003.py!}
```