Make endpoints return more helpful json decode failures #454
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.
Overview
This PR makes endpoints return more helpful messages when JSON decoding fails. It overrides the method to create
messages from decode failures with special handling for circe decoding failures.
Checklist
New tests have been added or existing tests have been modifiedNotes
Unfortunately this only returns the first error. I believe that this is because tapir just uses the
decode
function instead of thedecodeAccumulating
function for getting the circe decode result. We could also provide a closer derivation that would override this behavior.Here are some example responses:
Testing Instructions
./scripts/server --with-transactions
echo '{}' | http :9090/collections
echo '{ YOUR CORRECTED JSON HERE }' | http :9090/collection
Closes #427