You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@bookkeeper.apache.org by "Shawyeok (via GitHub)" <gi...@apache.org> on 2026/05/25 08:12:32 UTC

[PR] Issue 4795: docs: fix missing HTTP API endpoints in versioned admin REST API docs [bookkeeper]

Shawyeok opened a new pull request, #4796:
URL: https://github.com/apache/bookkeeper/pull/4796

   Descriptions of the changes in this PR:
   
   Fix #4795
   
   ### Motivation
   
   Several HTTP API endpoints implemented in `HttpRouter.java` were 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.5` tags):
   - `/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.3` tags):
   - `/api/v1/bookie/state/readonly` (GET + PUT)
   - `/api/v1/autorecovery/status` (GET + PUT)
   - `forceMajor` / `forceMinor` optional parameters on `PUT /api/v1/bookie/gc`
   - Fixed misaligned Markdown table separators
   
   Note: `suspend_compaction`, `resume_compaction`, `sanity`, and `entry_location_compact` were intentionally **not** added to 4.14.8 / 4.15.5 — those endpoints did not exist in `HttpRouter.java` at those release tags.
   
   > ---
   > - [x] Make sure the PR title is formatted like:
   >     `<Issue #>: Description of pull request`
   > - [ ] Make sure tests pass via `mvn clean apache-rat:check install spotbugs:check`.
   > - [x] Replace `<Issue #>` in the title with the actual Issue number.
   >
   > ---


-- 
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

To unsubscribe, e-mail: commits-unsubscribe@bookkeeper.apache.org

For queries about this service, please contact Infrastructure at:
users@infra.apache.org