aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorTom Christie2014-12-18 15:42:42 +0000
committerTom Christie2014-12-18 15:42:42 +0000
commitc1e4ec0c64933da5411e4cc3e63894d5f82cc337 (patch)
tree16c79f4fa235f00e7c8354d717f839e59c25e969
parentc678a1f118ea65fc1d13c40ef1a083577fdd5381 (diff)
downloaddjango-rest-framework-c1e4ec0c64933da5411e4cc3e63894d5f82cc337.tar.bz2
Update documentation
-rw-r--r--api-guide/authentication/index.html4
-rw-r--r--api-guide/content-negotiation/index.html6
-rw-r--r--api-guide/exceptions/index.html4
-rw-r--r--api-guide/fields/index.html4
-rw-r--r--api-guide/filtering/index.html4
-rw-r--r--api-guide/format-suffixes/index.html6
-rw-r--r--api-guide/generic-views/index.html4
-rw-r--r--api-guide/metadata/index.html531
-rw-r--r--api-guide/pagination/index.html4
-rw-r--r--api-guide/parsers/index.html4
-rw-r--r--api-guide/permissions/index.html4
-rw-r--r--api-guide/relations/index.html4
-rw-r--r--api-guide/renderers/index.html4
-rw-r--r--api-guide/requests/index.html4
-rw-r--r--api-guide/responses/index.html4
-rw-r--r--api-guide/reverse/index.html4
-rw-r--r--api-guide/routers/index.html4
-rw-r--r--api-guide/serializers/index.html4
-rw-r--r--api-guide/settings/index.html4
-rw-r--r--api-guide/status-codes/index.html4
-rw-r--r--api-guide/testing/index.html4
-rw-r--r--api-guide/throttling/index.html4
-rw-r--r--api-guide/validators/index.html4
-rw-r--r--api-guide/views/index.html4
-rw-r--r--api-guide/viewsets/index.html4
-rw-r--r--index.html5
-rw-r--r--topics/2.2-announcement/index.html4
-rw-r--r--topics/2.3-announcement/index.html4
-rw-r--r--topics/2.4-announcement/index.html4
-rw-r--r--topics/3.0-announcement/index.html4
-rw-r--r--topics/ajax-csrf-cors/index.html4
-rw-r--r--topics/browsable-api/index.html4
-rw-r--r--topics/browser-enhancements/index.html4
-rw-r--r--topics/contributing/index.html4
-rw-r--r--topics/credits/index.html4
-rw-r--r--topics/documenting-your-api/index.html4
-rw-r--r--topics/kickstarter-announcement/index.html4
-rw-r--r--topics/project-management/index.html4
-rw-r--r--topics/release-notes/index.html4
-rw-r--r--topics/rest-framework-2-announcement/index.html4
-rw-r--r--topics/rest-hypermedia-hateoas/index.html4
-rw-r--r--topics/third-party-resources/index.html4
-rw-r--r--tutorial/1-serialization/index.html4
-rw-r--r--tutorial/2-requests-and-responses/index.html4
-rw-r--r--tutorial/3-class-based-views/index.html4
-rw-r--r--tutorial/4-authentication-and-permissions/index.html4
-rw-r--r--tutorial/5-relationships-and-hyperlinked-apis/index.html4
-rw-r--r--tutorial/6-viewsets-and-routers/index.html4
-rw-r--r--tutorial/quickstart/index.html4
49 files changed, 726 insertions, 2 deletions
diff --git a/api-guide/authentication/index.html b/api-guide/authentication/index.html
index b2b68960..a41c7bb0 100644
--- a/api-guide/authentication/index.html
+++ b/api-guide/authentication/index.html
@@ -193,6 +193,10 @@
</li>
<li >
+ <a href="../metadata">Metadata</a>
+ </li>
+
+ <li >
<a href="../format-suffixes">Format suffixes</a>
</li>
diff --git a/api-guide/content-negotiation/index.html b/api-guide/content-negotiation/index.html
index 9ae7563b..fcc0ff3a 100644
--- a/api-guide/content-negotiation/index.html
+++ b/api-guide/content-negotiation/index.html
@@ -62,7 +62,7 @@
<div class="navbar-inner">
<div class="container-fluid">
<a class="repo-link btn btn-primary btn-small" href="https://github.com/tomchristie/django-rest-framework/tree/master">GitHub</a>
- <a class="repo-link btn btn-inverse btn-small " rel="prev" href="../format-suffixes">
+ <a class="repo-link btn btn-inverse btn-small " rel="prev" href="../metadata">
Next <i class="icon-arrow-right icon-white"></i>
</a>
<a class="repo-link btn btn-inverse btn-small " rel="next" href="../pagination">
@@ -193,6 +193,10 @@
</li>
<li >
+ <a href="../metadata">Metadata</a>
+ </li>
+
+ <li >
<a href="../format-suffixes">Format suffixes</a>
</li>
diff --git a/api-guide/exceptions/index.html b/api-guide/exceptions/index.html
index 6a6551ec..a0734a14 100644
--- a/api-guide/exceptions/index.html
+++ b/api-guide/exceptions/index.html
@@ -193,6 +193,10 @@
</li>
<li >
+ <a href="../metadata">Metadata</a>
+ </li>
+
+ <li >
<a href="../format-suffixes">Format suffixes</a>
</li>
diff --git a/api-guide/fields/index.html b/api-guide/fields/index.html
index 29c302cd..aedc4ea1 100644
--- a/api-guide/fields/index.html
+++ b/api-guide/fields/index.html
@@ -193,6 +193,10 @@
</li>
<li >
+ <a href="../metadata">Metadata</a>
+ </li>
+
+ <li >
<a href="../format-suffixes">Format suffixes</a>
</li>
diff --git a/api-guide/filtering/index.html b/api-guide/filtering/index.html
index 185b44d3..6a55b999 100644
--- a/api-guide/filtering/index.html
+++ b/api-guide/filtering/index.html
@@ -193,6 +193,10 @@
</li>
<li >
+ <a href="../metadata">Metadata</a>
+ </li>
+
+ <li >
<a href="../format-suffixes">Format suffixes</a>
</li>
diff --git a/api-guide/format-suffixes/index.html b/api-guide/format-suffixes/index.html
index facede7b..22181b1b 100644
--- a/api-guide/format-suffixes/index.html
+++ b/api-guide/format-suffixes/index.html
@@ -65,7 +65,7 @@
<a class="repo-link btn btn-inverse btn-small " rel="prev" href="../reverse">
Next <i class="icon-arrow-right icon-white"></i>
</a>
- <a class="repo-link btn btn-inverse btn-small " rel="next" href="../content-negotiation">
+ <a class="repo-link btn btn-inverse btn-small " rel="next" href="../metadata">
<i class="icon-arrow-left icon-white"></i> Previous
</a>
<a class="repo-link btn btn-inverse btn-small" href="#searchModal" data-toggle="modal"><i class="icon-search icon-white"></i> Search</a>
@@ -192,6 +192,10 @@
<a href="../content-negotiation">Content negotiation</a>
</li>
+ <li >
+ <a href="../metadata">Metadata</a>
+ </li>
+
<li class="active" >
<a href=".">Format suffixes</a>
</li>
diff --git a/api-guide/generic-views/index.html b/api-guide/generic-views/index.html
index 62b833d5..18910b4e 100644
--- a/api-guide/generic-views/index.html
+++ b/api-guide/generic-views/index.html
@@ -193,6 +193,10 @@
</li>
<li >
+ <a href="../metadata">Metadata</a>
+ </li>
+
+ <li >
<a href="../format-suffixes">Format suffixes</a>
</li>
diff --git a/api-guide/metadata/index.html b/api-guide/metadata/index.html
new file mode 100644
index 00000000..909bdcf4
--- /dev/null
+++ b/api-guide/metadata/index.html
@@ -0,0 +1,531 @@
+<!DOCTYPE html>
+<html lang="en">
+
+<head>
+ <meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
+ <meta charset="utf-8">
+ <title>Metadata - Django REST framework</title>
+ <link href="../../img/favicon.ico" rel="icon" type="image/x-icon">
+ <link rel="canonical" href="http://www.django-rest-framework.org/api-guide/metadata/" />
+ <meta name="viewport" content="width=device-width, initial-scale=1.0">
+ <meta name="description" content="Django, API, REST, Metadata">
+ <meta name="author" content="Tom Christie">
+
+ <!-- Le styles -->
+ <link href="../../css/prettify.css" rel="stylesheet">
+ <link href="../../css/bootstrap.css" rel="stylesheet">
+ <link href="../../css/bootstrap-responsive.css" rel="stylesheet">
+ <link href="../../css/default.css" rel="stylesheet">
+
+ <!-- Le HTML5 shim, for IE6-8 support of HTML5 elements -->
+ <!--[if lt IE 9]>
+ <script src="http://html5shim.googlecode.com/svn/trunk/html5.js"></script>
+ <![endif]-->
+
+ <script type="text/javascript">
+ var _gaq = _gaq || [];
+ _gaq.push(['_setAccount', 'UA-18852272-2']);
+ _gaq.push(['_trackPageview']);
+
+ (function() {
+ var ga = document.createElement('script');
+ ga.type = 'text/javascript';
+ ga.async = true;
+ ga.src = ('https:' == document.location.protocol ? 'https://ssl' : 'http://www') + '.google-analytics.com/ga.js';
+ var s = document.getElementsByTagName('script')[0];
+ s.parentNode.insertBefore(ga, s);
+ })();
+ </script>
+
+ <style>
+ span.fusion-wrap a {
+ display: block;
+ margin-top: 10px;
+ color: black;
+ }
+ a.fusion-poweredby {
+ display: block;
+ margin-top: 10px;
+ }
+ @media (max-width: 767px) {
+ div.promo {
+ display: none;
+ }
+ }
+ </style>
+</head>
+<body onload="prettyPrint()" class="-page">
+
+ <div class="wrapper">
+
+ <div class="navbar navbar-inverse navbar-fixed-top">
+ <div class="navbar-inner">
+ <div class="container-fluid">
+ <a class="repo-link btn btn-primary btn-small" href="https://github.com/tomchristie/django-rest-framework/tree/master">GitHub</a>
+ <a class="repo-link btn btn-inverse btn-small " rel="prev" href="../format-suffixes">
+ Next <i class="icon-arrow-right icon-white"></i>
+ </a>
+ <a class="repo-link btn btn-inverse btn-small " rel="next" href="../content-negotiation">
+ <i class="icon-arrow-left icon-white"></i> Previous
+ </a>
+ <a class="repo-link btn btn-inverse btn-small" href="#searchModal" data-toggle="modal"><i class="icon-search icon-white"></i> Search</a>
+ <a class="btn btn-navbar" data-toggle="collapse" data-target=".nav-collapse">
+ <span class="icon-bar"></span>
+ <span class="icon-bar"></span>
+ <span class="icon-bar"></span>
+ </a>
+ <a class="brand" href="http://www.django-rest-framework.org">Django REST framework</a>
+ <div class="nav-collapse collapse">
+
+ <!-- Main navigation -->
+ <ul class="nav navbar-nav">
+ <li ><a href="/">Home</a></li>
+
+ <li class="dropdown">
+ <a href="#" class="dropdown-toggle" data-toggle="dropdown">Tutorial <b class="caret"></b></a>
+ <ul class="dropdown-menu">
+
+ <li >
+ <a href="../../tutorial/quickstart">Quickstart</a>
+ </li>
+
+ <li >
+ <a href="../../tutorial/1-serialization">1 - Serialization</a>
+ </li>
+
+ <li >
+ <a href="../../tutorial/2-requests-and-responses">2 - Requests and responses</a>
+ </li>
+
+ <li >
+ <a href="../../tutorial/3-class-based-views">3 - Class based views</a>
+ </li>
+
+ <li >
+ <a href="../../tutorial/4-authentication-and-permissions">4 - Authentication and permissions</a>
+ </li>
+
+ <li >
+ <a href="../../tutorial/5-relationships-and-hyperlinked-apis">5 - Relationships and hyperlinked APIs</a>
+ </li>
+
+ <li >
+ <a href="../../tutorial/6-viewsets-and-routers">6 - Viewsets and routers</a>
+ </li>
+
+ </ul>
+ </li>
+
+ <li class="dropdown active">
+ <a href="#" class="dropdown-toggle" data-toggle="dropdown">API Guide <b class="caret"></b></a>
+ <ul class="dropdown-menu">
+
+ <li >
+ <a href="../requests">Requests</a>
+ </li>
+
+ <li >
+ <a href="../responses">Responses</a>
+ </li>
+
+ <li >
+ <a href="../views">Views</a>
+ </li>
+
+ <li >
+ <a href="../generic-views">Generic views</a>
+ </li>
+
+ <li >
+ <a href="../viewsets">Viewsets</a>
+ </li>
+
+ <li >
+ <a href="../routers">Routers</a>
+ </li>
+
+ <li >
+ <a href="../parsers">Parsers</a>
+ </li>
+
+ <li >
+ <a href="../renderers">Renderers</a>
+ </li>
+
+ <li >
+ <a href="../serializers">Serializers</a>
+ </li>
+
+ <li >
+ <a href="../fields">Serializer fields</a>
+ </li>
+
+ <li >
+ <a href="../relations">Serializer relations</a>
+ </li>
+
+ <li >
+ <a href="../validators">Validators</a>
+ </li>
+
+ <li >
+ <a href="../authentication">Authentication</a>
+ </li>
+
+ <li >
+ <a href="../permissions">Permissions</a>
+ </li>
+
+ <li >
+ <a href="../throttling">Throttling</a>
+ </li>
+
+ <li >
+ <a href="../filtering">Filtering</a>
+ </li>
+
+ <li >
+ <a href="../pagination">Pagination</a>
+ </li>
+
+ <li >
+ <a href="../content-negotiation">Content negotiation</a>
+ </li>
+
+ <li class="active" >
+ <a href=".">Metadata</a>
+ </li>
+
+ <li >
+ <a href="../format-suffixes">Format suffixes</a>
+ </li>
+
+ <li >
+ <a href="../reverse">Returning URLs</a>
+ </li>
+
+ <li >
+ <a href="../exceptions">Exceptions</a>
+ </li>
+
+ <li >
+ <a href="../status-codes">Status codes</a>
+ </li>
+
+ <li >
+ <a href="../testing">Testing</a>
+ </li>
+
+ <li >
+ <a href="../settings">Settings</a>
+ </li>
+
+ </ul>
+ </li>
+
+ <li class="dropdown">
+ <a href="#" class="dropdown-toggle" data-toggle="dropdown">Topics <b class="caret"></b></a>
+ <ul class="dropdown-menu">
+
+ <li >
+ <a href="../../topics/documenting-your-api">Documenting your API</a>
+ </li>
+
+ <li >
+ <a href="../../topics/ajax-csrf-cors">AJAX, CSRF & CORS</a>
+ </li>
+
+ <li >
+ <a href="../../topics/browser-enhancements">Browser enhancements</a>
+ </li>
+
+ <li >
+ <a href="../../topics/browsable-api">The Browsable API</a>
+ </li>
+
+ <li >
+ <a href="../../topics/rest-hypermedia-hateoas">REST, Hypermedia & HATEOAS</a>
+ </li>
+
+ <li >
+ <a href="../../topics/third-party-resources">Third Party Resources</a>
+ </li>
+
+ <li >
+ <a href="../../topics/contributing">Contributing to REST framework</a>
+ </li>
+
+ <li >
+ <a href="../../topics/project-management">Project management</a>
+ </li>
+
+ <li >
+ <a href="../../topics/rest-framework-2-announcement">2.0 Announcement</a>
+ </li>
+
+ <li >
+ <a href="../../topics/2.2-announcement">2.2 Announcement</a>
+ </li>
+
+ <li >
+ <a href="../../topics/2.3-announcement">2.3 Announcement</a>
+ </li>
+
+ <li >
+ <a href="../../topics/2.4-announcement">2.4 Announcement</a>
+ </li>
+
+ <li >
+ <a href="../../topics/3.0-announcement">3.0 Announcement</a>
+ </li>
+
+ <li >
+ <a href="../../topics/kickstarter-announcement">Kickstarter Announcement</a>
+ </li>
+
+ <li >
+ <a href="../../topics/release-notes">Release Notes</a>
+ </li>
+
+ <li >
+ <a href="../../topics/credits">Credits</a>
+ </li>
+
+ </ul>
+ </li>
+
+
+ </ul>
+
+ </div>
+ <!--/.nav-collapse -->
+
+ </div>
+ </div>
+ </div>
+
+ <div class="body-content">
+ <div class="container-fluid">
+
+ <!-- Search Modal -->
+ <div id="searchModal" class="modal hide fade" tabindex="-1" role="dialog" aria-labelledby="myModalLabel" aria-hidden="true">
+ <div class="modal-header">
+ <button type="button" class="close" data-dismiss="modal" aria-hidden="true">&times;</button>
+ <h3 id="myModalLabel">Documentation search</h3>
+ </div>
+
+ <div class="modal-body">
+ <!-- Custom google search -->
+ <script>
+ (function() {
+ var cx = '015016005043623903336:rxraeohqk6w';
+ var gcse = document.createElement('script');
+ gcse.type = 'text/javascript';
+ gcse.async = true;
+ gcse.src = (document.location.protocol == 'https:' ? 'https:' : 'http:') +
+ '//www.google.com/cse/cse.js?cx=' + cx;
+ var s = document.getElementsByTagName('script')[0];
+ s.parentNode.insertBefore(gcse, s);
+ })();
+ </script>
+ <gcse:search></gcse:search>
+ </div>
+
+ <div class="modal-footer">
+ <button class="btn" data-dismiss="modal" aria-hidden="true">Close</button>
+ </div>
+ </div>
+
+ <div class="row-fluid">
+
+ <div class="span3">
+ <!-- TODO
+ <p style="margin-top: -12px">
+ <a class="btn btn-mini btn-primary" style="width: 60px">&laquo; previous</a>
+ <a class="btn btn-mini btn-primary" style="float: right; margin-right: 8px; width: 60px;">next &raquo;</a>
+ </p>
+ -->
+ <div id="table-of-contents">
+ <ul class="nav nav-list side-nav well sidebar-nav-fixed">
+
+
+
+
+
+ <li class="main">
+ <a href="#metadata">Metadata</a>
+ </li>
+
+
+ <li>
+ <a href="#setting-the-metadata-scheme">Setting the metadata scheme</a>
+ </li>
+
+ <li>
+ <a href="#creating-schema-endpoints">Creating schema endpoints</a>
+ </li>
+
+
+
+
+ <li class="main">
+ <a href="#custom-metadata-classes">Custom metadata classes</a>
+ </li>
+
+
+ <li>
+ <a href="#example">Example</a>
+ </li>
+
+
+
+
+
+
+ </ul>
+
+ </div>
+ </div>
+
+ <div id="main-content" class="span9">
+
+
+ <a class="github" href="https://github.com/tomchristie/django-rest-framework/tree/master/rest_framework/metadata.py">
+ <span class="label label-info">metadata.py</span>
+ </a>
+
+
+
+ <hr />
+<p><strong>Note</strong>: This is the documentation for the <strong>version 3.0</strong> of REST framework. Documentation for <a href="http://tomchristie.github.io/rest-framework-2-docs/">version 2.4</a> is also available.</p>
+<hr />
+<h1 id="metadata">Metadata</h1>
+<blockquote>
+<p>[The <code>OPTIONS</code>] method allows a client to determine the options and/or requirements associated with a resource, or the capabilities of a server, without implying a resource action or initiating a resource retrieval.</p>
+<p>&mdash; <a href="http://tools.ietf.org/html/rfc7231#section-4.3.7">RFC7231, Section 4.3.7.</a></p>
+</blockquote>
+<p>REST framework includes a configurable mechanism for determining how your API should respond to <code>OPTIONS</code> requests. This allows you to return API schema or other resource information.</p>
+<p>There are not currently any widely adopted conventions for exactly what style of response should be returned for HTTP <code>OPTIONS</code> requests, so we provide an ad-hoc style that returns some useful information.</p>
+<p>Here's an example response that demonstrates the information that is returned by default.</p>
+<pre><code>HTTP 200 OK
+Allow: GET, POST, HEAD, OPTIONS
+Content-Type: application/json
+
+{
+ "name": "To Do List",
+ "description": "List existing 'To Do' items, or create a new item.",
+ "renders": [
+ "application/json",
+ "text/html"
+ ],
+ "parses": [
+ "application/json",
+ "application/x-www-form-urlencoded",
+ "multipart/form-data"
+ ],
+ "actions": {
+ "POST": {
+ "note": {
+ "type": "string",
+ "required": false,
+ "read_only": false,
+ "label": "title",
+ "max_length": 100
+ }
+ }
+ }
+}
+</code></pre>
+<h2 id="setting-the-metadata-scheme">Setting the metadata scheme</h2>
+<p>You can set the metadata class globally using the <code>'DEFAULT_METADATA_CLASS'</code> settings key:</p>
+<pre><code>REST_FRAMEWORK = {
+ 'DEFAULT_METADATA_CLASS': 'rest_framework.metadata.SimpleMetadata'
+}
+</code></pre>
+<p>Or you can set the metadata class individually for a view:</p>
+<pre><code>class APIRoot(APIView):
+ metadata_class = APIRootMetadata
+
+ def get(self, request, format=None):
+ return Response({
+ ...
+ })
+</code></pre>
+<p>The REST framework package only includes a single metadata class implementation, named <code>SimpleMetadata</code>. If you want to use an alternative style you'll need to implement a custom metadata class.</p>
+<h2 id="creating-schema-endpoints">Creating schema endpoints</h2>
+<p>If you have specific requirements for creating schema endpoints that are accessed with regular <code>GET</code> requests, you might consider re-using the metadata API for doing so.</p>
+<p>For example, the following additional route could be used on a viewset to provide a linkable schema endpoint.</p>
+<pre><code>@list_route(methods=['GET'])
+def schema(self, request):
+ meta = self.metadata_class()
+ data = meta.determine_metadata(request, self)
+ return Response(data)
+</code></pre>
+<p>There are a couple of reasons that you might choose to take this approach, including that <code>OPTIONS</code> responses <a href="https://www.mnot.net/blog/2012/10/29/NO_OPTIONS">are not cacheable</a>.</p>
+<hr />
+<h1 id="custom-metadata-classes">Custom metadata classes</h1>
+<p>If you want to provide a custom metadata class you should override <code>BaseMetadata</code> and implement the <code>determine_metadata(self, request, view)</code> method.</p>
+<p>Useful things that you might want to do could include returning schema information, using a format such as <a href="http://json-schema.org/">JSON schema</a>, or returning debug information to admin users.</p>
+<h2 id="example">Example</h2>
+<p>The following class could be used to limit the information that is returned to <code>OPTIONS</code> requests.</p>
+<pre><code>class MinimalMetadata(BaseMetadata):
+ """
+ Don't include field and other information for `OPTIONS` requests.
+ Just return the name and description.
+ """
+ def determine_metadata(self, request, view):
+ return {
+ 'name': view.get_view_name(),
+ 'description': view.get_view_description()
+ }
+</code></pre>
+
+ </div>
+ <!--/span-->
+ </div>
+ <!--/row-->
+ </div>
+ <!--/.fluid-container-->
+ </div>
+ <!--/.body content-->
+ <div id="push"></div>
+ </div>
+ <!--/.wrapper -->
+
+ <footer class="span12">
+ <p>Documentation built with <a href="http://www.mkdocs.org/">MkDocs</a>.</a>
+ </p>
+ </footer>
+
+ <!-- Le javascript
+ ================================================== -->
+ <!-- Placed at the end of the document so the pages load faster -->
+ <script src="../../js/jquery-1.8.1-min.js"></script>
+ <script src="../../js/prettify-1.0.js"></script>
+ <script src="../../js/bootstrap-2.1.1-min.js"></script>
+ <script src="../../js/theme.js"></script>
+
+ <script>
+ //$('.side-nav').scrollspy()
+ var shiftWindow = function() {
+ scrollBy(0, -50)
+ };
+ if (location.hash) shiftWindow();
+ window.addEventListener("hashchange", shiftWindow);
+
+ $('.dropdown-menu').on('click touchstart', function(event) {
+ event.stopPropagation();
+ });
+
+ // Dynamically force sidenav to no higher than browser window
+ $('.side-nav').css('max-height', window.innerHeight - 130);
+
+ $(function() {
+ $(window).resize(function() {
+ $('.side-nav').css('max-height', window.innerHeight - 130);
+ });
+ });
+ </script>
+</body>
+
+</html> \ No newline at end of file
diff --git a/api-guide/pagination/index.html b/api-guide/pagination/index.html
index 11ef3d27..5e8f2a82 100644
--- a/api-guide/pagination/index.html
+++ b/api-guide/pagination/index.html
@@ -193,6 +193,10 @@
</li>
<li >
+ <a href="../metadata">Metadata</a>
+ </li>
+
+ <li >
<a href="../format-suffixes">Format suffixes</a>
</li>
diff --git a/api-guide/parsers/index.html b/api-guide/parsers/index.html
index 8e362b95..116b63da 100644
--- a/api-guide/parsers/index.html
+++ b/api-guide/parsers/index.html
@@ -193,6 +193,10 @@
</li>
<li >
+ <a href="../metadata">Metadata</a>
+ </li>
+
+ <li >
<a href="../format-suffixes">Format suffixes</a>
</li>
diff --git a/api-guide/permissions/index.html b/api-guide/permissions/index.html
index 45efddf9..7b6f889c 100644
--- a/api-guide/permissions/index.html
+++ b/api-guide/permissions/index.html
@@ -193,6 +193,10 @@
</li>
<li >
+ <a href="../metadata">Metadata</a>
+ </li>
+
+ <li >
<a href="../format-suffixes">Format suffixes</a>
</li>
diff --git a/api-guide/relations/index.html b/api-guide/relations/index.html
index 239eec48..85378cc5 100644
--- a/api-guide/relations/index.html
+++ b/api-guide/relations/index.html
@@ -193,6 +193,10 @@
</li>
<li >
+ <a href="../metadata">Metadata</a>
+ </li>
+
+ <li >
<a href="../format-suffixes">Format suffixes</a>
</li>
diff --git a/api-guide/renderers/index.html b/api-guide/renderers/index.html
index 7c9ae852..58d6a3cc 100644
--- a/api-guide/renderers/index.html
+++ b/api-guide/renderers/index.html
@@ -193,6 +193,10 @@
</li>
<li >
+ <a href="../metadata">Metadata</a>
+ </li>
+
+ <li >
<a href="../format-suffixes">Format suffixes</a>
</li>
diff --git a/api-guide/requests/index.html b/api-guide/requests/index.html
index 88833ed5..4cc5fd3d 100644
--- a/api-guide/requests/index.html
+++ b/api-guide/requests/index.html
@@ -193,6 +193,10 @@
</li>
<li >
+ <a href="../metadata">Metadata</a>
+ </li>
+
+ <li >
<a href="../format-suffixes">Format suffixes</a>
</li>
diff --git a/api-guide/responses/index.html b/api-guide/responses/index.html
index 8ca4cfc0..43b75ade 100644
--- a/api-guide/responses/index.html
+++ b/api-guide/responses/index.html
@@ -193,6 +193,10 @@
</li>
<li >
+ <a href="../metadata">Metadata</a>
+ </li>
+
+ <li >
<a href="../format-suffixes">Format suffixes</a>
</li>
diff --git a/api-guide/reverse/index.html b/api-guide/reverse/index.html
index f15c35d4..b716060d 100644
--- a/api-guide/reverse/index.html
+++ b/api-guide/reverse/index.html
@@ -193,6 +193,10 @@
</li>
<li >
+ <a href="../metadata">Metadata</a>
+ </li>
+
+ <li >
<a href="../format-suffixes">Format suffixes</a>
</li>
diff --git a/api-guide/routers/index.html b/api-guide/routers/index.html
index bc95fe9d..32022b86 100644
--- a/api-guide/routers/index.html
+++ b/api-guide/routers/index.html
@@ -193,6 +193,10 @@
</li>
<li >
+ <a href="../metadata">Metadata</a>
+ </li>
+
+ <li >
<a href="../format-suffixes">Format suffixes</a>
</li>
diff --git a/api-guide/serializers/index.html b/api-guide/serializers/index.html
index 13bc661d..64d6c8b9 100644
--- a/api-guide/serializers/index.html
+++ b/api-guide/serializers/index.html
@@ -193,6 +193,10 @@
</li>
<li >
+ <a href="../metadata">Metadata</a>
+ </li>
+
+ <li >
<a href="../format-suffixes">Format suffixes</a>
</li>
diff --git a/api-guide/settings/index.html b/api-guide/settings/index.html
index 94050822..f3062be6 100644
--- a/api-guide/settings/index.html
+++ b/api-guide/settings/index.html
@@ -193,6 +193,10 @@
</li>
<li >
+ <a href="../metadata">Metadata</a>
+ </li>
+
+ <li >
<a href="../format-suffixes">Format suffixes</a>
</li>
diff --git a/api-guide/status-codes/index.html b/api-guide/status-codes/index.html
index e2138d5e..2e503c0a 100644
--- a/api-guide/status-codes/index.html
+++ b/api-guide/status-codes/index.html
@@ -193,6 +193,10 @@
</li>
<li >
+ <a href="../metadata">Metadata</a>
+ </li>
+
+ <li >
<a href="../format-suffixes">Format suffixes</a>
</li>
diff --git a/api-guide/testing/index.html b/api-guide/testing/index.html
index f3b6d005..650fc53e 100644
--- a/api-guide/testing/index.html
+++ b/api-guide/testing/index.html
@@ -193,6 +193,10 @@
</li>
<li >
+ <a href="../metadata">Metadata</a>
+ </li>
+
+ <li >
<a href="../format-suffixes">Format suffixes</a>
</li>
diff --git a/api-guide/throttling/index.html b/api-guide/throttling/index.html
index 5b8c6df0..7db58e4c 100644
--- a/api-guide/throttling/index.html
+++ b/api-guide/throttling/index.html
@@ -193,6 +193,10 @@
</li>
<li >
+ <a href="../metadata">Metadata</a>
+ </li>
+
+ <li >
<a href="../format-suffixes">Format suffixes</a>
</li>
diff --git a/api-guide/validators/index.html b/api-guide/validators/index.html
index 5ae6f03b..525cea8a 100644
--- a/api-guide/validators/index.html
+++ b/api-guide/validators/index.html
@@ -193,6 +193,10 @@
</li>
<li >
+ <a href="../metadata">Metadata</a>
+ </li>
+
+ <li >
<a href="../format-suffixes">Format suffixes</a>
</li>
diff --git a/api-guide/views/index.html b/api-guide/views/index.html
index 231854d9..f07a4921 100644
--- a/api-guide/views/index.html
+++ b/api-guide/views/index.html
@@ -193,6 +193,10 @@
</li>
<li >
+ <a href="../metadata">Metadata</a>
+ </li>
+
+ <li >
<a href="../format-suffixes">Format suffixes</a>
</li>
diff --git a/api-guide/viewsets/index.html b/api-guide/viewsets/index.html
index a0d4251e..d8cd2526 100644
--- a/api-guide/viewsets/index.html
+++ b/api-guide/viewsets/index.html
@@ -193,6 +193,10 @@
</li>
<li >
+ <a href="../metadata">Metadata</a>
+ </li>
+
+ <li >
<a href="../format-suffixes">Format suffixes</a>
</li>
diff --git a/index.html b/index.html
index 59b81d21..b3c40b31 100644
--- a/index.html
+++ b/index.html
@@ -193,6 +193,10 @@
</li>
<li >
+ <a href="api-guide/metadata/">Metadata</a>
+ </li>
+
+ <li >
<a href="api-guide/format-suffixes/">Format suffixes</a>
</li>
@@ -609,6 +613,7 @@ urlpatterns = [
<li><a href="api-guide/filtering/">Filtering</a></li>
<li><a href="api-guide/pagination/">Pagination</a></li>
<li><a href="api-guide/content-negotiation/">Content negotiation</a></li>
+<li><a href="api-guide/metadata/">Metadata</a></li>
<li><a href="api-guide/format-suffixes/">Format suffixes</a></li>
<li><a href="api-guide/reverse/">Returning URLs</a></li>
<li><a href="api-guide/exceptions/">Exceptions</a></li>
diff --git a/topics/2.2-announcement/index.html b/topics/2.2-announcement/index.html
index d25fb362..2a19330b 100644
--- a/topics/2.2-announcement/index.html
+++ b/topics/2.2-announcement/index.html
@@ -193,6 +193,10 @@
</li>
<li >
+ <a href="../../api-guide/metadata">Metadata</a>
+ </li>
+
+ <li >
<a href="../../api-guide/format-suffixes">Format suffixes</a>
</li>
diff --git a/topics/2.3-announcement/index.html b/topics/2.3-announcement/index.html
index 12dc5ba1..eb6b8728 100644
--- a/topics/2.3-announcement/index.html
+++ b/topics/2.3-announcement/index.html
@@ -193,6 +193,10 @@
</li>
<li >
+ <a href="../../api-guide/metadata">Metadata</a>
+ </li>
+
+ <li >
<a href="../../api-guide/format-suffixes">Format suffixes</a>
</li>
diff --git a/topics/2.4-announcement/index.html b/topics/2.4-announcement/index.html
index fa96619a..2ea710fe 100644
--- a/topics/2.4-announcement/index.html
+++ b/topics/2.4-announcement/index.html
@@ -193,6 +193,10 @@
</li>
<li >
+ <a href="../../api-guide/metadata">Metadata</a>
+ </li>
+
+ <li >
<a href="../../api-guide/format-suffixes">Format suffixes</a>
</li>
diff --git a/topics/3.0-announcement/index.html b/topics/3.0-announcement/index.html
index 83dab0a8..96e68826 100644
--- a/topics/3.0-announcement/index.html
+++ b/topics/3.0-announcement/index.html
@@ -193,6 +193,10 @@
</li>
<li >
+ <a href="../../api-guide/metadata">Metadata</a>
+ </li>
+
+ <li >
<a href="../../api-guide/format-suffixes">Format suffixes</a>
</li>
diff --git a/topics/ajax-csrf-cors/index.html b/topics/ajax-csrf-cors/index.html
index 0e22734f..64fa3d8d 100644
--- a/topics/ajax-csrf-cors/index.html
+++ b/topics/ajax-csrf-cors/index.html
@@ -193,6 +193,10 @@
</li>
<li >
+ <a href="../../api-guide/metadata">Metadata</a>
+ </li>
+
+ <li >
<a href="../../api-guide/format-suffixes">Format suffixes</a>
</li>
diff --git a/topics/browsable-api/index.html b/topics/browsable-api/index.html
index f82c984d..bd4a1992 100644
--- a/topics/browsable-api/index.html
+++ b/topics/browsable-api/index.html
@@ -193,6 +193,10 @@
</li>
<li >
+ <a href="../../api-guide/metadata">Metadata</a>
+ </li>
+
+ <li >
<a href="../../api-guide/format-suffixes">Format suffixes</a>
</li>
diff --git a/topics/browser-enhancements/index.html b/topics/browser-enhancements/index.html
index 30c36d72..1a949705 100644
--- a/topics/browser-enhancements/index.html
+++ b/topics/browser-enhancements/index.html
@@ -193,6 +193,10 @@
</li>
<li >
+ <a href="../../api-guide/metadata">Metadata</a>
+ </li>
+
+ <li >
<a href="../../api-guide/format-suffixes">Format suffixes</a>
</li>
diff --git a/topics/contributing/index.html b/topics/contributing/index.html
index 62d0ff39..0a28159d 100644
--- a/topics/contributing/index.html
+++ b/topics/contributing/index.html
@@ -193,6 +193,10 @@
</li>
<li >
+ <a href="../../api-guide/metadata">Metadata</a>
+ </li>
+
+ <li >
<a href="../../api-guide/format-suffixes">Format suffixes</a>
</li>
diff --git a/topics/credits/index.html b/topics/credits/index.html
index c20448dd..54575998 100644
--- a/topics/credits/index.html
+++ b/topics/credits/index.html
@@ -193,6 +193,10 @@
</li>
<li >
+ <a href="../../api-guide/metadata">Metadata</a>
+ </li>
+
+ <li >
<a href="../../api-guide/format-suffixes">Format suffixes</a>
</li>
diff --git a/topics/documenting-your-api/index.html b/topics/documenting-your-api/index.html
index 25c6210c..c40302fc 100644
--- a/topics/documenting-your-api/index.html
+++ b/topics/documenting-your-api/index.html
@@ -193,6 +193,10 @@
</li>
<li >
+ <a href="../../api-guide/metadata">Metadata</a>
+ </li>
+
+ <li >
<a href="../../api-guide/format-suffixes">Format suffixes</a>
</li>
diff --git a/topics/kickstarter-announcement/index.html b/topics/kickstarter-announcement/index.html
index f8bc71e0..717fdb07 100644
--- a/topics/kickstarter-announcement/index.html
+++ b/topics/kickstarter-announcement/index.html
@@ -193,6 +193,10 @@
</li>
<li >
+ <a href="../../api-guide/metadata">Metadata</a>
+ </li>
+
+ <li >
<a href="../../api-guide/format-suffixes">Format suffixes</a>
</li>
diff --git a/topics/project-management/index.html b/topics/project-management/index.html
index 036e23a0..e1e7d756 100644
--- a/topics/project-management/index.html
+++ b/topics/project-management/index.html
@@ -193,6 +193,10 @@
</li>
<li >
+ <a href="../../api-guide/metadata">Metadata</a>
+ </li>
+
+ <li >
<a href="../../api-guide/format-suffixes">Format suffixes</a>
</li>
diff --git a/topics/release-notes/index.html b/topics/release-notes/index.html
index a8d74ed8..fb25f224 100644
--- a/topics/release-notes/index.html
+++ b/topics/release-notes/index.html
@@ -193,6 +193,10 @@
</li>
<li >
+ <a href="../../api-guide/metadata">Metadata</a>
+ </li>
+
+ <li >
<a href="../../api-guide/format-suffixes">Format suffixes</a>
</li>
diff --git a/topics/rest-framework-2-announcement/index.html b/topics/rest-framework-2-announcement/index.html
index 7047aa7c..18935f20 100644
--- a/topics/rest-framework-2-announcement/index.html
+++ b/topics/rest-framework-2-announcement/index.html
@@ -193,6 +193,10 @@
</li>
<li >
+ <a href="../../api-guide/metadata">Metadata</a>
+ </li>
+
+ <li >
<a href="../../api-guide/format-suffixes">Format suffixes</a>
</li>
diff --git a/topics/rest-hypermedia-hateoas/index.html b/topics/rest-hypermedia-hateoas/index.html
index c5171cc0..30e6c2b6 100644
--- a/topics/rest-hypermedia-hateoas/index.html
+++ b/topics/rest-hypermedia-hateoas/index.html
@@ -193,6 +193,10 @@
</li>
<li >
+ <a href="../../api-guide/metadata">Metadata</a>
+ </li>
+
+ <li >
<a href="../../api-guide/format-suffixes">Format suffixes</a>
</li>
diff --git a/topics/third-party-resources/index.html b/topics/third-party-resources/index.html
index db4aa07f..0f9e1a9c 100644
--- a/topics/third-party-resources/index.html
+++ b/topics/third-party-resources/index.html
@@ -193,6 +193,10 @@
</li>
<li >
+ <a href="../../api-guide/metadata">Metadata</a>
+ </li>
+
+ <li >
<a href="../../api-guide/format-suffixes">Format suffixes</a>
</li>
diff --git a/tutorial/1-serialization/index.html b/tutorial/1-serialization/index.html
index 7cb478bd..a0e975d0 100644
--- a/tutorial/1-serialization/index.html
+++ b/tutorial/1-serialization/index.html
@@ -193,6 +193,10 @@
</li>
<li >
+ <a href="../../api-guide/metadata">Metadata</a>
+ </li>
+
+ <li >
<a href="../../api-guide/format-suffixes">Format suffixes</a>
</li>
diff --git a/tutorial/2-requests-and-responses/index.html b/tutorial/2-requests-and-responses/index.html
index f117a9d3..0f4980a7 100644
--- a/tutorial/2-requests-and-responses/index.html
+++ b/tutorial/2-requests-and-responses/index.html
@@ -193,6 +193,10 @@
</li>
<li >
+ <a href="../../api-guide/metadata">Metadata</a>
+ </li>
+
+ <li >
<a href="../../api-guide/format-suffixes">Format suffixes</a>
</li>
diff --git a/tutorial/3-class-based-views/index.html b/tutorial/3-class-based-views/index.html
index 6533945d..8d3886c9 100644
--- a/tutorial/3-class-based-views/index.html
+++ b/tutorial/3-class-based-views/index.html
@@ -193,6 +193,10 @@
</li>
<li >
+ <a href="../../api-guide/metadata">Metadata</a>
+ </li>
+
+ <li >
<a href="../../api-guide/format-suffixes">Format suffixes</a>
</li>
diff --git a/tutorial/4-authentication-and-permissions/index.html b/tutorial/4-authentication-and-permissions/index.html
index 21e181c5..c05e6cee 100644
--- a/tutorial/4-authentication-and-permissions/index.html
+++ b/tutorial/4-authentication-and-permissions/index.html
@@ -193,6 +193,10 @@
</li>
<li >
+ <a href="../../api-guide/metadata">Metadata</a>
+ </li>
+
+ <li >
<a href="../../api-guide/format-suffixes">Format suffixes</a>
</li>
diff --git a/tutorial/5-relationships-and-hyperlinked-apis/index.html b/tutorial/5-relationships-and-hyperlinked-apis/index.html
index e552c6e4..0d82b190 100644
--- a/tutorial/5-relationships-and-hyperlinked-apis/index.html
+++ b/tutorial/5-relationships-and-hyperlinked-apis/index.html
@@ -193,6 +193,10 @@
</li>
<li >
+ <a href="../../api-guide/metadata">Metadata</a>
+ </li>
+
+ <li >
<a href="../../api-guide/format-suffixes">Format suffixes</a>
</li>
diff --git a/tutorial/6-viewsets-and-routers/index.html b/tutorial/6-viewsets-and-routers/index.html
index 03839e8d..4babe707 100644
--- a/tutorial/6-viewsets-and-routers/index.html
+++ b/tutorial/6-viewsets-and-routers/index.html
@@ -193,6 +193,10 @@
</li>
<li >
+ <a href="../../api-guide/metadata">Metadata</a>
+ </li>
+
+ <li >
<a href="../../api-guide/format-suffixes">Format suffixes</a>
</li>
diff --git a/tutorial/quickstart/index.html b/tutorial/quickstart/index.html
index 0c593f47..80e36829 100644
--- a/tutorial/quickstart/index.html
+++ b/tutorial/quickstart/index.html
@@ -193,6 +193,10 @@
</li>
<li >
+ <a href="../../api-guide/metadata">Metadata</a>
+ </li>
+
+ <li >
<a href="../../api-guide/format-suffixes">Format suffixes</a>
</li>