refactor(parser): Improve ALB models with examples and descriptions #7100
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
pull-request-size
bot
added
the
size/M
2 tasks
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## develop #7100 +/- ##
========================================
Coverage 96.35% 96.35%
========================================
Files 275 275
Lines 12980 12980
Branches 965 965
========================================
Hits 12507 12507
Misses 366 366
Partials 107 107 ☔ View full report in Codecov by Sentry. 🚀 New features to boost your workflow:
|
leandrodamascena
requested review from
dreamorosi
and removed request for
anafalcao
dreamorosi
approved these changes
Aug 5, 2025
|
This was referenced Aug 6, 2025
Closed
dcabib
added a commit
to dcabib/powertools-lambda-python
that referenced
this pull request
Aug 30, 2025
Enhances the SQS parser models with field descriptions and examples using Pydantic's Field() functionality. This improvement provides better documentation and metadata for SQS event parsing, following the pattern established in PR aws-powertools#7100. All field descriptions are based on official AWS SQS documentation and include realistic examples from actual test events. Closes aws-powertools#7116
5 tasks
dcabib
added a commit
to dcabib/powertools-lambda-python
that referenced
this pull request
Aug 30, 2025
Enhances the SNS parser models with field descriptions and examples using Pydantic's Field() functionality. This improvement provides better documentation and metadata for SNS event parsing, following the pattern established in PR aws-powertools#7100. All field descriptions are based on official AWS SNS documentation and include realistic examples from actual test events. Closes aws-powertools#7117
5 tasks
leandrodamascena
added a commit
that referenced
this pull request
Sep 1, 2025
…7287) * refactor(parser): Improve SNS models with examples and descriptions Enhances the SNS parser models with field descriptions and examples using Pydantic's Field() functionality. This improvement provides better documentation and metadata for SNS event parsing, following the pattern established in PR #7100. All field descriptions are based on official AWS SNS documentation and include realistic examples from actual test events. Closes #7117 * style: apply ruff formatting to SNS models Fix CI formatting issues as requested by leandrodamascena * style: fix line length issues in SNS models Break long lines over 120 characters following ALB/Kinesis pattern as requested by leandrodamascena. Use parentheses for multi-line strings and break long URL examples. * Fix styles * Fix styles --------- Co-authored-by: Leandro Damascena <lcdama@amazon.pt>
dcabib
added a commit
to dcabib/powertools-lambda-python
that referenced
this pull request
Sep 1, 2025
Enhances the Kafka parser models with field descriptions and examples using Pydantic's Field() functionality. This improvement provides better documentation and metadata for Kafka event parsing, following the pattern established in PR aws-powertools#7100. All field descriptions are based on official AWS MSK and Kafka documentation and include realistic examples from actual test events. Closes aws-powertools#7118
5 tasks
leandrodamascena
pushed a commit
that referenced
this pull request
Sep 1, 2025
…#7293) Enhances the Kafka parser models with field descriptions and examples using Pydantic's Field() functionality. This improvement provides better documentation and metadata for Kafka event parsing, following the pattern established in PR #7100. All field descriptions are based on official AWS MSK and Kafka documentation and include realistic examples from actual test events. Closes #7118
dcabib
added a commit
to dcabib/powertools-lambda-python
that referenced
this pull request
Sep 1, 2025
…scriptions Enhances the Transfer Family parser models with field descriptions and examples using Pydantic's Field() functionality. This improvement provides better documentation and metadata for Transfer Family event parsing, following the pattern established in PR aws-powertools#7100. All field descriptions are based on official AWS Transfer Family Lambda authorizer documentation and include realistic examples from actual test events. Closes aws-powertools#7119
5 tasks
leandrodamascena
pushed a commit
that referenced
this pull request
Sep 1, 2025
…scriptions (#7294) * refactor(parser): Improve Transfer Family models with examples and descriptions Enhances the Transfer Family parser models with field descriptions and examples using Pydantic's Field() functionality. This improvement provides better documentation and metadata for Transfer Family event parsing, following the pattern established in PR #7100. All field descriptions are based on official AWS Transfer Family Lambda authorizer documentation and include realistic examples from actual test events. Closes #7119 * security: fix password examples to avoid security hotspots Replace specific password examples with placeholder format to resolve SonarQube security hotspots while maintaining documentation value. * security: remove IP address examples as requested Remove IP address examples from source_ip field to avoid triggering security pipelines in customer environments as requested by leandrodamascena.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Issue number: #7099
Summary
Enhances the ALB models with field descriptions and examples using Pydantic's Field() functionality. This improvement provides better documentation and metadata for ALB event models.
This change is fully backward compatible - no breaking changes to existing validation and serialization process.
Changes
User experience
Customers will be able to see examples and description when serializing models.
Checklist
If your change doesn't seem to apply, please leave them unchecked.
Is this a breaking change?
RFC issue number:
Checklist:
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.