encode/django-rest-framework
1
1
Fork 0
mirror of https://github.com/encode/django-rest-framework.git synced 2025-01-30 19:24:40 +03:00
Code Issues Packages Projects Releases Wiki Activity

Update documentation

Browse Source
This commit is contained in:
Tom Christie 2015-08-13 09:25:15 +00:00
parent fe13e40347
commit 4d5a47decd
4 changed files with 66 additions and 54 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

8
mkdocs/search_index.json
View File

File diff suppressed because one or more lines are too long

96
sitemap.xml
View File

@ -4,7 +4,7 @@
<url>
<loc>http://www.django-rest-framework.org//</loc>
<lastmod>2015-08-11</lastmod>
<lastmod>2015-08-13</lastmod>
<changefreq>daily</changefreq>
</url>
@ -13,43 +13,43 @@
<url>
<loc>http://www.django-rest-framework.org//tutorial/quickstart/</loc>
<lastmod>2015-08-11</lastmod>
<lastmod>2015-08-13</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>http://www.django-rest-framework.org//tutorial/1-serialization/</loc>
<lastmod>2015-08-11</lastmod>
<lastmod>2015-08-13</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>http://www.django-rest-framework.org//tutorial/2-requests-and-responses/</loc>
<lastmod>2015-08-11</lastmod>
<lastmod>2015-08-13</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>http://www.django-rest-framework.org//tutorial/3-class-based-views/</loc>
<lastmod>2015-08-11</lastmod>
<lastmod>2015-08-13</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>http://www.django-rest-framework.org//tutorial/4-authentication-and-permissions/</loc>
<lastmod>2015-08-11</lastmod>
<lastmod>2015-08-13</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>http://www.django-rest-framework.org//tutorial/5-relationships-and-hyperlinked-apis/</loc>
<lastmod>2015-08-11</lastmod>
<lastmod>2015-08-13</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>http://www.django-rest-framework.org//tutorial/6-viewsets-and-routers/</loc>
<lastmod>2015-08-11</lastmod>
<lastmod>2015-08-13</lastmod>
<changefreq>daily</changefreq>
</url>
@ -59,157 +59,157 @@
<url>
<loc>http://www.django-rest-framework.org//api-guide/requests/</loc>
<lastmod>2015-08-11</lastmod>
<lastmod>2015-08-13</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>http://www.django-rest-framework.org//api-guide/responses/</loc>
<lastmod>2015-08-11</lastmod>
<lastmod>2015-08-13</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>http://www.django-rest-framework.org//api-guide/views/</loc>
<lastmod>2015-08-11</lastmod>
<lastmod>2015-08-13</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>http://www.django-rest-framework.org//api-guide/generic-views/</loc>
<lastmod>2015-08-11</lastmod>
<lastmod>2015-08-13</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>http://www.django-rest-framework.org//api-guide/viewsets/</loc>
<lastmod>2015-08-11</lastmod>
<lastmod>2015-08-13</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>http://www.django-rest-framework.org//api-guide/routers/</loc>
<lastmod>2015-08-11</lastmod>
<lastmod>2015-08-13</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>http://www.django-rest-framework.org//api-guide/parsers/</loc>
<lastmod>2015-08-11</lastmod>
<lastmod>2015-08-13</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>http://www.django-rest-framework.org//api-guide/renderers/</loc>
<lastmod>2015-08-11</lastmod>
<lastmod>2015-08-13</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>http://www.django-rest-framework.org//api-guide/serializers/</loc>
<lastmod>2015-08-11</lastmod>
<lastmod>2015-08-13</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>http://www.django-rest-framework.org//api-guide/fields/</loc>
<lastmod>2015-08-11</lastmod>
<lastmod>2015-08-13</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>http://www.django-rest-framework.org//api-guide/relations/</loc>
<lastmod>2015-08-11</lastmod>
<lastmod>2015-08-13</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>http://www.django-rest-framework.org//api-guide/validators/</loc>
<lastmod>2015-08-11</lastmod>
<lastmod>2015-08-13</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>http://www.django-rest-framework.org//api-guide/authentication/</loc>
<lastmod>2015-08-11</lastmod>
<lastmod>2015-08-13</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>http://www.django-rest-framework.org//api-guide/permissions/</loc>
<lastmod>2015-08-11</lastmod>
<lastmod>2015-08-13</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>http://www.django-rest-framework.org//api-guide/throttling/</loc>
<lastmod>2015-08-11</lastmod>
<lastmod>2015-08-13</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>http://www.django-rest-framework.org//api-guide/filtering/</loc>
<lastmod>2015-08-11</lastmod>
<lastmod>2015-08-13</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>http://www.django-rest-framework.org//api-guide/pagination/</loc>
<lastmod>2015-08-11</lastmod>
<lastmod>2015-08-13</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>http://www.django-rest-framework.org//api-guide/versioning/</loc>
<lastmod>2015-08-11</lastmod>
<lastmod>2015-08-13</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>http://www.django-rest-framework.org//api-guide/content-negotiation/</loc>
<lastmod>2015-08-11</lastmod>
<lastmod>2015-08-13</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>http://www.django-rest-framework.org//api-guide/metadata/</loc>
<lastmod>2015-08-11</lastmod>
<lastmod>2015-08-13</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>http://www.django-rest-framework.org//api-guide/format-suffixes/</loc>
<lastmod>2015-08-11</lastmod>
<lastmod>2015-08-13</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>http://www.django-rest-framework.org//api-guide/reverse/</loc>
<lastmod>2015-08-11</lastmod>
<lastmod>2015-08-13</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>http://www.django-rest-framework.org//api-guide/exceptions/</loc>
<lastmod>2015-08-11</lastmod>
<lastmod>2015-08-13</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>http://www.django-rest-framework.org//api-guide/status-codes/</loc>
<lastmod>2015-08-11</lastmod>
<lastmod>2015-08-13</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>http://www.django-rest-framework.org//api-guide/testing/</loc>
<lastmod>2015-08-11</lastmod>
<lastmod>2015-08-13</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>http://www.django-rest-framework.org//api-guide/settings/</loc>
<lastmod>2015-08-11</lastmod>
<lastmod>2015-08-13</lastmod>
<changefreq>daily</changefreq>
</url>
@ -219,85 +219,85 @@
<url>
<loc>http://www.django-rest-framework.org//topics/documenting-your-api/</loc>
<lastmod>2015-08-11</lastmod>
<lastmod>2015-08-13</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>http://www.django-rest-framework.org//topics/internationalization/</loc>
<lastmod>2015-08-11</lastmod>
<lastmod>2015-08-13</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>http://www.django-rest-framework.org//topics/ajax-csrf-cors/</loc>
<lastmod>2015-08-11</lastmod>
<lastmod>2015-08-13</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>http://www.django-rest-framework.org//topics/browser-enhancements/</loc>
<lastmod>2015-08-11</lastmod>
<lastmod>2015-08-13</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>http://www.django-rest-framework.org//topics/browsable-api/</loc>
<lastmod>2015-08-11</lastmod>
<lastmod>2015-08-13</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>http://www.django-rest-framework.org//topics/rest-hypermedia-hateoas/</loc>
<lastmod>2015-08-11</lastmod>
<lastmod>2015-08-13</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>http://www.django-rest-framework.org//topics/third-party-resources/</loc>
<lastmod>2015-08-11</lastmod>
<lastmod>2015-08-13</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>http://www.django-rest-framework.org//topics/contributing/</loc>
<lastmod>2015-08-11</lastmod>
<lastmod>2015-08-13</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>http://www.django-rest-framework.org//topics/project-management/</loc>
<lastmod>2015-08-11</lastmod>
<lastmod>2015-08-13</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>http://www.django-rest-framework.org//topics/3.0-announcement/</loc>
<lastmod>2015-08-11</lastmod>
<lastmod>2015-08-13</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>http://www.django-rest-framework.org//topics/3.1-announcement/</loc>
<lastmod>2015-08-11</lastmod>
<lastmod>2015-08-13</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>http://www.django-rest-framework.org//topics/3.2-announcement/</loc>
<lastmod>2015-08-11</lastmod>
<lastmod>2015-08-13</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>http://www.django-rest-framework.org//topics/kickstarter-announcement/</loc>
<lastmod>2015-08-11</lastmod>
<lastmod>2015-08-13</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>http://www.django-rest-framework.org//topics/release-notes/</loc>
<lastmod>2015-08-11</lastmod>
<lastmod>2015-08-13</lastmod>
<changefreq>daily</changefreq>
</url>

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

@ -406,6 +406,16 @@
</code></pre>
<hr />
<h2 id="32x-series">3.2.x series</h2>
<h3 id="322">3.2.2</h3>
<p><strong>Date</strong>: <a href="https://github.com/tomchristie/django-rest-framework/issues?q=milestone%3A%223.2.1+Release%22">13th August 2015</a>.</p>
<ul>
<li>Add <code>display_value()</code> method for use when displaying relational field select inputs. (<a href="https://github.com/tomchristie/django-rest-framework/issues/3254">#3254</a>)</li>
<li>Fix issue with <code>BooleanField</code> checkboxes incorrectly displaying as checked. (<a href="https://github.com/tomchristie/django-rest-framework/issues/3258">#3258</a>)</li>
<li>Ensure empty checkboxes properly set <code>BooleanField</code> to <code>False</code> in all cases. (<a href="https://github.com/tomchristie/django-rest-framework/issues/2776">#2776</a>)</li>
<li>Allow <code>WSGIRequest.FILES</code> property without raising incorrect deprecated error. (<a href="https://github.com/tomchristie/django-rest-framework/issues/3261">#3261</a>)</li>
<li>Resolve issue with rendering nested serializers in forms. (<a href="https://github.com/tomchristie/django-rest-framework/issues/3260">#3260</a>)</li>
<li>Raise an error if user accidentally pass a serializer instance to a response, rather than data. (<a href="https://github.com/tomchristie/django-rest-framework/issues/3241">#3241</a>)</li>
</ul>
<h3 id="321">3.2.1</h3>
<p><strong>Date</strong>: <a href="https://github.com/tomchristie/django-rest-framework/issues?q=milestone%3A%223.2.1+Release%22">7th August 2015</a>.</p>
<ul>
@ -604,6 +614,8 @@
<!-- 3.2.0 -->
<!-- 3.2.1 -->
<!-- 3.2.2 -->
</div> <!--/span-->

4
tutorial/2-requests-and-responses/index.html
View File

@ -511,8 +511,8 @@ HTTP/1.1 200 OK
http http://127.0.0.1:8000/snippets/ Accept:text/html # Request HTML
</code></pre>
<p>Or by appending a format suffix:</p>
<pre><code>http http://127.0.0.1:8000/snippets/.json # JSON suffix
http http://127.0.0.1:8000/snippets/.api # Browsable API suffix
<pre><code>http http://127.0.0.1:8000/snippets.json # JSON suffix
http http://127.0.0.1:8000/snippets.api # Browsable API suffix
</code></pre>
<p>Similarly, we can control the format of the request that we send, using the <code>Content-Type</code> header.</p>
<pre><code># POST using form data