From 9b468fba60def77144949628211aac95c6316c70 Mon Sep 17 00:00:00 2001 From: Mark Henwood Date: Sun, 7 Dec 2014 11:57:07 +0000 Subject: [PATCH] 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. --- docs/api-guide/viewsets.md | 3 +++ 1 file changed, 3 insertions(+) diff --git a/docs/api-guide/viewsets.md b/docs/api-guide/viewsets.md index 28186c643..3e37cef89 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