-
Notifications
You must be signed in to change notification settings - Fork 450
refactor(parser): Improve SQS models with examples and descriptions #7286
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
refactor(parser): Improve SQS models with examples and descriptions #7286
Conversation
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
Thanks a lot for your first contribution! Please check out our contributing guidelines and don't hesitate to ask whatever you need. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Hey @dcabib thanks a lot! Just a small change and we are ready to merge.
Hey @dcabib please run |
Remove extremely long receiptHandle example as requested by leandrodamascena and apply ruff formatting to fix CI issues.
|
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## develop #7286 +/- ##
========================================
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:
|
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Thanks @dcabib! Approved!
closes #7116
Summary
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 #7100.
Changes
Added Field() descriptions and examples to all SQS parser model classes:
SqsAttributesModel
- Core SQS message attributes with AWS-accurate descriptionsSqsMsgAttributeModel
- User-defined message attributes with comprehensive documentationSqsRecordModel
- Individual SQS record structure with detailed field explanationsSqsModel
- Root SQS event model with proper sequence documentationAll field descriptions are based on official AWS SQS documentation
Examples sourced from actual test events (sqsEvent.json, sqsDlqTriggerEvent.json)
Maintains 100% backward compatibility - no breaking changes to type annotations or validation logic
User experience
Customers will be able to see examples and descriptions when using SQS 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 #7116