Skip to content

Conversation

@oyiz-michael
Copy link
Contributor

@oyiz-michael oyiz-michael commented Jan 19, 2026

Issue number: closes #7711

Summary

Changes

This PR fixes a bug where OpenAPI schema return types were bleeding across routes when reusing response dictionaries. The issue occurred when multiple routes shared the same response dictionary object (e.g., via Responses.combine()), causing the schema generator to mutate the shared dictionary and incorrectly apply one route's return type schema to all routes.

Root cause: The _add_route_to_openapi_routes method was directly referencing the shared response dictionary, so modifications made during schema generation affected all routes using that dictionary.

Solution: Changed line 670 in api_gateway.py to use copy.deepcopy() to create an independent copy of the response dictionary before any modifications, ensuring each route's schema remains isolated.

Files changed:

  • aws_lambda_powertools/event_handler/api_gateway.py: Added import copy and modified response dictionary handling to use deepcopy()
  • tests/functional/event_handler/_pydantic/test_openapi_shared_response_bleed.py: Added comprehensive regression tests

User experience

Before:

from aws_lambda_powertools.event_handler import APIGatewayRestResolver

responses = Responses.combine(
    Responses.success,
    Responses.not_found
)

@app.get("/exams", responses=responses)
def list_exams() -> list[ExamSummary]:
    ...

@app.get("/exam/<exam_id>/config", responses=responses)
def get_exam_config(exam_id: str) -> ExamConfig:
    ...

The generated OpenAPI schema would incorrectly show both routes returning the same type (whichever was processed last), instead of list[ExamSummary] and ExamConfig respectively.

After:
Each route correctly maintains its own return type schema in the OpenAPI specification, regardless of shared response dictionaries. The /exams route shows list[ExamSummary] and the /exam/<exam_id>/config route shows ExamConfig as expected.

Testing:
Added 2 new regression tests that verify no schema bleed occurs
Code quality checks pass: ruff format, ruff check, mypy
All 323 existing event handler tests pass

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.

…e dictionaries

Fixes aws-powertools#7711

When multiple routes shared the same response dictionary object,
the OpenAPI schema generator was mutating the shared dictionary
by directly modifying it. This caused schema bleeding where one
route's return type would incorrectly appear in another route's
OpenAPI schema.

The fix uses copy.deepcopy() to create independent copies of
response dictionaries before mutation, ensuring each route gets
its own correct OpenAPI schema based on its return type annotation.
Relates to aws-powertools#7711

Add comprehensive tests to verify that when multiple routes share
the same response dictionary, each route gets its own correct
OpenAPI schema without bleeding return types between routes.

Tests cover:
- Different return types (list vs single object) with shared responses
- Verification that shared dictionaries are not mutated
- Regression testing for standard behavior
@oyiz-michael oyiz-michael requested a review from a team as a code owner January 19, 2026 00:14
@oyiz-michael oyiz-michael requested a review from sdangol January 19, 2026 00:14
@pull-request-size pull-request-size bot added the size/L Denotes a PR that changes 100-499 lines, ignoring generated files. label Jan 19, 2026
@github-actions github-actions bot added the bug Something isn't working label Jan 19, 2026
@codecov
Copy link

codecov bot commented Jan 19, 2026

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 96.72%. Comparing base (8761fe7) to head (282d4f4).
⚠️ Report is 1 commits behind head on develop.

Additional details and impacted files
@@           Coverage Diff            @@
##           develop    #7952   +/-   ##
========================================
  Coverage    96.72%   96.72%           
========================================
  Files          278      278           
  Lines        13626    13627    +1     
  Branches      1083     1083           
========================================
+ Hits         13180    13181    +1     
  Misses         327      327           
  Partials       119      119           

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

@sonarqubecloud
Copy link

Copy link
Contributor

@leandrodamascena leandrodamascena left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Hey @oyiz-michael thanks a lot for this PR! Approved.

@leandrodamascena leandrodamascena merged commit d04d30f into aws-powertools:develop Jan 19, 2026
14 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

bug Something isn't working event_handlers size/L Denotes a PR that changes 100-499 lines, ignoring generated files. tests

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Bug: OpenAPI schema return types bleed across routes when reusing response dictionaries

3 participants