Frun1na opened a new pull request, #4835:
URL: https://github.com/apache/rocketmq-dashboard/pull/4835
### Which Issue(s) This PR Fixes
- Fixes #4828
- Fixes #4831
### Brief Description
A group of controllers exists without any representation in
`docs/api-spec.md`; the quick reference
stopped at 98 entries while the server exposes 18 more endpoints. This PR
documents all of them and
supersedes my two partial PRs (#4827, #4830), which are closed in favor of
this one consolidated
change:
- **1.3 `GET /api/auth/status`** / **1.4 `POST /api/auth/password`**
(`AuthController`): login policy
and current-user probe (with `Cache-Control: no-store`), and the password
change with its 401/503
semantics.
- **5.9 LiteTopic 会话管理** (5 endpoints, `LiteTopicController`): capability
probe, session list /
detail, TTL extension, quota — fields from `LiteTopicItemVO` /
`LiteTopicSessionVO` /
`LiteTopicQuotaVO` / `LiteTopicCapabilityVO`.
- **8.8 查询历史** (4 endpoints, `QueryHistoryController`): persisted message /
trace query history
with snapshot replay; `pageSize` bounds from `validatePage` (1-100).
- **15.14 `POST /api/ai/runs/:runId/speed`** (`AiConversationController`):
client-measured generation
speed persisted for transcript replay.
- **17. 云凭证 Cloud Credentials** (6 endpoints, `CloudCredentialController`):
paged masked list, CSV
export, create / update / delete, and the plaintext secret reveal —
including which endpoints mask
`accessKey` / drop `secretKey`, and that only the reveal endpoint is
admin-only (`AuthInterceptor`
credential-reveal guard).
The quick reference now lists 116 endpoints, consistent with the sections as
the document's own
maintenance rule requires. All of these were previously invisible to API
consumers building from the
specification.
### 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 the
controllers 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: [email protected]
For queries about this service, please contact Infrastructure at:
[email protected]