BoostryJP / ibet-Wallet-API

A powerful API suite for seamlessly building ibet blockchain wallet systems 🛠
https://ibet.jp/ibet-for-fin
Apache License 2.0
9 stars 0 forks source link

[FEATURE] Make query parameter description shown in openapi document #1223

Closed purplesmoke05 closed 2 years ago

purplesmoke05 commented 2 years ago

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.

dev-22.12ではOpenAPIドキュメント上でクエリパラメータの説明が表示されない。これはFastAPIがPydanticモデルをクエリパラメータとして使用するのをサポートしていないためである。

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.

PydanticベースモデルからPydantic dataclassへクエリパラメータを置換し、OpenAPIドキュメント上でクエリパラメータの説明が表示されるようにする。

Additional context

In addition to this, it would be better to clearly separate the schema model for request use and response use.

リクエスト/レスポンスでスキーマモデルを明確に分けた方がいいかもしれない。