commit bb31a9fdef60b1fa8ec6655c38dba9ff417b15a7 parent fe56800701a9ef73176348851c829bb6a4892cc9 Author: Chris Bracken <chris@bracken.jp> Date: Tue, 12 Apr 2022 10:46:57 -0700 Document HTTP endpoints in README.md Diffstat:
| M | README.md | | | 9 | +++++++++ |
1 file changed, 9 insertions(+), 0 deletions(-)
diff --git a/README.md b/README.md @@ -4,6 +4,15 @@ Tempestas A small HTTP server backed by a PostgreSQL database for collecting data from [sensor.community][sc] devices running the AirRohr firmware. +API endpoints: +* /sensor/airrohr/: HTTP endpoint for submitting AirRohr formatted POST + requests. +* /sensor/reading/$sensorID/$readingType: HTTP endpoint for retrieving + JSON-formatted data for the specified sensor and reading type. +* /sensor/sensors/: HTTP endpoint for retrieving a JSON-formatted list of + sensors. + + Building and running --------------------