Update of autogenerated documentation.

[chrisu/seepark.git] / web / seepark_web.py

diff --git a/web/seepark_web.py b/web/seepark_web.py
index 70b0d4be6275031536a91512881e9061deb82158..1ff515138a159df48396c238a723fc4ef66cdc4d 100644 (file)
--- a/web/seepark_web.py
+++ b/web/seepark_web.py
@@ -307,10 +307,11 @@ def sensorid(version, sensor_id):
     """Return all data for a specific sensor
 
     URL parameters:
-    begin=<datetime>, optional, format like "2018-05-19T21:07:53"
-    end=<datetime>, optional, format like "2018-05-19T21:07:53"
-    mode=<full|consolidated>, optional. return all rows (default) or with lower resolution (for charts)
-    format=<default|c3>, optional. return result as returned by sqlalchemy (default) or formatted for c3.js
+
+    * ``begin=<datetime>``, optional, format like ``2018-05-19T21:07:53``
+    * ``end=<datetime>``, optional, format like ``2018-05-19T21:07:53``
+    * ``mode=<full|consolidated>``, optional. return all rows (default) or with lower resolution (for charts)
+    * ``format=<default|c3>``, optional. return result as returned by sqlalchemy (default) or formatted for c3.js
     """
     result = sensordata(sensor_id=sensor_id)
     return jsonify(result)
@@ -321,10 +322,11 @@ def sensortype(version, sensor_type):
     """Return all data for a specific sensor type
 
     URL parameters:
-    begin=<datetime>, optional, format like "2018-05-19T21:07:53"
-    end=<datetime>, optional, format like "2018-05-19T21:07:53"
-    mode=<full|consolidated>, optional. return all rows (default) or with lower resolution (for charts)
-    format=<default|c3>, optional. return result as returned by sqlalchemy (default) or formatted for c3.js
+
+    * ``begin=<datetime>``, optional, format like ``2018-05-19T21:07:53``
+    * ``end=<datetime>``, optional, format like ``2018-05-19T21:07:53``
+    * ``mode=<full|consolidated>``, optional. return all rows (default) or with lower resolution (for charts)
+    * ``format=<default|c3>``, optional. return result as returned by sqlalchemy (default) or formatted for c3.js
     """
     result = sensordata(sensor_type=sensor_type)
     return jsonify(result)
@@ -356,8 +358,10 @@ def currentwater(version):
     return jsonify({"value": value, "timestamp": timestamp})
 
 
-@app.route('/report/<int:year>-<int:month>')
+@app.route('/report/<int:year>/<int:month>')
 def report(year, month):
+    """Report for given year and month
+    """
     paper_size = (29.7 / 2.54, 21. / 2.54)  # A4
 
     begin = datetime.datetime(year, month, 1)