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 eb577422 with MkDocs version: 0.15.3

Browse Source
This commit is contained in:
Tom Christie 2017-02-10 11:17:39 +00:00
parent 0ca8f76197
commit 34d2270f9c
10 changed files with 90 additions and 64 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

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

@ -877,9 +877,11 @@ Django's regular <a href="https://docs.djangoproject.com/en/stable/ref/settings/
<h1 id="composite-fields"><a class="toclink" href="#composite-fields">Composite fields</a></h1>
<h2 id="listfield"><a class="toclink" href="#listfield">ListField</a></h2>
<p>A field class that validates a list of objects.</p>
<p><strong>Signature</strong>: <code>ListField(child)</code></p>
<p><strong>Signature</strong>: <code>ListField(child, min_length=None, max_length=None)</code></p>
<ul>
<li><code>child</code> - A field instance that should be used for validating the objects in the list. If this argument is not provided then objects in the list will not be validated.</li>
<li><code>min_length</code> - Validates that the list contains no fewer than this number of elements.</li>
<li><code>max_length</code> - Validates that the list contains no more than this number of elements.</li>
</ul>
<p>For example, to validate a list of integers you might use something like the following:</p>
<pre><code>scores = serializers.ListField(

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

@ -1120,7 +1120,7 @@ in the serializer context.</p>
model = Account
fields = ('account_url', 'account_name', 'users', 'created')
extra_kwargs = {
'url': {'view_name': 'accounts', 'lookup_field': 'account_name'}
'url': {'view_name': 'accounts', 'lookup_field': 'account_name'},
'users': {'lookup_field': 'username'}
}
</code></pre>

BIN
img/premium/machinalis-readme.png
View File

Binary file not shown.
Side by Side Swipe Overlay

Before

Width:  |  Height:  |  Size: 14 KiB

After

Width:  |  Height:  |  Size: 13 KiB

BIN
img/premium/rollbar-readme.png Normal file
View File

Binary file not shown.
Side by Side

After

Width:  |  Height:  |  Size: 12 KiB

BIN
img/premium/rover-readme.png
View File

Binary file not shown.
Side by Side Swipe Overlay

Before

Width:  |  Height:  |  Size: 54 KiB

After

Width:  |  Height:  |  Size: 52 KiB

BIN
img/premium/sentry-readme.png
View File

Binary file not shown.
Side by Side Swipe Overlay

Before

Width:  |  Height:  |  Size: 26 KiB

After

Width:  |  Height:  |  Size: 24 KiB

BIN
img/premium/stream-readme.png
View File

Binary file not shown.
Side by Side Swipe Overlay

Before

Width:  |  Height:  |  Size: 20 KiB

After

Width:  |  Height:  |  Size: 19 KiB

15
mkdocs/search_index.json
View File

File diff suppressed because one or more lines are too long

114
sitemap.xml
View File

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

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

@ -454,6 +454,23 @@
</code></pre>
<hr />
<h2 id="35x-series"><a class="toclink" href="#35x-series">3.5.x series</a></h2>
<h3 id="354"><a class="toclink" href="#354">3.5.4</a></h3>
<p><strong>Date</strong>: <a href="https://github.com/tomchristie/django-rest-framework/issues?q=milestone%3A%223.5.4+Release%22">10th February 2017</a></p>
<ul>
<li>Add max_length and min_length arguments for ListField. (<a href="https://github.com/tomchristie/django-rest-framework/issues/4877">#4877</a>)</li>
<li>Add per-view custom exception handler support. (<a href="https://github.com/tomchristie/django-rest-framework/issues/4753">#4753</a>)</li>
<li>Support disabling of declared fields on serializer subclasses. (<a href="https://github.com/tomchristie/django-rest-framework/issues/4764">#4764</a>)</li>
<li>Support custom view names on <code>@list_route</code> and <code>@detail_route</code> endpoints. (<a href="https://github.com/tomchristie/django-rest-framework/issues/4821">#4821</a>)</li>
<li>Correct labels for fields in login template when custom user model is used. (<a href="https://github.com/tomchristie/django-rest-framework/issues/4841">#4841</a>)</li>
<li>Whitespace fixes for descriptions generated from docstrings. (<a href="https://github.com/tomchristie/django-rest-framework/issues/4759">#4759</a>, <a href="https://github.com/tomchristie/django-rest-framework/issues/4869">#4869</a>, <a href="https://github.com/tomchristie/django-rest-framework/issues/4870">#4870</a>)</li>
<li>Better error reporting when schemas are returned by views without a schema renderer. (<a href="https://github.com/tomchristie/django-rest-framework/issues/4790">#4790</a>)</li>
<li>Fix for returned response of <code>PUT</code> requests when <code>prefetch_related</code> is used. (<a href="https://github.com/tomchristie/django-rest-framework/issues/4661">#4661</a>, <a href="https://github.com/tomchristie/django-rest-framework/issues/4668">#4668</a>)</li>
<li>Fix for breadcrumb view names. (<a href="https://github.com/tomchristie/django-rest-framework/issues/4750">#4750</a>)</li>
<li>Fix for RequestsClient ensuring fully qualified URLs. (<a href="https://github.com/tomchristie/django-rest-framework/issues/4678">#4678</a>)</li>
<li>Fix for incorrect behavior of writable-nested fields check in some cases. (<a href="https://github.com/tomchristie/django-rest-framework/issues/4634">#4634</a>, <a href="https://github.com/tomchristie/django-rest-framework/issues/4669">#4669</a>)</li>
<li>Resolve Django deprecation warnings. (<a href="https://github.com/tomchristie/django-rest-framework/issues/4712">#4712</a>)</li>
<li>Various cleanup of test cases.</li>
</ul>
<h3 id="353"><a class="toclink" href="#353">3.5.3</a></h3>
<p><strong>Date</strong>: <a href="https://github.com/tomchristie/django-rest-framework/issues?q=milestone%3A%223.5.3+Release%22">7th November 2016</a></p>
<ul>
@ -1009,6 +1026,8 @@
<!-- 3.5.2 -->
<!-- 3.5.3 -->
<!-- 3.5.4 -->
</div> <!--/span-->