Skip to content

Document setting JSON_API_UNIFORM_EXCEPTIONS #813

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Aug 22, 2020
Merged

Document setting JSON_API_UNIFORM_EXCEPTIONS #813

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
d1e77e8
Document setting JSON_API_UNIFORM_EXCEPTIONS
sliverc Aug 21, 2020
f4fcaf7
Merge branch 'master' into exception_handling
n2ygk Aug 22, 2020
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 7 additions & 0 deletions docs/usage.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -237,6 +237,13 @@ class MyViewset(ModelViewSet):

```

### Exception handling

For the `exception_handler` class, if the optional `JSON_API_UNIFORM_EXCEPTIONS` is set to True,
all exceptions will respond with the JSON API [error format](http://jsonapi.org/format/#error-objects).

When `JSON_API_UNIFORM_EXCEPTIONS` is False (the default), non-JSON API views will respond
with the normal DRF error format.

### Performance Testing

Expand Down