[fix] correct localization and example errors in open-api & system-tables docs#3689
Merged
morningman merged 2 commits intoMay 20, 2026
Merged
Conversation
…bles docs Batch of fixes in the open-api (fe-http) and system-tables docs: - table_privileges.md: frontmatter `language` was `zh-CN` for an all-English doc -> `en`. - statistic-action.md: untranslated Chinese (description, `## Description`, `无` values) -> English. - statement-execution-action.md: untranslated Chinese translated; the description referred to a `sql` field but the request body uses `stmt` -> corrected; the undocumented `<ns_name>` path parameter is now documented. - show-meta-info-action.md: Chinese `无` in Path parameters -> `None`. - upload-action.md: Response JSON example was missing a comma after `absPath` (fixed in both EN and ZH copies, as it is a code-syntax error). - column_statistics.md: broken anchor `#viewing-statistics` -> `#viewing-column-statistics` (only the next/4.x versions, whose target heading was renamed). Localization fixes apply only to the English doc tree; the Chinese i18n copies are left as-is. Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
The CI pipeline no longer builds these legacy versions, so changes there cannot be merged. Restore those files to their base state.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
A batch of doc-audit fixes (findings #32-#38) across the open-api (fe-http) and system-tables docs:
system-tables/information_schema/table_privileges.md: frontmatterlanguagewaszh-CNfor an all-English doc →en.open-api/fe-http/statistic-action.md: untranslated Chinese (frontmatterdescription,## Descriptionbody,无parameter values) → English.open-api/fe-http/statement-execution-action.md: untranslated Chinese translated; the description referred to asqlfield but the request body actually usesstmt→ corrected.POST /api/query/<ns_name>/<db_name>has two path params but only<db_name>was documented → added a<ns_name>entry.open-api/fe-http/show-meta-info-action.md: Chinese无in the Path parameters section →None.open-api/fe-http/upload-action.md: the Response JSON example was missing a comma after theabsPathfield (invalid JSON) → comma added. Fixed in both EN and ZH copies since it is a code-syntax error.system-tables/information_schema/column_statistics.md: broken anchorstatistics#viewing-statistics→#viewing-column-statistics(only the next/4.x versions, whose target heading was renamed; 2.1/3.x targets still have the old anchor and are left unchanged).The localization fixes (#32-#36) apply only to the English doc tree; the Chinese
i18n/zh-CNcopies are correctly Chinese and left as-is.Test plan
stmtfield name,withthe<ns_name>param)#viewing-column-statisticsanchor exists in the next/4.x target doc, and the old anchor still exists in 2.1/3.x