refactor(parser): Improve Kafka models with examples and descriptions

[dcabib]

Issue number: #7118

Summary

Enhances the Kafka parser models with field descriptions and examples using Pydantic's Field() functionality. This improvement provides better documentation and metadata for Kafka event parsing, following the pattern established in PR #7100.

Changes

• Added Field() descriptions and examples to all Kafka parser model classes:

  • KafkaRecordSchemaMetadata - Schema registry metadata with format and ID documentation
  • KafkaRecordModel - Individual Kafka record structure with comprehensive field explanations
  • KafkaBaseEventModel - Base event model with bootstrap servers and records mapping
  • KafkaSelfManagedEventModel - Self-managed Kafka event source identifier
  • KafkaMskEventModel - AWS MSK-specific event model with cluster ARN

• All field descriptions are based on official AWS MSK and Kafka Lambda documentation

• Examples sourced from actual test events (kafkaEventMsk.json, kafkaEventSelfManaged.json)

• Maintains 100% backward compatibility - no breaking changes to type annotations or validation logic

• Preserves all existing field validators for proper data processing

User experience

Customers will be able to see examples and descriptions when using Kafka parser models, providing:

• Rich IntelliSense with field descriptions and realistic examples
• Self-documenting code without needing external AWS documentation
• Professional API documentation via .model_json_schema()
• Faster development with immediate reference for acceptable values
• Clear understanding of MSK vs self-managed Kafka differences

Checklist

• Meet tenets criteria
• I have performed a self-review of this change
• Changes have been tested (all existing tests pass)
• Changes are documented (via Field descriptions)
• PR title follows conventional commit semantics

Is this a breaking change? No

---

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.

Closes #7118

[sonarqubecloud]

Quality Gate passed

Issues
0 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 Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 96.35%. Comparing base (4c24ee7) to head (82005ee).
⚠️ Report is 2 commits behind head on develop.

Additional details and impacted files

@@           Coverage Diff            @@
##           develop    #7293   +/-   ##
========================================
  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]

Thanks @dcabib! Approved!