goutamadwant commented on issue #11072: URL: https://github.com/apache/seatunnel/issues/11072#issuecomment-6246395950
@amimardev thanks for raising this request. I have the first slice ready for review. In case you have something ready, pls send us through and we can discuss on using the changes. @davidzollo @DanielLeens This feature has a good community value as below **Community value:** Client and monitoring-tool authors can use an accurate, machine-readable contract for these reads, including the current field types, tag filters, and optional Basic authentication. Drift checks keep it aligned as contributors add endpoints, without changing existing REST behavior. For the first PR ( #12856 ) below is the scope : 1. **Scope:** The spec covers only the existing read-only Zeta REST v2 endpoints `GET /overview` and `GET /resource/workers`. It does not imply coverage of the remaining REST v2 routes. 2. **Keeping it in sync:** The YAML is maintained in the SeaTunnel repository. A JUnit guard checks the two documented paths and methods against `RestConstant`, `JettyService` registrations, their servlet GET handlers, and serialized response fields. A local HTTP integration test also checks the live response shapes, tag filtering, and configured Basic authentication. Adding another route requires an explicit spec and test update. 3. **Docs entry:** The English and Chinese REST v2 reference pages link to the same YAML spec. The website sync and production builds were checked locally; both rendered links resolve to files identical to the source YAML. Let me know if the direction looks good and in case have any suggestions/inputs. thanks! -- 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]
