Skip to content

refactor(parser): Improve DynamoDB models with examples and descriptions #7146

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.

Sign up for GitHub

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

Jump to bottom
Merged
merged 4 commits into from
Aug 18, 2025
Merged

refactor(parser): Improve DynamoDB models with examples and descriptions #7146

merged 4 commits into from
Aug 18, 2025

Conversation

sreejaaryahi18
Copy link
Contributor

@sreejaaryahi18 sreejaaryahi18 commented Aug 10, 2025 •
edited
Loading

Issue number: #7123

Summary

Added description and examples parameters to all fields in DynamoDB parser models (aws_lambda_powertools/utilities/parser/models/dynamodb.py) using Field().
These additions provide detailed explanations and realistic example values based on AWS DynamoDB official documentation and sample event.

Changes

Please provide a summary of what's being changed

User experience

Before this update, the DynamoDB parser models lacked descriptive metadata and examples, making it harder for users to understand field purposes and expected values.
After this update, developers will have clearer, documented field descriptions and example values that improve usability, reduce confusion, and enhance validation confidence when working with DynamoDB stream events

Please share what the user experience looks like before and after this change

Checklist

If your change doesn't seem to apply, please leave them unchecked.

Is this a breaking change? No

RFC issue number:
#7123

Checklist:

  • Migration process documented
  • Implement warnings (if it can live side by side)

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.

@sreejaaryahi18 sreejaaryahi18 requested a review from a team as a code owner August 10, 2025 14:42
@pull-request-size pull-request-size bot added the size/L Denotes a PR that changes 100-499 lines, ignoring generated files. label Aug 10, 2025
@boring-cyborg boring-cyborg
Copy link

boring-cyborg bot commented Aug 10, 2025

Thanks a lot for your first contribution! Please check out our contributing guidelines and don't hesitate to ask whatever you need.
In the meantime, check out the #python channel on our Powertools for AWS Lambda Discord: Invite link

@sreejaaryahi18 sreejaaryahi18 changed the title #7123 Tech debt: Improve documentation of Event model fields in Dynam… docs(#7123): add descriptions and examples to DynamoDB parser model fields Aug 10, 2025
@leandrodamascena leandrodamascena changed the title docs(#7123): add descriptions and examples to DynamoDB parser model fields refactor(parser): Improve DynamoDB models with examples and descriptions Aug 11, 2025
@leandrodamascena leandrodamascena linked an issue Aug 11, 2025 that may be closed by this pull request
Tech debt: Improve documentation of Event model fields in DynamoDB parser models #7123
Closed
2 tasks
leandrodamascena
leandrodamascena requested changes Aug 11, 2025
View reviewed changes
Copy link
Contributor

@leandrodamascena leandrodamascena left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Hey @sreejaaryahi18 this is a super nice work, thanks a lot for working on this! I just left some few comments that we need to address before merging it.

Please let me know if you need any additional help

@github-actions github-actions bot added documentation Improvements or additions to documentation enhancement labels Aug 11, 2025
@leandrodamascena
Copy link
Contributor

Hey @sreejaaryahi18 can you please run make format and push the code again?

@sreejaaryahi18
Copy link
Contributor Author

Hey @leandrodamascena Ive made the changes, could you check its right now?

@leandrodamascena
Copy link
Contributor

Hey @leandrodamascena Ive made the changes, could you check its right now?

Thanks for addressing all the feedback! I'll review tomorrow!

@github-actions github-actions bot removed the documentation Improvements or additions to documentation label Aug 18, 2025
@sonarqubecloud SonarQubeCloud
Copy link

Quality Gate Passed Quality Gate passed

Issues
3 New issues
0 Accepted issues

Measures
0 Security Hotspots
0.0% Coverage on New Code
0.0% Duplication on New Code

See analysis details on SonarQube Cloud

@codecov Codecov
Copy link

codecov bot commented Aug 18, 2025 •
edited
Loading

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 96.35%. Comparing base (5a4b2a0) to head (436761d).
⚠️ Report is 1 commits behind head on develop.

Additional details and impacted files 
@@           Coverage Diff            @@
##           develop    #7146   +/-   ##
========================================
  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.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

leandrodamascena
leandrodamascena approved these changes Aug 18, 2025
View reviewed changes
Copy link
Contributor

@leandrodamascena leandrodamascena left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Hey @sreejaaryahi18 thanks a lot for working on this PR!

APPROVED!

@leandrodamascena leandrodamascena merged commit d670b6d into aws-powertools:develop Aug 18, 2025
14 checks passed
@boring-cyborg boring-cyborg
Copy link

boring-cyborg bot commented Aug 18, 2025

Awesome work, congrats on your first merged pull request and thank you for helping improve everyone's experience!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@hjgraca hjgraca hjgraca approved these changes

@leandrodamascena leandrodamascena leandrodamascena approved these changes

Assignees

@sreejaaryahi18 sreejaaryahi18

Labels
enhancement size/L Denotes a PR that changes 100-499 lines, ignoring generated files.
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

Tech debt: Improve documentation of Event model fields in DynamoDB parser models
3 participants
@sreejaaryahi18 @leandrodamascena @hjgraca
pFad - Phonifier reborn

Pfad - The Proxy pFad of © 2024 Garber Painting. All rights reserved.

Note: This service is not intended for secure transactions such as banking, social media, email, or purchasing. Use at your own risk. We assume no liability whatsoever for broken pages.


Alternative Proxies:

Alternative Proxy

pFad Proxy

pFad v3 Proxy

pFad v4 Proxy