Skip to content

refactor(parser): Improve EventBridge models with examples and descriptions #7090

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

Merged
merged 1 commit into from
Aug 1, 2025

Conversation

leandrodamascena
Copy link
Contributor

Issue number: #7089

Summary

Enhances the EventBridgeModel with field descriptions and examples using Pydantic's Field() functionality. This improvement provides better documentation and metadata for EventBridge event model.

This change is fully backward compatible - no breaking changes to existing validation and serialization process.

Changes

Please provide a summary of what's being changed

User experience

Customers will be able to see examples and description when serializing models.

Checklist

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

Is this a breaking change?

RFC issue number:

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.

@leandrodamascena leandrodamascena requested a review from a team as a code owner August 1, 2025 12:18
@pull-request-size pull-request-size bot added the size/M Denotes a PR that changes 30-99 lines, ignoring generated files. label Aug 1, 2025
@leandrodamascena leandrodamascena self-assigned this Aug 1, 2025
@github-actions github-actions bot added the feature New feature or functionality label Aug 1, 2025
@leandrodamascena leandrodamascena requested review from dreamorosi and removed request for anafalcao August 1, 2025 12:18
Copy link

sonarqubecloud bot commented Aug 1, 2025

@leandrodamascena leandrodamascena changed the title feat(parser): Improve EventBridge models with examples and descriptions refactor(parser): Improve EventBridge models with examples and descriptions Aug 1, 2025
@github-actions github-actions bot added enhancement and removed feature New feature or functionality labels Aug 1, 2025
Copy link

codecov bot commented Aug 1, 2025

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 96.34%. Comparing base (96f30bf) to head (18a46ae).
⚠️ Report is 2 commits behind head on develop.

Additional details and impacted files
@@           Coverage Diff            @@
##           develop    #7090   +/-   ##
========================================
  Coverage    96.34%   96.34%           
========================================
  Files          275      275           
  Lines        12980    12980           
  Branches       965      965           
========================================
  Hits         12505    12505           
  Misses         367      367           
  Partials       108      108           

☔ 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 b8ae35b into develop Aug 1, 2025
19 checks passed
@leandrodamascena leandrodamascena deleted the feat/parser-improvemodels-eventbridge branch August 1, 2025 12:55
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement 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 EventBridge Model
2 participants