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

   ### Which Documentation
   
   `docs/api-spec.md` — §13.1 `AuditRecord.result` and the enum appendix at the 
end of the document.
   
   ### What Is Wrong
   
   The two places disagree with each other and with the server:
   
   - §13.1 lists the persisted result codes as `SUCCESS` / `FAILED` / `FAILURE` 
/ `PARTIAL`. `FAILURE` is never stored. The audit vocabulary defines only 
`SUCCESS` and `FAILED` (`OperationAuditConstants.Result`), and cluster 
configuration updates additionally record `PARTIAL` through 
`ClusterConfigUpdateResultVO.Status.name()` in `ClusterService`. 
`NotificationOutboxService` does use `FAILURE`, but that is the notification 
delivery status, not the audit result.
   - The enum appendix contradicts both the code and §13.1 by listing lowercase 
`success` / `failure`.
   
   Because the field description states the value is a persisted result code, 
the document should match what the server stores.
   
   ### Suggested Change
   
   - §13.1: `SUCCESS` / `FAILED` / `PARTIAL`
   - Appendix: `SUCCESS`, `FAILED`, `PARTIAL`
   
   Opened PR #4709 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]

Reply via email to