docs: add doc for api (#2796)

Signed-off-by: yisaer <[email protected]>
lf-edge · Apr 24, 2024 · 253be23 · 253be23
1 parent 72cb202
commit 253be23
Show file tree

Hide file tree

Showing 3 changed files with 31 additions and 0 deletions.
diff --git a/docs/en_US/api/restapi/rules.md b/docs/en_US/api/restapi/rules.md
@@ -174,6 +174,14 @@ Among them, the following states respectively represent the unix timestamp of th
 }
 ```
 
+## get the status of all rules
+
+The command is used to get the status of all rules. If the rule is running, the metrics will be retrieved realtime.
+
+```shell
+GET http://localhost:9081/rules/status/all
+```
+
 ## get the topology structure of a rule
 
 The command is used to get the status of the rule represented as a json string. In the json string, there are 2 fields:

diff --git a/docs/zh_CN/api/restapi/rules.md b/docs/zh_CN/api/restapi/rules.md
@@ -174,6 +174,14 @@ GET http://localhost:9081/rules/{id}/status
 }
 ```
 
+## 获取所有规则的状态
+
+该命令用于获取所有规则的状态。 如果规则正在运行，则将实时检索状态指标。
+
+```shell
+GET http://localhost:9081/rules/status/all
+```
+
 ## 验证规则
 
 该 API 用于验证规则。

diff --git a/extensions/sinks/kafka/kafka.json b/extensions/sinks/kafka/kafka.json
@@ -50,6 +50,21 @@
         "zh_CN": "主题"
       }
     },
+    {
+      "name": "requiredACKs",
+      "default": "",
+      "optional": false,
+      "control": "text",
+      "type": "int",
+      "hint": {
+        "en_US": "The mechanism for Kafka client to confirm messages",
+        "zh_CN": "Kafka 客户端确认消息的机制"
+      },
+      "label": {
+        "en_US": "requiredACKs",
+        "zh_CN": "确认机制"
+      }
+    },
     {
       "name": "saslAuthType",
       "default": "none",