Re-add discriminator field to discriminated union JSON schema #1578
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.
Summary
After PR #1555, the discriminator field was removed from the generated JSON schema for discriminated unions. This caused the OpenAPI documentation tests (
tests/agent_server/test_openapi_discriminator.py::test_action_schema_has_discriminator) to fail because Swagger UI needs the discriminator field to properly display discriminated unions instead of showing them as "object | object | object...".This PR re-adds the discriminator field with the proper mapping in the
__get_pydantic_json_schema__method ofDiscriminatedUnionMixin. The test expectation was also updated to include the discriminator field.Changes:
openhands-sdk/openhands/sdk/utils/models.py: Added code to build a discriminator mapping from the$refschemas and include the discriminator field in the generated JSON schematests/sdk/utils/test_discriminated_union.py: Updated thetest_json_schema_expectedtest to verify the discriminator field is presentChecklist
@tofarr 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.12-nodejs22golang: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:472e283-pythonRun
All tags pushed for this build
About Multi-Architecture Support
472e283-python) is a multi-arch manifest supporting both amd64 and arm64472e283-python-amd64) are also available if needed