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

📝 Update enum examples to use str, and improve Swagger UI in examples (#351)

Browse Source
This commit is contained in:
Sebastián Ramírez
2019-06-28 21:27:27 +02:00
committed by GitHub
parent 7e48be1561
commit 9a71672a95
3 changed files with 5 additions and 2 deletions
Download Patch File Download Diff File Expand all files Collapse all files

4
docs/tutorial/path-params.md
View File

@@ -119,7 +119,9 @@ If you have a *path operation* that receives a *path parameter*, but you want th
### Create an `Enum` class
Import `Enum` and create a sub-class that inherits from it.
Import `Enum` and create a sub-class that inherits from `str` and from `Enum`.
By inheriting from `str` the API docs will be able to know that the values must be of type `string` and will be able to render correctly.
And create class attributes with fixed values, those fixed values will be the available valid values: