aboutsummaryrefslogtreecommitdiffstats
path: root/docs/api-guide
diff options
context:
space:
mode:
authorTom Christie2013-03-08 20:41:00 +0000
committerTom Christie2013-03-08 20:41:00 +0000
commit4d48de631baee39025da04b95f46051d7398bd6c (patch)
tree979eb612a93b4ae0c60d099d34b2b7d1fc1f2965 /docs/api-guide
parent5fffaf89e2df8f1213e2a8c3aea7efb35941808c (diff)
downloaddjango-rest-framework-4d48de631baee39025da04b95f46051d7398bd6c.tar.bz2
Docs on per-object filtering
Diffstat (limited to 'docs/api-guide')
-rw-r--r--docs/api-guide/filtering.md8
1 files changed, 8 insertions, 0 deletions
diff --git a/docs/api-guide/filtering.md b/docs/api-guide/filtering.md
index 53ea7cbc..ed946368 100644
--- a/docs/api-guide/filtering.md
+++ b/docs/api-guide/filtering.md
@@ -140,6 +140,14 @@ For more details on using filter sets see the [django-filter documentation][djan
---
+### Filtering and object lookups
+
+Note that if a filter backend is configured for a view, then as well as being used to filter list views, it will also be used to filter the querysets used for returning a single object.
+
+For instance, given the previous example, and a product with an id of `4675`, the following URL would either return the corresponding object, or return a 404 response, depending on if the filtering conditions were met by the given product instance:
+
+ http://example.com/api/products/4675/?category=clothing&max_price=10.00
+
## Overriding the initial queryset
Note that you can use both an overridden `.get_queryset()` and generic filtering together, and everything will work as expected. For example, if `Product` had a many-to-many relationship with `User`, named `purchase`, you might want to write a view like this: