chore(api/diff): improve error message when json parsing objects #3536
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 & motivation
The fact that the
objects
parameter of the diff upload and download is meant to be JSON stringified representation of a list is often missed by developers (Speckle and non-Speckle, it's really not an obvious API design choice). It is currently difficult to debug because the error message is not helpful.This PR wraps the JSON parsing error and provides additional context to help make the issue clearer and the problem easier to resolve.
It also ensures the correct status code is returned to the user.
Changes:
To-do before merge:
Screenshots:
Validation of changes:
(NB, the stack trace is only displayed because this is running in development mode)
Checklist:
References