fix(event_handler): match generic alias response models in OpenAPI schema - #8453
Open
TanbirRamim wants to merge 1 commit into
Open
Conversation
…hema Custom responses are deep-copied before resolving their model, and deepcopy returns a new object for generic aliases such as list[Model]. The identity check against response_extra_models never matched, so schema generation raised StopIteration. Compare by equality instead. Fixes aws-powertools#8450
powertools-for-aws-oss-automation
Bot
added
the
size/M
|
Thanks a lot for your first contribution! Please check out our contributing guidelines and don't hesitate to ask whatever you need. |
|
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.
Issue number: closes #8450
Summary
Changes
Since custom responses started being deep-copied before their
modelis resolved, a generic alias such aslist[Model]comes back as a newGenericAliasobject, so the identity check in_resolve_response_payloadnever found the matching field andget_openapi_schema()raisedStopIteration. This compares the model with==instead ofis; plain classes still compare by identity, and generic aliases compare structurally. I added a regression test intest_openapi_responses.pycoveringlist[Model]anddict[str, Model], which fails withStopIterationbefore the change and passes after; the event_handler functional tests, ruff and mypy all pass locally.User experience
Before, any route with a generic alias as a custom response model broke OpenAPI schema generation, Swagger and validation setup with
StopIteration. After, those routes produce the expected array or object schema again, as they did up to 3.24.0.By submitting this pull request, I confirm that you can use, modify, copy, and redistribute this contribution, under the terms of your choice.
Disclaimer: We value your time and bandwidth. As such, any pull requests created on non-triaged issues might not be successful.