Skip to content
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

docs(event_handler): add Terraform payload info for API Gateway HTTP API #5351

Merged
merged 3 commits into from
Oct 9, 2024

Conversation

leandrodamascena
Copy link
Contributor

Issue number: #4089

Summary

Changes

This PR adds a info banner for Terraform users of API Gateway HTTP API. It alerts them to check the payload version, as Terraform defaults to v1, while our APIGatewayHttpResolver requires v2.

Additional issue: #5321

User experience

Please share what the user experience looks like before and after this change

Checklist

If your change doesn't seem to apply, please leave them unchecked.

Is this a breaking change?

RFC issue number:

Checklist:

  • Migration process documented
  • Implement warnings (if it can live side by side)

Acknowledgment

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.

@leandrodamascena leandrodamascena requested a review from a team as a code owner October 8, 2024 20:51
@boring-cyborg boring-cyborg bot added the documentation Improvements or additions to documentation label Oct 8, 2024
@pull-request-size pull-request-size bot added the size/XS Denotes a PR that changes 0-9 lines, ignoring generated files. label Oct 8, 2024
Copy link

sonarqubecloud bot commented Oct 9, 2024

@leandrodamascena leandrodamascena merged commit f87d60b into develop Oct 9, 2024
4 checks passed
@leandrodamascena leandrodamascena deleted the docs/terraform-http-resolver branch October 9, 2024 12:45
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation size/XS Denotes a PR that changes 0-9 lines, ignoring generated files.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Docs: Note on default payload_format_version when using Terraform's apigatewayv2
2 participants