Docs: Add information on the default OpenAPI files available · litestar-org/litestar#3941

(3 comments) (0 reactions) (0 assignees)Python (8,243 stars) (550 forks)user submission

Documentation :books:Good First IssueHelp Wanted :sos:

説明

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

コントリビューターガイド

技術スタック: pythonrest api
領域: documentation
Issue 種別: documentation
難度: 2
推定時間: under 1 hour
活動状況: fresh
明確さ: clear
前提条件: Familiarity with Litestar frameworkKnowledge of OpenAPI
初心者向け度: 90
調査方針: Examine the two referenced documentation pages and the OpenAPI controller implementation to understand how the default files are served. Then add a clear section in the OpenAPI usage documentation that explicitly mentions the availability of openapi.json, openapi.yaml, and openapi.yml at the configured OpenAPI path. Consider including a note for Scalar API client's collection import feature.