fix(pydantic): recurse into oneOf variants in strict JSON schema#2987
Open
alvinttang wants to merge 2 commits intoopenai:mainfrom
Open
fix(pydantic): recurse into oneOf variants in strict JSON schema#2987alvinttang wants to merge 2 commits intoopenai:mainfrom
alvinttang wants to merge 2 commits intoopenai:mainfrom
Conversation
Pydantic v2 generates oneOf (not anyOf) for discriminated unions (fields using discriminator=...). The _ensure_strict_json_schema function already recurses into anyOf and allOf variants but skips oneOf, so inline object schemas inside oneOf never receive additionalProperties: false or the required array -- causing the OpenAI API to reject the schema. Add oneOf handling that mirrors the existing anyOf logic.
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.
Summary
_ensure_strict_json_schema()insrc/openai/lib/_pydantic.pyrecurses intoanyOfandallOfvariants but skipsoneOf. Pydantic v2 generatesoneOf(notanyOf) for discriminated unions — i.e. fields usingdiscriminator=...:This produces a schema with
"oneOf": [{"$ref": "#/$defs/Cat"}, {"$ref": "#/$defs/Dog"}]in thepetproperty. Any inline object schemas nested insideoneOf(rather than via$ref) would not receiveadditionalProperties: falseor therequiredarray, causing the OpenAI API to reject the schema with:Fix
Add
oneOfhandling that mirrors the existinganyOflogic (7 lines).Test plan
test_discriminated_union_oneOfregression testanyOfbehavior is unchanged$defsinside discriminated unions still get strict treatment🤖 Generated with Claude Code