Refactor API routes and add response schemas for sensor data endpoints

backend/app/api.py

@@ -4,5 +4,5 @@ from app.routes.sensor import sensor_router
 
 api = NinjaAPI()
 
-api.add_router("/api", user_router)
-api.add_router("/api", sensor_router)
+api.add_router("", user_router)
+api.add_router("", sensor_router)

backend/app/routes/sensor.py

@@ -6,13 +6,27 @@ from utils.influx import InfluxDBHelper
 from dotenv import load_dotenv
 import os
 
+from app.schemas.sensor import (
+    RoomDataRangeResponse,
+    GetRoomsResponse,
+    RoomDataCSVResponse,
+    RoomDataCSVDownloadResponse,
+    GetRoomsFromBuildingResponse,
+    GetBauResponse,
+    RoomAvailabilityResponse,
+    SensorAvailabilityResponse,
+    AllRoomsAvailabilityResponse,
+    AllSensorsAvailabilityResponse,
+    Error,
+)
+
 sensor_router = Router(tags=["sensor"])
 
 
-@sensor_router.get("/room_data_range")
+@sensor_router.get("/room_data_range", response=RoomDataRangeResponse)
 def room_data_range(request, room: str, start: str = "-30d", stop: str = "now()"):
     if not room:
-        return JsonResponse({"error": "Missing 'room' parameter"}, status=400)
+        return 400, Error("Missing 'room' parameter")
 
     load_dotenv()
     client = InfluxDBHelper(
@@ -38,7 +52,7 @@ def room_data_range(request, room: str, start: str = "-30d", stop: str = "now()"
     return {"room": room, "data": data_by_time}
 
 
-@sensor_router.get("/get_rooms")
+@sensor_router.get("/get_rooms", response=GetRoomsResponse)
 def get_rooms(request):
     client = InfluxDBHelper(
         url=os.getenv("INFLUXDB_URL"),
@@ -56,7 +70,7 @@ def get_rooms(request):
     return {"rooms": sorted(rooms)}
 
 
-@sensor_router.get("/room_data_csv")
+@sensor_router.get("/room_data_csv", response=RoomDataCSVResponse)
 def room_data_csv_view(request, room: str, start: str = "-30d", stop: str = "now()"):
     if not room:
         return JsonResponse({"error": "Missing 'room' parameter"}, status=400)
@@ -84,7 +98,7 @@ def room_data_csv_view(request, room: str, start: str = "-30d", stop: str = "now
     return {"room": room, "data": results}
 
 
-@sensor_router.get("/room_data_csv_download")
+@sensor_router.get("/room_data_csv_download", response=RoomDataCSVDownloadResponse)
 def room_data_csv_download(request, room: str, start: str = "-30d", stop: str = "now()"):
     if not room:
         return JsonResponse({"error": "Missing 'room' parameter"}, status=400)
@@ -103,7 +117,7 @@ def room_data_csv_download(request, room: str, start: str = "-30d", stop: str =
     return response
 
 
-@sensor_router.get("/get_rooms_from_building")
+@sensor_router.get("/get_rooms_from_building", response=GetRoomsFromBuildingResponse)
 def get_rooms_from_building(request, building: str):
     if not building:
         return JsonResponse({"error": "Missing 'building' parameter"}, status=400)
@@ -127,7 +141,7 @@ def get_rooms_from_building(request, building: str):
     return {"building": building, "rooms": sorted(rooms)}
 
 
-@sensor_router.get("/get_bau")
+@sensor_router.get("/get_bau", response=GetBauResponse)
 def get_bau(request):
     client = InfluxDBHelper(
         url=os.getenv("INFLUXDB_URL"),
@@ -149,7 +163,7 @@ def get_bau(request):
     return {"baus": sorted(baus)}
 
 
-@sensor_router.get("/room_availability")
+@sensor_router.get("/room_availability", response=RoomAvailabilityResponse)
 def room_availability(request, room: str, start: str = "-30d", stop: str = "now()"):
     if not room:
         return JsonResponse({"error": "Missing 'room' parameter"}, status=400)
@@ -166,7 +180,7 @@ def room_availability(request, room: str, start: str = "-30d", stop: str = "now(
     return {"room": room, "available": availability}
 
 
-@sensor_router.get("/sensor_availability")
+@sensor_router.get("/sensor_availability", response=SensorAvailabilityResponse)
 def sensor_availability(request, mac: str, start: str = "-30d", stop: str = "now()"):
     if not mac:
         return JsonResponse({"error": "Missing 'mac' parameter"}, status=400)
@@ -183,7 +197,7 @@ def sensor_availability(request, mac: str, start: str = "-30d", stop: str = "now
     return {"sensor_mac": mac, "available": availability}
 
 
-@sensor_router.get("/all_rooms_availability")
+@sensor_router.get("/all_rooms_availability", response=AllRoomsAvailabilityResponse)
 def all_rooms_availability(request, start: str = "-30d", stop: str = "now()"):
     client = InfluxDBHelper(
         url=os.getenv("INFLUXDB_URL"),
@@ -197,7 +211,7 @@ def all_rooms_availability(request, start: str = "-30d", stop: str = "now()"):
     return {"available_rooms": rooms_available}
 
 
-@sensor_router.get("/all_sensors_availability")
+@sensor_router.get("/all_sensors_availability", response=AllSensorsAvailabilityResponse)
 def all_sensors_availability(request, start: str = "-30d", stop: str = "now()"):
     client = InfluxDBHelper(
         url=os.getenv("INFLUXDB_URL"),

backend/app/schemas/sensor.py

+from ninja import Schema
+from typing import List, Dict, Optional
+
+
+class RoomDataPoint(Schema):
+    time: str
+    field: str
+    value: float
+
+
+class RoomDataRangeResponse(Schema):
+    room: str
+    data: Dict[str, Dict[str, float]]
+
+
+class GetRoomsResponse(Schema):
+    rooms: List[str]
+
+
+class RoomDataCSVResponse(Schema):
+    room: str
+    data: List[RoomDataPoint]
+
+
+class RoomDataCSVDownloadResponse(Schema):
+    csv_data: str
+
+
+class GetRoomsFromBuildingResponse(Schema):
+    building: str
+    rooms: List[str]
+
+
+class GetBauResponse(Schema):
+    baus: List[str]
+
+
+class RoomAvailabilityResponse(Schema):
+    room: str
+    available: bool
+
+
+class SensorAvailabilityResponse(Schema):
+    sensor_mac: str
+    available: bool
+
+
+class AllRoomsAvailabilityResponse(Schema):
+    available_rooms: List[str]
+
+
+class AllSensorsAvailabilityResponse(Schema):
+    available_sensors: List[str]
+
+
+class Error(Schema):
+    message: str