litestar-org/litestar
Docs: Add information on the default OpenAPI files available
开放
#3,941 创建于 2025年1月10日
Documentation :books:Good First IssueHelp Wanted :sos:
仓库指标
- 星标
- (8,243 个星标)
- PR 合并指标
- (平均合并 13小时 27分钟) (30 天内合并 26 个 PR)
描述
Summary
In https://docs.litestar.dev/latest/usage/openapi we don't really specifically say anything about the availability of $openapi_path/openapi.{json,yaml,yml} except in 2 places, 1 of which says it is deprecated:
- https://docs.litestar.dev/latest/usage/openapi/ui_plugins.html#providing-a-subclass-of-openapicontroller (but just glossing over)
- https://docs.litestar.dev/latest/usage/openapi/ui_plugins.html#configuring-the-openapi-root-path (but just glossing over)
It would be nice to document this when people need them e.g., for Scalar API client's collection import feature