aboutsummaryrefslogtreecommitdiffstats
path: root/docs/api-guide
diff options
context:
space:
mode:
authorTom Christie2013-04-26 14:03:26 +0100
committerTom Christie2013-04-26 14:03:26 +0100
commite301e2d974649a932ab9a7ca32199c068fa30495 (patch)
tree89591732481ff53f9e72421b77333c6134cbb920 /docs/api-guide
parentd985aec3c9034ab1aa899e914a5ac0baf314cb3c (diff)
downloaddjango-rest-framework-e301e2d974649a932ab9a7ca32199c068fa30495.tar.bz2
Adding 'view or viewset' to docs appropriate.
Diffstat (limited to 'docs/api-guide')
-rwxr-xr-xdocs/api-guide/authentication.md3
-rw-r--r--docs/api-guide/filtering.md3
-rw-r--r--docs/api-guide/parsers.md5
-rw-r--r--docs/api-guide/permissions.md3
-rw-r--r--docs/api-guide/renderers.md3
-rw-r--r--docs/api-guide/throttling.md5
6 files changed, 14 insertions, 8 deletions
diff --git a/docs/api-guide/authentication.md b/docs/api-guide/authentication.md
index 1f08f542..c2f73901 100755
--- a/docs/api-guide/authentication.md
+++ b/docs/api-guide/authentication.md
@@ -43,7 +43,8 @@ The default authentication schemes may be set globally, using the `DEFAULT_AUTHE
)
}
-You can also set the authentication scheme on a per-view basis, using the `APIView` class based views.
+You can also set the authentication scheme on a per-view or per-viewset basis,
+using the `APIView` class based views.
class ExampleView(APIView):
authentication_classes = (SessionAuthentication, BasicAuthentication)
diff --git a/docs/api-guide/filtering.md b/docs/api-guide/filtering.md
index 805d82f8..53cd3e13 100644
--- a/docs/api-guide/filtering.md
+++ b/docs/api-guide/filtering.md
@@ -94,7 +94,8 @@ You must also set the filter backend to `DjangoFilterBackend` in your settings:
## Specifying filter fields
-If all you need is simple equality-based filtering, you can set a `filter_fields` attribute on the view, listing the set of fields you wish to filter against.
+If all you need is simple equality-based filtering, you can set a `filter_fields` attribute on the view, or viewset,
+listing the set of fields you wish to filter against.
class ProductList(generics.ListAPIView):
queryset = Product.objects.all()
diff --git a/docs/api-guide/parsers.md b/docs/api-guide/parsers.md
index a2830492..49d59d10 100644
--- a/docs/api-guide/parsers.md
+++ b/docs/api-guide/parsers.md
@@ -34,7 +34,8 @@ The default set of parsers may be set globally, using the `DEFAULT_PARSER_CLASSE
)
}
-You can also set the renderers used for an individual view, using the `APIView` class based views.
+You can also set the renderers used for an individual view, or viewset,
+using the `APIView` class based views.
class ExampleView(APIView):
"""
@@ -187,4 +188,4 @@ The following third party packages are also available.
[cite]: https://groups.google.com/d/topic/django-developers/dxI4qVzrBY4/discussion
[messagepack]: https://github.com/juanriaza/django-rest-framework-msgpack
[juanriaza]: https://github.com/juanriaza
-[djangorestframework-msgpack]: https://github.com/juanriaza/django-rest-framework-msgpack \ No newline at end of file
+[djangorestframework-msgpack]: https://github.com/juanriaza/django-rest-framework-msgpack
diff --git a/docs/api-guide/permissions.md b/docs/api-guide/permissions.md
index 4772c5e0..4b3eda6d 100644
--- a/docs/api-guide/permissions.md
+++ b/docs/api-guide/permissions.md
@@ -39,7 +39,8 @@ If not specified, this setting defaults to allowing unrestricted access:
'rest_framework.permissions.AllowAny',
)
-You can also set the authentication policy on a per-view basis, using the `APIView` class based views.
+You can also set the authentication policy on a per-view, or per-viewset basis,
+using the `APIView` class based views.
class ExampleView(APIView):
permission_classes = (IsAuthenticated,)
diff --git a/docs/api-guide/renderers.md b/docs/api-guide/renderers.md
index e2fc36ca..00739422 100644
--- a/docs/api-guide/renderers.md
+++ b/docs/api-guide/renderers.md
@@ -27,7 +27,8 @@ The default set of renderers may be set globally, using the `DEFAULT_RENDERER_CL
)
}
-You can also set the renderers used for an individual view, using the `APIView` class based views.
+You can also set the renderers used for an individual view, or viewset,
+using the `APIView` class based views.
class UserCountView(APIView):
"""
diff --git a/docs/api-guide/throttling.md b/docs/api-guide/throttling.md
index 1abd49f4..d6de85ba 100644
--- a/docs/api-guide/throttling.md
+++ b/docs/api-guide/throttling.md
@@ -40,7 +40,8 @@ The default throttling policy may be set globally, using the `DEFAULT_THROTTLE_C
The rate descriptions used in `DEFAULT_THROTTLE_RATES` may include `second`, `minute`, `hour` or `day` as the throttle period.
-You can also set the throttling policy on a per-view basis, using the `APIView` class based views.
+You can also set the throttling policy on a per-view or per-viewset basis,
+using the `APIView` class based views.
class ExampleView(APIView):
throttle_classes = (UserThrottle,)
@@ -167,4 +168,4 @@ The following is an example of a rate throttle, that will randomly throttle 1 in
[cite]: https://dev.twitter.com/docs/error-codes-responses
[permissions]: permissions.md
[cache-setting]: https://docs.djangoproject.com/en/dev/ref/settings/#caches
-[cache-docs]: https://docs.djangoproject.com/en/dev/topics/cache/#setting-up-the-cache \ No newline at end of file
+[cache-docs]: https://docs.djangoproject.com/en/dev/topics/cache/#setting-up-the-cache