Frun1na opened a new pull request, #4810:
URL: https://github.com/apache/rocketmq-dashboard/pull/4810
### Which Issue(s) This PR Fixes
- Fixes #ISSUE_ID
### Brief Description
Sections 5 (topic), 6 (consumer group) and 8.1 (message list) documented
request fields, field names
and response shapes that do not match the controllers. Every correction
below was read back from the
implementation:
| Section | Document said | The code does |
|---|---|---|
| 5.1 topic list | `createdAt` / `updatedAt` | `TopicVO extends BaseEntity`,
so the fields are `gmtCreate` / `gmtModified` (`BaseEntity:25-26`); the web
client reads the same names (`metadata.ts:22-23`) |
| 5.8 topic send | request `{topic, tag, key, body, properties}`; response
`sendTime: string` ISO 8601 | `SendMessageDTO` also accepts `instanceId`,
`messageGroup` (FIFO) and `deliveryTimestamp` (delay, epoch millis) — all
optional; `sendTime` is a `long` epoch-millis value (`SendMessageVO:30`,
populated with `System.currentTimeMillis()` in all three providers) |
| 6.1 group list | `createdAt` / `updatedAt` | `ConsumerGroupVO extends
BaseEntity` → `gmtCreate` / `gmtModified` |
| 6.5 group create | `clusterId` / `subscriptionMode` / `consumeType`
required, plus a `subscribedTopics` field | `CreateConsumerGroupDTO` marks only
`name` `@NotBlank` — `clusterId`, `subscriptionMode` and `consumeType` are
optional; there is no `subscribedTopics` field; the DTO also takes
`subscriptionDataType`, `deliveryOrderType`, `delaySeconds` and `instanceId` |
| 6.7 reset offset | `timestamp: string` ISO 8601, `topic` optional,
`instanceId` not listed | `ResetConsumerOffsetDTO`: `timestamp` is a positive
`Long` epoch-millis (`@NotNull @Positive`), `topic` is `@NotBlank` (required),
`instanceId` is `@NotBlank` (required) |
| 6.8 group import | `multipart/form-data` with a `file` part; response
`{imported, failed, errors[]}` | JSON `@RequestBody` `{instanceId, groups:
CreateConsumerGroupDTO[]}`; response `{imported, failed, groups[], failures:
[{index, name, message}]}` (`ConsumerGroupController:104-109`,
`ImportConsumerGroupsResultVO`) |
| 8.1 message list | — | the `MessageRecord` table omits `reconsumeTimes`
(`MessageRecordVO:44`) |
The timestamp corrections follow the ones already applied to the instance
and ACL sections (#4725,
#4723): the entities expose `gmtCreate` / `gmtModified`, and the sections
that legitimately document
`createdAt` (AI conversations) were left untouched.
### How Did You Test This Change
Documentation-only change; there is no docs build or spec validation to run.
Every claim in the table
was verified by reading the controller mapping, the DTO validation
annotations and the VO field
declarations directly (file and line cited per row).
--
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]
