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

leandrodamascena · web-flow · commit f87d60b601ed · 2024-10-09T13:45:45.000+01:00
Updating docs with terraform information
diff --git a/docs/core/event_handler/api_gateway.md b/docs/core/event_handler/api_gateway.md
@@ -131,6 +131,9 @@ When using Amazon API Gateway HTTP API to front your Lambda functions, you can u
 ???+ note
     Using HTTP API v1 payload? Use `APIGatewayRestResolver` instead. `APIGatewayHttpResolver` defaults to v2 payload.
 
+    <!-- markdownlint-disable-next-line MD013 -->
+    If you're using Terraform to deploy a HTTP API, note that it defaults the [payload_format_version](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/resources/apigatewayv2_integration#payload_format_version){target="_blank" rel="nofollow"} value to 1.0 if not specified.
+
 ```python hl_lines="5 11" title="Using HTTP API resolver"
 --8<-- "examples/event_handler_rest/src/getting_started_http_api_resolver.py"
 ```
