improved API error messages with structured causes and remediation hints for agents and UI clients

Author: CamDavidsonPilon

core/tests/web/test_unit_api.py

@@ -22,6 +22,10 @@ def test_invalid_update_target(client) -> None:
     assert resp.status_code == 404
     data = resp.get_json()
     assert data.get("error") == "Invalid target"
+    error_info = data.get("error_info", {})
+    assert error_info.get("status") == 404
+    assert error_info.get("message") == "Invalid target"
+    assert isinstance(error_info.get("remediation"), str)
 
 
 @pytest.mark.parametrize("endpoint", ["/unit_api/system/reboot", "/unit_api/system/shutdown"])
@@ -45,6 +49,10 @@ def test_get_clock_time_success(client) -> None:
 def test_set_clock_non_leader(client) -> None:
     resp = client.patch("/unit_api/system/utc_clock", json={})
     assert resp.status_code == 400  # need to provide clock data, else it errors
+    data = resp.get_json()
+    error_info = data.get("error_info", {})
+    assert error_info.get("status") == 400
+    assert isinstance(error_info.get("remediation"), str)
 
 
 def test_set_clock_time_sync_branch(client, monkeypatch) -> None:
@@ -72,6 +80,10 @@ def test_hardware_check_requires_model_payload(client) -> None:
     assert resp.status_code == 400
     data = resp.get_json()
     assert data["error"] == "Missing model_name or model_version"
+    error_info = data.get("error_info", {})
+    assert error_info.get("status") == 400
+    assert error_info.get("message") == "Missing model_name or model_version"
+    assert isinstance(error_info.get("remediation"), str)
 
 
 def test_hardware_check_queues_task(client, monkeypatch) -> None: