Issue 4795: docs: fix missing HTTP API endpoints in versioned admin REST API docs#4796
Open
Shawyeok wants to merge 1 commit into
Open
Conversation
Several HTTP endpoints implemented in HttpRouter.java were absent from the versioned admin REST API documentation. Each version's doc was verified against its corresponding git tag to ensure only endpoints actually present in that release are documented. Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
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
1 participant
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.
Descriptions of the changes in this PR:
Fix #4795
Motivation
Several HTTP API endpoints implemented in
HttpRouter.javawere absent from the versioned admin REST API documentation pages (site3/website/versioned_docs/version-*/admin/http.md). Each version's doc was audited against its corresponding git tag to ensure only endpoints actually present in that release are documented.Changes
version-4.14.8 and version-4.15.5 — added missing endpoints (verified against
release-4.14.8/release-4.15.5tags):/api/v1/bookie/cluster_info/api/v1/bookie/state/readonly(GET + PUT)/api/v1/autorecovery/status(GET + PUT)version-4.16.7 and version-4.17.3 — added missing endpoints (verified against
release-4.16.7/release-4.17.3tags):/api/v1/bookie/state/readonly(GET + PUT)/api/v1/autorecovery/status(GET + PUT)forceMajor/forceMinoroptional parameters onPUT /api/v1/bookie/gcNote:
suspend_compaction,resume_compaction,sanity, andentry_location_compactwere intentionally not added to 4.14.8 / 4.15.5 — those endpoints did not exist inHttpRouter.javaat those release tags.