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:27 UTC
[I] [Bug] api-spec omits the query-history and LiteTopic endpoint groups entirely [rocketmq-dashboard]
Frun1na opened a new issue, #4828:
URL: https://github.com/apache/rocketmq-dashboard/issues/4828
### Before Creating the Bug Report
- [x] I have searched the [open issues](https://github.com/apache/rocketmq-dashboard/issues) and found no similar issue.
### What Happened
Two endpoint groups are missing from `docs/api-spec.md` entirely, although the controllers expose them
and the web client uses them:
- `QueryHistoryController` (4 endpoints under `/api/query-history`): the persisted message/trace query
history with result-snapshot replay.
- `LiteTopicController` (5 endpoints under `/api/liteTopic`): LiteTopic capability probe, session
list/detail, TTL extension and quota.
The document's own quick reference stops at 98 entries and contains neither group, so API consumers
cannot discover these endpoints, their parameters or response fields from the specification.
### Expected Behavior
The two groups should be documented (with the quick reference extended accordingly), with request
parameters, requiredness from the validation annotations, and response fields taken from the
controllers and their VOs.
--
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.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
Re: [I] [Bug] api-spec omits the query-history and LiteTopic endpoint groups entirely [rocketmq-dashboard]
Posted by "RockteMQ-AI (via GitHub)" <gi...@apache.org>.
RockteMQ-AI commented on issue #4828:
URL: https://github.com/apache/rocketmq-dashboard/issues/4828#issuecomment-5770198261
**Issue Evaluation**
Category: `documentation` | Status: **Confirmed**
Thank you for the detailed report. This is a documentation accuracy issue — the `api-spec.md` does not fully reflect the current controller endpoints and DTO structures.
**Assessment:** The api-spec document needs to be updated to match the actual implementation. This is a valid documentation gap.
**Suggested action:** Update `docs/api-spec.md` to align with the current controller implementations.
---
*Automated evaluation by github-manager*
--
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: [I] [Bug] api-spec omits the query-history and LiteTopic endpoint groups entirely [rocketmq-dashboard]
Posted by "github-actions[bot] (via GitHub)" <gi...@apache.org>.
github-actions[bot] commented on issue #4828:
URL: https://github.com/apache/rocketmq-dashboard/issues/4828#issuecomment-5963524463
This issue has been automatically closed because there has been no activity for 7 days. If you believe this issue is still relevant, please reopen it with updated information.
--
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: [I] [Bug] api-spec omits the query-history and LiteTopic endpoint groups entirely [rocketmq-dashboard]
Posted by "github-actions[bot] (via GitHub)" <gi...@apache.org>.
github-actions[bot] closed issue #4828: [Bug] api-spec omits the query-history and LiteTopic endpoint groups entirely
URL: https://github.com/apache/rocketmq-dashboard/issues/4828
--
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: [I] [Bug] api-spec omits the query-history and LiteTopic endpoint groups entirely [rocketmq-dashboard]
Posted by "lizhimins (via GitHub)" <gi...@apache.org>.
lizhimins commented on issue #4828:
URL: https://github.com/apache/rocketmq-dashboard/issues/4828#issuecomment-6437343547
Resolved by #4835 (merged into `rocketmq-studio` as `d6ff5e4fc`).
Reopening to correct the state: this was closed by the stale bot as `not planned`, but the gap was real and is now documented. The query-history group is §8.8 with its four endpoints (`/api/query-history/messages`, `/traces`, `/summary`, `/messages/{id}/results`), and LiteTopic is §5.9-§5.13 (session list, session detail, extendTTL, quota, capability). The endpoint quick-reference went from 126 to 190 of the 234 mappings in the codebase.
--
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: [I] [Bug] api-spec omits the query-history and LiteTopic endpoint groups entirely [rocketmq-dashboard]
Posted by "lizhimins (via GitHub)" <gi...@apache.org>.
lizhimins closed issue #4828: [Bug] api-spec omits the query-history and LiteTopic endpoint groups entirely
URL: https://github.com/apache/rocketmq-dashboard/issues/4828
--
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