Add doc to location_complete route about instability

Signed-off-by: Aaron Chong <[email protected]>
open-rmf · May 28, 2024 · deca732 · deca732
1 parent e45452d
commit deca732
Showing 1 changed file with 4 additions and 0 deletions.
diff --git a/packages/api-server/api_server/routes/tasks/tasks.py b/packages/api-server/api_server/routes/tasks/tasks.py
@@ -399,6 +399,10 @@ async def location_complete(
     success: bool,
     logger: LoggerAdapter = Depends(get_logger),
 ):
+    """
+    Warning: This endpoint is still actively being worked on and could be
+    subjected to modifications.
+    """
     alerts = await get_alerts_of_task(task_id=task_id, unresponded=True)
     if len(alerts) == 0:
         raise HTTPException(