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

This commit is contained in:
Sebastián Ramírez authored and GitHub committed 2019-06-28 21:27:27 +02:00
1 parent 7e48be1561
commit 9a71672a95
3 files changed
+5 -2

No files matched your search

+1 -1
View File
@@ -3,7 +3,7 @@ from enum import Enum
from fastapi import FastAPI
class ModelName(Enum):
class ModelName(str, Enum):
alexnet = "alexnet"
resnet = "resnet"
lenet = "lenet"
+3 -1
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:
@@ -35,6 +35,7 @@ openapi_schema = {
"schema": {
"title": "Model_Name",
"enum": ["alexnet", "resnet", "lenet"],
"type": "string",
},
"name": "model_name",
"in": "path",