Docs: minor general improvements to Event Handler rest

[dreamorosi]

What were you searching in the docs?

Reading the docs for Event Handler REST that we just published, there's a number of areas that we can improve.

Is this related to an existing documentation section?

https://docs.powertools.aws.dev/lambda/typescript/latest/features/event-handler/rest/

How can we improve?

In no particular order:

• At the very beginning we say “Event handler for Amazon API Gateway REST and HTTP APIs, Application Loader Balancer (ALB), Lambda Function URLs, and VPC Lattice.” - right now we only support the first one, so we should update it to something like “Event handler for Amazon API Gateway REST APIs in AWS Lambda (support for HTTP APIs, ALB, Lambda Function URLs, and VPC Lattice is currently on the roadmap).” or something along those lines.
• Under "Key Features", same thing as above
• Also under "Key Features", Built-in middleware engine for request/response transformation and validation - Validation should be “coming soon”
• Finally, under "Key Features": Works with micro function (one or a few routes) and monolithic functions (all routes) - the explanation buried later in the text - we might want to link to the relevant section
• Nit: Install section we say “This is not necessary if you’re installing Powertools for AWS Lambda (TypeScript) via Lambda layer.” - we should replace the “installing” word with "using" or equivalent since you don't install when using layers
• Rework the "Required resources" section to reflect that we only support API Gateway today
• “We generally recommend to have separate functions for each HTTP method, as the functionality tends to differ depending on which method is used” - might be ambiguous - separate Lambda functions (micro-functions?) - Might be better like “We recommend defining separate route handlers for each HTTP method within your Lambda function, as the functionality typically differs between operations such as GET, POST, PUT, DELETE etc”
• Considerations - should we move this upper in the page?
• I've gotten the feedback that many/most of the sections that have "coming soon" are not clear on whether this is something that's on the roadmap or what to do in the meanwhile. Should we improve them?

Got a suggestion in mind?

No response

Acknowledgment

• I understand the final update might be different from my proposed suggestion, or refused.

[powertools-for-aws-oss-automation]

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 reopen the issue, or open a new issue referencing 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 v2.27.0 version!