This is an automated email from the ASF dual-hosted git repository.
lizhimins pushed a commit to branch rocketmq-studio
in repository https://gitbox.apache.org/repos/asf/rocketmq-dashboard.git
The following commit(s) were added to refs/heads/rocketmq-studio by this push:
new 96c484637 docs: correct the audit result values in the API spec (#4709)
96c484637 is described below
commit 96c4846377e169b78704c73fb266243b50b8b61b
Author: Apulupie <[email protected]>
AuthorDate: Mon Sep 21 21:10:20 2026 +0800
docs: correct the audit result values in the API spec (#4709)
`docs/api-spec.md` gave the audit `result` values as `SUCCESS / FAILED /
FAILURE / PARTIAL` in the `AuditRecord` section and as lowercase `success`,
`failure` in the enum appendix. Neither matches what is stored.
`OperationAuditConstants.Result` defines only `SUCCESS` and `FAILED`, and the
single `"FAILURE"` literal in the server is a notification delivery state in
`NotificationOutboxService`, not an audit result; `PARTIAL` is real, since
`ClusterService.recordConfigUpdateAudit` passe [...]
Both lines now read `SUCCESS`, `FAILED`, `PARTIAL`, and no other occurrence
of the old vocabulary remains in the document. `audit.yaml` declares no `enum`
for `result` on either the input or the output schema, so no catalog
regeneration is involved.
Fixes #4712
---
docs/api-spec.md | 4 ++--
1 file changed, 2 insertions(+), 2 deletions(-)
diff --git a/docs/api-spec.md b/docs/api-spec.md
index e5588ecba..db7c9ec78 100644
--- a/docs/api-spec.md
+++ b/docs/api-spec.md
@@ -1858,7 +1858,7 @@ GET
/api/audit-logs?page={page}&pageSize={pageSize}&search={search}&operationTyp
| `target` | `string \| null` | 操作对象，无操作对象时为 `null` |
| `clusterId` | `string \| null` | 所属集群 ID，无集群上下文时为 `null` |
| `detail` | `string` | 详细描述 |
-| `result` | `string` | 持久化的结果代码，如 `SUCCESS` / `FAILED` / `FAILURE` /
`PARTIAL` |
+| `result` | `string` | 持久化的结果代码，如 `SUCCESS` / `FAILED` / `PARTIAL` |
| `errorMessage` | `string` | 失败或部分成功时的错误信息 |
### 13.2 获取审计日志筛选项
@@ -2846,7 +2846,7 @@ GET /api/metrics/grafana/dashboards/export
| **ACL 操作** | `PUB`, `SUB`, `ALL` |
| **ACL 决策** | `ALLOW`, `DENY` |
| **告警级别** | `error`, `warning`, `info` |
-| **审计结果** | `success`, `failure` |
+| **审计结果** | `SUCCESS`, `FAILED`, `PARTIAL` |
| **投递状态** | `success`, `failed`, `pending` |
| **证书状态** | `valid`, `expiring`, `expired` |
| **证书类型** | `TLS`, `mTLS`, `ServiceAccount` |
