Skip to content

Commit

Permalink
Deployed 2d8e9ad with MkDocs version: 1.2.4
Browse files Browse the repository at this point in the history
  • Loading branch information
@tomchristie
tomchristie committed Mar 16, 2024
1 parent 5796b1a commit a3abf94
Show file tree
Hide file tree
Showing 85 changed files with 1,346 additions and 606 deletions.
4 changes: 4 additions & 0 deletions 404.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -289,6 +289,10 @@
<a href="/community/release-notes/">Release Notes</a>
</li>

<li >
<a href="/community/3.15-announcement/">3.15 Announcement</a>
</li>

<li >
<a href="/community/3.14-announcement/">3.14 Announcement</a>
</li>
Expand Down
4 changes: 4 additions & 0 deletions api-guide/authentication/index.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -289,6 +289,10 @@
<a href="../../community/release-notes/">Release Notes</a>
</li>

<li >
<a href="../../community/3.15-announcement/">3.15 Announcement</a>
</li>

<li >
<a href="../../community/3.14-announcement/">3.14 Announcement</a>
</li>
Expand Down
4 changes: 4 additions & 0 deletions api-guide/caching/index.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -289,6 +289,10 @@
<a href="../../community/release-notes/">Release Notes</a>
</li>

<li >
<a href="../../community/3.15-announcement/">3.15 Announcement</a>
</li>

<li >
<a href="../../community/3.14-announcement/">3.14 Announcement</a>
</li>
Expand Down
4 changes: 4 additions & 0 deletions api-guide/content-negotiation/index.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -289,6 +289,10 @@
<a href="../../community/release-notes/">Release Notes</a>
</li>

<li >
<a href="../../community/3.15-announcement/">3.15 Announcement</a>
</li>

<li >
<a href="../../community/3.14-announcement/">3.14 Announcement</a>
</li>
Expand Down
4 changes: 4 additions & 0 deletions api-guide/exceptions/index.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -289,6 +289,10 @@
<a href="../../community/release-notes/">Release Notes</a>
</li>

<li >
<a href="../../community/3.15-announcement/">3.15 Announcement</a>
</li>

<li >
<a href="../../community/3.14-announcement/">3.14 Announcement</a>
</li>
Expand Down
6 changes: 5 additions & 1 deletion api-guide/fields/index.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -289,6 +289,10 @@
<a href="../../community/release-notes/">Release Notes</a>
</li>

<li >
<a href="../../community/3.15-announcement/">3.15 Announcement</a>
</li>

<li >
<a href="../../community/3.14-announcement/">3.14 Announcement</a>
</li>
Expand Down Expand Up @@ -836,7 +840,7 @@ <h2 id="decimalfield"><a class="toclink" href="#decimalfield">DecimalField</a></
<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 quantizing 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>
<li><code>normalize_output</code> Will normalize the decimal value when serialized. This will strip all trailing zeroes and change the value's precision to the minimum required precision to be able to represent the value without loosing data. Defaults to <code>False</code>.</li>
<li><code>normalize_output</code> Will normalize the decimal value when serialized. This will strip all trailing zeroes and change the value's precision to the minimum required precision to be able to represent the value without losing data. Defaults to <code>False</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>
Expand Down
4 changes: 4 additions & 0 deletions api-guide/filtering/index.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -289,6 +289,10 @@
<a href="../../community/release-notes/">Release Notes</a>
</li>

<li >
<a href="../../community/3.15-announcement/">3.15 Announcement</a>
</li>

<li >
<a href="../../community/3.14-announcement/">3.14 Announcement</a>
</li>
Expand Down
4 changes: 4 additions & 0 deletions api-guide/format-suffixes/index.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -289,6 +289,10 @@
<a href="../../community/release-notes/">Release Notes</a>
</li>

<li >
<a href="../../community/3.15-announcement/">3.15 Announcement</a>
</li>

<li >
<a href="../../community/3.14-announcement/">3.14 Announcement</a>
</li>
Expand Down
4 changes: 4 additions & 0 deletions api-guide/generic-views/index.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -289,6 +289,10 @@
<a href="../../community/release-notes/">Release Notes</a>
</li>

<li >
<a href="../../community/3.15-announcement/">3.15 Announcement</a>
</li>

<li >
<a href="../../community/3.14-announcement/">3.14 Announcement</a>
</li>
Expand Down
4 changes: 4 additions & 0 deletions api-guide/metadata/index.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -289,6 +289,10 @@
<a href="../../community/release-notes/">Release Notes</a>
</li>

<li >
<a href="../../community/3.15-announcement/">3.15 Announcement</a>
</li>

<li >
<a href="../../community/3.14-announcement/">3.14 Announcement</a>
</li>
Expand Down
4 changes: 4 additions & 0 deletions api-guide/pagination/index.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -289,6 +289,10 @@
<a href="../../community/release-notes/">Release Notes</a>
</li>

<li >
<a href="../../community/3.15-announcement/">3.15 Announcement</a>
</li>

<li >
<a href="../../community/3.14-announcement/">3.14 Announcement</a>
</li>
Expand Down
4 changes: 4 additions & 0 deletions api-guide/parsers/index.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -289,6 +289,10 @@
<a href="../../community/release-notes/">Release Notes</a>
</li>

<li >
<a href="../../community/3.15-announcement/">3.15 Announcement</a>
</li>

<li >
<a href="../../community/3.14-announcement/">3.14 Announcement</a>
</li>
Expand Down
4 changes: 4 additions & 0 deletions api-guide/permissions/index.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -289,6 +289,10 @@
<a href="../../community/release-notes/">Release Notes</a>
</li>

<li >
<a href="../../community/3.15-announcement/">3.15 Announcement</a>
</li>

<li >
<a href="../../community/3.14-announcement/">3.14 Announcement</a>
</li>
Expand Down
4 changes: 4 additions & 0 deletions api-guide/relations/index.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -289,6 +289,10 @@
<a href="../../community/release-notes/">Release Notes</a>
</li>

<li >
<a href="../../community/3.15-announcement/">3.15 Announcement</a>
</li>

<li >
<a href="../../community/3.14-announcement/">3.14 Announcement</a>
</li>
Expand Down
4 changes: 4 additions & 0 deletions api-guide/renderers/index.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -289,6 +289,10 @@
<a href="../../community/release-notes/">Release Notes</a>
</li>

<li >
<a href="../../community/3.15-announcement/">3.15 Announcement</a>
</li>

<li >
<a href="../../community/3.14-announcement/">3.14 Announcement</a>
</li>
Expand Down
4 changes: 4 additions & 0 deletions api-guide/requests/index.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -289,6 +289,10 @@
<a href="../../community/release-notes/">Release Notes</a>
</li>

<li >
<a href="../../community/3.15-announcement/">3.15 Announcement</a>
</li>

<li >
<a href="../../community/3.14-announcement/">3.14 Announcement</a>
</li>
Expand Down
4 changes: 4 additions & 0 deletions api-guide/responses/index.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -289,6 +289,10 @@
<a href="../../community/release-notes/">Release Notes</a>
</li>

<li >
<a href="../../community/3.15-announcement/">3.15 Announcement</a>
</li>

<li >
<a href="../../community/3.14-announcement/">3.14 Announcement</a>
</li>
Expand Down
4 changes: 4 additions & 0 deletions api-guide/reverse/index.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -289,6 +289,10 @@
<a href="../../community/release-notes/">Release Notes</a>
</li>

<li >
<a href="../../community/3.15-announcement/">3.15 Announcement</a>
</li>

<li >
<a href="../../community/3.14-announcement/">3.14 Announcement</a>
</li>
Expand Down
4 changes: 4 additions & 0 deletions api-guide/routers/index.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -289,6 +289,10 @@
<a href="../../community/release-notes/">Release Notes</a>
</li>

<li >
<a href="../../community/3.15-announcement/">3.15 Announcement</a>
</li>

<li >
<a href="../../community/3.14-announcement/">3.14 Announcement</a>
</li>
Expand Down
4 changes: 4 additions & 0 deletions api-guide/schemas/index.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -289,6 +289,10 @@
<a href="../../community/release-notes/">Release Notes</a>
</li>

<li >
<a href="../../community/3.15-announcement/">3.15 Announcement</a>
</li>

<li >
<a href="../../community/3.14-announcement/">3.14 Announcement</a>
</li>
Expand Down
4 changes: 4 additions & 0 deletions api-guide/serializers/index.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -289,6 +289,10 @@
<a href="../../community/release-notes/">Release Notes</a>
</li>

<li >
<a href="../../community/3.15-announcement/">3.15 Announcement</a>
</li>

<li >
<a href="../../community/3.14-announcement/">3.14 Announcement</a>
</li>
Expand Down
4 changes: 4 additions & 0 deletions api-guide/settings/index.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -289,6 +289,10 @@
<a href="../../community/release-notes/">Release Notes</a>
</li>

<li >
<a href="../../community/3.15-announcement/">3.15 Announcement</a>
</li>

<li >
<a href="../../community/3.14-announcement/">3.14 Announcement</a>
</li>
Expand Down
4 changes: 4 additions & 0 deletions api-guide/status-codes/index.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -289,6 +289,10 @@
<a href="../../community/release-notes/">Release Notes</a>
</li>

<li >
<a href="../../community/3.15-announcement/">3.15 Announcement</a>
</li>

<li >
<a href="../../community/3.14-announcement/">3.14 Announcement</a>
</li>
Expand Down
4 changes: 4 additions & 0 deletions api-guide/testing/index.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -289,6 +289,10 @@
<a href="../../community/release-notes/">Release Notes</a>
</li>

<li >
<a href="../../community/3.15-announcement/">3.15 Announcement</a>
</li>

<li >
<a href="../../community/3.14-announcement/">3.14 Announcement</a>
</li>
Expand Down
4 changes: 4 additions & 0 deletions api-guide/throttling/index.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -289,6 +289,10 @@
<a href="../../community/release-notes/">Release Notes</a>
</li>

<li >
<a href="../../community/3.15-announcement/">3.15 Announcement</a>
</li>

<li >
<a href="../../community/3.14-announcement/">3.14 Announcement</a>
</li>
Expand Down
13 changes: 7 additions & 6 deletions api-guide/validators/index.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -289,6 +289,10 @@
<a href="../../community/release-notes/">Release Notes</a>
</li>

<li >
<a href="../../community/3.15-announcement/">3.15 Announcement</a>
</li>

<li >
<a href="../../community/3.14-announcement/">3.14 Announcement</a>
</li>
Expand Down Expand Up @@ -634,12 +638,9 @@ <h4 id="using-with-a-hidden-date-field"><a class="toclink" href="#using-with-a-h
<p><strong>Note:</strong> <code>HiddenField()</code> does not appear in <code>partial=True</code> serializer (when making <code>PATCH</code> request). This behavior might change in future, follow updates on <a href="https://github.com/encode/django-rest-framework/discussions/8259">github discussion</a>. </p>
<hr />
<h1 id="advanced-field-defaults"><a class="toclink" href="#advanced-field-defaults">Advanced field defaults</a></h1>
<p>Validators that are applied across multiple fields in the serializer can sometimes require a field input that should not be provided by the API client, but that <em>is</em> available as input to the validator.</p>
<p>Two patterns that you may want to use for this sort of validation include:</p>
<ul>
<li>Using <code>HiddenField</code>. This field will be present in <code>validated_data</code> but <em>will not</em> be used in the serializer output representation.</li>
<li>Using a standard field with <code>read_only=True</code>, but that also includes a <code>default=…</code> argument. This field <em>will</em> be used in the serializer output representation, but cannot be set directly by the user.</li>
</ul>
<p>Validators that are applied across multiple fields in the serializer can sometimes require a field input that should not be provided by the API client, but that <em>is</em> available as input to the validator.
For this purposes use <code>HiddenField</code>. This field will be present in <code>validated_data</code> but <em>will not</em> be used in the serializer output representation.</p>
<p><strong>Note:</strong> Using a <code>read_only=True</code> field is excluded from writable fields so it won't use a <code>default=…</code> argument. Look <a href="https://www.django-rest-framework.org/community/3.8-announcement/#altered-the-behaviour-of-read_only-plus-default-on-field">3.8 announcement</a>.</p>
<p>REST framework includes a couple of defaults that may be useful in this context.</p>
<h4 id="currentuserdefault"><a class="toclink" href="#currentuserdefault">CurrentUserDefault</a></h4>
<p>A default class that can be used to represent the current user. In order to use this, the 'request' must have been provided as part of the context dictionary when instantiating the serializer.</p>
Expand Down
4 changes: 4 additions & 0 deletions api-guide/versioning/index.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -289,6 +289,10 @@
<a href="../../community/release-notes/">Release Notes</a>
</li>

<li >
<a href="../../community/3.15-announcement/">3.15 Announcement</a>
</li>

<li >
<a href="../../community/3.14-announcement/">3.14 Announcement</a>
</li>
Expand Down
4 changes: 4 additions & 0 deletions api-guide/views/index.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -289,6 +289,10 @@
<a href="../../community/release-notes/">Release Notes</a>
</li>

<li >
<a href="../../community/3.15-announcement/">3.15 Announcement</a>
</li>

<li >
<a href="../../community/3.14-announcement/">3.14 Announcement</a>
</li>
Expand Down
6 changes: 5 additions & 1 deletion api-guide/viewsets/index.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -289,6 +289,10 @@
<a href="../../community/release-notes/">Release Notes</a>
</li>

<li >
<a href="../../community/3.15-announcement/">3.15 Announcement</a>
</li>

<li >
<a href="../../community/3.14-announcement/">3.14 Announcement</a>
</li>
Expand Down Expand Up @@ -729,7 +733,7 @@ <h1 id="custom-viewset-base-classes"><a class="toclink" href="#custom-viewset-ba
<p>You may need to provide custom <code>ViewSet</code> classes that do not have the full set of <code>ModelViewSet</code> actions, or that customize the behavior in some other way.</p>
<h2 id="example_3"><a class="toclink" href="#example_3">Example</a></h2>
<p>To create a base viewset class that provides <code>create</code>, <code>list</code> and <code>retrieve</code> operations, inherit from <code>GenericViewSet</code>, and mixin the required actions:</p>
<pre><code>from rest_framework import mixins
<pre><code>from rest_framework import mixins, viewsets

class CreateListRetrieveViewSet(mixins.CreateModelMixin,
mixins.ListModelMixin,
Expand Down
4 changes: 4 additions & 0 deletions community/3.0-announcement/index.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -289,6 +289,10 @@
<a href="../release-notes/">Release Notes</a>
</li>

<li >
<a href="../3.15-announcement/">3.15 Announcement</a>
</li>

<li >
<a href="../3.14-announcement/">3.14 Announcement</a>
</li>
Expand Down
4 changes: 4 additions & 0 deletions community/3.1-announcement/index.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -289,6 +289,10 @@
<a href="../release-notes/">Release Notes</a>
</li>

<li >
<a href="../3.15-announcement/">3.15 Announcement</a>
</li>

<li >
<a href="../3.14-announcement/">3.14 Announcement</a>
</li>
Expand Down
4 changes: 4 additions & 0 deletions community/3.10-announcement/index.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -289,6 +289,10 @@
<a href="../release-notes/">Release Notes</a>
</li>

<li >
<a href="../3.15-announcement/">3.15 Announcement</a>
</li>

<li >
<a href="../3.14-announcement/">3.14 Announcement</a>
</li>
Expand Down
Loading

0 comments on commit a3abf94

Please sign in to comment.