avoid misparsing references as other types using Pydantic discriminated unions #1216
Conversation
This file contains 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
nkrishnaswami
changed the title
dbanty
reviewed
Mar 15, 2025
There was a problem hiding this comment.
I think your read of the spec is right, the presence of $ref should guarantee it's treated like a reference. Thanks for the fix!
A couple recommendations:
- Taking prints out of the tests, I assume those were there for debugging
- We should add an e2e test for this as well, just to make sure if we tweak the way we use models at some point we don't get a regression. I think just adding some extra stuff to existing
$refs in https://github.com/openapi-generators/openapi-python-client/blob/main/end_to_end_tests/baseline_openapi_3.0.json and verifying it doesn't change anything should be enough.
|
Thanks, @dbanty -- I'll make the updates now. |
* Remove `print` statements * add example verifying new behavior to E2E test
|
I've confirmed the modified E2E test fails without this change, also |
|
@nkrishnaswami hope you don't mind I pushed directly to try and solve mypy & Ruff's complaints in CI |
dbanty
changed the title
dbanty
approved these changes
Mar 15, 2025
|
Don't mind at all -- thanks! |
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.
I’ve found a corner case, I think due to changes to Pydantic’s smart mode for disambiguating unions, where a subdocument with a
$refkey and additional keys (title, description, etc) is validated as aSchemainstead of as aReferencemodel. I believe these should be ignored per "any properties added SHALL be ignored" () This was a problem for me since I want to use a reference to an enum as a header parameter in FastAPI. The OpenAPI document generated by FastAPI included several fields (title, description, etc) along with$ref. TheSchemainstance it was validate to lacked any actual type constraint information, so openapi-python-client needed to treat this as anAnyParameter, and disallowed it in headers.I have attached an example OpenAPI document
oa.jsonyou can use to replicate this with the currentopenapi-python-client, or you can use the test cases from the first commit in this PR, which resolves it by using a Pydantic discriminated union testing for the presence of$reffor all the unions includingReference.(I had created an issue upstream, but figured I'd share the workaround here.)