[DOC] Complete the internal_api_server api document by maobaolong · Pull Request #2617 · LMCache/LMCache

maobaolong · 2026-02-19T03:25:39Z

What this PR does / why we need it:

Organized internal api server's various endpoints into logical categories: Common, Controller, and vLLM/Inference. It provides comprehensive details for each API, including methods, paths, parameters, and example responses, making it easier for developers to understand and utilize the server's functionalities. The main API server overview has also been refined to reflect this new structure and guide users on extending the API server.

Special notes for your reviewers:

If applicable:

this PR contains user facing changes - docs added
this PR contains unit tests

Signed-off-by: baoloongmao <baoloongmao@tencent.com>

gemini-code-assist · 2026-02-19T03:25:55Z

Summary of Changes

Hello @maobaolong, I'm Gemini Code Assist¹! I'm currently reviewing this pull request and will post my feedback shortly. In the meantime, here's a summary to help you and other reviewers quickly get up to speed!

This pull request significantly enhances the documentation for the internal API server by organizing its various endpoints into logical categories: Common, Controller, and vLLM/Inference. It provides comprehensive details for each API, including methods, paths, parameters, and example responses, making it easier for developers to understand and utilize the server's functionalities. The main API server overview has also been refined to reflect this new structure and guide users on extending the API server.

Highlights

New API Documentation Files: Introduced dedicated documentation files for common, controller-specific, and vLLM/inference-specific internal APIs, providing detailed descriptions, parameters, and example responses for each endpoint.
API Categorization and Structure: The main internal API server documentation was restructured to categorize APIs into Common, vLLM/Inference, and Controller sections, improving navigability and clarity.
Updated API Server Overview: The internal_api_server.rst file was updated to provide a high-level overview of the API server's purpose and how APIs are organized, along with new sections on port assignment and how to extend the server with new endpoints.
Removed Outdated Testing Information: Obsolete sections detailing how to test the server and specific endpoint examples were removed from the main documentation, as these are now covered in the new, categorized API documentation.

🧠 New Feature in Public Preview: You can now enable Memory to help Gemini Code Assist learn from your team's feedback. This makes future code reviews more consistent and personalized to your project's style. Click here to enable Memory in your admin console.

Changelog

docs/source/internal_api_server/common_apis.rst
- Added a new documentation file detailing common internal APIs such as /env, /loglevel, /metrics, /threads, and /run_script.
docs/source/internal_api_server/controller_apis.rst
- Added a new documentation file for controller-specific internal APIs, including /controller/key-stats and /controller/workers.
docs/source/internal_api_server/internal_api_server.rst
- Updated the main internal API server documentation to categorize APIs into Common, vLLM/Inference, and Controller sections.
- Removed the outdated 'Testing the Server' section and specific endpoint examples.
- Added new documentation sections covering port assignment, API category and route discovery, and instructions for extending the server.
docs/source/internal_api_server/vllm_apis.rst
- Added a new documentation file for vLLM/Inference-specific internal APIs, covering version information, configuration, metadata, cache operations, freeze mode, and chunk statistics.

Activity

No specific activity (comments, reviews, etc.) was provided in the context for this pull request.

Using Gemini Code Assist

The full guide for Gemini Code Assist can be found on our documentation page, here are some quick tips.

Invoking Gemini

You can request assistance from Gemini at any point by creating a comment using either /gemini <command> or @gemini-code-assist <command>. Below is a summary of the supported commands on the current page.

Feature	Command	Description
Code Review	`/gemini review`	Performs a code review for the current pull request in its current state.
Pull Request Summary	`/gemini summary`	Provides a summary of the current pull request in its current state.
Comment	@gemini-code-assist	Responds in comments when explicitly tagged, both in pull request comments and review comments.
Help	`/gemini help`	Displays a list of available commands.

Customization

To customize Gemini Code Assist for GitHub experience, repository maintainers can create a configuration file and/or provide a custom code review style guide (such as PEP-8 for Python) by creating and adding files to a .gemini/ folder in the base of the repository. Detailed instructions can be found here.

Limitations & Feedback

Gemini Code Assist may make mistakes. Please leave feedback on any instances where its feedback is incorrect or counter productive. You can react with 👍 and 👎 on @gemini-code-assist comments. If you're interested in giving your feedback about your experience with Gemini Code Assist for Github and other Google products, sign up here.

You can also get AI-powered code generation, chat, as well as code reviews directly in the IDE at no cost with the Gemini Code Assist IDE Extension.

Review the Privacy Notices, Generative AI Prohibited Use Policy, Terms of Service, and learn how to configure Gemini Code Assist in GitHub here. Gemini can make mistakes, so double check it and use code with caution. ↩

gemini-code-assist

Code Review

The pull request introduces comprehensive API documentation for the internal API server, categorizing endpoints into Common, vLLM/Inference, and Controller APIs. It also refactors the main internal_api_server.rst file to provide a better overview and links to these new detailed API documents. The changes significantly improve the clarity and discoverability of the internal APIs. I've identified a few areas for improvement regarding consistency in response types and error handling documentation.

Signed-off-by: baoloongmao <baoloongmao@tencent.com>

maobaolong · 2026-02-19T06:46:50Z

@sammshen @chunxiaozheng Would you like to help to review this document? Thanks!

sammshen

LGTM!

chunxiaozheng

lgtm

* [DOC] Complete the internal_api_server api document Signed-off-by: baoloongmao <baoloongmao@tencent.com> * doc: Fix API response content-type from text/plain to application/json Signed-off-by: baoloongmao <baoloongmao@tencent.com> --------- Signed-off-by: baoloongmao <baoloongmao@tencent.com> Signed-off-by: DongDongJu <commisori28@gmail.com>

* [DOC] Complete the internal_api_server api document Signed-off-by: baoloongmao <baoloongmao@tencent.com> * doc: Fix API response content-type from text/plain to application/json Signed-off-by: baoloongmao <baoloongmao@tencent.com> --------- Signed-off-by: baoloongmao <baoloongmao@tencent.com>

* [DOC] Complete the internal_api_server api document Signed-off-by: baoloongmao <baoloongmao@tencent.com> * doc: Fix API response content-type from text/plain to application/json Signed-off-by: baoloongmao <baoloongmao@tencent.com> --------- Signed-off-by: baoloongmao <baoloongmao@tencent.com> Signed-off-by: shaoxiawjc <wjc2800@163.com>

[DOC] Complete the internal_api_server api document

534031b

Signed-off-by: baoloongmao <baoloongmao@tencent.com>

maobaolong added the documentation Improvements or additions to documentation label Feb 19, 2026

gemini-code-assist Bot reviewed Feb 19, 2026

View reviewed changes

Comment thread docs/source/internal_api_server/common_apis.rst Outdated

Comment thread docs/source/internal_api_server/vllm_apis.rst

Comment thread docs/source/internal_api_server/vllm_apis.rst Outdated

maobaolong requested a review from sammshen February 19, 2026 03:27

doc: Fix API response content-type from text/plain to application/json

0ea1f9d

Signed-off-by: baoloongmao <baoloongmao@tencent.com>

maobaolong added the full Run comprehensive tests on this PR label Feb 19, 2026

maobaolong enabled auto-merge (squash) February 19, 2026 06:46

sammshen approved these changes Feb 19, 2026

View reviewed changes

sammshen mentioned this pull request Feb 19, 2026

[Refactor]: Northbound #2458

Open

12 tasks

chunxiaozheng approved these changes Feb 19, 2026

View reviewed changes

maobaolong merged commit 4291495 into LMCache:dev Feb 19, 2026
29 of 30 checks passed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[DOC] Complete the internal_api_server api document#2617

[DOC] Complete the internal_api_server api document#2617
maobaolong merged 2 commits intoLMCache:devfrom
maobaolong:internal_api_server_api

maobaolong commented Feb 19, 2026 •

edited

Loading

Uh oh!

gemini-code-assist Bot commented Feb 19, 2026

Uh oh!

gemini-code-assist Bot left a comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

maobaolong commented Feb 19, 2026

Uh oh!

sammshen left a comment

Uh oh!

chunxiaozheng left a comment

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

Conversation

maobaolong commented Feb 19, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

gemini-code-assist Bot commented Feb 19, 2026

Summary of Changes

Highlights

Footnotes

Uh oh!

gemini-code-assist Bot left a comment

Choose a reason for hiding this comment

Code Review

Uh oh!

Uh oh!

Uh oh!

Uh oh!

maobaolong commented Feb 19, 2026

Uh oh!

sammshen left a comment

Choose a reason for hiding this comment

Uh oh!

chunxiaozheng left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

maobaolong commented Feb 19, 2026 •

edited

Loading