[FLINK-35646][docs] Add docs for materialized table refresh api

lsyldliu · Jun 21, 2024 · a7c01c6 · a7c01c6
1 parent db05deb
commit a7c01c6
Show file tree

Hide file tree

Showing 6 changed files with 1,444 additions and 2 deletions.
diff --git a/docs/content.zh/docs/dev/table/sql-gateway/rest.md b/docs/content.zh/docs/dev/table/sql-gateway/rest.md
@@ -96,7 +96,8 @@ OpenAPI 规范如下，默认版本是 v2。
 | Version                       | Description                    |
 | ----------- |--------------------------------|
 | [Open API v1 specification]({{< ref_static "generated/rest_v1_sql_gateway.yml" >}}) | 允许用户提交 SQL 语句到 Gateway 并执行。 |
-| [Open API v2 specification]({{< ref_static "generated/rest_v2_sql_gateway.yml" >}}) | 支持 SQL 客户端连接到 Gateway。         |
+| [Open API v2 specification]({{< ref_static "generated/rest_v2_sql_gateway.yml" >}}) | 支持 SQL 客户端连接到 Gateway。 |
+| [Open API v3 specification]({{< ref_static "generated/rest_v3_sql_gateway.yml" >}}) | 支持 Materialized Table 刷新操作. |
 
 {{< hint warning >}}
 OpenAPI 规范目前仍处于实验阶段。
@@ -105,6 +106,11 @@ OpenAPI 规范目前仍处于实验阶段。
 #### API reference
 
 {{< tabs "f00ed142-b05f-44f0-bafc-799080c1d40d" >}}
+{{< tab "v3" >}}
+
+{{< generated/rest_v3_sql_gateway >}}
+
+{{< /tab >}}
 {{< tab "v2" >}}
 
 {{< generated/rest_v2_sql_gateway >}}

diff --git a/docs/content/docs/dev/table/sql-gateway/rest.md b/docs/content/docs/dev/table/sql-gateway/rest.md
@@ -100,6 +100,7 @@ The available OpenAPI specification is as follows. The default version is v2.
 | ----------- | ------- |
 | [Open API v1 specification]({{< ref_static "generated/rest_v1_sql_gateway.yml" >}}) | Allow users to submit statements to the gateway and execute. |
 | [Open API v2 specification]({{< ref_static "generated/rest_v2_sql_gateway.yml" >}}) | Supports SQL Client to connect to the gateway. |
+| [Open API v3 specification]({{< ref_static "generated/rest_v3_sql_gateway.yml" >}}) | Supports Materialized Table refresh operation. |
 
 {{< hint warning >}}
 The OpenAPI specification is still experimental.
@@ -108,6 +109,11 @@ The OpenAPI specification is still experimental.
 #### API reference
 
 {{< tabs "f00ed142-b05f-44f0-bafc-799080c1d40d" >}}
+{{< tab "v3" >}}
+
+{{< generated/rest_v3_sql_gateway >}}
+
+{{< /tab >}}
 {{< tab "v2" >}}
 
 {{< generated/rest_v2_sql_gateway >}}