Frun1na opened a new issue, #4815:
URL: https://github.com/apache/rocketmq-dashboard/issues/4815

   ### Before Creating the Bug Report
   
   - [x] I have searched the [open 
issues](https://github.com/apache/rocketmq-dashboard/issues) and found no 
similar issue.
   
   ### What Happened
   
   `docs/api-spec.md` sections 10 (clients) and 11-13 (alerting / system alerts 
/ audit) diverge from the
   controllers in ways an integrator would hit on the first call:
   
   - 10.1 omits the **required** `namesrvAddr` query parameter (every 
documented request returns 400) and
     lists client languages as `C++` / `C#` / `Node.js` while the API returns 
`Cpp` / `CSharp` / `NodeJS`.
   - 11.1 documents alert-rule `duration` values like `1分钟` and `metric` values 
like `磁盘使用率`; the
     validator only accepts Prometheus durations 
(`(?:[0-9]+(?:ms|s|m|h|d|w|y))+`) and metric names, so
     the documented values are rejected with 400. The `AlertRule` field list 
also omits `domain`,
     `aggregation`, `windowSeconds`, `severity`, `consecutiveSamples`, 
`reminderInterval`,
     `notificationTemplate` and the scoping fields, and types `id` as a string 
where it is a `Long`.
   - 12.1 types the system-alert `id` as a string (`Long` in `SystemAlertVO`) 
and documents `time` as a
     short `HH:mm` string where it is ISO 8601; a dozen returned fields are 
missing.
   - 13.4 marks `beforeDays` as required with range 1-365; it is optional 
(default 30, `@Max(365)`).
   
   ### Expected Behavior
   
   The sections should match the controllers: required query parameters listed, 
enum values taken from
   the API (display names belong to the UI), ids typed as numbers, and the real 
request/response shapes.
   


-- 
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]

Reply via email to