Draft
Conversation
Co-authored-by: openhands <openhands@all-hands.dev>
Contributor
Python API breakage checks — ✅ PASSEDResult: ✅ PASSED |
Contributor
REST API breakage checks (OpenAPI) — ✅ PASSEDResult: ✅ PASSED |
Contributor
Co-authored-by: openhands <openhands@all-hands.dev>
Co-authored-by: openhands <openhands@all-hands.dev>
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Why
The health check endpoints were returning inconsistent payload types:
/alivealready returned JSON, while/healthreturned a plain string. This makes simple health probes work, but it is less consistent for API consumers and tooling.Summary
{"status": "ok"}from/healthso it matches/alive/aliveand/healthJSON payloadIssue Number
Closes #1826.
How to Test
uv run pytest tests/agent_server/test_server_details_router.pyuv run pytest tests/cross/test_remote_conversation_live_server.py::test_health_endpoints_return_ok_jsonuv run python - <<'PY'from fastapi.testclient import TestClientfrom openhands.agent_server.api import create_appfrom openhands.agent_server.config import Configclient = TestClient(create_app(Config(static_files_path=None)))print(client.get('/alive').status_code, client.get('/alive').json())print(client.get('/health').status_code, client.get('/health').json())PY/alive 200 {'status': 'ok'}/health 200 {'status': 'ok'}Video/Screenshots
Not applicable for this API-only change.
Type
Notes
@neubig can click here to continue refining the PR
Agent Server images for this PR
• GHCR package: https://github.com/OpenHands/agent-sdk/pkgs/container/agent-server
Variants & Base Images
eclipse-temurin:17-jdknikolaik/python-nodejs:python3.13-nodejs22-slimgolang:1.21-bookwormPull (multi-arch manifest)
# Each variant is a multi-arch manifest supporting both amd64 and arm64 docker pull ghcr.io/openhands/agent-server:9bbba02-pythonRun
All tags pushed for this build
About Multi-Architecture Support
9bbba02-python) is a multi-arch manifest supporting both amd64 and arm649bbba02-python-amd64) are also available if needed