on master help sign in
add generated files
commit898c994eedcd0dcc02cf56eb99c12ebd13ec52c7 authorNoémi Ványi <sitbackandwait@gmail.com> dateTue 6 Sep 2016, 18:14 (10 years ago) parentf4c2ed8
2 files changed+10−4
_sources/dev/search_api.txt+3−1 dev/search_api.html+7−3
_sources/dev/search_api.txt+3−1
@@ -1,7 +1,7 @@
11Search API
22==========
33
4−The search supports both ``GET`` and ``POST``. However, using ``GET`` the parameters of the request remain hidden. So it is advised to use ``GET`` for querying.
4+The search supports both ``GET`` and ``POST``.
55
66Furthermore, two enpoints ``/`` and ``/search`` are available for querying.
77
@@ -29,3 +29,5 @@ Parameters
2929+------------------+----------------------------------------------------------------------------------------------------+-----------------------------+
3030| ``pageno`` | Search page number | optional (default: ``1``) |
3131+------------------+----------------------------------------------------------------------------------------------------+-----------------------------+
32+| ``time_range`` | Time range of search | optional |
33++------------------+----------------------------------------------------------------------------------------------------+-----------------------------+
dev/search_api.html+7−3
@@ -41,12 +41,12 @@
4141
4242 <div class="section" id="search-api">
4343<h1>Search API<a class="headerlink" href="#search-api" title="Permalink to this headline">¶</a></h1>
44−<p>The search supports both <code class="docutils literal"><span class="pre">GET</span></code> and <code class="docutils literal"><span class="pre">POST</span></code>. However, using <code class="docutils literal"><span class="pre">GET</span></code> the parameters of the request remain hidden. So it is advised to use <code class="docutils literal"><span class="pre">GET</span></code> for querying.</p>
44+<p>The search supports both <code class="docutils literal"><span class="pre">GET</span></code> and <code class="docutils literal"><span class="pre">POST</span></code>.</p>
4545<p>Furthermore, two enpoints <code class="docutils literal"><span class="pre">/</span></code> and <code class="docutils literal"><span class="pre">/search</span></code> are available for querying.</p>
46−<div class="code sh highlight-default"><div class="highlight"><pre><span class="n">GET</span> <span class="o">/</span>
46+<div class="code sh highlight-default"><div class="highlight"><pre><span></span><span class="n">GET</span> <span class="o">/</span>
4747</pre></div>
4848</div>
49−<div class="code sh highlight-default"><div class="highlight"><pre><span class="n">GET</span> <span class="o">/</span><span class="n">search</span>
49+<div class="code sh highlight-default"><div class="highlight"><pre><span></span><span class="n">GET</span> <span class="o">/</span><span class="n">search</span>
5050</pre></div>
5151</div>
5252<div class="section" id="parameters">
@@ -84,6 +84,10 @@
8484<td>Search page number</td>
8585<td>optional (default: <code class="docutils literal"><span class="pre">1</span></code>)</td>
8686</tr>
87+<tr class="row-odd"><td><code class="docutils literal"><span class="pre">time_range</span></code></td>
88+<td>Time range of search</td>
89+<td>optional</td>
90+</tr>
8791</tbody>
8892</table>
8993</div>