Frun1na opened a new pull request, #5684:
URL: https://github.com/apache/rocketmq-dashboard/pull/5684
### Which Issue(s) This PR Fixes
No issue: documentation for endpoints the specification omits entirely.
Second area extracted from #4835 so it can be reviewed on its own (the
consumer-group area is #5683; the umbrella report #4831 is already closed by
the stale bot).
### Brief Description
The specification has no LiteTopic section at all, although the console has
a page for it and the controller exposes five endpoints. This adds §5.9-5.13
and their rows in 接口速查:
- **5.9** `GET /api/liteTopic/list` — session list with `pattern` /
`namespace` filters
- **5.10** `GET /api/liteTopic/session/:sessionId` — session detail,
including the nested `liteTopics` entries
- **5.11** `POST /api/liteTopic/extendTTL` — TTL change (`newTTL` must be
positive)
- **5.12** `GET /api/liteTopic/quota` — quota counters and rates
- **5.13** `GET /api/liteTopic/capability` — whether the cluster supports
LiteTopic
Every path, parameter and field was read off the current code:
| Section | Source |
|---|---|
| 5.9-5.13 paths and parameters | `LiteTopicController`
(`@RequestMapping("/api/liteTopic")`, `@RequestParam(required = false)` for
`pattern` / `namespace`) |
| 5.9 | `LiteTopicItemVO` (all nine fields) |
| 5.10 | `LiteTopicSessionVO` (all sixteen fields) and its nested
`SessionLiteTopic` (`topicName` / `status` / `ttlRemaining`) |
| 5.11 | `LiteTopicTTLUpdateDTO` (`@NotBlank` `instanceId` / `topicPattern`,
`@NotNull` `newTTL`) and `LiteTopicService.extendTTL` (`newTTL` must be
positive) |
| 5.12 | `LiteTopicQuotaVO` (all twelve fields) |
| 5.13 | `LiteTopicCapabilityVO` |
### How Did You Test This Change?
Documentation only — no code, configuration or test changes.
- Each endpoint was matched against its `@GetMapping` / `@PostMapping`
declaration in
`server/src/main/java/org/apache/rocketmq/studio/instance/topic/LiteTopicController.java`;
each parameter's required flag against its `@RequestParam` declaration.
- Each response field list was matched field-by-field against the VO it
renders, including the nested `LiteTopicSessionVO.SessionLiteTopic` shape.
- The positive-`newTTL` rule comes from `LiteTopicService.extendTTL`, which
rejects null, zero and negative values with `400`.
- Markdown structure checked with `grep -n "^### 5\\."` (5.1-5.13 in order,
no duplicates) and the new table rows are unique.
### Checklist
- [x] One coherent change; unrelated modifications are not bundled in
- [x] Commit subject follows Conventional Commits (`feat:` / `fix:` /
`refactor:` / `chore:` / `docs:` / `perf:`)
- [x] Tests added or updated for non-trivial changes, test methods named
`...Test`
- [ ] New UI text has both Chinese and English entries under `web/src/i18n/`
- [ ] Architecture constraints stay green (`mvn test` runs the ArchUnit
checks)
- [ ] New source files carry the ASF license header
- [x] Documentation touched where behaviour changed (README / `docs/` /
in-app help)
---
The quick-reference rows are numbered 114-118 because #5683 (the
consumer-group area) adds 108-113 to the same place in the table; whichever of
the two merges second needs a one-line renumber. Happy to rebase if you prefer
them combined or reordered.
--
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]
