refactor: improve NotFoundError exceptions raised on API v1 and how records are retrieved from database #4876
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
This is the first of some PRs refactoring and improving the error handling for API v1.
In this specific PR I'm improving how
NotFoundError
is managed in the API v1 with the following changes:NotFoundError
is added to the list of the captures exceptions for API v1.NotFoundError
is not changed using the same structure:{"detail": "message"}
. Once we are working on v2.0 we can change it to use the new one.get
: useful to get an instance of a database model using an id.get_or_raise
: useful to get an instance of a database model using an id and raising aNotFoundError
exception if the instance is not found.options
parameter that can be used to pre-load associations.Refs #4871
Type of change
(Please delete options that are not relevant. Remember to title the PR according to the type of change)
How Has This Been Tested
(Please describe the tests that you ran to verify your changes. And ideally, reference
tests
)Checklist