Meaningful validation error responses #31
Merged
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.
I've found the validation errors returned are not that helpful. Consider the following examples:
{"message":"must have a value"}
{"message":""}
{"message":"doesn't match the schema"}
{"message":"doesn't match the schema"}
This PR makes use of the Error attribute, which comes back as (overly verbose) multi-line text. However, the first line contains a useful amount of detail. The results (for the same scenarios) are as follows:
{"message":"Parameter 'someEnumValue' in path has an error: must have a value: must have a value"}
{"message":"Parameter 'someEnumValue' in path has an error: JSON value is not one of the allowed values"}
{"message":"Request body has an error: doesn't match the schema: Property 'someProperty' is missing"}
{"message":"Request body has an error: doesn't match the schema: Error at \"/somePropery\": JSON value is not one of the allowed values"}
The full error text contains way too much information, including escaped JSON objects to describe the actual schema. I think this is too much info, so the first line seems like an easy way to get a good balance.