diff --git a/api-guide/relations.html b/api-guide/relations.html index d774972d9..d9e1a8a16 100644 --- a/api-guide/relations.html +++ b/api-guide/relations.html @@ -330,7 +330,7 @@ class Track(models.Model):

By default this field is read-write, although you can change this behavior using the read_only flag.

Arguments:

+
+

Note: The base_name argument is used to specify the initial part of the view name pattern. In the example above, that's the user or account part.

+

Typically you won't need to specify the base-name argument, but if you have a viewset where you've defined a custom get_queryset method, then the viewset may not have any .model or .queryset attribute set. If you try to register that viewset you'll see an error like this:

+
'base_name' argument not specified, and could not automatically determine the name from the viewset, as it does not have a '.model' or '.queryset' attribute.
+
+

This means you'll need to explicitly set the base_name argument when registering the viewset, as it could not be automatically determined from the model name.

+

Any methods on the viewset decorated with @link or @action will also be routed. For example, given a method like this on the UserViewSet class: