Skip to content

Conversation

sreejaaryahi18
Copy link
Contributor

@sreejaaryahi18 sreejaaryahi18 commented Sep 8, 2025

Issue number: closes #7121

Summary

Improved the documentation for the CloudWatch parser models by adding descriptions and example values to the fields using Pydantic's Field() function.

Changes

Please provide a summary of what's being changed
Added description and examples to all relevant fields in cloudwatch.py

User experience

Please share what the user experience looks like before and after this change
Before:
Fields in the models didn’t have any inline descriptions, so developers had to refer to external documentation or examples to understand them.
After:
Each field now includes a clear description and realistic example values


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 September 8, 2025 18:29
@pull-request-size pull-request-size bot added the size/M Denotes a PR that changes 30-99 lines, ignoring generated files. label Sep 8, 2025
@github-actions github-actions bot added the feature New feature or functionality label Sep 8, 2025
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 please run make format before pushing a commit.

Copy link

sonarqubecloud bot commented Sep 9, 2025

@leandrodamascena leandrodamascena self-requested a review September 9, 2025 13:03
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.

Thanks for working on this @sreejaaryahi18! Approved.

Copy link

codecov bot commented Sep 9, 2025

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 96.36%. Comparing base (3808bd2) to head (dc3dd9f).
⚠️ Report is 1 commits behind head on develop.

Additional details and impacted files
@@           Coverage Diff            @@
##           develop    #7343   +/-   ##
========================================
  Coverage    96.36%   96.36%           
========================================
  Files          275      275           
  Lines        13007    13007           
  Branches       968      968           
========================================
  Hits         12534    12534           
  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 merged commit 439638c into aws-powertools:develop Sep 9, 2025
14 checks passed
@sreejaaryahi18 sreejaaryahi18 deleted the docs/cloudwatch-event-model-fields-7121 branch September 9, 2025 16:27
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

feature New feature or functionality size/M Denotes a PR that changes 30-99 lines, ignoring generated files.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Tech debt: Improve documentation of Event model fields in CloudWatch parser models

3 participants