Closed purplesmoke05 closed 2 years ago
In dev-22.12, query parameter description is not shown in openapi document because FastAPI does not support using Pydantic Model as query parameter.
dev-22.12
dev-22.12ではOpenAPIドキュメント上でクエリパラメータの説明が表示されない。これはFastAPIがPydanticモデルをクエリパラメータとして使用するのをサポートしていないためである。
Replace query parameter from pydantic BaseModel to pydantic dataclass so that query param description is shown in openapi document.
PydanticベースモデルからPydantic dataclassへクエリパラメータを置換し、OpenAPIドキュメント上でクエリパラメータの説明が表示されるようにする。
In addition to this, it would be better to clearly separate the schema model for request use and response use.
リクエスト/レスポンスでスキーマモデルを明確に分けた方がいいかもしれない。
Is your feature request related to a problem? Please describe.
In
dev-22.12
, query parameter description is not shown in openapi document because FastAPI does not support using Pydantic Model as query parameter.Describe the solution you'd like
Replace query parameter from pydantic BaseModel to pydantic dataclass so that query param description is shown in openapi document.
Additional context
In addition to this, it would be better to clearly separate the schema model for request use and response use.