Update autogenerated API docs.
[chrisu/seepark.git] / web / static / doc / index.html
index f07d6c5e99cec3617d15ec3e52bdf2a9204db3a4..0bb93c5027c4956632817bb973b63d1c94b5cdc0 100644 (file)
 <dt id="get--api-(version)-sensor-type-(sensor_type)">
 <code class="descname">GET </code><code class="descname">/api/</code><span class="sig-paren">(</span><em>version</em><span class="sig-paren">)</span><code class="descname">/sensor/type/</code><span class="sig-paren">(</span><em>sensor_type</em><span class="sig-paren">)</span><a class="headerlink" href="#get--api-(version)-sensor-type-(sensor_type)" title="Permalink to this definition">¶</a></dt>
 <dd><p>Return all data for a specific sensor type</p>
-<p>URL parameters:
-begin=&lt;datetime&gt;, optional, format like &#8220;2018-05-19T21:07:53&#8221;
-end=&lt;datetime&gt;, optional, format like &#8220;2018-05-19T21:07:53&#8221;
-mode=&lt;full|consolidated&gt;, optional. return all rows (default) or with lower resolution (for charts)
-format=&lt;default|c3&gt;, optional. return result as returned by sqlalchemy (default) or formatted for c3.js</p>
+<p>URL parameters:</p>
+<ul class="simple">
+<li><code class="docutils literal"><span class="pre">begin=&lt;datetime&gt;</span></code>, optional, format like <code class="docutils literal"><span class="pre">2018-05-19T21:07:53</span></code></li>
+<li><code class="docutils literal"><span class="pre">end=&lt;datetime&gt;</span></code>, optional, format like <code class="docutils literal"><span class="pre">2018-05-19T21:07:53</span></code></li>
+<li><code class="docutils literal"><span class="pre">mode=&lt;full|consolidated&gt;</span></code>, optional. return all rows (default) or with lower resolution (for charts)</li>
+<li><code class="docutils literal"><span class="pre">format=&lt;default|c3&gt;</span></code>, optional. return result as returned by sqlalchemy (default) or formatted for c3.js</li>
+</ul>
 </dd></dl>
 
 <dl class="get">
 <dt id="get--api-(version)-sensor-id-(sensor_id)">
 <code class="descname">GET </code><code class="descname">/api/</code><span class="sig-paren">(</span><em>version</em><span class="sig-paren">)</span><code class="descname">/sensor/id/</code><span class="sig-paren">(</span><em>sensor_id</em><span class="sig-paren">)</span><a class="headerlink" href="#get--api-(version)-sensor-id-(sensor_id)" title="Permalink to this definition">¶</a></dt>
 <dd><p>Return all data for a specific sensor</p>
-<p>URL parameters:
-begin=&lt;datetime&gt;, optional, format like &#8220;2018-05-19T21:07:53&#8221;
-end=&lt;datetime&gt;, optional, format like &#8220;2018-05-19T21:07:53&#8221;
-mode=&lt;full|consolidated&gt;, optional. return all rows (default) or with lower resolution (for charts)
-format=&lt;default|c3&gt;, optional. return result as returned by sqlalchemy (default) or formatted for c3.js</p>
-</dd></dl>
-
-<dl class="get">
-<dt id="get--report-(int-year)-(int-month)">
-<code class="descname">GET </code><code class="descname">/report/</code><span class="sig-paren">(</span><em class="property">int: </em><em>year</em><span class="sig-paren">)</span><code class="descname">-</code><span class="sig-paren">(</span><em class="property">int: </em><em>month</em><span class="sig-paren">)</span><a class="headerlink" href="#get--report-(int-year)-(int-month)" title="Permalink to this definition">¶</a></dt>
-<dd><p>Report for given year and month</p>
+<p>URL parameters:</p>
+<ul class="simple">
+<li><code class="docutils literal"><span class="pre">begin=&lt;datetime&gt;</span></code>, optional, format like <code class="docutils literal"><span class="pre">2018-05-19T21:07:53</span></code></li>
+<li><code class="docutils literal"><span class="pre">end=&lt;datetime&gt;</span></code>, optional, format like <code class="docutils literal"><span class="pre">2018-05-19T21:07:53</span></code></li>
+<li><code class="docutils literal"><span class="pre">mode=&lt;full|consolidated&gt;</span></code>, optional. return all rows (default) or with lower resolution (for charts)</li>
+<li><code class="docutils literal"><span class="pre">format=&lt;default|c3&gt;</span></code>, optional. return result as returned by sqlalchemy (default) or formatted for c3.js</li>
+</ul>
 </dd></dl>
 
 <dl class="get">
@@ -82,6 +80,12 @@ format=&lt;default|c3&gt;, optional. return result as returned by sqlalchemy (de
 <dd><p>List all city IDs found in the database</p>
 </dd></dl>
 
+<dl class="get">
+<dt id="get--report-(int-year)-(int-month)">
+<code class="descname">GET </code><code class="descname">/report/</code><span class="sig-paren">(</span><em class="property">int: </em><em>year</em><span class="sig-paren">)</span><code class="descname">/</code><span class="sig-paren">(</span><em class="property">int: </em><em>month</em><span class="sig-paren">)</span><a class="headerlink" href="#get--report-(int-year)-(int-month)" title="Permalink to this definition">¶</a></dt>
+<dd><p>Report for given year (4 digits) and month (2 digits)</p>
+</dd></dl>
+
 <dl class="get">
 <dt id="get--api-(version)-sensors-">
 <code class="descname">GET </code><code class="descname">/api/</code><span class="sig-paren">(</span><em>version</em><span class="sig-paren">)</span><code class="descname">/sensors/</code><a class="headerlink" href="#get--api-(version)-sensors-" title="Permalink to this definition">¶</a></dt>