add generated files

This commit is contained in:
Noémi Ványi 2016-09-06 18:14:11 +02:00
parent f4c2ed82b5
commit 898c994eed
2 changed files with 10 additions and 4 deletions

View File

@ -1,7 +1,7 @@
Search API Search API
========== ==========
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. The search supports both ``GET`` and ``POST``.
Furthermore, two enpoints ``/`` and ``/search`` are available for querying. Furthermore, two enpoints ``/`` and ``/search`` are available for querying.
@ -29,3 +29,5 @@ Parameters
+------------------+----------------------------------------------------------------------------------------------------+-----------------------------+ +------------------+----------------------------------------------------------------------------------------------------+-----------------------------+
| ``pageno`` | Search page number | optional (default: ``1``) | | ``pageno`` | Search page number | optional (default: ``1``) |
+------------------+----------------------------------------------------------------------------------------------------+-----------------------------+ +------------------+----------------------------------------------------------------------------------------------------+-----------------------------+
| ``time_range`` | Time range of search | optional |
+------------------+----------------------------------------------------------------------------------------------------+-----------------------------+

View File

@ -41,12 +41,12 @@
<div class="section" id="search-api"> <div class="section" id="search-api">
<h1>Search API<a class="headerlink" href="#search-api" title="Permalink to this headline"></a></h1> <h1>Search API<a class="headerlink" href="#search-api" title="Permalink to this headline"></a></h1>
<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> <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>
<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> <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>
<div class="code sh highlight-default"><div class="highlight"><pre><span class="n">GET</span> <span class="o">/</span> <div class="code sh highlight-default"><div class="highlight"><pre><span></span><span class="n">GET</span> <span class="o">/</span>
</pre></div> </pre></div>
</div> </div>
<div class="code sh highlight-default"><div class="highlight"><pre><span class="n">GET</span> <span class="o">/</span><span class="n">search</span> <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>
</pre></div> </pre></div>
</div> </div>
<div class="section" id="parameters"> <div class="section" id="parameters">
@ -84,6 +84,10 @@
<td>Search page number</td> <td>Search page number</td>
<td>optional (default: <code class="docutils literal"><span class="pre">1</span></code>)</td> <td>optional (default: <code class="docutils literal"><span class="pre">1</span></code>)</td>
</tr> </tr>
<tr class="row-odd"><td><code class="docutils literal"><span class="pre">time_range</span></code></td>
<td>Time range of search</td>
<td>optional</td>
</tr>
</tbody> </tbody>
</table> </table>
</div> </div>