Skip to content

Releases: insspb/asyncapi3

[0.0.2] Update `PatternedRootModel` methods and use it as unified strict patterned object key validation

14 Jan 14:30
75d4622

Choose a tag to compare

What's Changed

  • Update: pyproject.toml to correct pypi metadata by @insspb in #3
  • Changed: Sync regex pattern for key validation between objects in root and components by @insspb in #4
  • Fix: Remove __getattr__ access type from PatternedRootModel and child models by @insspb in #5

Full Changelog: https://github.com/insspb/asyncapi3/blob/main/CHANGELOG.md#002---2026-01-14

[0.0.1] First Public Release

11 Jan 20:43
722f1bf

Choose a tag to compare

Release Notes - 0.0.1

🎉 First Public Release

We're excited to announce the first public release of AsyncAPI3 - a complete Python
object model for the AsyncAPI 3.0 specification!

✨ Key Highlights

  • Complete AsyncAPI 3.0 specification coverage with Pydantic v2 models
  • 18+ messaging protocols supported - Full bindings for AMQP, MQTT, Kafka, etc.
  • 100% test coverage with comprehensive validation guarantees
  • Type-safe development with MyPy support and runtime validation
  • Production-ready codebase with modern tooling and CI/CD pipeline

📦 What's Included

This release provides the complete AsyncAPI 3.0 object model implementation:

  • All core AsyncAPI objects (Info, Channels, Operations, Messages, etc.)
  • Full protocol bindings support (see README.md for complete list)
  • Comprehensive test suite with 100% coverage

⚠️ Early Development Notice

This is version 0.0.1 - the first public release. While we've implemented
comprehensive AsyncAPI 3.0 specification coverage with extensive testing, please be aware:

  • Potential bugs may exist in edge cases or complex scenarios
  • API may change in future versions as we refine the interface based on user feedback

Get involved! Please report bugs
and share your use cases in our GitHub issues.
Your feedback helps us prioritize features and fix issues that matter most to you!

🔧 Key Features

Validation Behavior

All models use special Pydantic configuration ensuring data integrity:

  • validate_assignment=True - Field assignments are validated
  • revalidate_instances="always" - Nested models stay consistent
  • extra="allow" - Extensions are supported while maintaining validation

Serialization Consistency

  • Automatic camelCase conversion for JSON output
  • Snake_case Python API following PEP8
  • Reference resolution and proper $ref handling

Type Safety

  • Full MyPy support with strict typing
  • Pydantic v2 features for better validation
  • Comprehensive error messages

📋 Known Limitations

This initial release focuses on core AsyncAPI 3.0 functionality. Some features are
planned for future releases:

  • CLI tool for specification validation
  • Advanced schema validation features
  • Additional tooling and integrations

🤝 Contributing

We welcome contributions! The project follows modern Python development practices:

  • Code quality: Ruff linting and MyPy type checking
  • Testing: Comprehensive pytest suite
  • CI/CD: Automated checks on all PRs

📚 Documentation