Repository navigation
Describe generated OpenAPI schemas through bootstrapper settings - #161
Merged
Merged
Conversation
Codecov Report✅ All modified and coverable lines are covered by tests.
Flags with carried forward coverage won't be shown. Click here to find out more.
... and 1 file with indirect coverage changes 🚀 New features to boost your workflow:
|
vrslev
marked this pull request as ready for review
October 22, 2026 19:00
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
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.
Agent:
Generated framework errors leave OpenAPI fields undocumented, so applications repeat schema cleanup. The FastAPI and Litestar bootstrappers now add these descriptions automatically when
openapi_descriptions_enabledis enabled in settings orSwaggerConfig. The option defaults to false and uses the existing settings environment prefix.FastAPI applies the descriptions when its schema is generated, including routes registered after bootstrap. Litestar enriches its generated document when OpenAPI is enabled. Existing descriptions and runtime response shapes are preserved; application-specific metadata and authentication policy remain with the application. Health descriptions live beside the microbootstrap type that owns them. Regression tests cover both setting states, environment configuration, actual HTTP responses, cached generation, composite schemas and references.