Bug: APIGatewayRestResolver - openAPI metadata responses / tags on @router fails with unhashable type: dict

[MCR2019]

Expected Behaviour

When adding responses or tags metadata to a router this should behave in the same was as when it is added to the app.

Current Behaviour

When the routers are added to the app the metadata is used as a key. As the metadata fields for responses and tags are Dict and List then this produces the following error:

File "/Users/my_path/venv/lib/python3.10/site-packages/aws_lambda_powertools/event_handler/api_gateway.py", line 2160, in register_route
    self._routes_with_middleware[route_key] = []
TypeError: unhashable type: 'dict'

Code snippet

from aws_lambda_powertools.event_handler import APIGatewayRestResolver
from aws_lambda_powertools.event_handler.api_gateway import Router

router = Router()

app = APIGatewayRestResolver(enable_validation=True)
app.include_router(router)


@router.put(
    "/example-resource",
    responses={200: {"description": "Todo item found"}},
    tags=["Examples"]
)
def put():
    """"""


if __name__ == "__main__":
    """"""

Possible Solution

No response

Steps to Reproduce

• Create APIGatewatRestResolver.
• Create api_gateway Router.
• Add method to Router with responses or tags metadata.
• Add Router to app.

Powertools for AWS Lambda (Python) version

2.29.1

AWS Lambda function runtime

3.10

Packaging format used

PyPi

Debugging logs

No response

[boring-cyborg]

Thanks for opening your first issue here! We'll come back to you as soon as we can.
In the meantime, check out the #python channel on our Powertools for AWS Lambda Discord: Invite link

[leandrodamascena]

Hello @MCR2019! Thanks for reporting this bug! I was able to reproduce the error and we are working to fix it.
As it appears critical for those who are using the Router object and now integrating with the new OpenAPI utility, we will fix it as soon as possible and plan to release a patch by tomorrow.

We apologize for this bug. OpenAPI + Swagger are new utilities and we try our best to create tests and keep our code coverage high. Unfortunately, some things go through and we can't simulate them until someone reports it 😞

Thank you.

[rubenfonseca]

Working at this now!

[github-actions]

⚠️COMMENT VISIBILITY WARNING⚠️

This issue is now closed. Please be mindful that future comments are hard for our team to see.

If you need more assistance, please either tag a team member or open a new issue that references this one.

If you wish to keep having a conversation with other community members under this issue feel free to do so.

[github-actions]

This is now released under 2.30.1 version!

[rubenfonseca]

@MCR2019 thank you again for reporting this, we've just released 2.30.1 that should fix the problem you found!

[MCR2019]

@rubenfonseca - Thank you for fixing so quickly!