You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@flink.apache.org by ro...@apache.org on 2024/06/22 04:01:53 UTC
(flink) branch master updated (b92a5944c42 -> 12f2222bbcd)
This is an automated email from the ASF dual-hosted git repository.
ron pushed a change to branch master
in repository https://gitbox.apache.org/repos/asf/flink.git
from b92a5944c42 [FLINK-35659][table] Remove unnecessary parameter customScheduleTime for embedded scheduler
new f3867240292 [FLINK-35646][docs] Fix the error description of token parameter
new 993c5c12df1 [FLINK-35646][table] Exclude embedded workflow scheduler related rest api from docs
new 12f2222bbcd [FLINK-35646][docs] Add docs for materialized table refresh api
The 3 revisions listed above as "new" are entirely new to this
repository and will be described in separate emails. The revisions
listed as "add" were already present in the repository and have only
been added to this reference.
Summary of changes:
docs/content.zh/docs/dev/table/sql-gateway/rest.md | 8 +-
docs/content/docs/dev/table/sql-gateway/rest.md | 6 ++
docs/hugo_extended_0.110.0_Linux-64bit.tar.gz | Bin 0 -> 601126 bytes
.../shortcodes/generated/rest_v1_dispatcher.html | 4 +
.../shortcodes/generated/rest_v1_sql_gateway.html | 2 +-
.../shortcodes/generated/rest_v2_sql_gateway.html | 2 +-
...2_sql_gateway.html => rest_v3_sql_gateway.html} | 85 ++++++++++++++++++++-
docs/static/generated/rest_v1_dispatcher.yml | 7 ++
docs/static/generated/rest_v1_sql_gateway.yml | 2 +-
docs/static/generated/rest_v2_sql_gateway.yml | 2 +-
..._v2_sql_gateway.yml => rest_v3_sql_gateway.yml} | 59 +++++++++++++-
.../RefreshMaterializedTableHeaders.java | 5 ++
.../CreateEmbeddedSchedulerWorkflowHeaders.java | 7 ++
.../DeleteEmbeddedSchedulerWorkflowHeaders.java | 7 ++
.../ResumeEmbeddedSchedulerWorkflowHeaders.java | 7 ++
.../SuspendEmbeddedSchedulerWorkflowHeaders.java | 7 ++
.../MaterializedTableIdentifierPathParameter.java | 2 +-
.../statement/FetchResultsTokenPathParameter.java | 2 +-
18 files changed, 204 insertions(+), 10 deletions(-)
create mode 100644 docs/hugo_extended_0.110.0_Linux-64bit.tar.gz
copy docs/layouts/shortcodes/generated/{rest_v2_sql_gateway.html => rest_v3_sql_gateway.html} (88%)
copy docs/static/generated/{rest_v2_sql_gateway.yml => rest_v3_sql_gateway.yml} (90%)
(flink) 01/03: [FLINK-35646][docs] Fix the error description of token parameter
Posted by ro...@apache.org.
This is an automated email from the ASF dual-hosted git repository.
ron pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/flink.git
commit f386724029285864354abacafebbff725a0d0b9e
Author: fengli <ld...@163.com>
AuthorDate: Fri Jun 21 15:42:41 2024 +0800
[FLINK-35646][docs] Fix the error description of token parameter
---
docs/layouts/shortcodes/generated/rest_v1_dispatcher.html | 4 ++++
docs/layouts/shortcodes/generated/rest_v1_sql_gateway.html | 2 +-
docs/layouts/shortcodes/generated/rest_v2_sql_gateway.html | 2 +-
docs/static/generated/rest_v1_dispatcher.yml | 7 +++++++
docs/static/generated/rest_v1_sql_gateway.yml | 2 +-
docs/static/generated/rest_v2_sql_gateway.yml | 2 +-
.../rest/message/statement/FetchResultsTokenPathParameter.java | 2 +-
7 files changed, 16 insertions(+), 5 deletions(-)
diff --git a/docs/layouts/shortcodes/generated/rest_v1_dispatcher.html b/docs/layouts/shortcodes/generated/rest_v1_dispatcher.html
index 7390bf744cd..6ecd4a32d8b 100644
--- a/docs/layouts/shortcodes/generated/rest_v1_dispatcher.html
+++ b/docs/layouts/shortcodes/generated/rest_v1_dispatcher.html
@@ -1182,6 +1182,10 @@ Using 'curl' you can upload a jar via 'curl -X POST -H "Expect:" -F "jarfile=@pa
"jid" : {
"type" : "any"
},
+ "job-type" : {
+ "type" : "string",
+ "enum" : [ "BATCH", "STREAMING" ]
+ },
"maxParallelism" : {
"type" : "integer"
},
diff --git a/docs/layouts/shortcodes/generated/rest_v1_sql_gateway.html b/docs/layouts/shortcodes/generated/rest_v1_sql_gateway.html
index 754657d3a2e..0fa86ac6cea 100644
--- a/docs/layouts/shortcodes/generated/rest_v1_sql_gateway.html
+++ b/docs/layouts/shortcodes/generated/rest_v1_sql_gateway.html
@@ -405,7 +405,7 @@
<ul>
<li><code>session_handle</code> - The SessionHandle that identifies a session.</li>
<li><code>operation_handle</code> - The OperationHandle that identifies a operation.</li>
-<li><code>token</code> - The OperationHandle that identifies a operation.</li>
+<li><code>token</code> - The token that identifies which batch of data to fetch.</li>
</ul>
</td>
</tr>
diff --git a/docs/layouts/shortcodes/generated/rest_v2_sql_gateway.html b/docs/layouts/shortcodes/generated/rest_v2_sql_gateway.html
index 6f069491dd1..b64f83ba5c7 100644
--- a/docs/layouts/shortcodes/generated/rest_v2_sql_gateway.html
+++ b/docs/layouts/shortcodes/generated/rest_v2_sql_gateway.html
@@ -523,7 +523,7 @@ CREATE TABLE, DROP TABLE, ALTER TABLE, CREATE DATABASE, DROP DATABASE, ALTER DAT
<ul>
<li><code>session_handle</code> - The SessionHandle that identifies a session.</li>
<li><code>operation_handle</code> - The OperationHandle that identifies a operation.</li>
-<li><code>token</code> - The OperationHandle that identifies a operation.</li>
+<li><code>token</code> - The token that identifies which batch of data to fetch.</li>
</ul>
</td>
</tr>
diff --git a/docs/static/generated/rest_v1_dispatcher.yml b/docs/static/generated/rest_v1_dispatcher.yml
index 94e1082085e..031b7484e3c 100644
--- a/docs/static/generated/rest_v1_dispatcher.yml
+++ b/docs/static/generated/rest_v1_dispatcher.yml
@@ -2395,6 +2395,8 @@ components:
type: boolean
jid:
$ref: '#/components/schemas/JobID'
+ job-type:
+ $ref: '#/components/schemas/JobType'
maxParallelism:
type: integer
format: int64
@@ -2572,6 +2574,11 @@ components:
properties:
jobUrl:
type: string
+ JobType:
+ type: string
+ enum:
+ - BATCH
+ - STREAMING
JobVertexAccumulatorsInfo:
type: object
properties:
diff --git a/docs/static/generated/rest_v1_sql_gateway.yml b/docs/static/generated/rest_v1_sql_gateway.yml
index b1572799799..5dc7104d666 100644
--- a/docs/static/generated/rest_v1_sql_gateway.yml
+++ b/docs/static/generated/rest_v1_sql_gateway.yml
@@ -166,7 +166,7 @@ paths:
$ref: '#/components/schemas/OperationHandle'
- name: token
in: path
- description: The OperationHandle that identifies a operation.
+ description: The token that identifies which batch of data to fetch.
required: true
schema:
type: integer
diff --git a/docs/static/generated/rest_v2_sql_gateway.yml b/docs/static/generated/rest_v2_sql_gateway.yml
index c85b5734150..403863d62c4 100644
--- a/docs/static/generated/rest_v2_sql_gateway.yml
+++ b/docs/static/generated/rest_v2_sql_gateway.yml
@@ -210,7 +210,7 @@ paths:
$ref: '#/components/schemas/OperationHandle'
- name: token
in: path
- description: The OperationHandle that identifies a operation.
+ description: The token that identifies which batch of data to fetch.
required: true
schema:
type: integer
diff --git a/flink-table/flink-sql-gateway/src/main/java/org/apache/flink/table/gateway/rest/message/statement/FetchResultsTokenPathParameter.java b/flink-table/flink-sql-gateway/src/main/java/org/apache/flink/table/gateway/rest/message/statement/FetchResultsTokenPathParameter.java
index c91fe56ba98..0b2d10c175a 100644
--- a/flink-table/flink-sql-gateway/src/main/java/org/apache/flink/table/gateway/rest/message/statement/FetchResultsTokenPathParameter.java
+++ b/flink-table/flink-sql-gateway/src/main/java/org/apache/flink/table/gateway/rest/message/statement/FetchResultsTokenPathParameter.java
@@ -41,6 +41,6 @@ public class FetchResultsTokenPathParameter extends MessagePathParameter<Long> {
@Override
public String getDescription() {
- return "The OperationHandle that identifies a operation.";
+ return "The token that identifies which batch of data to fetch.";
}
}
(flink) 03/03: [FLINK-35646][docs] Add docs for materialized table refresh api
Posted by ro...@apache.org.
This is an automated email from the ASF dual-hosted git repository.
ron pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/flink.git
commit 12f2222bbcd7919e2378b1a6a9bdf56c2835a79e
Author: fengli <ld...@163.com>
AuthorDate: Fri Jun 21 16:39:17 2024 +0800
[FLINK-35646][docs] Add docs for materialized table refresh api
---
docs/content.zh/docs/dev/table/sql-gateway/rest.md | 8 +-
docs/content/docs/dev/table/sql-gateway/rest.md | 6 +
docs/hugo_extended_0.110.0_Linux-64bit.tar.gz | Bin 0 -> 601126 bytes
.../shortcodes/generated/rest_v3_sql_gateway.html | 762 +++++++++++++++++++++
docs/static/generated/rest_v3_sql_gateway.yml | 663 ++++++++++++++++++
.../RefreshMaterializedTableHeaders.java | 5 +
.../MaterializedTableIdentifierPathParameter.java | 2 +-
7 files changed, 1444 insertions(+), 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
index 5caea340bd4..a390f242d2b 100644
--- 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
index a38933f607c..4a4787f030c 100644
--- 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 >}}
diff --git a/docs/hugo_extended_0.110.0_Linux-64bit.tar.gz b/docs/hugo_extended_0.110.0_Linux-64bit.tar.gz
new file mode 100644
index 00000000000..61791d22a92
Binary files /dev/null and b/docs/hugo_extended_0.110.0_Linux-64bit.tar.gz differ
diff --git a/docs/layouts/shortcodes/generated/rest_v3_sql_gateway.html b/docs/layouts/shortcodes/generated/rest_v3_sql_gateway.html
new file mode 100644
index 00000000000..8f7c6a7a022
--- /dev/null
+++ b/docs/layouts/shortcodes/generated/rest_v3_sql_gateway.html
@@ -0,0 +1,762 @@
+<table class="rest-api table table-bordered">
+ <tbody>
+ <tr>
+ <td class="text-left" colspan="2"><h5><strong>/api_versions</strong></h5></td>
+ </tr>
+ <tr>
+ <td class="text-left" style="width: 20%">Verb: <code>GET</code></td>
+ <td class="text-left">Response code: <code>200 OK</code></td>
+ </tr>
+ <tr>
+ <td colspan="2">Get the current available versions for the Rest Endpoint. The client can choose one of the return version as the protocol for later communicate.</td>
+ </tr>
+ <tr>
+ <td colspan="2">
+ <label>
+ <details>
+ <summary>Request</summary>
+ <pre><code>{}</code></pre>
+ </label>
+ </td>
+ </tr>
+ <tr>
+ <td colspan="2">
+ <label>
+ <details>
+ <summary>Response</summary>
+ <pre><code>{
+ "type" : "object",
+ "id" : "urn:jsonschema:org:apache:flink:table:gateway:rest:message:util:GetApiVersionResponseBody",
+ "properties" : {
+ "versions" : {
+ "type" : "array",
+ "items" : {
+ "type" : "string"
+ }
+ }
+ }
+}</code></pre>
+ </label>
+ </td>
+ </tr>
+ </tbody>
+</table>
+<table class="rest-api table table-bordered">
+ <tbody>
+ <tr>
+ <td class="text-left" colspan="2"><h5><strong>/info</strong></h5></td>
+ </tr>
+ <tr>
+ <td class="text-left" style="width: 20%">Verb: <code>GET</code></td>
+ <td class="text-left">Response code: <code>200 OK</code></td>
+ </tr>
+ <tr>
+ <td colspan="2">Get meta data for this cluster.</td>
+ </tr>
+ <tr>
+ <td colspan="2">
+ <label>
+ <details>
+ <summary>Request</summary>
+ <pre><code>{}</code></pre>
+ </label>
+ </td>
+ </tr>
+ <tr>
+ <td colspan="2">
+ <label>
+ <details>
+ <summary>Response</summary>
+ <pre><code>{
+ "type" : "object",
+ "id" : "urn:jsonschema:org:apache:flink:table:gateway:rest:message:util:GetInfoResponseBody",
+ "properties" : {
+ "productName" : {
+ "type" : "string"
+ },
+ "version" : {
+ "type" : "string"
+ }
+ }
+}</code></pre>
+ </label>
+ </td>
+ </tr>
+ </tbody>
+</table>
+<table class="rest-api table table-bordered">
+ <tbody>
+ <tr>
+ <td class="text-left" colspan="2"><h5><strong>/sessions</strong></h5></td>
+ </tr>
+ <tr>
+ <td class="text-left" style="width: 20%">Verb: <code>POST</code></td>
+ <td class="text-left">Response code: <code>200 OK</code></td>
+ </tr>
+ <tr>
+ <td colspan="2">Opens a new session with specific properties. Specific properties can be given for current session which will override the default properties of gateway.</td>
+ </tr>
+ <tr>
+ <td colspan="2">
+ <label>
+ <details>
+ <summary>Request</summary>
+ <pre><code>{
+ "type" : "object",
+ "id" : "urn:jsonschema:org:apache:flink:table:gateway:rest:message:session:OpenSessionRequestBody",
+ "properties" : {
+ "properties" : {
+ "type" : "object",
+ "additionalProperties" : {
+ "type" : "string"
+ }
+ },
+ "sessionName" : {
+ "type" : "string"
+ }
+ }
+}</code></pre>
+ </label>
+ </td>
+ </tr>
+ <tr>
+ <td colspan="2">
+ <label>
+ <details>
+ <summary>Response</summary>
+ <pre><code>{
+ "type" : "object",
+ "id" : "urn:jsonschema:org:apache:flink:table:gateway:rest:message:session:OpenSessionResponseBody",
+ "properties" : {
+ "sessionHandle" : {
+ "type" : "string"
+ }
+ }
+}</code></pre>
+ </label>
+ </td>
+ </tr>
+ </tbody>
+</table>
+<table class="rest-api table table-bordered">
+ <tbody>
+ <tr>
+ <td class="text-left" colspan="2"><h5><strong>/sessions/:session_handle</strong></h5></td>
+ </tr>
+ <tr>
+ <td class="text-left" style="width: 20%">Verb: <code>DELETE</code></td>
+ <td class="text-left">Response code: <code>200 OK</code></td>
+ </tr>
+ <tr>
+ <td colspan="2">Closes the specific session.</td>
+ </tr>
+ <tr>
+ <td colspan="2">Path parameters</td>
+ </tr>
+ <tr>
+ <td colspan="2">
+ <ul>
+<li><code>session_handle</code> - The SessionHandle that identifies a session.</li>
+ </ul>
+ </td>
+ </tr>
+ <tr>
+ <td colspan="2">
+ <label>
+ <details>
+ <summary>Request</summary>
+ <pre><code>{}</code></pre>
+ </label>
+ </td>
+ </tr>
+ <tr>
+ <td colspan="2">
+ <label>
+ <details>
+ <summary>Response</summary>
+ <pre><code>{
+ "type" : "object",
+ "id" : "urn:jsonschema:org:apache:flink:table:gateway:rest:message:session:CloseSessionResponseBody",
+ "properties" : {
+ "status" : {
+ "type" : "string"
+ }
+ }
+}</code></pre>
+ </label>
+ </td>
+ </tr>
+ </tbody>
+</table>
+<table class="rest-api table table-bordered">
+ <tbody>
+ <tr>
+ <td class="text-left" colspan="2"><h5><strong>/sessions/:session_handle</strong></h5></td>
+ </tr>
+ <tr>
+ <td class="text-left" style="width: 20%">Verb: <code>GET</code></td>
+ <td class="text-left">Response code: <code>200 OK</code></td>
+ </tr>
+ <tr>
+ <td colspan="2">Get the session configuration.</td>
+ </tr>
+ <tr>
+ <td colspan="2">Path parameters</td>
+ </tr>
+ <tr>
+ <td colspan="2">
+ <ul>
+<li><code>session_handle</code> - The SessionHandle that identifies a session.</li>
+ </ul>
+ </td>
+ </tr>
+ <tr>
+ <td colspan="2">
+ <label>
+ <details>
+ <summary>Request</summary>
+ <pre><code>{}</code></pre>
+ </label>
+ </td>
+ </tr>
+ <tr>
+ <td colspan="2">
+ <label>
+ <details>
+ <summary>Response</summary>
+ <pre><code>{
+ "type" : "object",
+ "id" : "urn:jsonschema:org:apache:flink:table:gateway:rest:message:session:GetSessionConfigResponseBody",
+ "properties" : {
+ "properties" : {
+ "type" : "object",
+ "additionalProperties" : {
+ "type" : "string"
+ }
+ }
+ }
+}</code></pre>
+ </label>
+ </td>
+ </tr>
+ </tbody>
+</table>
+<table class="rest-api table table-bordered">
+ <tbody>
+ <tr>
+ <td class="text-left" colspan="2"><h5><strong>/sessions/:session_handle/complete-statement</strong></h5></td>
+ </tr>
+ <tr>
+ <td class="text-left" style="width: 20%">Verb: <code>GET</code></td>
+ <td class="text-left">Response code: <code>200 OK</code></td>
+ </tr>
+ <tr>
+ <td colspan="2">Get the completion hints for the given statement at the given position.</td>
+ </tr>
+ <tr>
+ <td colspan="2">Path parameters</td>
+ </tr>
+ <tr>
+ <td colspan="2">
+ <ul>
+<li><code>session_handle</code> - The SessionHandle that identifies a session.</li>
+ </ul>
+ </td>
+ </tr>
+ <tr>
+ <td colspan="2">
+ <label>
+ <details>
+ <summary>Request</summary>
+ <pre><code>{
+ "type" : "object",
+ "id" : "urn:jsonschema:org:apache:flink:table:gateway:rest:message:statement:CompleteStatementRequestBody",
+ "properties" : {
+ "position" : {
+ "type" : "integer"
+ },
+ "statement" : {
+ "type" : "string"
+ }
+ }
+}</code></pre>
+ </label>
+ </td>
+ </tr>
+ <tr>
+ <td colspan="2">
+ <label>
+ <details>
+ <summary>Response</summary>
+ <pre><code>{
+ "type" : "object",
+ "id" : "urn:jsonschema:org:apache:flink:table:gateway:rest:message:statement:CompleteStatementResponseBody",
+ "properties" : {
+ "candidates" : {
+ "type" : "array",
+ "items" : {
+ "type" : "string"
+ }
+ }
+ }
+}</code></pre>
+ </label>
+ </td>
+ </tr>
+ </tbody>
+</table>
+<table class="rest-api table table-bordered">
+ <tbody>
+ <tr>
+ <td class="text-left" colspan="2"><h5><strong>/sessions/:session_handle/configure-session</strong></h5></td>
+ </tr>
+ <tr>
+ <td class="text-left" style="width: 20%">Verb: <code>POST</code></td>
+ <td class="text-left">Response code: <code>200 OK</code></td>
+ </tr>
+ <tr>
+ <td colspan="2">Configures the session with the statement which could be:
+CREATE TABLE, DROP TABLE, ALTER TABLE, CREATE DATABASE, DROP DATABASE, ALTER DATABASE, CREATE FUNCTION, DROP FUNCTION, ALTER FUNCTION, CREATE CATALOG, DROP CATALOG, USE CATALOG, USE [CATALOG.]DATABASE, CREATE VIEW, DROP VIEW, LOAD MODULE, UNLOAD MODULE, USE MODULE, ADD JAR.</td>
+ </tr>
+ <tr>
+ <td colspan="2">Path parameters</td>
+ </tr>
+ <tr>
+ <td colspan="2">
+ <ul>
+<li><code>session_handle</code> - The SessionHandle that identifies a session.</li>
+ </ul>
+ </td>
+ </tr>
+ <tr>
+ <td colspan="2">
+ <label>
+ <details>
+ <summary>Request</summary>
+ <pre><code>{
+ "type" : "object",
+ "id" : "urn:jsonschema:org:apache:flink:table:gateway:rest:message:session:ConfigureSessionRequestBody",
+ "properties" : {
+ "executionTimeout" : {
+ "type" : "integer"
+ },
+ "statement" : {
+ "type" : "string"
+ }
+ }
+}</code></pre>
+ </label>
+ </td>
+ </tr>
+ <tr>
+ <td colspan="2">
+ <label>
+ <details>
+ <summary>Response</summary>
+ <pre><code>{}</code></pre>
+ </label>
+ </td>
+ </tr>
+ </tbody>
+</table>
+<table class="rest-api table table-bordered">
+ <tbody>
+ <tr>
+ <td class="text-left" colspan="2"><h5><strong>/sessions/:session_handle/heartbeat</strong></h5></td>
+ </tr>
+ <tr>
+ <td class="text-left" style="width: 20%">Verb: <code>POST</code></td>
+ <td class="text-left">Response code: <code>200 OK</code></td>
+ </tr>
+ <tr>
+ <td colspan="2">Trigger heartbeat to tell the server that the client is active, and to keep the session alive as long as configured timeout value.</td>
+ </tr>
+ <tr>
+ <td colspan="2">Path parameters</td>
+ </tr>
+ <tr>
+ <td colspan="2">
+ <ul>
+<li><code>session_handle</code> - The SessionHandle that identifies a session.</li>
+ </ul>
+ </td>
+ </tr>
+ <tr>
+ <td colspan="2">
+ <label>
+ <details>
+ <summary>Request</summary>
+ <pre><code>{}</code></pre>
+ </label>
+ </td>
+ </tr>
+ <tr>
+ <td colspan="2">
+ <label>
+ <details>
+ <summary>Response</summary>
+ <pre><code>{}</code></pre>
+ </label>
+ </td>
+ </tr>
+ </tbody>
+</table>
+<table class="rest-api table table-bordered">
+ <tbody>
+ <tr>
+ <td class="text-left" colspan="2"><h5><strong>/sessions/:session_handle/materialized-tables/:identifier/refresh</strong></h5></td>
+ </tr>
+ <tr>
+ <td class="text-left" style="width: 20%">Verb: <code>POST</code></td>
+ <td class="text-left">Response code: <code>200 OK</code></td>
+ </tr>
+ <tr>
+ <td colspan="2">Refresh materialized table</td>
+ </tr>
+ <tr>
+ <td colspan="2">Path parameters</td>
+ </tr>
+ <tr>
+ <td colspan="2">
+ <ul>
+<li><code>session_handle</code> - The SessionHandle that identifies a session.</li>
+<li><code>identifier</code> - The fully qualified string that identifies a materialized table.</li>
+ </ul>
+ </td>
+ </tr>
+ <tr>
+ <td colspan="2">
+ <label>
+ <details>
+ <summary>Request</summary>
+ <pre><code>{
+ "type" : "object",
+ "id" : "urn:jsonschema:org:apache:flink:table:gateway:rest:message:materializedtable:RefreshMaterializedTableRequestBody",
+ "properties" : {
+ "dynamicOptions" : {
+ "type" : "object",
+ "additionalProperties" : {
+ "type" : "string"
+ }
+ },
+ "executionConfig" : {
+ "type" : "object",
+ "additionalProperties" : {
+ "type" : "string"
+ }
+ },
+ "isPeriodic" : {
+ "type" : "boolean"
+ },
+ "periodic" : {
+ "type" : "boolean"
+ },
+ "scheduleTime" : {
+ "type" : "string"
+ },
+ "staticPartitions" : {
+ "type" : "object",
+ "additionalProperties" : {
+ "type" : "string"
+ }
+ }
+ }
+}</code></pre>
+ </label>
+ </td>
+ </tr>
+ <tr>
+ <td colspan="2">
+ <label>
+ <details>
+ <summary>Response</summary>
+ <pre><code>{
+ "type" : "object",
+ "id" : "urn:jsonschema:org:apache:flink:table:gateway:rest:message:materializedtable:RefreshMaterializedTableResponseBody",
+ "properties" : {
+ "operationHandle" : {
+ "type" : "string"
+ }
+ }
+}</code></pre>
+ </label>
+ </td>
+ </tr>
+ </tbody>
+</table>
+<table class="rest-api table table-bordered">
+ <tbody>
+ <tr>
+ <td class="text-left" colspan="2"><h5><strong>/sessions/:session_handle/operations/:operation_handle/cancel</strong></h5></td>
+ </tr>
+ <tr>
+ <td class="text-left" style="width: 20%">Verb: <code>POST</code></td>
+ <td class="text-left">Response code: <code>200 OK</code></td>
+ </tr>
+ <tr>
+ <td colspan="2">Cancel the operation.</td>
+ </tr>
+ <tr>
+ <td colspan="2">Path parameters</td>
+ </tr>
+ <tr>
+ <td colspan="2">
+ <ul>
+<li><code>session_handle</code> - The SessionHandle that identifies a session.</li>
+<li><code>operation_handle</code> - The OperationHandle that identifies a operation.</li>
+ </ul>
+ </td>
+ </tr>
+ <tr>
+ <td colspan="2">
+ <label>
+ <details>
+ <summary>Request</summary>
+ <pre><code>{}</code></pre>
+ </label>
+ </td>
+ </tr>
+ <tr>
+ <td colspan="2">
+ <label>
+ <details>
+ <summary>Response</summary>
+ <pre><code>{
+ "type" : "object",
+ "id" : "urn:jsonschema:org:apache:flink:table:gateway:rest:message:operation:OperationStatusResponseBody",
+ "properties" : {
+ "status" : {
+ "type" : "string"
+ }
+ }
+}</code></pre>
+ </label>
+ </td>
+ </tr>
+ </tbody>
+</table>
+<table class="rest-api table table-bordered">
+ <tbody>
+ <tr>
+ <td class="text-left" colspan="2"><h5><strong>/sessions/:session_handle/operations/:operation_handle/close</strong></h5></td>
+ </tr>
+ <tr>
+ <td class="text-left" style="width: 20%">Verb: <code>DELETE</code></td>
+ <td class="text-left">Response code: <code>200 OK</code></td>
+ </tr>
+ <tr>
+ <td colspan="2">Close the operation.</td>
+ </tr>
+ <tr>
+ <td colspan="2">Path parameters</td>
+ </tr>
+ <tr>
+ <td colspan="2">
+ <ul>
+<li><code>session_handle</code> - The SessionHandle that identifies a session.</li>
+<li><code>operation_handle</code> - The OperationHandle that identifies a operation.</li>
+ </ul>
+ </td>
+ </tr>
+ <tr>
+ <td colspan="2">
+ <label>
+ <details>
+ <summary>Request</summary>
+ <pre><code>{}</code></pre>
+ </label>
+ </td>
+ </tr>
+ <tr>
+ <td colspan="2">
+ <label>
+ <details>
+ <summary>Response</summary>
+ <pre><code>{
+ "type" : "object",
+ "id" : "urn:jsonschema:org:apache:flink:table:gateway:rest:message:operation:OperationStatusResponseBody",
+ "properties" : {
+ "status" : {
+ "type" : "string"
+ }
+ }
+}</code></pre>
+ </label>
+ </td>
+ </tr>
+ </tbody>
+</table>
+<table class="rest-api table table-bordered">
+ <tbody>
+ <tr>
+ <td class="text-left" colspan="2"><h5><strong>/sessions/:session_handle/operations/:operation_handle/result/:token</strong></h5></td>
+ </tr>
+ <tr>
+ <td class="text-left" style="width: 20%">Verb: <code>GET</code></td>
+ <td class="text-left">Response code: <code>200 OK</code></td>
+ </tr>
+ <tr>
+ <td colspan="2">Fetch results of Operation.</td>
+ </tr>
+ <tr>
+ <td colspan="2">Path parameters</td>
+ </tr>
+ <tr>
+ <td colspan="2">
+ <ul>
+<li><code>session_handle</code> - The SessionHandle that identifies a session.</li>
+<li><code>operation_handle</code> - The OperationHandle that identifies a operation.</li>
+<li><code>token</code> - The token that identifies which batch of data to fetch.</li>
+ </ul>
+ </td>
+ </tr>
+ <tr>
+ <td colspan="2">Query parameters</td>
+ </tr>
+ <tr>
+ <td colspan="2">
+ <ul>
+<li><code>rowFormat</code> (mandatory): The row format to serialize the RowData.</li>
+ </ul>
+ </td>
+ </tr>
+ <tr>
+ <td colspan="2">
+ <label>
+ <details>
+ <summary>Request</summary>
+ <pre><code>{}</code></pre>
+ </label>
+ </td>
+ </tr>
+ <tr>
+ <td colspan="2">
+ <label>
+ <details>
+ <summary>Response</summary>
+ <pre><code>{
+ "type" : "any"
+}</code></pre>
+ </label>
+ </td>
+ </tr>
+ </tbody>
+</table>
+<table class="rest-api table table-bordered">
+ <tbody>
+ <tr>
+ <td class="text-left" colspan="2"><h5><strong>/sessions/:session_handle/operations/:operation_handle/status</strong></h5></td>
+ </tr>
+ <tr>
+ <td class="text-left" style="width: 20%">Verb: <code>GET</code></td>
+ <td class="text-left">Response code: <code>200 OK</code></td>
+ </tr>
+ <tr>
+ <td colspan="2">Get the status of operation.</td>
+ </tr>
+ <tr>
+ <td colspan="2">Path parameters</td>
+ </tr>
+ <tr>
+ <td colspan="2">
+ <ul>
+<li><code>session_handle</code> - The SessionHandle that identifies a session.</li>
+<li><code>operation_handle</code> - The OperationHandle that identifies a operation.</li>
+ </ul>
+ </td>
+ </tr>
+ <tr>
+ <td colspan="2">
+ <label>
+ <details>
+ <summary>Request</summary>
+ <pre><code>{}</code></pre>
+ </label>
+ </td>
+ </tr>
+ <tr>
+ <td colspan="2">
+ <label>
+ <details>
+ <summary>Response</summary>
+ <pre><code>{
+ "type" : "object",
+ "id" : "urn:jsonschema:org:apache:flink:table:gateway:rest:message:operation:OperationStatusResponseBody",
+ "properties" : {
+ "status" : {
+ "type" : "string"
+ }
+ }
+}</code></pre>
+ </label>
+ </td>
+ </tr>
+ </tbody>
+</table>
+<table class="rest-api table table-bordered">
+ <tbody>
+ <tr>
+ <td class="text-left" colspan="2"><h5><strong>/sessions/:session_handle/statements</strong></h5></td>
+ </tr>
+ <tr>
+ <td class="text-left" style="width: 20%">Verb: <code>POST</code></td>
+ <td class="text-left">Response code: <code>200 OK</code></td>
+ </tr>
+ <tr>
+ <td colspan="2">Execute a statement.</td>
+ </tr>
+ <tr>
+ <td colspan="2">Path parameters</td>
+ </tr>
+ <tr>
+ <td colspan="2">
+ <ul>
+<li><code>session_handle</code> - The SessionHandle that identifies a session.</li>
+ </ul>
+ </td>
+ </tr>
+ <tr>
+ <td colspan="2">
+ <label>
+ <details>
+ <summary>Request</summary>
+ <pre><code>{
+ "type" : "object",
+ "id" : "urn:jsonschema:org:apache:flink:table:gateway:rest:message:statement:ExecuteStatementRequestBody",
+ "properties" : {
+ "executionConfig" : {
+ "type" : "object",
+ "additionalProperties" : {
+ "type" : "string"
+ }
+ },
+ "executionTimeout" : {
+ "type" : "integer"
+ },
+ "statement" : {
+ "type" : "string"
+ }
+ }
+}</code></pre>
+ </label>
+ </td>
+ </tr>
+ <tr>
+ <td colspan="2">
+ <label>
+ <details>
+ <summary>Response</summary>
+ <pre><code>{
+ "type" : "object",
+ "id" : "urn:jsonschema:org:apache:flink:table:gateway:rest:message:statement:ExecuteStatementResponseBody",
+ "properties" : {
+ "operationHandle" : {
+ "type" : "string"
+ }
+ }
+}</code></pre>
+ </label>
+ </td>
+ </tr>
+ </tbody>
+</table>
diff --git a/docs/static/generated/rest_v3_sql_gateway.yml b/docs/static/generated/rest_v3_sql_gateway.yml
new file mode 100644
index 00000000000..3a1dd2b557c
--- /dev/null
+++ b/docs/static/generated/rest_v3_sql_gateway.yml
@@ -0,0 +1,663 @@
+openapi: 3.0.1
+info:
+ title: Flink SQL Gateway REST API
+ contact:
+ email: user@flink.apache.org
+ license:
+ name: Apache 2.0
+ url: https://www.apache.org/licenses/LICENSE-2.0.html
+ version: v3/1.20-SNAPSHOT
+paths:
+ /api_versions:
+ get:
+ description: Get the current available versions for the Rest Endpoint. The client
+ can choose one of the return version as the protocol for later communicate.
+ operationId: getApiVersion
+ responses:
+ "200":
+ description: The request was successful.
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/GetApiVersionResponseBody'
+ /info:
+ get:
+ description: Get meta data for this cluster.
+ operationId: getInfo
+ responses:
+ "200":
+ description: The request was successful.
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/GetInfoResponseBody'
+ /sessions:
+ post:
+ description: Opens a new session with specific properties. Specific properties
+ can be given for current session which will override the default properties
+ of gateway.
+ operationId: openSession
+ requestBody:
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/OpenSessionRequestBody'
+ responses:
+ "200":
+ description: The request was successful.
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/OpenSessionResponseBody'
+ /sessions/{session_handle}:
+ get:
+ description: Get the session configuration.
+ operationId: getSessionConfig
+ parameters:
+ - name: session_handle
+ in: path
+ description: The SessionHandle that identifies a session.
+ required: true
+ schema:
+ $ref: '#/components/schemas/SessionHandle'
+ responses:
+ "200":
+ description: The request was successful.
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/GetSessionConfigResponseBody'
+ delete:
+ description: Closes the specific session.
+ operationId: closeSession
+ parameters:
+ - name: session_handle
+ in: path
+ description: The SessionHandle that identifies a session.
+ required: true
+ schema:
+ $ref: '#/components/schemas/SessionHandle'
+ responses:
+ "200":
+ description: The request was successful.
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/CloseSessionResponseBody'
+ /sessions/{session_handle}/complete-statement:
+ get:
+ description: Get the completion hints for the given statement at the given position.
+ operationId: completeStatement
+ parameters:
+ - name: session_handle
+ in: path
+ description: The SessionHandle that identifies a session.
+ required: true
+ schema:
+ $ref: '#/components/schemas/SessionHandle'
+ requestBody:
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/CompleteStatementRequestBody'
+ responses:
+ "200":
+ description: The request was successful.
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/CompleteStatementResponseBody'
+ /sessions/{session_handle}/configure-session:
+ post:
+ description: |-
+ Configures the session with the statement which could be:
+ CREATE TABLE, DROP TABLE, ALTER TABLE, CREATE DATABASE, DROP DATABASE, ALTER DATABASE, CREATE FUNCTION, DROP FUNCTION, ALTER FUNCTION, CREATE CATALOG, DROP CATALOG, USE CATALOG, USE [CATALOG.]DATABASE, CREATE VIEW, DROP VIEW, LOAD MODULE, UNLOAD MODULE, USE MODULE, ADD JAR.
+ operationId: configureSession
+ parameters:
+ - name: session_handle
+ in: path
+ description: The SessionHandle that identifies a session.
+ required: true
+ schema:
+ $ref: '#/components/schemas/SessionHandle'
+ requestBody:
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/ConfigureSessionRequestBody'
+ responses:
+ "200":
+ description: The request was successful.
+ /sessions/{session_handle}/heartbeat:
+ post:
+ description: "Trigger heartbeat to tell the server that the client is active,\
+ \ and to keep the session alive as long as configured timeout value."
+ operationId: triggerSession
+ parameters:
+ - name: session_handle
+ in: path
+ description: The SessionHandle that identifies a session.
+ required: true
+ schema:
+ $ref: '#/components/schemas/SessionHandle'
+ responses:
+ "200":
+ description: The request was successful.
+ /sessions/{session_handle}/materialized-tables/{identifier}/refresh:
+ post:
+ description: Refresh materialized table
+ operationId: refreshMaterializedTable
+ parameters:
+ - name: session_handle
+ in: path
+ description: The SessionHandle that identifies a session.
+ required: true
+ schema:
+ $ref: '#/components/schemas/SessionHandle'
+ - name: identifier
+ in: path
+ description: The fully qualified string that identifies a materialized table.
+ required: true
+ schema:
+ type: string
+ requestBody:
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/RefreshMaterializedTableRequestBody'
+ responses:
+ "200":
+ description: The request was successful.
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/RefreshMaterializedTableResponseBody'
+ /sessions/{session_handle}/operations/{operation_handle}/cancel:
+ post:
+ description: Cancel the operation.
+ operationId: cancelOperation
+ parameters:
+ - name: session_handle
+ in: path
+ description: The SessionHandle that identifies a session.
+ required: true
+ schema:
+ $ref: '#/components/schemas/SessionHandle'
+ - name: operation_handle
+ in: path
+ description: The OperationHandle that identifies a operation.
+ required: true
+ schema:
+ $ref: '#/components/schemas/OperationHandle'
+ responses:
+ "200":
+ description: The request was successful.
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/OperationStatusResponseBody'
+ /sessions/{session_handle}/operations/{operation_handle}/close:
+ delete:
+ description: Close the operation.
+ operationId: closeOperation
+ parameters:
+ - name: session_handle
+ in: path
+ description: The SessionHandle that identifies a session.
+ required: true
+ schema:
+ $ref: '#/components/schemas/SessionHandle'
+ - name: operation_handle
+ in: path
+ description: The OperationHandle that identifies a operation.
+ required: true
+ schema:
+ $ref: '#/components/schemas/OperationHandle'
+ responses:
+ "200":
+ description: The request was successful.
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/OperationStatusResponseBody'
+ /sessions/{session_handle}/operations/{operation_handle}/result/{token}:
+ get:
+ description: Fetch results of Operation.
+ operationId: fetchResults
+ parameters:
+ - name: session_handle
+ in: path
+ description: The SessionHandle that identifies a session.
+ required: true
+ schema:
+ $ref: '#/components/schemas/SessionHandle'
+ - name: operation_handle
+ in: path
+ description: The OperationHandle that identifies a operation.
+ required: true
+ schema:
+ $ref: '#/components/schemas/OperationHandle'
+ - name: token
+ in: path
+ description: The token that identifies which batch of data to fetch.
+ required: true
+ schema:
+ type: integer
+ format: int64
+ - name: rowFormat
+ in: query
+ description: The row format to serialize the RowData.
+ required: true
+ style: form
+ schema:
+ $ref: '#/components/schemas/RowFormat'
+ responses:
+ "200":
+ description: The request was successful.
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/FetchResultsResponseBody'
+ /sessions/{session_handle}/operations/{operation_handle}/status:
+ get:
+ description: Get the status of operation.
+ operationId: getOperationStatus
+ parameters:
+ - name: session_handle
+ in: path
+ description: The SessionHandle that identifies a session.
+ required: true
+ schema:
+ $ref: '#/components/schemas/SessionHandle'
+ - name: operation_handle
+ in: path
+ description: The OperationHandle that identifies a operation.
+ required: true
+ schema:
+ $ref: '#/components/schemas/OperationHandle'
+ responses:
+ "200":
+ description: The request was successful.
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/OperationStatusResponseBody'
+ /sessions/{session_handle}/statements:
+ post:
+ description: Execute a statement.
+ operationId: executeStatement
+ parameters:
+ - name: session_handle
+ in: path
+ description: The SessionHandle that identifies a session.
+ required: true
+ schema:
+ $ref: '#/components/schemas/SessionHandle'
+ requestBody:
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/ExecuteStatementRequestBody'
+ responses:
+ "200":
+ description: The request was successful.
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/ExecuteStatementResponseBody'
+components:
+ schemas:
+ CloseSessionResponseBody:
+ type: object
+ properties:
+ status:
+ type: string
+ Column:
+ type: object
+ properties:
+ comment:
+ type: string
+ dataType:
+ $ref: '#/components/schemas/DataType'
+ name:
+ type: string
+ persisted:
+ type: boolean
+ physical:
+ type: boolean
+ ColumnInfo:
+ type: object
+ properties:
+ comment:
+ type: string
+ logicalType:
+ $ref: '#/components/schemas/LogicalType'
+ name:
+ type: string
+ CompleteStatementRequestBody:
+ type: object
+ properties:
+ position:
+ type: integer
+ format: int32
+ statement:
+ type: string
+ CompleteStatementResponseBody:
+ type: object
+ properties:
+ candidates:
+ type: array
+ items:
+ type: string
+ ConfigureSessionRequestBody:
+ type: object
+ properties:
+ executionTimeout:
+ type: integer
+ format: int64
+ statement:
+ type: string
+ ConstraintType:
+ type: string
+ enum:
+ - PRIMARY_KEY
+ - UNIQUE_KEY
+ DataType:
+ type: object
+ properties:
+ children:
+ type: array
+ items:
+ $ref: '#/components/schemas/DataType'
+ logicalType:
+ $ref: '#/components/schemas/LogicalType'
+ ExecuteStatementRequestBody:
+ type: object
+ properties:
+ executionConfig:
+ type: object
+ additionalProperties:
+ type: string
+ executionTimeout:
+ type: integer
+ format: int64
+ statement:
+ type: string
+ ExecuteStatementResponseBody:
+ type: object
+ properties:
+ operationHandle:
+ type: string
+ Expression:
+ type: object
+ FetchResultsResponseBody:
+ type: object
+ properties:
+ jobID:
+ $ref: '#/components/schemas/JobID'
+ nextResultUri:
+ type: string
+ queryResult:
+ type: boolean
+ resultKind:
+ $ref: '#/components/schemas/ResultKind'
+ resultType:
+ $ref: '#/components/schemas/ResultType'
+ results:
+ $ref: '#/components/schemas/ResultInfo'
+ FieldGetter:
+ type: object
+ GetApiVersionResponseBody:
+ type: object
+ properties:
+ versions:
+ type: array
+ items:
+ type: string
+ GetInfoResponseBody:
+ type: object
+ properties:
+ productName:
+ type: string
+ version:
+ type: string
+ GetSessionConfigResponseBody:
+ type: object
+ properties:
+ properties:
+ type: object
+ additionalProperties:
+ type: string
+ IntermediateDataSetID:
+ pattern: "[0-9a-f]{32}"
+ type: string
+ JobID:
+ pattern: "[0-9a-f]{32}"
+ type: string
+ JobVertexID:
+ pattern: "[0-9a-f]{32}"
+ type: string
+ LogicalType:
+ type: object
+ properties:
+ children:
+ type: array
+ items:
+ $ref: '#/components/schemas/LogicalType'
+ nullable:
+ type: boolean
+ typeRoot:
+ $ref: '#/components/schemas/LogicalTypeRoot'
+ LogicalTypeRoot:
+ type: string
+ enum:
+ - CHAR
+ - VARCHAR
+ - BOOLEAN
+ - BINARY
+ - VARBINARY
+ - DECIMAL
+ - TINYINT
+ - SMALLINT
+ - INTEGER
+ - BIGINT
+ - FLOAT
+ - DOUBLE
+ - DATE
+ - TIME_WITHOUT_TIME_ZONE
+ - TIMESTAMP_WITHOUT_TIME_ZONE
+ - TIMESTAMP_WITH_TIME_ZONE
+ - TIMESTAMP_WITH_LOCAL_TIME_ZONE
+ - INTERVAL_YEAR_MONTH
+ - INTERVAL_DAY_TIME
+ - ARRAY
+ - MULTISET
+ - MAP
+ - ROW
+ - DISTINCT_TYPE
+ - STRUCTURED_TYPE
+ - "NULL"
+ - RAW
+ - SYMBOL
+ - UNRESOLVED
+ OpenSessionRequestBody:
+ type: object
+ properties:
+ properties:
+ type: object
+ additionalProperties:
+ type: string
+ sessionName:
+ type: string
+ OpenSessionResponseBody:
+ type: object
+ properties:
+ sessionHandle:
+ type: string
+ OperationHandle:
+ type: object
+ properties:
+ identifier:
+ type: string
+ format: uuid
+ OperationStatusResponseBody:
+ type: object
+ properties:
+ status:
+ type: string
+ RefreshMaterializedTableRequestBody:
+ type: object
+ properties:
+ dynamicOptions:
+ type: object
+ additionalProperties:
+ type: string
+ executionConfig:
+ type: object
+ additionalProperties:
+ type: string
+ isPeriodic:
+ type: boolean
+ periodic:
+ type: boolean
+ scheduleTime:
+ type: string
+ staticPartitions:
+ type: object
+ additionalProperties:
+ type: string
+ RefreshMaterializedTableResponseBody:
+ type: object
+ properties:
+ operationHandle:
+ type: string
+ ResolvedExpression:
+ type: object
+ properties:
+ children:
+ type: array
+ items:
+ $ref: '#/components/schemas/Expression'
+ outputDataType:
+ $ref: '#/components/schemas/DataType'
+ resolvedChildren:
+ type: array
+ items:
+ $ref: '#/components/schemas/ResolvedExpression'
+ ResolvedSchema:
+ type: object
+ properties:
+ columnCount:
+ type: integer
+ format: int32
+ columnDataTypes:
+ type: array
+ items:
+ $ref: '#/components/schemas/DataType'
+ columnNames:
+ type: array
+ items:
+ type: string
+ columns:
+ type: array
+ items:
+ $ref: '#/components/schemas/Column'
+ primaryKey:
+ $ref: '#/components/schemas/UniqueConstraint'
+ primaryKeyIndexes:
+ type: array
+ items:
+ type: integer
+ format: int32
+ watermarkSpecs:
+ type: array
+ items:
+ $ref: '#/components/schemas/WatermarkSpec'
+ ResourceID:
+ pattern: "[0-9a-f]{32}"
+ type: string
+ ResultInfo:
+ type: object
+ properties:
+ columnInfos:
+ type: array
+ items:
+ $ref: '#/components/schemas/ColumnInfo'
+ data:
+ type: array
+ items:
+ $ref: '#/components/schemas/RowData'
+ fieldGetters:
+ type: array
+ items:
+ $ref: '#/components/schemas/FieldGetter'
+ resultSchema:
+ $ref: '#/components/schemas/ResolvedSchema'
+ rowFormat:
+ $ref: '#/components/schemas/RowFormat'
+ ResultKind:
+ type: string
+ enum:
+ - SUCCESS
+ - SUCCESS_WITH_CONTENT
+ ResultType:
+ type: string
+ enum:
+ - NOT_READY
+ - PAYLOAD
+ - EOS
+ RowData:
+ type: object
+ properties:
+ arity:
+ type: integer
+ format: int32
+ rowKind:
+ $ref: '#/components/schemas/RowKind'
+ RowFormat:
+ type: string
+ enum:
+ - JSON
+ - PLAIN_TEXT
+ RowKind:
+ type: string
+ enum:
+ - INSERT
+ - UPDATE_BEFORE
+ - UPDATE_AFTER
+ - DELETE
+ SerializedThrowable:
+ type: object
+ properties:
+ serialized-throwable:
+ type: string
+ format: binary
+ SessionHandle:
+ type: object
+ properties:
+ identifier:
+ type: string
+ format: uuid
+ TriggerId:
+ pattern: "[0-9a-f]{32}"
+ type: string
+ UniqueConstraint:
+ type: object
+ properties:
+ columns:
+ type: array
+ items:
+ type: string
+ enforced:
+ type: boolean
+ name:
+ type: string
+ type:
+ $ref: '#/components/schemas/ConstraintType'
+ WatermarkSpec:
+ type: object
+ properties:
+ rowtimeAttribute:
+ type: string
+ watermarkExpression:
+ $ref: '#/components/schemas/ResolvedExpression'
diff --git a/flink-table/flink-sql-gateway/src/main/java/org/apache/flink/table/gateway/rest/header/materializedtable/RefreshMaterializedTableHeaders.java b/flink-table/flink-sql-gateway/src/main/java/org/apache/flink/table/gateway/rest/header/materializedtable/RefreshMaterializedTableHeaders.java
index 3c966a55216..573ee3322c7 100644
--- a/flink-table/flink-sql-gateway/src/main/java/org/apache/flink/table/gateway/rest/header/materializedtable/RefreshMaterializedTableHeaders.java
+++ b/flink-table/flink-sql-gateway/src/main/java/org/apache/flink/table/gateway/rest/header/materializedtable/RefreshMaterializedTableHeaders.java
@@ -93,4 +93,9 @@ public class RefreshMaterializedTableHeaders
public static RefreshMaterializedTableHeaders getInstance() {
return INSTANCE;
}
+
+ @Override
+ public String operationId() {
+ return "refreshMaterializedTable";
+ }
}
diff --git a/flink-table/flink-sql-gateway/src/main/java/org/apache/flink/table/gateway/rest/message/materializedtable/MaterializedTableIdentifierPathParameter.java b/flink-table/flink-sql-gateway/src/main/java/org/apache/flink/table/gateway/rest/message/materializedtable/MaterializedTableIdentifierPathParameter.java
index a5be839b30b..531499086da 100644
--- a/flink-table/flink-sql-gateway/src/main/java/org/apache/flink/table/gateway/rest/message/materializedtable/MaterializedTableIdentifierPathParameter.java
+++ b/flink-table/flink-sql-gateway/src/main/java/org/apache/flink/table/gateway/rest/message/materializedtable/MaterializedTableIdentifierPathParameter.java
@@ -41,6 +41,6 @@ public class MaterializedTableIdentifierPathParameter extends MessagePathParamet
@Override
public String getDescription() {
- return "The materialized table identifier.";
+ return "The fully qualified string that identifies a materialized table.";
}
}
(flink) 02/03: [FLINK-35646][table] Exclude embedded workflow scheduler related rest api from docs
Posted by ro...@apache.org.
This is an automated email from the ASF dual-hosted git repository.
ron pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/flink.git
commit 993c5c12df1c6c3c0b8a51e24a96f0725334fa2e
Author: fengli <ld...@163.com>
AuthorDate: Fri Jun 21 16:38:45 2024 +0800
[FLINK-35646][table] Exclude embedded workflow scheduler related rest api from docs
---
.../scheduler/CreateEmbeddedSchedulerWorkflowHeaders.java | 7 +++++++
.../scheduler/DeleteEmbeddedSchedulerWorkflowHeaders.java | 7 +++++++
.../scheduler/ResumeEmbeddedSchedulerWorkflowHeaders.java | 7 +++++++
.../scheduler/SuspendEmbeddedSchedulerWorkflowHeaders.java | 7 +++++++
4 files changed, 28 insertions(+)
diff --git a/flink-table/flink-sql-gateway/src/main/java/org/apache/flink/table/gateway/rest/header/materializedtable/scheduler/CreateEmbeddedSchedulerWorkflowHeaders.java b/flink-table/flink-sql-gateway/src/main/java/org/apache/flink/table/gateway/rest/header/materializedtable/scheduler/CreateEmbeddedSchedulerWorkflowHeaders.java
index aa3c20c9559..6dd416f1a9c 100644
--- a/flink-table/flink-sql-gateway/src/main/java/org/apache/flink/table/gateway/rest/header/materializedtable/scheduler/CreateEmbeddedSchedulerWorkflowHeaders.java
+++ b/flink-table/flink-sql-gateway/src/main/java/org/apache/flink/table/gateway/rest/header/materializedtable/scheduler/CreateEmbeddedSchedulerWorkflowHeaders.java
@@ -18,6 +18,7 @@
package org.apache.flink.table.gateway.rest.header.materializedtable.scheduler;
+import org.apache.flink.annotation.docs.Documentation;
import org.apache.flink.runtime.rest.HttpMethodWrapper;
import org.apache.flink.runtime.rest.messages.EmptyMessageParameters;
import org.apache.flink.runtime.rest.versioning.RestAPIVersion;
@@ -33,6 +34,7 @@ import java.util.Collections;
import static org.apache.flink.table.gateway.rest.util.SqlGatewayRestAPIVersion.V3;
/** Message headers for create workflow in embedded scheduler. */
+@Documentation.ExcludeFromDocumentation("The embedded rest api.")
public class CreateEmbeddedSchedulerWorkflowHeaders
implements SqlGatewayMessageHeaders<
CreateEmbeddedSchedulerWorkflowRequestBody,
@@ -87,4 +89,9 @@ public class CreateEmbeddedSchedulerWorkflowHeaders
public static CreateEmbeddedSchedulerWorkflowHeaders getInstance() {
return INSTANCE;
}
+
+ @Override
+ public String operationId() {
+ return "createWorkflow";
+ }
}
diff --git a/flink-table/flink-sql-gateway/src/main/java/org/apache/flink/table/gateway/rest/header/materializedtable/scheduler/DeleteEmbeddedSchedulerWorkflowHeaders.java b/flink-table/flink-sql-gateway/src/main/java/org/apache/flink/table/gateway/rest/header/materializedtable/scheduler/DeleteEmbeddedSchedulerWorkflowHeaders.java
index 5b4e997db15..01677b1a2cc 100644
--- a/flink-table/flink-sql-gateway/src/main/java/org/apache/flink/table/gateway/rest/header/materializedtable/scheduler/DeleteEmbeddedSchedulerWorkflowHeaders.java
+++ b/flink-table/flink-sql-gateway/src/main/java/org/apache/flink/table/gateway/rest/header/materializedtable/scheduler/DeleteEmbeddedSchedulerWorkflowHeaders.java
@@ -18,9 +18,11 @@
package org.apache.flink.table.gateway.rest.header.materializedtable.scheduler;
+import org.apache.flink.annotation.docs.Documentation;
import org.apache.flink.runtime.rest.HttpMethodWrapper;
/** Message headers for delete workflow in embedded scheduler. */
+@Documentation.ExcludeFromDocumentation("The embedded rest api.")
public class DeleteEmbeddedSchedulerWorkflowHeaders
extends AbstractEmbeddedSchedulerWorkflowHeaders {
@@ -47,4 +49,9 @@ public class DeleteEmbeddedSchedulerWorkflowHeaders
public static DeleteEmbeddedSchedulerWorkflowHeaders getInstance() {
return INSTANCE;
}
+
+ @Override
+ public String operationId() {
+ return "deleteWorkflow";
+ }
}
diff --git a/flink-table/flink-sql-gateway/src/main/java/org/apache/flink/table/gateway/rest/header/materializedtable/scheduler/ResumeEmbeddedSchedulerWorkflowHeaders.java b/flink-table/flink-sql-gateway/src/main/java/org/apache/flink/table/gateway/rest/header/materializedtable/scheduler/ResumeEmbeddedSchedulerWorkflowHeaders.java
index cc5ad891cb4..59312f58d2a 100644
--- a/flink-table/flink-sql-gateway/src/main/java/org/apache/flink/table/gateway/rest/header/materializedtable/scheduler/ResumeEmbeddedSchedulerWorkflowHeaders.java
+++ b/flink-table/flink-sql-gateway/src/main/java/org/apache/flink/table/gateway/rest/header/materializedtable/scheduler/ResumeEmbeddedSchedulerWorkflowHeaders.java
@@ -18,6 +18,7 @@
package org.apache.flink.table.gateway.rest.header.materializedtable.scheduler;
+import org.apache.flink.annotation.docs.Documentation;
import org.apache.flink.runtime.rest.HttpMethodWrapper;
import org.apache.flink.runtime.rest.messages.EmptyMessageParameters;
import org.apache.flink.runtime.rest.messages.EmptyResponseBody;
@@ -33,6 +34,7 @@ import java.util.Collections;
import static org.apache.flink.table.gateway.rest.util.SqlGatewayRestAPIVersion.V3;
/** Message headers for resume workflow in embedded scheduler. */
+@Documentation.ExcludeFromDocumentation("The embedded rest api.")
public class ResumeEmbeddedSchedulerWorkflowHeaders
implements SqlGatewayMessageHeaders<
ResumeEmbeddedSchedulerWorkflowRequestBody,
@@ -87,4 +89,9 @@ public class ResumeEmbeddedSchedulerWorkflowHeaders
public Collection<? extends RestAPIVersion<?>> getSupportedAPIVersions() {
return Collections.singleton(V3);
}
+
+ @Override
+ public String operationId() {
+ return "resumeWorkflow";
+ }
}
diff --git a/flink-table/flink-sql-gateway/src/main/java/org/apache/flink/table/gateway/rest/header/materializedtable/scheduler/SuspendEmbeddedSchedulerWorkflowHeaders.java b/flink-table/flink-sql-gateway/src/main/java/org/apache/flink/table/gateway/rest/header/materializedtable/scheduler/SuspendEmbeddedSchedulerWorkflowHeaders.java
index 4a8482759f3..000ccdcd54d 100644
--- a/flink-table/flink-sql-gateway/src/main/java/org/apache/flink/table/gateway/rest/header/materializedtable/scheduler/SuspendEmbeddedSchedulerWorkflowHeaders.java
+++ b/flink-table/flink-sql-gateway/src/main/java/org/apache/flink/table/gateway/rest/header/materializedtable/scheduler/SuspendEmbeddedSchedulerWorkflowHeaders.java
@@ -18,9 +18,11 @@
package org.apache.flink.table.gateway.rest.header.materializedtable.scheduler;
+import org.apache.flink.annotation.docs.Documentation;
import org.apache.flink.runtime.rest.HttpMethodWrapper;
/** Message headers for suspend workflow in embedded scheduler. */
+@Documentation.ExcludeFromDocumentation("The embedded rest api.")
public class SuspendEmbeddedSchedulerWorkflowHeaders
extends AbstractEmbeddedSchedulerWorkflowHeaders {
@@ -47,4 +49,9 @@ public class SuspendEmbeddedSchedulerWorkflowHeaders
public static SuspendEmbeddedSchedulerWorkflowHeaders getInstance() {
return INSTANCE;
}
+
+ @Override
+ public String operationId() {
+ return "suspendWorkflow";
+ }
}