docs: add section on default OpenAPI schema file endpoints#4641
Open
tysoncung wants to merge 1 commit intolitestar-org:mainfrom
Open
docs: add section on default OpenAPI schema file endpoints#4641tysoncung wants to merge 1 commit intolitestar-org:mainfrom
tysoncung wants to merge 1 commit intolitestar-org:mainfrom
Conversation
…org#3941) Document the default OpenAPI schema file endpoints (openapi.json, openapi.yaml, openapi.yml) that are served under the OpenAPI root path. This was previously only mentioned in passing, causing users to not realize these endpoints exist for importing into tools like Scalar API Client, Postman, etc.
github-actions
bot
added
area/docs
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Problem
The documentation for OpenAPI didn't explicitly document the availability of the default schema file endpoints (
openapi.json,openapi.yaml,openapi.yml). Users had to discover these paths by reading the source code or stumbling upon brief mentions in other sections.Solution
Added a new "Default OpenAPI Schema Files" section to the OpenAPI UI Plugins documentation that clearly documents:
/schema/openapi.json— always available (auto-registered even without explicit config)/schema/openapi.yamland/schema/openapi.yml— available withYamlRenderPluginFiles Changed
docs/usage/openapi/ui_plugins.rst: Added new documentation section before the "Configuring the OpenAPI Root Path" sectionCloses #3941
📚 Documentation preview 📚: https://litestar-org.github.io/litestar-docs-preview/4641