Repository navigation
Broken OpenAPI with entries as property name #1493
Description
Describe the bug
Error in OpenAPI generation when a model property is named with entries. If property is renamed (e.g. entry) generation is successful.
To Reproduce
- Create a file with:
from fastapi import FastAPI
from pydantic import BaseModel
app = FastAPI()
class Item(BaseModel):
entries: str
@app.post("/demo")
def read_root(e: Item):
return e- Open the browser and call the docs
http://localhost:8000/docs. - Schema is not rendered (see screenshot)
Expected behavior
Schema is correctly rendered.
Screenshots
Environment
- OS: macOS
- FastAPI Version 0.55.1
- Python 3.7.1
Additional context
Related swagger UI issue fixed in this PR: swagger-api/swagger-ui#6025
Activity
phy25 commentedon May 30, 2020
https://github.com/swagger-api/swagger-ui/releases/tag/v3.25.5
The latest swagger-ui release should have fixed this - this has nothing to do with fastapi.
tiangolo commentedon Jun 6, 2020
Thanks for the help here @phy25 ! 👏 🙇
Yeah, that wouldn't be an issue with FastAPI but Swagger UI.
github-actions commentedon Jun 17, 2020
Assuming the original issue was solved, it will be automatically closed now. But feel free to add more comments or create new issues.
[-][BUG] Broken OpenAPI with `entries` as property name[/-][+]Broken OpenAPI with `entries` as property name[/+]