feat: improve "key" property in validation error messages #4216
Conversation
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
github-actions
bot
added
area/private-api
250MHz
force-pushed
the
improve-validation-error-key
branch
from
04894df to
3f30198
Compare
250MHz
changed the title
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## main #4216 +/- ##
=======================================
Coverage 98.38% 98.39%
=======================================
Files 348 348
Lines 15895 15922 +27
Branches 1756 1764 +8
=======================================
+ Hits 15638 15666 +28
Misses 121 121
+ Partials 136 135 -1 ☔ View full report in Codecov by Sentry. 🚀 New features to boost your workflow:
|
* Start "key" with an array index when the validation error applies to a request body or a query parameter that is a list. * Use alternative name for query parameters, cookies, and headers in "key" instead of the parameter's name in a route handler's signature. * Parameters in route handlers that are not the request body but whose names start with "data" will not have their validation error message "source" set to "body". * Use a "key" that better resembles the format that msgspec uses when an ExtendedMsgSpecValidationError is raised.
250MHz
force-pushed
the
improve-validation-error-key
branch
from
3f30198 to
7563095
Compare
|
Documentation preview will be available shortly at https://litestar-org.github.io/litestar-docs-preview/4216 |
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.
Description
Start "key" with an array index when the validation error applies to a request body or a query parameter that is a list.
Use alternative name for query parameters, cookies, and headers in "key" instead of the parameter's name in a route handler's signature.
Parameters in route handlers that are not the request body but whose names start with "data" will not have their validation error message "source" set to "body".
Use a "key" that better resembles the format that msgspec uses when an ExtendedMsgSpecValidationError is raised.
Closes
Closes #4215