(seatunnel) branch dev updated: [Docs] update rest-api doc (#7111)

[fanjia]

This is an automated email from the ASF dual-hosted git repository.

fanjia pushed a commit to branch dev
in repository https://gitbox.apache.org/repos/asf/seatunnel.git


The following commit(s) were added to refs/heads/dev by this push:
     new 485140aa22 [Docs] update rest-api doc (#7111)
485140aa22 is described below

commit 485140aa22f93523a899e77eb776b032aadd7b14
Author: Jarvis <liunaijie1...@163.com>
AuthorDate: Fri Jul 5 14:57:49 2024 +0800

    [Docs] update rest-api doc (#7111)
---
 docs/en/seatunnel-engine/rest-api.md | 10 ++++++++++
 docs/zh/seatunnel-engine/rest-api.md | 10 ++++++++++
 2 files changed, 20 insertions(+)

diff --git a/docs/en/seatunnel-engine/rest-api.md 
b/docs/en/seatunnel-engine/rest-api.md
index adde89d89a..d84e440a3c 100644
--- a/docs/en/seatunnel-engine/rest-api.md
+++ b/docs/en/seatunnel-engine/rest-api.md
@@ -37,6 +37,9 @@ network:
 
 ### Returns an overview over the Zeta engine cluster.
 
+<details>
+ <summary><code>GET</code> <code><b>/hazelcast/rest/maps/overview</b></code> 
<code>(Returns an overview over the Zeta engine cluster.)</code></summary>
+
 #### Parameters
 
 #### Responses
@@ -55,6 +58,13 @@ network:
 }
 ```
 
+If you use `dynamic-slot`, the `totalSlot` and `unassignedSlot` always be `0`.
+If you set it to fix slot number, it will return the correct total and 
unassigned slot number
+
+</details>
+
+------------------------------------------------------------------------------------------
+
 ### Returns an overview over all jobs and their current state.
 
 <details>
diff --git a/docs/zh/seatunnel-engine/rest-api.md 
b/docs/zh/seatunnel-engine/rest-api.md
index e6aecaeb2f..9e2d867f4a 100644
--- a/docs/zh/seatunnel-engine/rest-api.md
+++ b/docs/zh/seatunnel-engine/rest-api.md
@@ -36,6 +36,9 @@ network:
 
 ### 返回Zeta集群的概览
 
+<details>
+ <summary><code>GET</code> <code><b>/hazelcast/rest/maps/overview</b></code> 
<code>(Returns an overview over the Zeta engine cluster.)</code></summary>
+
 #### 参数
 
 #### 响应
@@ -54,6 +57,13 @@ network:
 }
 ```
 
+当你使用`dynamic-slot`时, 返回结果中的`totalSlot`和`unassignedSlot`将始终为0.
+当你设置为固定的slot值时, 将正确返回集群中总共的slot数量以及未分配的slot数量.
+
+</details>
+
+------------------------------------------------------------------------------------------
+
 ### 返回所有作业及其当前状态的概览。
 
 <details>