Browse Source

add generated files

Noémi Ványi 8 years ago
parent
commit
898c994eed
2 changed files with 10 additions and 4 deletions
  1. 3
    1
      _sources/dev/search_api.txt
  2. 7
    3
      dev/search_api.html

+ 3
- 1
_sources/dev/search_api.txt View File

1
 Search API
1
 Search API
2
 ==========
2
 ==========
3
 
3
 
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``.
5
 
5
 
6
 Furthermore, two enpoints ``/`` and ``/search`` are available for querying.
6
 Furthermore, two enpoints ``/`` and ``/search`` are available for querying.
7
 
7
 
29
 +------------------+----------------------------------------------------------------------------------------------------+-----------------------------+
29
 +------------------+----------------------------------------------------------------------------------------------------+-----------------------------+
30
 | ``pageno``       | Search page number                                                                                 | optional (default: ``1``)   |
30
 | ``pageno``       | Search page number                                                                                 | optional (default: ``1``)   |
31
 +------------------+----------------------------------------------------------------------------------------------------+-----------------------------+
31
 +------------------+----------------------------------------------------------------------------------------------------+-----------------------------+
32
+| ``time_range``   | Time range of search                                                                               | optional                    |
33
++------------------+----------------------------------------------------------------------------------------------------+-----------------------------+

+ 7
- 3
dev/search_api.html View File

41
             
41
             
42
   <div class="section" id="search-api">
42
   <div class="section" id="search-api">
43
 <h1>Search API<a class="headerlink" href="#search-api" title="Permalink to this headline">¶</a></h1>
43
 <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>
45
 <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>
45
 <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>
47
 </pre></div>
47
 </pre></div>
48
 </div>
48
 </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>
50
 </pre></div>
50
 </pre></div>
51
 </div>
51
 </div>
52
 <div class="section" id="parameters">
52
 <div class="section" id="parameters">
84
 <td>Search page number</td>
84
 <td>Search page number</td>
85
 <td>optional (default: <code class="docutils literal"><span class="pre">1</span></code>)</td>
85
 <td>optional (default: <code class="docutils literal"><span class="pre">1</span></code>)</td>
86
 </tr>
86
 </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>
87
 </tbody>
91
 </tbody>
88
 </table>
92
 </table>
89
 </div>
93
 </div>