Frun1na opened a new issue, #4726:
URL: https://github.com/apache/rocketmq-dashboard/issues/4726
### Which Documentation
`docs/api-spec.md` — §3 实例管理 (§3.1 / §3.2 / §3.3).
### What Is Wrong
The section documents an instance type that the API rejects:
- §3.1 offers `PROXY` as a `type` filter value and as a response value
("兼容值"), and §3.2 / §3.3
state that "旧 `PROXY` 请求归一为 `PROXY_CLUSTER`".
- `InstanceType` defines only `CLOUD`, `PROXY_LOCAL`, `PROXY_CLUSTER`,
`DIRECT`. No code normalises
`PROXY`: the list filter binds the query parameter straight to the enum,
and the create/update
DTOs bind the body field the same way. `GlobalExceptionHandler` maps
`MethodArgumentTypeMismatchException` to HTTP 400, so a request following
the spec fails with 400
before any service code runs.
Additionally, §3.1's response table names the timestamps `createdAt` /
`updatedAt` and types `id`
as a string, while `InstanceVO` (via `BaseEntity`) exposes `gmtCreate` /
`gmtModified` and a
`Long id`. The web client reads those field names
(`web/src/api/instance.ts`).
### Suggested Change
- List the four real type values everywhere and drop the `PROXY`
compatibility claim; note instead
that `CLOUD` is reserved for vendor-managed instances (manual creation is
rejected with
"CLOUD type is reserved for vendor-managed instances").
- §3.1: `id` → `number`, `createdAt` → `gmtCreate`, `updatedAt` →
`gmtModified`.
Opened PR #4725 for this.
--
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]
