Skip to content

Feature request: implement APIGatewayProxyWebsocketEventSchema #3787

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
1 of 2 tasks
fredericrous opened this issue Mar 30, 2025 · 9 comments · Fixed by #3807
Closed
1 of 2 tasks

Feature request: implement APIGatewayProxyWebsocketEventSchema #3787

fredericrous opened this issue Mar 30, 2025 · 9 comments · Fixed by #3807
Assignees
Labels
completed This item is complete and has been merged/shipped feature-request This item refers to a feature request for an existing or new utility good-first-issue Something that is suitable for those who want to start contributing parser This item relates to the Parser Utility

Comments

@fredericrous
Copy link

Use case

as a Developer I would to use powertools parser on websocket lambda's event

Solution/User Experience

implement APIGatewayProxyWebsocketEventSchema

Alternative solutions

Acknowledgment

Future readers

Please react with 👍 and your use case to help us understand customer demand.

@fredericrous fredericrous added feature-request This item refers to a feature request for an existing or new utility triage This item has not been triaged by a maintainer, please wait labels Mar 30, 2025
Copy link

boring-cyborg bot commented Mar 30, 2025

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

@dreamorosi
Copy link
Contributor

Hi @fredericrous, do you have an example of this event payload?

@fredericrous
Copy link
Author

the event looks like this https://docs.aws.amazon.com/apigateway/latest/developerguide/apigateway-websocket-api-lambda-auth.html

in @types/aws-lambda it is implemented under the name of APIGatewayProxyWebsocketEventV2
however @types/aws-lambda implements it only partially, see DefinitelyTyped/DefinitelyTyped#68039

@leandrodamascena
Copy link
Contributor

Hey, we already have this Model in PT Python and I forgot to open an issue to add this support in PT TypeScript too, my bad!

But looks like we are missing to add the queryStringParameters and multiValueQueryStringParameters fields too. Thanks for pointing out this @fredericrous.

@dreamorosi dreamorosi added good-first-issue Something that is suitable for those who want to start contributing help-wanted We would really appreciate some support from community for this one confirmed The scope is clear, ready for implementation parser This item relates to the Parser Utility and removed triage This item has not been triaged by a maintainer, please wait labels Mar 31, 2025
@dreamorosi dreamorosi moved this from Triage to Backlog in Powertools for AWS Lambda (TypeScript) Mar 31, 2025
@dreamorosi
Copy link
Contributor

Thank you both for the additional clarifications.

I have added this item on the backlog and also added the help-wanted and good-first-isssue to it.

If anyone is interested in working on this, please leave a comment so I can assign the issue to you. If not picked up by the community we'll work on it during the coming weeks.

@VatsalGoel3
Copy link
Contributor

@dreamorosi, I can pick this up

@dreamorosi
Copy link
Contributor

Ok, thank you!

Copy link
Contributor

github-actions bot commented Apr 5, 2025

⚠️ 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 github-actions bot added pending-release This item has been merged and will be released soon and removed help-wanted We would really appreciate some support from community for this one confirmed The scope is clear, ready for implementation labels Apr 5, 2025
Copy link
Contributor

github-actions bot commented Apr 8, 2025

This is now released under v2.18.0 version!

@github-actions github-actions bot added completed This item is complete and has been merged/shipped and removed pending-release This item has been merged and will be released soon labels Apr 8, 2025
@dreamorosi dreamorosi moved this from Coming soon to Shipped in Powertools for AWS Lambda (TypeScript) Apr 8, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
completed This item is complete and has been merged/shipped feature-request This item refers to a feature request for an existing or new utility good-first-issue Something that is suitable for those who want to start contributing parser This item relates to the Parser Utility
Projects
4 participants