From d97eb666b84fd2368aeade810abcdf535c542a89 Mon Sep 17 00:00:00 2001
From: Sam Anthony <sam@samanthony.xyz>
Date: Mon, 4 Nov 2024 10:45:14 -0500
Subject: api: add descriptions

---
 api | 10 +++++-----
 1 file changed, 5 insertions(+), 5 deletions(-)

diff --git a/api b/api
index d6774a3..ab01f63 100644
--- a/api
+++ b/api
@@ -1,7 +1,7 @@
-Method	Path				Query
+Method	Path				Query						Description
 
-POST	/humidity			<float RH>
-POST	/target_humidity	<float RH>
-GET		/humidity
-GET		/target_humidity
+POST	/humidity			?<string room ID>&<float RH>		Set the measured humidity of a room.
+POST	/target_humidity	<float RH>					Set the target humidity for the building.
+GET		/humidity										Get the average humidity of the building.
+GET		/target_humidity								Get the target humidity of the building.
 POST	/duty_cycle		<TODO>
\ No newline at end of file
-- 
cgit v1.2.3