goutamadwant opened a new pull request, #12856:
URL: https://github.com/apache/seatunnel/pull/12856
<!--
Thank you for contributing to SeaTunnel! Please make sure that your code
changes
are covered with tests. And in case of new features or big changes
remember to adjust the documentation.
Feel free to ping committers for the review!
## Contribution Checklist
- Make sure that the pull request corresponds to a [GITHUB
issue](https://github.com/apache/seatunnel/issues).
- Name the pull request in the form "[Feature] [component] Title of the
pull request", where *Feature* can be replaced by `Hotfix`, `Bug`, etc.
- Minor fixes should be named following this pattern: `[hotfix] [docs] Fix
typo in README.md doc`.
-->
### Purpose of this pull request
This contribution adds an initial OpenAPI 3.1 contract for the existing `GET
/overview` and `GET /resource/workers` Zeta REST v2 endpoints.
It addresses the first-delivery scope discussed in #11072; the issue remains
open for the other endpoints and any later client-generation work.
The contract describes the current response field types, free-form
worker-tag query keys, optional Basic authentication, and the unavailable
worker snapshot. A test keeps these two documented paths and methods aligned
with `RestConstant`, `JettyService`, their GET handlers, and serialized
response fields. The existing HTTP integration test also exercises both routes
through Jetty. English and Chinese REST v2 documentation links point to the
same maintained YAML file.
The only added dependency is the already version-managed Jackson YAML parser
in **test scope**, so the contract check can parse the document structurally.
No production REST handler, response, or runtime dependency changes.
### Does this PR introduce _any_ user-facing change?
Yes. Consumers can download a machine-readable contract for these two
read-only operations from the REST v2 documentation and use it with OpenAPI
tooling. The existing endpoints and their wire behavior are unchanged. The
contract does not claim coverage of other REST v2 routes.
### How was this patch tested?
- `RestApiHttpBasicTest`, `TestOpenApiV2RouteSync`, and
`WorkerResourceServletTest`: 9 tests passed on JDK 11 and 9 on JDK 17. The live
Jetty test checks response shapes, tag filtering, and Basic-auth behavior.
- The touched module's JDK 17 `verify` build passed with tests skipped; the
focused tests above were run separately.
- The YAML passed OpenAPI 3.1 schema validation and OpenAPI Generator 7.26.0
validation. A generated Python client smoke check passed for both operations,
tag-query serialization, and representative response parsing.
- The SeaTunnel website sync and English/Chinese production builds passed.
Each rendered documentation link resolves to a YAML asset identical to the
source file.
Repository-wide offline `verify` could not complete because the local Maven
cache lacks the Debezium DB2 artifact. The full test suite, other language
generators, and upstream CI have not been run.
### Check list
* [x] If any new Jar binary package adding in your PR, please add License
Notice according to the [New License
Guide](https://github.com/apache/seatunnel/blob/dev/docs/en/developer/new-license.md).
Not applicable; no binary JAR was added.
* [x] If necessary, please update the documentation to describe the new
feature. Updated the English and Chinese REST v2 documentation.
* [x] If necessary, please update `incompatible-changes.md` to describe the
incompatibility caused by this PR. Not applicable; no existing behavior changes.
* [x] If you are contributing the connector code, please check that the
following files are updated. Not applicable; no connector code changes.
1. Update
[plugin-mapping.properties](https://github.com/apache/seatunnel/blob/dev/plugin-mapping.properties)
and add new connector information in it.
2. Update the pom file of
[seatunnel-dist](https://github.com/apache/seatunnel/blob/dev/seatunnel-dist/pom.xml).
3. Add ci label in
[label-scope-conf](https://github.com/apache/seatunnel/blob/dev/.github/workflows/labeler/label-scope-conf.yml).
4. Add e2e testcase in
[seatunnel-e2e](https://github.com/apache/seatunnel/tree/dev/seatunnel-e2e/seatunnel-connector-v2-e2e/).
5. Update connector
[plugin_config](https://github.com/apache/seatunnel/blob/dev/config/plugin_config).
--
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]
