-
Notifications
You must be signed in to change notification settings - Fork 450
refactor(parser): improves S3 models with examples and descriptions #7292
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): improves S3 models with examples and descriptions #7292
Conversation
a1bdb09
to
69fbe39
Compare
69fbe39
to
c8dbd4f
Compare
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 @ivica-k thanks a lot for this PR! I just left some few comments to improve.
f42161f
to
e62c5fd
Compare
e62c5fd
to
65ab4b0
Compare
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## develop #7292 +/- ##
========================================
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:
|
Lovely! I believe I addressed most of them, if not all, with the latest commit. |
|
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 a lot for working on this and addressing all the comments @ivica-k! APPROVED!!
Issue number: closes #7120
Summary
Changes
Improves the S3 models with field descriptions and examples using Pydantic's
Field()
functionality. This improvement provides better documentation and metadata for S3 event models.This change is fully backward compatible - no breaking changes to existing validation and serialization process.
User experience
Users will be able to see examples and description when serializing models.
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.