Skip to content

Conversation

leandrodamascena
Copy link
Contributor

Issue number: #7091

Summary

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

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:32
@pull-request-size pull-request-size bot added the size/L Denotes a PR that changes 100-499 lines, ignoring generated files. label Aug 1, 2025
@leandrodamascena leandrodamascena linked an issue Aug 1, 2025 that may be closed by this pull request
2 tasks
@leandrodamascena leandrodamascena self-assigned this Aug 1, 2025
@leandrodamascena leandrodamascena requested review from dreamorosi and removed request for anafalcao August 1, 2025 12:36
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 (b8ae35b) to head (cd3ed80).
⚠️ Report is 1 commits behind head on develop.

Additional details and impacted files
@@           Coverage Diff            @@
##           develop    #7092   +/-   ##
========================================
  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 8096018 into develop Aug 1, 2025
9 of 10 checks passed
@leandrodamascena leandrodamascena deleted the feat/parser-improvemodels-kinesis branch August 1, 2025 12:56
Copy link

sonarqubecloud bot commented Aug 1, 2025

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement size/L Denotes a PR that changes 100-499 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 Kinesis Models
2 participants