Skip to content

docs: add REST API job lifecycle cookbook#10983

Draft
DanielLeens wants to merge 2 commits into
apache:devfrom
DanielLeens:docs-p0-3-rest-api-lifecycle
Draft

docs: add REST API job lifecycle cookbook#10983
DanielLeens wants to merge 2 commits into
apache:devfrom
DanielLeens:docs-p0-3-rest-api-lifecycle

Conversation

@DanielLeens
Copy link
Copy Markdown
Contributor

Purpose

Practical operational guide for managing the full SeaTunnel Zeta REST API job lifecycle, complementing the existing REST API reference docs.

Changes

  • Added docs/en/engines/zeta/rest-api-job-lifecycle.md (EN)
  • Added docs/zh/engines/zeta/rest-api-job-lifecycle.md (ZH)
  • Updated docs/sidebars.js to include the new page inside the REST API category

Coverage

  • Job submission via JSON body (single job, multi-transform examples)
  • Status query: running-job, running-jobs, finished-job, metrics endpoints
  • Log query endpoint
  • Stop / cancel / stop-with-savepoint semantics comparison table
  • Job recovery: restart from latest checkpoint or specified savepoint
  • Authentication: basic auth and bearer token examples
  • Performance considerations (finished-job accumulation, concurrent submission throttling, dynamic port discovery)
  • Common errors and troubleshooting table

Closes #10979 (P0-3)

Add practical REST API job lifecycle guide covering:
- Job submission via JSON body (single job and multi-transform examples)
- Job status query: running, finished, and metrics endpoints
- Log query endpoint usage
- Stop / cancel / stop-with-savepoint semantics comparison table
- Job recovery: restart from checkpoint or specific savepoint path
- Authentication: basic auth and bearer token examples
- Performance considerations: finished-job slowness, concurrent submission throttling
- Common errors and troubleshooting table

Closes apache#10979 (P0-3)
@davidzollo davidzollo marked this pull request as draft May 30, 2026 08:47
@davidzollo
Copy link
Copy Markdown
Contributor

CI Fix: Replace deprecated field names

The Code style CI check is failing because AllFileSpecificationCheckTest forbids source_table_name and result_table_name anywhere in the repo. These were replaced by plugin_input / plugin_output in a previous migration.

Files affected:

  • docs/en/engines/zeta/rest-api-job-lifecycle.md
  • docs/zh/engines/zeta/rest-api-job-lifecycle.md

Fix (16 occurrences, both files):

s/"result_table_name"/"plugin_output"/g
s/"source_table_name"/"plugin_input"/g

The fix commit is available at: https://github.com/davidzollo/seatunnel/tree/fix/pr-10983-ci-fix

You can apply it with:

git fetch https://github.com/davidzollo/seatunnel fix/pr-10983-ci-fix
git cherry-pick FETCH_HEAD

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Projects

None yet

Development

Successfully merging this pull request may close these issues.

[Umbrella][Docs] P0 Documentation Optimization — Tracking

2 participants