aboutsummaryrefslogtreecommitdiffstats
path: root/docs/api-guide/viewsets.md
diff options
context:
space:
mode:
authorMark Henwood2014-12-07 11:57:07 +0000
committerMark Henwood2014-12-07 12:02:43 +0000
commit9b468fba60def77144949628211aac95c6316c70 (patch)
tree4bb81b27d8906dc98b536ac056d681289d172700 /docs/api-guide/viewsets.md
parent71c49fea8abf1007d17aaf801dab9099b36515bd (diff)
downloaddjango-rest-framework-9b468fba60def77144949628211aac95c6316c70.tar.bz2
Amend ViewSet docs to warn of potential problem
I went through this exact problem and so thought the docs might benefit from a small hint at the appropriate point.
Diffstat (limited to 'docs/api-guide/viewsets.md')
-rw-r--r--docs/api-guide/viewsets.md3
1 files changed, 3 insertions, 0 deletions
diff --git a/docs/api-guide/viewsets.md b/docs/api-guide/viewsets.md
index 28186c64..3e37cef8 100644
--- a/docs/api-guide/viewsets.md
+++ b/docs/api-guide/viewsets.md
@@ -201,6 +201,8 @@ Note that you can use any of the standard attributes or method overrides provide
def get_queryset(self):
return self.request.user.accounts.all()
+Note however that upon removal of the `queryset` property from your `ViewSet`, any associated [router][routers] will be unable to derive the base_name of your Model automatically, and so you you will have to specify the `base_name` kwarg as part of your [router registration][routers].
+
Also note that although this class provides the complete set of create/list/retrieve/update/destroy actions by default, you can restrict the available operations by using the standard permission classes.
## ReadOnlyModelViewSet
@@ -243,3 +245,4 @@ To create a base viewset class that provides `create`, `list` and `retrieve` ope
By creating your own base `ViewSet` classes, you can provide common behavior that can be reused in multiple viewsets across your API.
[cite]: http://guides.rubyonrails.org/routing.html
+[routers]: routers.md