You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@rocketmq.apache.org by "Frun1na (via GitHub)" <gi...@apache.org> on 2026/09/21 07:27:15 UTC
[I] [Doc] Audit result values in docs/api-spec.md contradict the code [rocketmq-dashboard]
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: commits-unsubscribe@rocketmq.apache.org.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
Re: [I] [Doc] Audit result values in docs/api-spec.md contradict the code [rocketmq-dashboard]
Posted by "lizhimins (via GitHub)" <gi...@apache.org>.
lizhimins commented on issue #4712:
URL: https://github.com/apache/rocketmq-dashboard/issues/4712#issuecomment-5761019194
Resolved by #4709 (merged into rocketmq-studio as 96c484637).
--
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: commits-unsubscribe@rocketmq.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
Re: [I] [Doc] Audit result values in docs/api-spec.md contradict the code [rocketmq-dashboard]
Posted by "RockteMQ-AI (via GitHub)" <gi...@apache.org>.
RockteMQ-AI commented on issue #4712:
URL: https://github.com/apache/rocketmq-dashboard/issues/4712#issuecomment-5757334334
**Issue Evaluation**
Category: `documentation` | Status: **Valid**
The documentation inconsistency is confirmed. The `docs/api-spec.md` contains contradictory result values:
- §13.1 lists `SUCCESS` / `FAILED` / `FAILURE` / `PARTIAL` — `FAILURE` is not a valid audit result code
- The enum appendix uses lowercase `success` / `failure` which contradicts both the code and §13.1
The correct values based on `OperationAuditConstants.Result` are `SUCCESS` / `FAILED`, with `PARTIAL` used for cluster config updates.
PR #4709 is noted for addressing this. The suggested change aligns with the server-side implementation.
---
*Automated evaluation by RockteMQ-AI*
--
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: commits-unsubscribe@rocketmq.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
Re: [I] [Doc] Audit result values in docs/api-spec.md contradict the code [rocketmq-dashboard]
Posted by "lizhimins (via GitHub)" <gi...@apache.org>.
lizhimins closed issue #4712: [Doc] Audit result values in docs/api-spec.md contradict the code
URL: https://github.com/apache/rocketmq-dashboard/issues/4712
--
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: commits-unsubscribe@rocketmq.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org