You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@seatunnel.apache.org by "DanielLeens (via GitHub)" <gi...@apache.org> on 2026/08/07 03:18:36 UTC

[PR] [Docs][Zeta] Clarify REST API v2 is Zeta-only and document pause/resume/delete [seatunnel]

DanielLeens opened a new pull request, #11680:
URL: https://github.com/apache/seatunnel/pull/11680

   ### Purpose of this pull request
   
   Fixes two REST API v2 documentation gaps surfaced by repeated real user confusion (traced from a
   support-bot Q&A export): both are corrected in this PR, grounded directly in current source.
   
   **1. Wrong engine-support claim.** `docs/{en,zh}/engines/overview.md`'s feature comparison table
   claims `REST API: Flink ✅`. This is incorrect. SeaTunnel's REST API v2
   (`RestHttpGetCommandProcessor` / `RestHttpPostCommandProcessor`) lives exclusively in
   `seatunnel-engine-server`, which only `seatunnel-core/seatunnel-starter` (the Zeta engine's own
   starter) depends on -- `seatunnel-flink-starter` and `seatunnel-spark-starter` do not pull it in.
   Three separate users quoted this exact table back as their source of confusion when asking whether
   REST API v2 works on Flink. Corrected the cell to `❌` and added a `:::note` explaining what "REST
   API" means in that table and pointing to the real REST API V2 doc.
   
   **2. Missing pause/resume/delete guidance.** `rest-api-v2.md` documents `/submit-job` and
   `/stop-job` but never explains how to pause, resume, or delete a job -- users repeatedly asked
   whether such endpoints exist. They don't (verified against the full route list in
   `RestConstant.java`: `overview`, `running-jobs`, `job-info`, `finished-jobs`, `encrypt-config`,
   `submit-job(s)`, `stop-job(s)`, `update-tags`, `logs`, `metrics`, `jobs/checkpoints*` -- no
   pause/resume/delete). Added a "Pause, Resume Or Delete A Job" section documenting the equivalent
   flow: `/stop-job` with `isStopWithSavePoint: true` to pause, `/submit-job` again with the same
   `jobId` and `isStartWithSavePoint: true` to resume (verified `JobInfoService.submitJob` throws
   `"Please provide jobId when start with save point."` when `jobId` is omitted in that case), and
   `history-job-expire-minutes`-based automatic cleanup in place of a delete endpoint. Also added a
   one-line `:::tip` at the top of the doc stating the API is Zeta-only, matching fix 1.
   
   Both `docs/en` and `docs/zh` are updated in lockstep for both files.
   
   ### Does this PR introduce _any_ user-facing change?
   
   No functional change. Documentation-only correction and addition; no config, API, or behavior
   changes.
   
   ### How was this patch tested?
   
   Documentation-only change (no Java/module code touched), so `./mvnw spotless:apply` is a no-op here
   -- confirmed the root `pom.xml` spotless config only formats `<java>` and `<pom>`, not markdown.
   Every factual claim added or changed was verified directly against the current `dev` HEAD source
   rather than existing docs:
   - `seatunnel-core/seatunnel-starter/pom.xml`, `seatunnel-core/seatunnel-flink-starter/pom.xml`,
     `seatunnel-core/seatunnel-spark-starter/pom.xml`: confirmed only `seatunnel-starter` depends on
     `seatunnel-engine-server`.
   - `seatunnel-engine/.../rest/RestConstant.java`, `RestHttpGetCommandProcessor.java`,
     `RestHttpPostCommandProcessor.java`: confirmed the full endpoint list and absence of
     pause/resume/delete routes.
   - `seatunnel-engine/.../rest/service/JobInfoService.java`: confirmed the exact `jobId`-required
     error message for `isStartWithSavePoint`.
   - Cross-reference anchors (`#stop-a-job`, `#submit-a-job`, `#44-history-job-expiry-configuration`,
     and their zh equivalents) checked against the current heading text in both files.
   
   ### Check list
   
   * [x] No new JAR binary package is added.
   * [x] English and Chinese documentation both updated.
   * [x] No incompatible configuration or API change is introduced (docs-only).
   * [x] N/A -- documentation-only change, no test coverage applicable.


-- 
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: commits-unsubscribe@seatunnel.apache.org

For queries about this service, please contact Infrastructure at:
users@infra.apache.org


Re: [PR] [Docs][Zeta] Clarify REST API v2 is Zeta-only and document pause/resume/delete [seatunnel]

Posted by "davidzollo (via GitHub)" <gi...@apache.org>.
davidzollo merged PR #11680:
URL: https://github.com/apache/seatunnel/pull/11680


-- 
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: commits-unsubscribe@seatunnel.apache.org

For queries about this service, please contact Infrastructure at:
users@infra.apache.org