Repository navigation
Add one API metadata setting to web bootstrappers - #162
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.
🚀 New features to boost your workflow:
|
vrslev
marked this pull request as ready for review
October 22, 2026 21:05
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:
Default HTTP errors lack a short summary, while generated validation schemas need useful field descriptions. Add one disabled-by-default
api_metadata_enabledsetting to the FastAPI and Litestar settings classes. The bootstrappers apply both schema descriptions and HTTP status titles; no separate instrument configuration is needed. Custom error handlers retain ownership of their payloads, headers and schemas, and native debug tracebacks are preserved.This replaces the
openapi_descriptions_enabledoption released in 1.8.0. Existing callers must migrate their settings and environment variables to the new name; enabling it also extends default HTTP error bodies withtitle. The README documents that migration. The setting works independently of Swagger UI and does not certify conformance to an API standard.