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

Deployed 3dc40f95 with MkDocs version: 0.16.3

Browse Source
This commit is contained in:
Carlton Gibson 2017-11-06 12:07:26 +01:00
parent e09c7709aa
commit 76a3ee5054
7 changed files with 110 additions and 69 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

1
api-guide/fields/index.html
View File

@ -783,6 +783,7 @@ color_channel = serializers.ChoiceField(
<li><code>max_value</code> Validate that the number provided is no greater than this value.</li>
<li><code>min_value</code> Validate that the number provided is no less than this value.</li>
<li><code>localize</code> Set to <code>True</code> to enable localization of input and output based on the current locale. This will also force <code>coerce_to_string</code> to <code>True</code>. Defaults to <code>False</code>. Note that data formatting is enabled if you have set <code>USE_L10N=True</code> in your settings file.</li>
<li><code>rounding</code> Sets the rounding mode used when quantising to the configured precision. Valid values are <a href="https://docs.python.org/3/library/decimal.html#rounding-modes"><code>decimal</code> module rounding modes</a>. Defaults to <code>None</code>.</li>
</ul>
<h4 id="example-usage"><a class="toclink" href="#example-usage">Example usage</a></h4>
<p>To validate numbers up to 999 with a resolution of 2 decimal places, you would use:</p>

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

@ -635,7 +635,7 @@ class UserListView(generics.ListAPIView):
</code></pre>
<p>For more advanced filtering requirements you can specify a <code>FilterSet</code> class that should be used by the view.
You can read more about <code>FilterSet</code>s in the <a href="https://django-filter.readthedocs.io/en/latest/index.html">django-filter documentation</a>.
It's also recommended that you read the section on <a href="https://django-filter.readthedocs.io/en/develop/guide/rest_framework.html">DRF integration</a>.</p>
It's also recommended that you read the section on <a href="https://django-filter.readthedocs.io/en/latest/guide/rest_framework.html">DRF integration</a>.</p>
<h2 id="searchfilter"><a class="toclink" href="#searchfilter">SearchFilter</a></h2>
<p>The <code>SearchFilter</code> class supports simple single query parameter based searching, and is based on the <a href="https://docs.djangoproject.com/en/stable/ref/contrib/admin/#django.contrib.admin.ModelAdmin.search_fields">Django admin's search functionality</a>.</p>
<p>When in use, the browsable API will include a <code>SearchFilter</code> control:</p>

1
api-guide/parsers/index.html
View File

@ -522,6 +522,7 @@ class ExampleView(APIView):
<p>Or, if you're using the <code>@api_view</code> decorator with function based views.</p>
<pre><code>from rest_framework.decorators import api_view
from rest_framework.decorators import parser_classes
from rest_framework.parsers import JSONParser
@api_view(['POST'])
@parser_classes((JSONParser,))

19
mkdocs/search_index.json
View File

File diff suppressed because one or more lines are too long

122
sitemap.xml
View File

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

33
topics/release-notes/index.html
View File

@ -478,6 +478,37 @@
</code></pre>
<hr />
<h2 id="37x-series"><a class="toclink" href="#37x-series">3.7.x series</a></h2>
<h3 id="372"><a class="toclink" href="#372">3.7.2</a></h3>
<p><strong>Date</strong>: <a href="https://github.com/encode/django-rest-framework/milestone/59?closed=1">6th Novemember 2017</a></p>
<ul>
<li>Fixed Django 2.1 compatibility due to removal of django.contrib.auth.login()/logout() views. <a href="https://github.com/encode/django-rest-framework/issues/5510">#5510</a></li>
<li>Add missing import for TextLexer. <a href="https://github.com/encode/django-rest-framework/issues/5512">#5512</a></li>
<li>Adding examples and documentation for caching <a href="https://github.com/encode/django-rest-framework/issues/5514">#5514</a></li>
<li>Include date and date-time format for schema generation <a href="https://github.com/encode/django-rest-framework/issues/5511">#5511</a></li>
<li>Use triple backticks for markdown code blocks <a href="https://github.com/encode/django-rest-framework/issues/5513">#5513</a></li>
<li>Interactive docs - make bottom sidebar items sticky <a href="https://github.com/encode/django-rest-framework/issues/5516">#5516</a></li>
<li>Clarify pagination system check <a href="https://github.com/encode/django-rest-framework/issues/5524">#5524</a></li>
<li>Stop JSONBoundField mangling invalid JSON <a href="https://github.com/encode/django-rest-framework/issues/5527">#5527</a></li>
<li>Have JSONField render as textarea in Browsable API <a href="https://github.com/encode/django-rest-framework/issues/5530">#5530</a></li>
<li>Schema: Exclude OPTIONS/HEAD for ViewSet actions <a href="https://github.com/encode/django-rest-framework/issues/5532">#5532</a></li>
<li>Fix ordering for dotted sources <a href="https://github.com/encode/django-rest-framework/issues/5533">#5533</a></li>
<li>Fix: Fields with <code>allow_null=True</code> should imply a default serialization value <a href="https://github.com/encode/django-rest-framework/issues/5518">#5518</a></li>
<li>Ensure Location header is strictly a 'str', not subclass. <a href="https://github.com/encode/django-rest-framework/issues/5544">#5544</a></li>
<li>Add import to example in api-guide/parsers <a href="https://github.com/encode/django-rest-framework/issues/5547">#5547</a></li>
<li>Catch OverflowError for "out of range" datetimes <a href="https://github.com/encode/django-rest-framework/issues/5546">#5546</a></li>
<li>Add djangorestframework-rapidjson to third party packages <a href="https://github.com/encode/django-rest-framework/issues/5549">#5549</a></li>
<li>Increase test coverage for <code>drf_create_token</code> command <a href="https://github.com/encode/django-rest-framework/issues/5550">#5550</a></li>
<li>Add trove classifier for Python 3.6 support. <a href="https://github.com/encode/django-rest-framework/issues/5555">#5555</a></li>
<li>Add pip cache support to the Travis CI configuration <a href="https://github.com/encode/django-rest-framework/issues/5556">#5556</a></li>
<li>Rename [<code>wheel</code>] section to [<code>bdist_wheel</code>] as the former is legacy <a href="https://github.com/encode/django-rest-framework/issues/5557">#5557</a></li>
<li>Fix invalid escape sequence deprecation warnings <a href="https://github.com/encode/django-rest-framework/issues/5560">#5560</a></li>
<li>Add interactive docs error template <a href="https://github.com/encode/django-rest-framework/issues/5548">#5548</a></li>
<li>Add rounding parameter to DecimalField <a href="https://github.com/encode/django-rest-framework/issues/5562">#5562</a></li>
<li>Fix all BytesWarning caught during tests <a href="https://github.com/encode/django-rest-framework/issues/5561">#5561</a></li>
<li>Use dict and set literals instead of calls to dict() and set() <a href="https://github.com/encode/django-rest-framework/issues/5559">#5559</a></li>
<li>Change ImageField validation pattern, use validators from DjangoImageField <a href="https://github.com/encode/django-rest-framework/issues/5539">#5539</a></li>
<li>Fix processing unicode symbols in query_string by Python 2 <a href="https://github.com/encode/django-rest-framework/issues/5552">#5552</a></li>
</ul>
<h3 id="371"><a class="toclink" href="#371">3.7.1</a></h3>
<p><strong>Date</strong>: <a href="https://github.com/encode/django-rest-framework/milestone/58?closed=1">16th October 2017</a></p>
<ul>
@ -1206,6 +1237,8 @@
<!-- 3.7.0 -->
<!-- 3.7.1 -->
<!-- 3.7.2 -->
</div> <!--/span-->

1
topics/third-party-packages/index.html
View File

@ -590,6 +590,7 @@ You probably want to also tag the version now:
<li><a href="https://github.com/django-json-api/django-rest-framework-json-api">djangorestframework-jsonapi</a> - Provides a parser, renderer, serializers, and other tools to help build an API that is compliant with the jsonapi.org spec.</li>
<li><a href="https://github.com/gizmag/drf-ujson-renderer">drf_ujson</a> - Implements JSON rendering using the UJSON package.</li>
<li><a href="https://github.com/wq/django-rest-pandas">rest-pandas</a> - Pandas DataFrame-powered renderers including Excel, CSV, and SVG formats.</li>
<li><a href="https://github.com/allisson/django-rest-framework-rapidjson">djangorestframework-rapidjson</a> - Provides rapidjson support with parser and renderer.</li>
</ul>
<h3 id="filtering"><a class="toclink" href="#filtering">Filtering</a></h3>
<ul>