From 1bf712341508b5d9aa07fb62f55b7e495278fabf Mon Sep 17 00:00:00 2001
From: Filipe Ximenes
Date: Tue, 20 Aug 2013 16:24:13 -0300
Subject: improving documentation about object level permissions #1049

---
 docs/api-guide/generic-views.md | 5 ++++-
 1 file changed, 4 insertions(+), 1 deletion(-)

(limited to 'docs/api-guide/generic-views.md')

diff --git a/docs/api-guide/generic-views.md b/docs/api-guide/generic-views.md
index 32a4feef..2a585f9c 100755
--- a/docs/api-guide/generic-views.md
+++ b/docs/api-guide/generic-views.md
@@ -108,7 +108,10 @@ For example:
         filter = {}
         for field in self.multiple_lookup_fields:
             filter[field] = self.kwargs[field]
-        return get_object_or_404(queryset, **filter)
+
+        obj = get_object_or_404(queryset, **filter)
+        self.check_object_permissions(self.request, obj)
+        return obj
 
 #### `get_serializer_class(self)`
 
-- 
cgit v1.2.3


From 5e40e50f2b187fe2ff2e8ee63b4e39ece42f1521 Mon Sep 17 00:00:00 2001
From: Tom Christie
Date: Wed, 21 Aug 2013 19:46:09 +0100
Subject: Include import paths throughout docs.

Closes #1051.  Thanks to @pydanny for the report.
---
 docs/api-guide/generic-views.md | 5 +++++
 1 file changed, 5 insertions(+)

(limited to 'docs/api-guide/generic-views.md')

diff --git a/docs/api-guide/generic-views.md b/docs/api-guide/generic-views.md
index 32a4feef..7f754df8 100755
--- a/docs/api-guide/generic-views.md
+++ b/docs/api-guide/generic-views.md
@@ -17,6 +17,11 @@ If the generic views don't suit the needs of your API, you can drop down to usin
 
 Typically when using the generic views, you'll override the view, and set several class attributes.
 
+    from django.contrib.auth.models import User
+    from myapp.serializers import UserSerializer
+	from rest_framework import generics
+	from rest_framework.permissions import IsAdminUser
+
     class UserList(generics.ListCreateAPIView):
         queryset = User.objects.all()
         serializer_class = UserSerializer
-- 
cgit v1.2.3


From cf6ae397db1353370fef05df99a8d321806a6f58 Mon Sep 17 00:00:00 2001
From: Tom Christie
Date: Wed, 21 Aug 2013 19:57:30 +0100
Subject: Docs tweaking around `check_object_permissions`

---
 docs/api-guide/generic-views.md | 2 ++
 1 file changed, 2 insertions(+)

(limited to 'docs/api-guide/generic-views.md')

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.
-- 
cgit v1.2.3


From da9c17067c3150897da4cab149f12dee08768346 Mon Sep 17 00:00:00 2001
From: Brett Koonce
Date: Thu, 29 Aug 2013 09:23:34 -0500
Subject: minor sp

---
 docs/api-guide/generic-views.md | 4 ++--
 1 file changed, 2 insertions(+), 2 deletions(-)

(limited to 'docs/api-guide/generic-views.md')

diff --git a/docs/api-guide/generic-views.md b/docs/api-guide/generic-views.md
index 931cae54..7185b6b6 100755
--- a/docs/api-guide/generic-views.md
+++ b/docs/api-guide/generic-views.md
@@ -73,7 +73,7 @@ The following attributes control the basic view behavior.
 
 **Pagination**:
 
-The following attibutes are used to control pagination when used with list views.
+The following attributes are used to control pagination when used with list views.
 
 * `paginate_by` - The size of pages to use with paginated data.  If set to `None` then pagination is turned off.  If unset this uses the same value as the `PAGINATE_BY` setting, which defaults to `None`.
 * `paginate_by_param` - The name of a query parameter, which can be used by the client to override the default page size to use for pagination.  If unset this uses the same value as the `PAGINATE_BY_PARAM` setting, which defaults to `None`.
@@ -135,7 +135,7 @@ For example:
 
 #### `get_paginate_by(self)`
 
-Returns the page size to use with pagination.  By default this uses the `paginate_by` attribute, and may be overridden by the cient if the `paginate_by_param` attribute is set.
+Returns the page size to use with pagination.  By default this uses the `paginate_by` attribute, and may be overridden by the client if the `paginate_by_param` attribute is set.
 
 You may want to override this method to provide more complex behavior such as modifying page sizes based on the media type of the response.
 
-- 
cgit v1.2.3