refactor(parser): Improve Transfer Family models with examples and descriptions #7294
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
…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
pull-request-size
bot
added
the
size/M
Replace specific password examples with placeholder format to resolve SonarQube security hotspots while maintaining documentation value.
leandrodamascena
requested changes
Sep 1, 2025
aws_lambda_powertools/utilities/parser/models/transfer_family.py
Outdated
Show resolved
Hide resolved
Remove IP address examples from source_ip field to avoid triggering security pipelines in customer environments as requested by leandrodamascena.
pull-request-size
bot
added
size/S
|
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## develop #7294 +/- ##
========================================
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
approved these changes
Sep 1, 2025
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: #7119
Summary
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.
Changes
Added Field() descriptions and examples to the Transfer Family parser model:
TransferFamilyAuthorizer- Lambda authorizer event model with comprehensive field documentationAll field descriptions are based on official AWS Transfer Family Lambda authorizer documentation
Examples sourced from actual test events (transferFamilyAuthorizer.json) and AWS documentation
Maintains 100% backward compatibility - no breaking changes to type annotations or validation logic
Preserves existing field aliases (serverId, sourceIp) and IPvAnyAddress type validation
User experience
Customers will be able to see examples and descriptions when using Transfer Family parser models, providing:
Checklist
Is this a breaking change? No
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.
Closes #7119