Aias00 opened a new issue, #4151: URL: https://github.com/apache/rocketmq-dashboard/issues/4151
## Problem `docs/api-spec.md` no longer matches the current Message and Producer controller surfaces. The quick-reference table lists only the legacy message query and message-id trace routes, while the code also exposes paged queries, trace-by-key, queue browsing, direct consumption, and two Producer connection endpoints. The detailed Message section also omits required `instanceId`, the optional `tag` and `traceTopic` filters, and describes millisecond timestamps as ISO strings even though the controller and VOs use integer epoch milliseconds. There is no detailed Producer endpoint section. ## Expected documentation Synchronize the documentation with `MessageController`, `ProducerController`, their response VOs, and the frontend API clients: - add the five missing Message routes to the quick reference and detailed section; - document `traceTopic` for message-id and business-key trace lookup; - document paged message query metadata and truncation semantics; - document queue offset lookup and exact-offset message reads; - document direct-consume request and response fields; - document Producer group suggestions and connection inventory/summary responses; - correct Message timestamp parameter and response types to Unix milliseconds; - keep quick-reference numbering contiguous. ## Scope This is a documentation-only change for `MessageController` and `ProducerController`. It does not change runtime APIs or attempt a repository-wide API documentation rewrite. ## Verification Cross-check every documented method, path, parameter, default, limit, and response field against the current controller, service DTO/VO, and frontend API client. -- 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: [email protected] For queries about this service, please contact Infrastructure at: [email protected]
