Handling multi-error summaries (returned when using oneOf for example) #1
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
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.
The validation error response coming from the
getkin/kin-openapidoes contain a useful summary on the first line, but under some circumstances this multi-line string error (obviously not the easiest thing to work with) can contain descriptions of other possible errors.One such circumstance is when using "oneOf" to validate request bodies. In the scenario where a payload fails to validate against either of the oneOf schemas, the validation middleware simply returns the first description. It is however apparent that they appear in random order, which leads to an inconsistent (and often incorrect) validation response.
This PR shows how we can make this experience slightly more accurate.