diff options
| author | Tom Christie | 2013-08-21 19:57:30 +0100 | 
|---|---|---|
| committer | Tom Christie | 2013-08-21 19:57:30 +0100 | 
| commit | cf6ae397db1353370fef05df99a8d321806a6f58 (patch) | |
| tree | e60f5fd5ed106e2590d858da79db4518363ace4e /docs/api-guide | |
| parent | d900847d98e40921cd9bde251e002453d1d922be (diff) | |
| download | django-rest-framework-cf6ae397db1353370fef05df99a8d321806a6f58.tar.bz2 | |
Docs tweaking around `check_object_permissions`
Diffstat (limited to 'docs/api-guide')
| -rwxr-xr-x | docs/api-guide/generic-views.md | 2 | ||||
| -rw-r--r-- | docs/api-guide/permissions.md | 3 | 
2 files changed, 4 insertions, 1 deletions
| diff --git a/docs/api-guide/generic-views.md b/docs/api-guide/generic-views.md index 281a0481..931cae54 100755 --- a/docs/api-guide/generic-views.md +++ b/docs/api-guide/generic-views.md @@ -118,6 +118,8 @@ For example:          self.check_object_permissions(self.request, obj)          return obj +Note that if your API doesn't include any object level permissions, you may optionally exclude the ``self.check_object_permissions, and simply return the object from the `get_object_or_404` lookup. +  #### `get_serializer_class(self)`  Returns the class that should be used for the serializer.  Defaults to returning the `serializer_class` attribute, or dynamically generating a serializer class if the `model` shortcut is being used. diff --git a/docs/api-guide/permissions.md b/docs/api-guide/permissions.md index 6b80a98c..12aa4c18 100644 --- a/docs/api-guide/permissions.md +++ b/docs/api-guide/permissions.md @@ -25,7 +25,8 @@ Object level permissions are run by REST framework's generic views when `.get_ob  As with view level permissions, an `exceptions.PermissionDenied` exception will be raised if the user is not allowed to act on the given object.  If you're writing your own views and want to enforce object level permissions, -you'll need to explicitly call the `.check_object_permissions(request, obj)` method on the view at the point at which you've retrieved the object. +or if you override the `get_object` method on a generic view, then you'll need to explicitly call the `.check_object_permissions(request, obj)` method on the view at the point at which you've retrieved the object. +  This will either raise a `PermissionDenied` or `NotAuthenticated` exception, or simply return if the view has the appropriate permissions.  For example: | 
