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

Deployed ea60872 with MkDocs version: 0.15.3

Browse Source
This commit is contained in:
Tom Christie 2016-11-07 13:43:49 +00:00
parent bda1cea4e6
commit 086ffa3ec7
7 changed files with 92 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

@ -1026,7 +1026,6 @@ To indicate invalid data, we should raise a <code>serializers.ValidationError</c
def to_internal_value(self, data):
if not isinstance(data, six.text_type):
msg = 'Incorrect type. Expected a string, but got %s'
self.fail('incorrect_type', input_type=type(data).__name__)
if not re.match(r'^rgb\([0-9]+,[0-9]+,[0-9]+\)$', data):

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

@ -669,6 +669,10 @@ that the resulting behavior is more transparent.</p>
if value % 2 != 0:
raise serializers.ValidationError('This field must be an even number.')
</code></pre>
<h4 id="field-level-validation"><a class="toclink" href="#field-level-validation">Field-level validation</a></h4>
<p>You can specify custom field-level validation by adding <code>.validate_&lt;field_name&gt;</code> methods
to your <code>Serializer</code> subclass. This is documented in the
<a href="http://www.django-rest-framework.org/api-guide/serializers/#field-level-validation">Serializer docs</a></p>
<h2 id="class-based"><a class="toclink" href="#class-based">Class-based</a></h2>
<p>To write a class-based validator, use the <code>__call__</code> method. Class-based validators are useful as they allow you to parameterize and reuse behavior.</p>
<pre><code>class MultipleOf(object):

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

4
topics/html-and-forms/index.html
View File

@ -486,7 +486,7 @@ class ProfileDetail(APIView):
<pre><code>class LoginSerializer(serializers.Serializer):
email = serializers.EmailField(
max_length=100,
style={'placeholder': 'Email'}
style={'placeholder': 'Email', 'autofocus': True}
)
password = serializers.CharField(
max_length=100,
@ -576,7 +576,7 @@ class ProfileDetail(APIView):
<tr>
<td>input.html</td>
<td>Any string, numeric or date/time field</td>
<td>input_type, placeholder, hide_label</td>
<td>input_type, placeholder, hide_label, autofocus</td>
</tr>
<tr>
<td>textarea.html</td>

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

@ -454,6 +454,13 @@
</code></pre>
<hr />
<h2 id="35x-series"><a class="toclink" href="#35x-series">3.5.x series</a></h2>
<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>
<li>Don't raise incorrect FilterSet deprecation warnings. (<a href="https://github.com/tomchristie/django-rest-framework/issues/4660">#4660</a>, <a href="https://github.com/tomchristie/django-rest-framework/issues/4643">#4643</a>, <a href="https://github.com/tomchristie/django-rest-framework/issues/4644">#4644</a>)</li>
<li>Schema generation should not raise 404 when a view permission class does. (<a href="https://github.com/tomchristie/django-rest-framework/issues/4645">#4645</a>, <a href="https://github.com/tomchristie/django-rest-framework/issues/4646">#4646</a>)</li>
<li>Add <code>autofocus</code> support for input controls. (<a href="https://github.com/tomchristie/django-rest-framework/issues/4650">#4650</a>)</li>
</ul>
<h3 id="352"><a class="toclink" href="#352">3.5.2</a></h3>
<p><strong>Date</strong>: <a href="https://github.com/tomchristie/django-rest-framework/issues?q=milestone%3A%223.5.2+Release%22">1st November 2016</a></p>
<ul>
@ -1000,6 +1007,8 @@
<!-- 3.5.1 -->
<!-- 3.5.2 -->
<!-- 3.5.3 -->
</div> <!--/span-->

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

@ -590,6 +590,7 @@ You probably want to also tag the version now:
<li><a href="https://github.com/dustinfarris/ember-django-adapter">ember-django-adapter</a> - An adapter for working with Ember.js</li>
<li><a href="https://github.com/WGBH/django-versatileimagefield">django-versatileimagefield</a> - Provides a drop-in replacement for Django's stock <code>ImageField</code> that makes it easy to serve images in multiple sizes/renditions from a single field. For DRF-specific implementation docs, <a href="https://django-versatileimagefield.readthedocs.io/en/latest/drf_integration.html">click here</a>.</li>
<li><a href="https://github.com/aschn/drf-tracking">drf-tracking</a> - Utilities to track requests to DRF API views.</li>
<li><a href="https://github.com/ArabellaTech/drf_tweaks">drf_tweaks</a> - Serializers with one-step validation (and more), pagination without counts and other tweaks.</li>
<li><a href="https://github.com/dealertrack/django-rest-framework-braces">django-rest-framework-braces</a> - Collection of utilities for working with Django Rest Framework. The most notable ones are <a href="https://django-rest-framework-braces.readthedocs.io/en/latest/overview.html#formserializer">FormSerializer</a> and <a href="https://django-rest-framework-braces.readthedocs.io/en/latest/overview.html#serializerform">SerializerForm</a>, which are adapters between DRF serializers and Django forms.</li>
<li><a href="https://drf-haystack.readthedocs.io/en/latest/">drf-haystack</a> - Haystack search for Django Rest Framework</li>
<li><a href="https://github.com/mrhwick/django-rest-framework-version-transforms">django-rest-framework-version-transforms</a> - Enables the use of delta transformations for versioning of DRF resource representations.</li>