wenjin272 opened a new issue, #1055: URL: https://github.com/apache/flink-agents/issues/1055
### Search before asking - [x] I searched in the [issues](https://github.com/apache/flink-agents/issues) and found nothing similar. ### Description The [Flink Agents 0.4 roadmap](https://github.com/apache/flink-agents/discussions/862) calls for a comprehensive review of the existing APIs and an API compatibility mechanism. As Flink Agents matures toward 1.0, the 0.4 release may be the last planned opportunity for broad breaking changes. We should use this window to make the public APIs more mature, consistent, and easy to use, and then establish a stable compatibility baseline for future releases. This umbrella issue tracks the overall API review. Detailed proposals and implementation work should be tracked in child issues and linked here. #### Scope - Audit the public Java, Python, and YAML API surfaces. - Review naming, abstractions, types, configuration, lifecycle, extension points, defaults, validation, and error handling from a user's perspective. - Verify semantic consistency across Java, Python, YAML, and cross-language boundaries. - Identify APIs that should be simplified, consolidated, deprecated, removed, or redesigned before 1.0. - For each proposed breaking change, document the rationale, user impact, and migration path in a child issue. - Define the compatibility approach after 0.4, including API stability classification, deprecation policy, and compatibility validation where applicable. - Update documentation, examples, migration guidance, and tests for accepted changes. #### Tracking - [ ] Inventory and classify the existing public API surface. - [ ] Create and link component-specific review issues. - [ ] Review API proposals and agree on the changes targeted for 0.4. - [ ] Implement the accepted API changes. - [ ] Define and document the post-0.4 API compatibility mechanism. - [ ] Complete API documentation, migration notes, examples, and validation. #### Child issues Child issues will be added here as the review progresses. ### Are you willing to submit a PR? - [ ] I'm willing to submit a PR! -- This is an automated message from the Apache Git Service. To respond to the message, please log on to GitHub and use the URL above to go to the specific comment. To unsubscribe, e-mail: [email protected] For queries about this service, please contact Infrastructure at: [email protected]
