🐛 Fix JSON Schema for ValidationError at field loc
#3810
Merged
Conversation
This file contains 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
|
📝 Docs preview for commit 95ce749 at: https://612e50e590ccc9407a6d3a82--fastapi.netlify.app |
Codecov Report
@@ Coverage Diff @@
## master #3810 +/- ##
=========================================
Coverage 100.00% 100.00%
=========================================
Files 409 409
Lines 10264 10264
=========================================
Hits 10264 10264
Continue to review full report at Codecov.
|
|
📝 Docs preview for commit 6caac74 at: https://612ea7456baaa23ddbd68c4c--fastapi.netlify.app |
|
📝 Docs preview for commit ae1128a at: https://615f4487606f2867f92c1744--fastapi.netlify.app |
tiangolo
changed the title
ValidationError at field loc
|
Awesome, thanks @dconatha for the work and explanation! 🤓 🍰 This will be available in FastAPI |
This was referenced Apr 17, 2022
JeanArhancet
pushed a commit
to JeanArhancet/fastapi
that referenced
this pull request
Aug 20, 2022
Co-authored-by: Devin Conathan <dconatha@amfam.com>
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.
See #3790
Basically, Pydantic's schema for the
locfield of the error detail isUnion[str, int]notstrfor e.g. cases when the invalid data is at a particular index of an array:See the type defined in Pydantic's source here:
https://github.com/samuelcolvin/pydantic/blob/5ccbdcb5904f35834300b01432a665c75dc02296/pydantic/error_wrappers.py#L12
The
openapi.jsonschema for aValidationErrorshould match this.This is particularly important for automated testing using https://schemathesis.readthedocs.io/en/stable/ because ValidationErrors that don't match the schema will lead to failing tests.
I've updated the
validation_error_definition(h/t to @silversurfer34 for creating the issue and supplying the fixed schema 😄 ).Also I had to update all the tests since the
openapi.jsons are hardcoded in that.