fix: add examples below application/json in openapi schema file#4572
Open
fix: add examples below application/json in openapi schema file#4572
Conversation
4 tasks
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## main #4572 +/- ##
=======================================
Coverage 97.87% 97.87%
=======================================
Files 292 292
Lines 15077 15081 +4
Branches 1703 1704 +1
=======================================
+ Hits 14757 14761 +4
Misses 184 184
Partials 136 136 ☔ View full report in Codecov by Sentry. 🚀 New features to boost your workflow:
|
sobolevn
reviewed
Mar 19, 2026
| """ | ||
|
|
||
| examples: dict[str, Example | Reference] | None = None | ||
| examples: Mapping[str, Example | Reference] | None = None |
Member
There was a problem hiding this comment.
This is a breaking change technically, if you disallow .update in users' typing. It is not a big deal, but I would keep this annotation unchaged if possible :)
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.
Closes
#4558
Running the following file, examples are correctly setup regarding openapi documentation, they are visible using /schema endpoint.
📚 Documentation preview 📚: https://litestar-org.github.io/litestar-docs-preview/4572