encode/django-rest-framework
1
1
Fork 0
mirror of https://github.com/encode/django-rest-framework.git synced 2024-11-23 01:57:00 +03:00
Code Issues Packages Projects Releases Wiki Activity

Deployed ac7b20cc with MkDocs version: 0.16.3

Browse Source
This commit is contained in:
Carlton Gibson 2019-03-04 14:47:54 +01:00
parent aaee4bd6e6
commit fcde219928
3 changed files with 73 additions and 70 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

5
api-guide/filtering/index.html
View File

@ -687,7 +687,10 @@ class UserListView(generics.ListAPIView):
</code></pre> </code></pre>
<p>By default, the search parameter is named <code>'search</code>', but this may be overridden with the <code>SEARCH_PARAM</code> setting.</p> <p>By default, the search parameter is named <code>'search</code>', but this may be overridden with the <code>SEARCH_PARAM</code> setting.</p>
<p>To dynamically change search fields based on request content, it's possible to subclass the <code>SearchFilter</code> and override the <code>get_search_fields()</code> function. For example, the following subclass will only search on <code>title</code> if the query parameter <code>title_only</code> is in the request:</p> <p>To dynamically change search fields based on request content, it's possible to subclass the <code>SearchFilter</code> and override the <code>get_search_fields()</code> function. For example, the following subclass will only search on <code>title</code> if the query parameter <code>title_only</code> is in the request:</p>
<pre><code>class CustomSearchFilter(self, view, request): <pre><code>from rest_framework import filters
class CustomSearchFilter(filters.SearchFilter):
def get_search_fields(self, view, request):
if request.query_params.get('title_only'): if request.query_params.get('title_only'):
return ('title',) return ('title',)
return super(CustomSearchFilter, self).get_search_fields(view, request) return super(CustomSearchFilter, self).get_search_fields(view, request)

4
mkdocs/search_index.json
View File

File diff suppressed because one or more lines are too long

128
sitemap.xml
View File

@ -4,7 +4,7 @@
<url> <url>
<loc>https://www.django-rest-framework.org//</loc> <loc>https://www.django-rest-framework.org//</loc>
<lastmod>2019-03-03</lastmod> <lastmod>2019-03-04</lastmod>
<changefreq>daily</changefreq> <changefreq>daily</changefreq>
</url> </url>
@ -13,49 +13,49 @@
<url> <url>
<loc>https://www.django-rest-framework.org//tutorial/quickstart/</loc> <loc>https://www.django-rest-framework.org//tutorial/quickstart/</loc>
<lastmod>2019-03-03</lastmod> <lastmod>2019-03-04</lastmod>
<changefreq>daily</changefreq> <changefreq>daily</changefreq>
</url> </url>
<url> <url>
<loc>https://www.django-rest-framework.org//tutorial/1-serialization/</loc> <loc>https://www.django-rest-framework.org//tutorial/1-serialization/</loc>
<lastmod>2019-03-03</lastmod> <lastmod>2019-03-04</lastmod>
<changefreq>daily</changefreq> <changefreq>daily</changefreq>
</url> </url>
<url> <url>
<loc>https://www.django-rest-framework.org//tutorial/2-requests-and-responses/</loc> <loc>https://www.django-rest-framework.org//tutorial/2-requests-and-responses/</loc>
<lastmod>2019-03-03</lastmod> <lastmod>2019-03-04</lastmod>
<changefreq>daily</changefreq> <changefreq>daily</changefreq>
</url> </url>
<url> <url>
<loc>https://www.django-rest-framework.org//tutorial/3-class-based-views/</loc> <loc>https://www.django-rest-framework.org//tutorial/3-class-based-views/</loc>
<lastmod>2019-03-03</lastmod> <lastmod>2019-03-04</lastmod>
<changefreq>daily</changefreq> <changefreq>daily</changefreq>
</url> </url>
<url> <url>
<loc>https://www.django-rest-framework.org//tutorial/4-authentication-and-permissions/</loc> <loc>https://www.django-rest-framework.org//tutorial/4-authentication-and-permissions/</loc>
<lastmod>2019-03-03</lastmod> <lastmod>2019-03-04</lastmod>
<changefreq>daily</changefreq> <changefreq>daily</changefreq>
</url> </url>
<url> <url>
<loc>https://www.django-rest-framework.org//tutorial/5-relationships-and-hyperlinked-apis/</loc> <loc>https://www.django-rest-framework.org//tutorial/5-relationships-and-hyperlinked-apis/</loc>
<lastmod>2019-03-03</lastmod> <lastmod>2019-03-04</lastmod>
<changefreq>daily</changefreq> <changefreq>daily</changefreq>
</url> </url>
<url> <url>
<loc>https://www.django-rest-framework.org//tutorial/6-viewsets-and-routers/</loc> <loc>https://www.django-rest-framework.org//tutorial/6-viewsets-and-routers/</loc>
<lastmod>2019-03-03</lastmod> <lastmod>2019-03-04</lastmod>
<changefreq>daily</changefreq> <changefreq>daily</changefreq>
</url> </url>
<url> <url>
<loc>https://www.django-rest-framework.org//tutorial/7-schemas-and-client-libraries/</loc> <loc>https://www.django-rest-framework.org//tutorial/7-schemas-and-client-libraries/</loc>
<lastmod>2019-03-03</lastmod> <lastmod>2019-03-04</lastmod>
<changefreq>daily</changefreq> <changefreq>daily</changefreq>
</url> </url>
@ -65,169 +65,169 @@
<url> <url>
<loc>https://www.django-rest-framework.org//api-guide/requests/</loc> <loc>https://www.django-rest-framework.org//api-guide/requests/</loc>
<lastmod>2019-03-03</lastmod> <lastmod>2019-03-04</lastmod>
<changefreq>daily</changefreq> <changefreq>daily</changefreq>
</url> </url>
<url> <url>
<loc>https://www.django-rest-framework.org//api-guide/responses/</loc> <loc>https://www.django-rest-framework.org//api-guide/responses/</loc>
<lastmod>2019-03-03</lastmod> <lastmod>2019-03-04</lastmod>
<changefreq>daily</changefreq> <changefreq>daily</changefreq>
</url> </url>
<url> <url>
<loc>https://www.django-rest-framework.org//api-guide/views/</loc> <loc>https://www.django-rest-framework.org//api-guide/views/</loc>
<lastmod>2019-03-03</lastmod> <lastmod>2019-03-04</lastmod>
<changefreq>daily</changefreq> <changefreq>daily</changefreq>
</url> </url>
<url> <url>
<loc>https://www.django-rest-framework.org//api-guide/generic-views/</loc> <loc>https://www.django-rest-framework.org//api-guide/generic-views/</loc>
<lastmod>2019-03-03</lastmod> <lastmod>2019-03-04</lastmod>
<changefreq>daily</changefreq> <changefreq>daily</changefreq>
</url> </url>
<url> <url>
<loc>https://www.django-rest-framework.org//api-guide/viewsets/</loc> <loc>https://www.django-rest-framework.org//api-guide/viewsets/</loc>
<lastmod>2019-03-03</lastmod> <lastmod>2019-03-04</lastmod>
<changefreq>daily</changefreq> <changefreq>daily</changefreq>
</url> </url>
<url> <url>
<loc>https://www.django-rest-framework.org//api-guide/routers/</loc> <loc>https://www.django-rest-framework.org//api-guide/routers/</loc>
<lastmod>2019-03-03</lastmod> <lastmod>2019-03-04</lastmod>
<changefreq>daily</changefreq> <changefreq>daily</changefreq>
</url> </url>
<url> <url>
<loc>https://www.django-rest-framework.org//api-guide/parsers/</loc> <loc>https://www.django-rest-framework.org//api-guide/parsers/</loc>
<lastmod>2019-03-03</lastmod> <lastmod>2019-03-04</lastmod>
<changefreq>daily</changefreq> <changefreq>daily</changefreq>
</url> </url>
<url> <url>
<loc>https://www.django-rest-framework.org//api-guide/renderers/</loc> <loc>https://www.django-rest-framework.org//api-guide/renderers/</loc>
<lastmod>2019-03-03</lastmod> <lastmod>2019-03-04</lastmod>
<changefreq>daily</changefreq> <changefreq>daily</changefreq>
</url> </url>
<url> <url>
<loc>https://www.django-rest-framework.org//api-guide/serializers/</loc> <loc>https://www.django-rest-framework.org//api-guide/serializers/</loc>
<lastmod>2019-03-03</lastmod> <lastmod>2019-03-04</lastmod>
<changefreq>daily</changefreq> <changefreq>daily</changefreq>
</url> </url>
<url> <url>
<loc>https://www.django-rest-framework.org//api-guide/fields/</loc> <loc>https://www.django-rest-framework.org//api-guide/fields/</loc>
<lastmod>2019-03-03</lastmod> <lastmod>2019-03-04</lastmod>
<changefreq>daily</changefreq> <changefreq>daily</changefreq>
</url> </url>
<url> <url>
<loc>https://www.django-rest-framework.org//api-guide/relations/</loc> <loc>https://www.django-rest-framework.org//api-guide/relations/</loc>
<lastmod>2019-03-03</lastmod> <lastmod>2019-03-04</lastmod>
<changefreq>daily</changefreq> <changefreq>daily</changefreq>
</url> </url>
<url> <url>
<loc>https://www.django-rest-framework.org//api-guide/validators/</loc> <loc>https://www.django-rest-framework.org//api-guide/validators/</loc>
<lastmod>2019-03-03</lastmod> <lastmod>2019-03-04</lastmod>
<changefreq>daily</changefreq> <changefreq>daily</changefreq>
</url> </url>
<url> <url>
<loc>https://www.django-rest-framework.org//api-guide/authentication/</loc> <loc>https://www.django-rest-framework.org//api-guide/authentication/</loc>
<lastmod>2019-03-03</lastmod> <lastmod>2019-03-04</lastmod>
<changefreq>daily</changefreq> <changefreq>daily</changefreq>
</url> </url>
<url> <url>
<loc>https://www.django-rest-framework.org//api-guide/permissions/</loc> <loc>https://www.django-rest-framework.org//api-guide/permissions/</loc>
<lastmod>2019-03-03</lastmod> <lastmod>2019-03-04</lastmod>
<changefreq>daily</changefreq> <changefreq>daily</changefreq>
</url> </url>
<url> <url>
<loc>https://www.django-rest-framework.org//api-guide/caching/</loc> <loc>https://www.django-rest-framework.org//api-guide/caching/</loc>
<lastmod>2019-03-03</lastmod> <lastmod>2019-03-04</lastmod>
<changefreq>daily</changefreq> <changefreq>daily</changefreq>
</url> </url>
<url> <url>
<loc>https://www.django-rest-framework.org//api-guide/throttling/</loc> <loc>https://www.django-rest-framework.org//api-guide/throttling/</loc>
<lastmod>2019-03-03</lastmod> <lastmod>2019-03-04</lastmod>
<changefreq>daily</changefreq> <changefreq>daily</changefreq>
</url> </url>
<url> <url>
<loc>https://www.django-rest-framework.org//api-guide/filtering/</loc> <loc>https://www.django-rest-framework.org//api-guide/filtering/</loc>
<lastmod>2019-03-03</lastmod> <lastmod>2019-03-04</lastmod>
<changefreq>daily</changefreq> <changefreq>daily</changefreq>
</url> </url>
<url> <url>
<loc>https://www.django-rest-framework.org//api-guide/pagination/</loc> <loc>https://www.django-rest-framework.org//api-guide/pagination/</loc>
<lastmod>2019-03-03</lastmod> <lastmod>2019-03-04</lastmod>
<changefreq>daily</changefreq> <changefreq>daily</changefreq>
</url> </url>
<url> <url>
<loc>https://www.django-rest-framework.org//api-guide/versioning/</loc> <loc>https://www.django-rest-framework.org//api-guide/versioning/</loc>
<lastmod>2019-03-03</lastmod> <lastmod>2019-03-04</lastmod>
<changefreq>daily</changefreq> <changefreq>daily</changefreq>
</url> </url>
<url> <url>
<loc>https://www.django-rest-framework.org//api-guide/content-negotiation/</loc> <loc>https://www.django-rest-framework.org//api-guide/content-negotiation/</loc>
<lastmod>2019-03-03</lastmod> <lastmod>2019-03-04</lastmod>
<changefreq>daily</changefreq> <changefreq>daily</changefreq>
</url> </url>
<url> <url>
<loc>https://www.django-rest-framework.org//api-guide/metadata/</loc> <loc>https://www.django-rest-framework.org//api-guide/metadata/</loc>
<lastmod>2019-03-03</lastmod> <lastmod>2019-03-04</lastmod>
<changefreq>daily</changefreq> <changefreq>daily</changefreq>
</url> </url>
<url> <url>
<loc>https://www.django-rest-framework.org//api-guide/schemas/</loc> <loc>https://www.django-rest-framework.org//api-guide/schemas/</loc>
<lastmod>2019-03-03</lastmod> <lastmod>2019-03-04</lastmod>
<changefreq>daily</changefreq> <changefreq>daily</changefreq>
</url> </url>
<url> <url>
<loc>https://www.django-rest-framework.org//api-guide/format-suffixes/</loc> <loc>https://www.django-rest-framework.org//api-guide/format-suffixes/</loc>
<lastmod>2019-03-03</lastmod> <lastmod>2019-03-04</lastmod>
<changefreq>daily</changefreq> <changefreq>daily</changefreq>
</url> </url>
<url> <url>
<loc>https://www.django-rest-framework.org//api-guide/reverse/</loc> <loc>https://www.django-rest-framework.org//api-guide/reverse/</loc>
<lastmod>2019-03-03</lastmod> <lastmod>2019-03-04</lastmod>
<changefreq>daily</changefreq> <changefreq>daily</changefreq>
</url> </url>
<url> <url>
<loc>https://www.django-rest-framework.org//api-guide/exceptions/</loc> <loc>https://www.django-rest-framework.org//api-guide/exceptions/</loc>
<lastmod>2019-03-03</lastmod> <lastmod>2019-03-04</lastmod>
<changefreq>daily</changefreq> <changefreq>daily</changefreq>
</url> </url>
<url> <url>
<loc>https://www.django-rest-framework.org//api-guide/status-codes/</loc> <loc>https://www.django-rest-framework.org//api-guide/status-codes/</loc>
<lastmod>2019-03-03</lastmod> <lastmod>2019-03-04</lastmod>
<changefreq>daily</changefreq> <changefreq>daily</changefreq>
</url> </url>
<url> <url>
<loc>https://www.django-rest-framework.org//api-guide/testing/</loc> <loc>https://www.django-rest-framework.org//api-guide/testing/</loc>
<lastmod>2019-03-03</lastmod> <lastmod>2019-03-04</lastmod>
<changefreq>daily</changefreq> <changefreq>daily</changefreq>
</url> </url>
<url> <url>
<loc>https://www.django-rest-framework.org//api-guide/settings/</loc> <loc>https://www.django-rest-framework.org//api-guide/settings/</loc>
<lastmod>2019-03-03</lastmod> <lastmod>2019-03-04</lastmod>
<changefreq>daily</changefreq> <changefreq>daily</changefreq>
</url> </url>
@ -237,49 +237,49 @@
<url> <url>
<loc>https://www.django-rest-framework.org//topics/documenting-your-api/</loc> <loc>https://www.django-rest-framework.org//topics/documenting-your-api/</loc>
<lastmod>2019-03-03</lastmod> <lastmod>2019-03-04</lastmod>
<changefreq>daily</changefreq> <changefreq>daily</changefreq>
</url> </url>
<url> <url>
<loc>https://www.django-rest-framework.org//topics/api-clients/</loc> <loc>https://www.django-rest-framework.org//topics/api-clients/</loc>
<lastmod>2019-03-03</lastmod> <lastmod>2019-03-04</lastmod>
<changefreq>daily</changefreq> <changefreq>daily</changefreq>
</url> </url>
<url> <url>
<loc>https://www.django-rest-framework.org//topics/internationalization/</loc> <loc>https://www.django-rest-framework.org//topics/internationalization/</loc>
<lastmod>2019-03-03</lastmod> <lastmod>2019-03-04</lastmod>
<changefreq>daily</changefreq> <changefreq>daily</changefreq>
</url> </url>
<url> <url>
<loc>https://www.django-rest-framework.org//topics/ajax-csrf-cors/</loc> <loc>https://www.django-rest-framework.org//topics/ajax-csrf-cors/</loc>
<lastmod>2019-03-03</lastmod> <lastmod>2019-03-04</lastmod>
<changefreq>daily</changefreq> <changefreq>daily</changefreq>
</url> </url>
<url> <url>
<loc>https://www.django-rest-framework.org//topics/html-and-forms/</loc> <loc>https://www.django-rest-framework.org//topics/html-and-forms/</loc>
<lastmod>2019-03-03</lastmod> <lastmod>2019-03-04</lastmod>
<changefreq>daily</changefreq> <changefreq>daily</changefreq>
</url> </url>
<url> <url>
<loc>https://www.django-rest-framework.org//topics/browser-enhancements/</loc> <loc>https://www.django-rest-framework.org//topics/browser-enhancements/</loc>
<lastmod>2019-03-03</lastmod> <lastmod>2019-03-04</lastmod>
<changefreq>daily</changefreq> <changefreq>daily</changefreq>
</url> </url>
<url> <url>
<loc>https://www.django-rest-framework.org//topics/browsable-api/</loc> <loc>https://www.django-rest-framework.org//topics/browsable-api/</loc>
<lastmod>2019-03-03</lastmod> <lastmod>2019-03-04</lastmod>
<changefreq>daily</changefreq> <changefreq>daily</changefreq>
</url> </url>
<url> <url>
<loc>https://www.django-rest-framework.org//topics/rest-hypermedia-hateoas/</loc> <loc>https://www.django-rest-framework.org//topics/rest-hypermedia-hateoas/</loc>
<lastmod>2019-03-03</lastmod> <lastmod>2019-03-04</lastmod>
<changefreq>daily</changefreq> <changefreq>daily</changefreq>
</url> </url>
@ -289,115 +289,115 @@
<url> <url>
<loc>https://www.django-rest-framework.org//community/tutorials-and-resources/</loc> <loc>https://www.django-rest-framework.org//community/tutorials-and-resources/</loc>
<lastmod>2019-03-03</lastmod> <lastmod>2019-03-04</lastmod>
<changefreq>daily</changefreq> <changefreq>daily</changefreq>
</url> </url>
<url> <url>
<loc>https://www.django-rest-framework.org//community/third-party-packages/</loc> <loc>https://www.django-rest-framework.org//community/third-party-packages/</loc>
<lastmod>2019-03-03</lastmod> <lastmod>2019-03-04</lastmod>
<changefreq>daily</changefreq> <changefreq>daily</changefreq>
</url> </url>
<url> <url>
<loc>https://www.django-rest-framework.org//community/contributing/</loc> <loc>https://www.django-rest-framework.org//community/contributing/</loc>
<lastmod>2019-03-03</lastmod> <lastmod>2019-03-04</lastmod>
<changefreq>daily</changefreq> <changefreq>daily</changefreq>
</url> </url>
<url> <url>
<loc>https://www.django-rest-framework.org//community/project-management/</loc> <loc>https://www.django-rest-framework.org//community/project-management/</loc>
<lastmod>2019-03-03</lastmod> <lastmod>2019-03-04</lastmod>
<changefreq>daily</changefreq> <changefreq>daily</changefreq>
</url> </url>
<url> <url>
<loc>https://www.django-rest-framework.org//community/release-notes/</loc> <loc>https://www.django-rest-framework.org//community/release-notes/</loc>
<lastmod>2019-03-03</lastmod> <lastmod>2019-03-04</lastmod>
<changefreq>daily</changefreq> <changefreq>daily</changefreq>
</url> </url>
<url> <url>
<loc>https://www.django-rest-framework.org//community/3.9-announcement/</loc> <loc>https://www.django-rest-framework.org//community/3.9-announcement/</loc>
<lastmod>2019-03-03</lastmod> <lastmod>2019-03-04</lastmod>
<changefreq>daily</changefreq> <changefreq>daily</changefreq>
</url> </url>
<url> <url>
<loc>https://www.django-rest-framework.org//community/3.8-announcement/</loc> <loc>https://www.django-rest-framework.org//community/3.8-announcement/</loc>
<lastmod>2019-03-03</lastmod> <lastmod>2019-03-04</lastmod>
<changefreq>daily</changefreq> <changefreq>daily</changefreq>
</url> </url>
<url> <url>
<loc>https://www.django-rest-framework.org//community/3.7-announcement/</loc> <loc>https://www.django-rest-framework.org//community/3.7-announcement/</loc>
<lastmod>2019-03-03</lastmod> <lastmod>2019-03-04</lastmod>
<changefreq>daily</changefreq> <changefreq>daily</changefreq>
</url> </url>
<url> <url>
<loc>https://www.django-rest-framework.org//community/3.6-announcement/</loc> <loc>https://www.django-rest-framework.org//community/3.6-announcement/</loc>
<lastmod>2019-03-03</lastmod> <lastmod>2019-03-04</lastmod>
<changefreq>daily</changefreq> <changefreq>daily</changefreq>
</url> </url>
<url> <url>
<loc>https://www.django-rest-framework.org//community/3.5-announcement/</loc> <loc>https://www.django-rest-framework.org//community/3.5-announcement/</loc>
<lastmod>2019-03-03</lastmod> <lastmod>2019-03-04</lastmod>
<changefreq>daily</changefreq> <changefreq>daily</changefreq>
</url> </url>
<url> <url>
<loc>https://www.django-rest-framework.org//community/3.4-announcement/</loc> <loc>https://www.django-rest-framework.org//community/3.4-announcement/</loc>
<lastmod>2019-03-03</lastmod> <lastmod>2019-03-04</lastmod>
<changefreq>daily</changefreq> <changefreq>daily</changefreq>
</url> </url>
<url> <url>
<loc>https://www.django-rest-framework.org//community/3.3-announcement/</loc> <loc>https://www.django-rest-framework.org//community/3.3-announcement/</loc>
<lastmod>2019-03-03</lastmod> <lastmod>2019-03-04</lastmod>
<changefreq>daily</changefreq> <changefreq>daily</changefreq>
</url> </url>
<url> <url>
<loc>https://www.django-rest-framework.org//community/3.2-announcement/</loc> <loc>https://www.django-rest-framework.org//community/3.2-announcement/</loc>
<lastmod>2019-03-03</lastmod> <lastmod>2019-03-04</lastmod>
<changefreq>daily</changefreq> <changefreq>daily</changefreq>
</url> </url>
<url> <url>
<loc>https://www.django-rest-framework.org//community/3.1-announcement/</loc> <loc>https://www.django-rest-framework.org//community/3.1-announcement/</loc>
<lastmod>2019-03-03</lastmod> <lastmod>2019-03-04</lastmod>
<changefreq>daily</changefreq> <changefreq>daily</changefreq>
</url> </url>
<url> <url>
<loc>https://www.django-rest-framework.org//community/3.0-announcement/</loc> <loc>https://www.django-rest-framework.org//community/3.0-announcement/</loc>
<lastmod>2019-03-03</lastmod> <lastmod>2019-03-04</lastmod>
<changefreq>daily</changefreq> <changefreq>daily</changefreq>
</url> </url>
<url> <url>
<loc>https://www.django-rest-framework.org//community/kickstarter-announcement/</loc> <loc>https://www.django-rest-framework.org//community/kickstarter-announcement/</loc>
<lastmod>2019-03-03</lastmod> <lastmod>2019-03-04</lastmod>
<changefreq>daily</changefreq> <changefreq>daily</changefreq>
</url> </url>
<url> <url>
<loc>https://www.django-rest-framework.org//community/mozilla-grant/</loc> <loc>https://www.django-rest-framework.org//community/mozilla-grant/</loc>
<lastmod>2019-03-03</lastmod> <lastmod>2019-03-04</lastmod>
<changefreq>daily</changefreq> <changefreq>daily</changefreq>
</url> </url>
<url> <url>
<loc>https://www.django-rest-framework.org//community/funding/</loc> <loc>https://www.django-rest-framework.org//community/funding/</loc>
<lastmod>2019-03-03</lastmod> <lastmod>2019-03-04</lastmod>
<changefreq>daily</changefreq> <changefreq>daily</changefreq>
</url> </url>
<url> <url>
<loc>https://www.django-rest-framework.org//community/jobs/</loc> <loc>https://www.django-rest-framework.org//community/jobs/</loc>
<lastmod>2019-03-03</lastmod> <lastmod>2019-03-04</lastmod>
<changefreq>daily</changefreq> <changefreq>daily</changefreq>
</url> </url>