Announcing OpenAPI-Suite Version 2.0 development

[lscalese]

We are excited to announce the upcoming release of OpenAPI-Suite Version 2.0, a major architectural overhaul that addresses fundamental limitations in the current design and paves the way for future enhancements.

Why Version 2?

The current version of OpenAPI-Suite has served us well, but as we've attempted to add new features and improvements, we've encountered significant limitations in the foundation of the project:

• The direct code generation from OpenAPI specifications has become increasingly difficult to maintain
• Adding support for new features or making modifications to the generated code patterns requires extensive changes
• Edge cases in complex OpenAPI specifications are challenging to handle in the current architecture

Technical Improvements

Version 2.0 introduces a complete redesign of the internal architecture:

1. OpenAPI Simplification & Flattening Layer:

   • Pre-processes complex OpenAPI specifications
   • Normalizes variations and resolves references
   • Creates a consistent structure for further processing

2. Abstract Syntax Tree (AST) Transformation:

   • Converts simplified specifications into an intermediate AST representation
   • Provides a flexible structure that can be traversed, analyzed, and modified
   • Decouples the source specification from the target code generation
   • Enables AI-powered enhancements to improve classnames for nested object definitions, eliminating cryptic naming conventions
   • Allows for intelligent refactoring of the object model while preserving semantic meaning

3. Enhanced ObjectScript Code Generation:

   • Generates code from the AST rather than directly from the OpenAPI spec
   • Results in cleaner, more maintainable code generator
   • Enables easier customization of output formats and patterns

Benefits

This architectural shift will deliver several important benefits:

• Improved Maintainability: Changes to the code generation patterns can be implemented without affecting the parsing logic
• Enhanced Extensibility: Adding support for new OpenAPI features or ObjectScript patterns is significantly easier
• Better Developer Experience: Generated code will be more consistent and predictable
• Future-Proofing: The modular design accommodates future specification changes and new output targets

Timeline

We are currently working on the core architectural components and will be releasing a beta version for testing in the coming months. We welcome community feedback and contributions to help shape this new version.