Add autogenerated API documentation.
[chrisu/seepark.git] / web / static / doc / index.html
1 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
2   "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
3
4
5 <html xmlns="http://www.w3.org/1999/xhtml">
6   <head>
7     <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
8     
9     <title>Seepark API documentation &#8212; seepark 0.1.0 documentation</title>
10     
11     <link rel="stylesheet" href="_static/alabaster.css" type="text/css" />
12     <link rel="stylesheet" href="_static/pygments.css" type="text/css" />
13     
14     <script type="text/javascript">
15       var DOCUMENTATION_OPTIONS = {
16         URL_ROOT:    './',
17         VERSION:     '0.1.0',
18         COLLAPSE_INDEX: false,
19         FILE_SUFFIX: '.html',
20         HAS_SOURCE:  true
21       };
22     </script>
23     <script type="text/javascript" src="_static/jquery.js"></script>
24     <script type="text/javascript" src="_static/underscore.js"></script>
25     <script type="text/javascript" src="_static/doctools.js"></script>
26     <link rel="index" title="Index" href="genindex.html" />
27     <link rel="search" title="Search" href="search.html" />
28     <link rel="top" title="seepark 0.1.0 documentation" href="#" />
29    
30   <link rel="stylesheet" href="_static/custom.css" type="text/css" />
31   
32   <meta name="viewport" content="width=device-width, initial-scale=0.9, maximum-scale=0.9" />
33
34   </head>
35   <body role="document">
36   
37
38     <div class="document">
39       <div class="documentwrapper">
40         <div class="bodywrapper">
41           <div class="body" role="main">
42             
43   <div class="section" id="seepark-api-documentation">
44 <h1>Seepark API documentation<a class="headerlink" href="#seepark-api-documentation" title="Permalink to this headline">¶</a></h1>
45 <dl class="get">
46 <dt id="get--api-(version)-openweathermap-city-(cityid)">
47 <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">/openweathermap/city/</code><span class="sig-paren">(</span><em>cityid</em><span class="sig-paren">)</span><a class="headerlink" href="#get--api-(version)-openweathermap-city-(cityid)" title="Permalink to this definition">¶</a></dt>
48 <dd><p>List all data found for a city</p>
49 </dd></dl>
50
51 <dl class="get">
52 <dt id="get--api-(version)-sensor-type-(sensor_type)">
53 <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>
54 <dd><p>Return all data for a specific sensor type</p>
55 <p>URL parameters:
56 begin=&lt;datetime&gt;, optional, format like &#8220;2018-05-19T21:07:53&#8221;
57 end=&lt;datetime&gt;, optional, format like &#8220;2018-05-19T21:07:53&#8221;
58 mode=&lt;full|consolidated&gt;, optional. return all rows (default) or with lower resolution (for charts)
59 format=&lt;default|c3&gt;, optional. return result as returned by sqlalchemy (default) or formatted for c3.js</p>
60 </dd></dl>
61
62 <dl class="get">
63 <dt id="get--api-(version)-sensor-id-(sensor_id)">
64 <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>
65 <dd><p>Return all data for a specific sensor</p>
66 <p>URL parameters:
67 begin=&lt;datetime&gt;, optional, format like &#8220;2018-05-19T21:07:53&#8221;
68 end=&lt;datetime&gt;, optional, format like &#8220;2018-05-19T21:07:53&#8221;
69 mode=&lt;full|consolidated&gt;, optional. return all rows (default) or with lower resolution (for charts)
70 format=&lt;default|c3&gt;, optional. return result as returned by sqlalchemy (default) or formatted for c3.js</p>
71 </dd></dl>
72
73 <dl class="get">
74 <dt id="get--report-(int-year)-(int-month)">
75 <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>
76 <dd><p>Report for given year and month</p>
77 </dd></dl>
78
79 <dl class="get">
80 <dt id="get--api-(version)-openweathermap-cities">
81 <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">/openweathermap/cities</code><a class="headerlink" href="#get--api-(version)-openweathermap-cities" title="Permalink to this definition">¶</a></dt>
82 <dd><p>List all city IDs found in the database</p>
83 </dd></dl>
84
85 <dl class="get">
86 <dt id="get--api-(version)-sensors-">
87 <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>
88 <dd><p>List all sensors found in the database</p>
89 </dd></dl>
90
91 </div>
92 <div class="section" id="indices-and-tables">
93 <h1>Indices and tables<a class="headerlink" href="#indices-and-tables" title="Permalink to this headline">¶</a></h1>
94 <ul class="simple">
95 <li><a class="reference internal" href="search.html"><span class="std std-ref">Search Page</span></a></li>
96 </ul>
97 </div>
98
99
100           </div>
101         </div>
102       </div>
103       <div class="sphinxsidebar" role="navigation" aria-label="main navigation">
104         <div class="sphinxsidebarwrapper">
105   <h3><a href="#">Table Of Contents</a></h3>
106   <ul>
107 <li><a class="reference internal" href="#">Seepark API documentation</a></li>
108 <li><a class="reference internal" href="#indices-and-tables">Indices and tables</a></li>
109 </ul>
110 <div class="relations">
111 <h3>Related Topics</h3>
112 <ul>
113   <li><a href="#">Documentation overview</a><ul>
114   </ul></li>
115 </ul>
116 </div>
117   <div role="note" aria-label="source link">
118     <h3>This Page</h3>
119     <ul class="this-page-menu">
120       <li><a href="_sources/index.txt"
121             rel="nofollow">Show Source</a></li>
122     </ul>
123    </div>
124 <div id="searchbox" style="display: none" role="search">
125   <h3>Quick search</h3>
126     <form class="search" action="search.html" method="get">
127       <div><input type="text" name="q" /></div>
128       <div><input type="submit" value="Go" /></div>
129       <input type="hidden" name="check_keywords" value="yes" />
130       <input type="hidden" name="area" value="default" />
131     </form>
132 </div>
133 <script type="text/javascript">$('#searchbox').show(0);</script>
134         </div>
135       </div>
136       <div class="clearer"></div>
137     </div>
138     <div class="footer">
139       &copy;2019, Gregor Herrmann; Philipp Spitzer; Chrisu Jähnl.
140       
141       |
142       Powered by <a href="http://sphinx-doc.org/">Sphinx 1.4.9</a>
143       &amp; <a href="https://github.com/bitprophet/alabaster">Alabaster 0.7.8</a>
144       
145       |
146       <a href="_sources/index.txt"
147           rel="nofollow">Page source</a>
148     </div>
149
150     
151
152     
153   </body>
154 </html>