You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@rocketmq.apache.org by "Frun1na (via GitHub)" <gi...@apache.org> on 2026/09/22 01:22:01 UTC

[PR] docs: document the query-history and LiteTopic endpoints [rocketmq-dashboard]

Frun1na opened a new pull request, #4827:
URL: https://github.com/apache/rocketmq-dashboard/pull/4827

   ### Which Issue(s) This PR Fixes
   
   - Fixes #ISSUE_ID
   
   ### Brief Description
   
   Two endpoint groups existed in the controllers but were absent from `docs/api-spec.md` — the quick
   reference stops at 98 entries while the controllers expose both groups:
   
   - **8.8 查询历史 (4 endpoints, `QueryHistoryController`)**: the persisted history of message and trace
     queries with their result snapshots — `GET /api/query-history/messages` (paged, `pageSize` capped at
     100 by `validatePage`), `GET /api/query-history/traces`, `GET /api/query-history/summary` and
     `GET /api/query-history/messages/:id/results`. Field tables come from `MessageQueryHistoryVO`,
     `TraceQueryHistoryVO` and `QueryHistorySummaryVO`; the result replay returns the `MessageRecord`
     shape already defined in 8.1.
   - **5.9 LiteTopic 会话管理 (5 endpoints, `LiteTopicController`)**: capability probe, session list /
     detail, TTL extension (`LiteTopicTTLUpdateDTO` requires `topicPattern` + `newTTL`) and quota.
     Field tables come from `LiteTopicItemVO`, `LiteTopicSessionVO`, `LiteTopicQuotaVO` and
     `LiteTopicCapabilityVO`.
   
   Nine rows (99-107) were appended to the quick reference, keeping it consistent with the section count
   as the document's own maintenance rule requires.
   
   ### How Did You Test This Change
   
   Documentation-only change; there is no docs build or spec validation to run. Every endpoint path,
   parameter, requiredness and response field was read back from `QueryHistoryController`,
   `LiteTopicController` and their VOs/DTOs before being written down.
   


-- 
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@rocketmq.apache.org

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


Re: [PR] docs: document the query-history and LiteTopic endpoints [rocketmq-dashboard]

Posted by "Frun1na (via GitHub)" <gi...@apache.org>.
Frun1na closed pull request #4827: docs: document the query-history and LiteTopic endpoints
URL: https://github.com/apache/rocketmq-dashboard/pull/4827


-- 
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@rocketmq.apache.org

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


Re: [PR] docs: document the query-history and LiteTopic endpoints [rocketmq-dashboard]

Posted by "Frun1na (via GitHub)" <gi...@apache.org>.
Frun1na commented on PR #4827:
URL: https://github.com/apache/rocketmq-dashboard/pull/4827#issuecomment-5770077435

   Consolidating the undocumented-endpoints documentation into #4835 (this branch's quick-reference rows and sections are included there), so the specification changes land as one reviewable unit.


-- 
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@rocketmq.apache.org

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