docs: remove query_detail open API documentation#3731
Conversation
|
run buildall |
|
/review |
|
run buildall |
|
/review |
![github-actions[bot]](https://avatars.githubusercontent.com/in/15368?s=60&v=4){kind=small}
There was a problem hiding this comment.
I found one issue: the PR removes the query_detail page from historical 1.2 and 2.0 docs, but the corresponding Doris source branches still expose GET /api/query_detail via fe/fe-core/src/main/java/org/apache/doris/httpv2/rest/QueryDetailAction.java.
Checkpoint conclusions from AGENTS.md:
- Goal: remove docs for an API endpoint that is gone from current supported code. This is satisfied for
current,4.x,3.x, and2.1; it is not satisfied for 1.2/2.0 because the endpoint still exists there. - Scope: the change is mechanically focused, but it overreaches by deleting valid historical-version content.
- Documentation information architecture: active versions/locales are updated consistently, but 1.2/2.0 English and zh docs plus their sidebar entries should be preserved unless those archived docs are intentionally being desupported.
- Links, redirects, and navigation: in-repo searches did not find remaining references to
query-detail-actionor/api/query_detail; sidebar entries were removed consistently, but the 1.2/2.0 sidebar removals are part of the issue above. No redirect was added for deleted active pages; this may be acceptable only if there is no suitable replacement page for the removed API. - Docusaurus/frontend/build scripts: not applicable; this PR only changes docs and sidebars.
- Validation:
git diff --checkpassed; modified versioned sidebar JSON files parse successfully; targeted text search found no remaining exact references.yarn docs:links:changedcould not run in this runner because dependencies are not installed (Cannot find module 'gray-matter'). I also checked Doris source branches:master,branch-4.0,branch-3.0, andbranch-2.1do not containQueryDetailAction, whilebranch-2.0andbranch-1.2-ltsdo. - Other issues: no additional correctness, usability, accessibility, SEO, or maintainability issues found beyond the historical version deletion.
|
|
||
| ## Request | ||
|
|
||
| `GET /api/query_detail` |
There was a problem hiding this comment.
This deletion looks incorrect for the 1.2 docs. The corresponding Doris branch-1.2-lts source still contains fe/fe-core/src/main/java/org/apache/doris/httpv2/rest/QueryDetailAction.java with @RequestMapping(path = "/api/query_detail", method = RequestMethod.GET), so 1.2 users still need this version-specific API reference. Please keep the 1.2 English/zh pages and sidebar entries unless the archived 1.2 docs are intentionally being desupported.
|
|
||
| ## Request | ||
|
|
||
| `GET /api/query_detail` |
There was a problem hiding this comment.
This deletion looks incorrect for the 2.0 docs. The corresponding Doris branch-2.0 source still contains fe/fe-core/src/main/java/org/apache/doris/httpv2/rest/QueryDetailAction.java with @RequestMapping(path = "/api/query_detail", method = RequestMethod.GET), so 2.0 users still need this version-specific API reference. Please keep the 2.0 English/zh pages and sidebar entries unless the archived 2.0 docs are intentionally being desupported.
#3742) ## Summary - `build-check.yml` previously forwarded every version segment it found in changed file paths straight to Docusaurus' `onlyIncludeVersions`. Touching files under retired version dirs (e.g. `versioned_docs/version-1.2/`, `version-2.0/`) made the build fail with `unknown versions (1.2,2.0) found`, even when those files were just being deleted. - This change intersects the detected versions with the active set (`current` + entries from `versions.json`) before building. Retired/unknown versions are logged and skipped; if everything is retired, we fall back to a minimal `4.x` build so the workflow still validates the site. ## Repro PR #3731 (deletes `query_detail` doc from every version dir including 1.2 and 2.0) failed with: ``` Invalid docs option "onlyIncludeVersions": unknown versions (1.2,2.0) found. Available version names are: current, 4.x, 3.x, 2.1 ``` Failed job: https://github.com/apache/doris-website/actions/runs/26280229035/job/77354293705?pr=3731 ## Test plan - [ ] Local simulation with PR #3731's changed-file list now produces `DOCS_VERSIONS=current,4.x,3.x,2.1` and logs `Ignoring changes to retired/unknown versions: 2.0,1.2`. - [ ] CI of this PR passes (only `.github/workflows/build-check.yml` changes; this PR itself touches no doc versions, so the workflow takes the minimal `4.x` fallback branch — verify by reading the `=== Build plan ===` line in the job log). - [ ] After merge, re-run CI on #3731 and confirm it goes green without reverting the 1.2/2.0 file deletions. Co-authored-by: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
Remove all query-detail-action docs across all versions and locales: - Delete 16 markdown files from docs/, versioned_docs/, i18n/zh-CN/, and ja-source/ - Remove sidebar entries from sidebars.ts and all versioned_sidebars/*.json files Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
morningman
force-pushed
the
remove-query-detail
branch
from
3e45c48 to
3c37930
Compare
3 participants
Summary
Remove all documentation for the
query_detail(QueryDetailAction) open API endpoint across all versions and locales.Changes
docs/(current)versioned_docs/(versions 1.2, 2.0, 2.1, 3.x, 4.x)i18n/zh-CN/(all versions + current)ja-source/(versions 2.1, 3.x, 4.x + current)sidebars.tsand allversioned_sidebars/*.jsonfiles