aboutsummaryrefslogtreecommitdiffstats
path: root/api-guide/settings.html
diff options
context:
space:
mode:
Diffstat (limited to 'api-guide/settings.html')
-rw-r--r--api-guide/settings.html6
1 files changed, 6 insertions, 0 deletions
diff --git a/api-guide/settings.html b/api-guide/settings.html
index 95f6d114..b436bd99 100644
--- a/api-guide/settings.html
+++ b/api-guide/settings.html
@@ -298,6 +298,12 @@ If set to <code>None</code> then generic filtering is disabled.</p>
<pre class="prettyprint lang-py"><code>GET http://example.com/api/accounts?page_size=999
</code></pre>
<p>Default: <code>None</code></p>
+<h3 id="search_param">SEARCH_PARAM</h3>
+<p>The name of a query paramater, which can be used to specify the search term used by <code>SearchFilter</code>.</p>
+<p>Default: <code>search</code></p>
+<h4 id="ordering_param">ORDERING_PARAM</h4>
+<p>The name of a query paramater, which can be used to specify the ordering of results returned by <code>OrderingFilter</code>.</p>
+<p>Default: <code>ordering</code></p>
<hr />
<h2 id="authentication-settings">Authentication settings</h2>
<p><em>The following settings control the behavior of unauthenticated requests.</em></p>