Skip to content

[fix] restore correct content for compaction-run BE HTTP API doc#3679

Merged
morningman merged 1 commit into
apache:masterfrom
boluor:fix-compaction-run-doc-content
May 19, 2026
Merged

[fix] restore correct content for compaction-run BE HTTP API doc#3679
morningman merged 1 commit into
apache:masterfrom
boluor:fix-compaction-run-doc-content

Conversation

@boluor
Copy link
Copy Markdown
Contributor

@boluor boluor commented May 19, 2026

Summary

The admin-manual/open-api/be-http/compaction-run.md doc in the English next and 4.x versions had been overwritten with a verbatim copy of the Disk Capacity Management doc — wrong title/sidebar_label/frontmatter and a body entirely about disk capacity, with nothing about the compaction API.

Restored the correct "Manually Trigger Compaction" content (documenting the POST /api/compaction/run BE HTTP API) from the version-3.x doc, which is identical to version-2.1 and consistent with the Chinese versions.

Scope: only English docs/ (next) and versioned_docs/version-4.x were affected. English 2.0/2.1/3.x and all Chinese versions were already correct and are untouched.

This also resolves a secondary inconsistency in the wrongly-placed content (BE Parameter section mixed capacity_*_flood_stage and storage_flood_stage_* parameter names) — that content is removed entirely by the restore.

Test plan

  • Confirmed EN 2.1/3.x and all ZH compaction-run.md already have the correct compaction API content
  • Confirmed EN next and 4.x were byte-identical copies of the disk-capacity doc
  • Restored content matches the /api/compaction/run API documented in the other versions

The `compaction-run.md` doc in the English next and 4.x versions had
been overwritten with a duplicate of the Disk Capacity Management doc —
wrong title, frontmatter and body, none of it about the compaction API.
Restored the correct "Manually Trigger Compaction" content (the
`/api/compaction/run` API) from the version-3.x doc, which is identical
to 2.1 and matches the Chinese versions. English 2.0/2.1/3.x and all
Chinese versions were already correct.

Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
@morningman morningman merged commit 566fafe into apache:master May 19, 2026
3 checks passed
@boluor boluor deleted the fix-compaction-run-doc-content branch May 21, 2026 12:21
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants