Skip to content

docs(parser): fix schema names in built-in schemas table - #5784

Merged
svozza merged 3 commits into
aws-powertools:mainfrom
vishwakt:docs/parser-schema-table-names
Oct 5, 2026
Merged

svozza merged 3 commits into
aws-powertools:mainfrom
vishwakt:docs/parser-schema-table-names

Conversation

@vishwakt

@vishwakt vishwakt commented Oct 5, 2026

Copy link
Copy Markdown
Contributor

Summary

The built-in schemas table in the Parser docs listed six schema names that don't match the exports of @aws-lambda-powertools/parser/schemas, so importing them as documented fails. This PR aligns the table with the actual exports in packages/parser/src/schemas/index.ts.

Changes

  • Rename CloudwatchLogsSchema to CloudWatchLogsSchema
  • Rename CustomSMSTriggerSchema to CustomSMSSenderTriggerSchema
  • Rename CustomEmailTriggerSchema to CustomEmailSenderTriggerSchema
  • Rename VerifyAuthChallengeResponseTriggerSchema to VerifyAuthChallengeTriggerSchema
  • Rename S3ObjectLambdaEvent to S3ObjectLambdaEventSchema
  • Remove the PreTokenGenerationTriggerSchema row, which has no matching export; PreTokenGenerationTriggerSchemaV1 and PreTokenGenerationTriggerSchemaV2AndV3 are already listed
  • Keep the table column alignment so markdownlint-cli2 passes

Issue number: closes #5778


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.

Six names in the built-in schemas table did not match the exports of
@aws-lambda-powertools/parser/schemas. Rename five rows to the exported
names and remove the PreTokenGenerationTriggerSchema row, which has no
matching export; its V1 and V2AndV3 variants are already listed.

Refs aws-powertools#5778
@svozza
svozza merged commit 923e4f7 into aws-powertools:main Oct 5, 2026
41 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

size/S PR between 10-29 LOC

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Docs: Parser built-in schemas table lists schema names that are not exported

2 participants