feat(parser): enhance API Gateway schemas

[dreamorosi]

Summary

Changes

Please provide a summary of what's being changed

As discussed in the linked issue, the schemas for API Gateway in the Parser utility had some inconsistencies and missing schemas.

In the issue I tested all the integration types and auth that I could think of for API Gateway and observed the payloads for each. I have used these payloads (that are in the issue) to inform the changes in this PR.

This PR fixes this by making the following changes:

• Add APIGatewayRequestAuthorizerEventSchema for Lambda Authorizer Request type in API Gateway v1 (REST)
• Add APIGatewayTokenAuthorizerEventSchema for Lambda Authorizer Token type in API Gateway v1 (REST)
• Add APIGatewayRequestAuthorizerEventV2Schema for Lambda Authorizer in API Gateway v2 (HTTP)
• Reviewed APIGatewayProxyEventSchema to conform with the actual event payload (see linked issue)
• Reviewed APIGatewayProxyEventV2Schema to conform with the actual event payload (see linked issue)

Additionally, while working on this I have also made three other changes that are not strictly related to the issue at hand but still interest the code I touched

• Extracted some shared schemas between v1 and v2 into a separate file that is now imported by both - before the v2 schemas were importing (and including in the final bundle) all the schemas from v1 only because they were importing a single shared schema
• Added docstrings with description, examples (where relevant), and links to all public schemas related to API Gateway
• Added subpath exports to target import only schemas from API Gateway v1 or v2 - this allows customers to avoid including all the schemas present in Parser when importing one (we'll roll out this change across all schemas)

Please add the issue number below, if no issue is present the PR might get blocked and not be reviewed

Issue number: #2624

---

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.

[dreamorosi]

@am29d - for when you're back.

Many of the test events used in the unit tests are not in line with what I observed and reported in the API Gateway tests discussed in the linked issue.

If possible, I'd ask you to please review my comment here, and if you agree replace the API Gateway event payloads with the ones I logged from API Gateway.

[am29d]

Thanks a lot for going through all the requests and adding the docs!

One minor ask: can we change to kebab-case apigw-proxy.ts for consistency?

I agree to change the test events with the ones you have generated. The previous events were afaik from the docs, which we imported from PT python.

[dreamorosi]

I have refactored the unit tests for API Gateway to use the events I recorded in the linked issue.

I have put the new test events in dedicated folders and used a slightly different way of reading the files. This new method only reads the files needed for that specific test suite instead of performing i/o to read all the events for each test.

Moving forward we should probably roll out this change across all other schemas/envelopes to improve test runtime.

Finally, I couldn't test the WebSocket API but I suspect there might be an opportunity to split the APIGatewayProxyEventSchema further and create a dedicated APIGatewayProxyWebsocketEventSchema.

I say this because some of the fields in the requestContext, namely: messageId, connectionId, routeKey, and eventType only seem to appear in these events. I'll address this in a future issue since I need to first figure out how to deploy a WS API (never done it) and I don't want to block your other PR.

[sonarqubecloud]

Quality Gate passed

Issues
0 New issues
0 Accepted issues

Measures
0 Security Hotspots
0.0% Coverage on New Code
5.9% Duplication on New Code

See analysis details on SonarCloud

[am29d]

Good call on refactoring the test event read operation. I remember having a mental todo but forgot about that. Great improvement!