aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorTom Christie2014-11-05 10:53:46 +0000
committerTom Christie2014-11-05 10:53:46 +0000
commit571440e143870cf38230eea7c3a49df23d1eaa7c (patch)
treee61361e831af0d43d4c64393b5d4d8bcc93440b5
parent0a5d088287be1bb56f37504cc75cee10fb4e74a0 (diff)
downloaddjango-rest-framework-571440e143870cf38230eea7c3a49df23d1eaa7c.tar.bz2
Stronger calling out of 'DjangoObjectPermissionsFilter'. Closes #1934.
-rw-r--r--docs/api-guide/permissions.md8
1 files changed, 7 insertions, 1 deletions
diff --git a/docs/api-guide/permissions.md b/docs/api-guide/permissions.md
index f3ae8171..446e362e 100644
--- a/docs/api-guide/permissions.md
+++ b/docs/api-guide/permissions.md
@@ -146,7 +146,13 @@ As with `DjangoModelPermissions`, this permission must only be applied to views
Note that `DjangoObjectPermissions` **does not** require the `django-guardian` package, and should support other object-level backends equally well.
-As with `DjangoModelPermissions` you can use custom model permissions by overriding `DjangoModelPermissions` and setting the `.perms_map` property. Refer to the source code for details. Note that if you add a custom `view` permission for `GET`, `HEAD` and `OPTIONS` requests, you'll probably also want to consider adding the `DjangoObjectPermissionsFilter` class to ensure that list endpoints only return results including objects for which the user has appropriate view permissions.
+As with `DjangoModelPermissions` you can use custom model permissions by overriding `DjangoModelPermissions` and setting the `.perms_map` property. Refer to the source code for details.
+
+---
+
+**Note**: If you need object level `view` permissions for `GET`, `HEAD` and `OPTIONS` requests, you'll want to consider also adding the `DjangoObjectPermissionsFilter` class to ensure that list endpoints only return results including objects for which the user has appropriate view permissions.
+
+---
## TokenHasReadWriteScope