This is an automated email from the ASF dual-hosted git repository.
panyuepeng pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/flink.git
The following commit(s) were added to refs/heads/master by this push:
new b631cca8d71 [FLINK-39041][docs] Rebuild REST API docs pages to
supplement the missing content. (#27855)
b631cca8d71 is described below
commit b631cca8d71f5c5719659fbe4eb3902bd5e6d8bd
Author: Yuepeng Pan <[email protected]>
AuthorDate: Wed Apr 1 18:17:22 2026 +0800
[FLINK-39041][docs] Rebuild REST API docs pages to supplement the missing
content. (#27855)
---
.../shortcodes/generated/rest_v1_dispatcher.html | 28 +++++++++++------
docs/static/generated/rest_v1_dispatcher.yml | 36 +++++++++++-----------
docs/static/generated/rest_v1_sql_gateway.yml | 22 +++++++++++++
docs/static/generated/rest_v2_sql_gateway.yml | 22 +++++++++++++
docs/static/generated/rest_v3_sql_gateway.yml | 22 +++++++++++++
docs/static/generated/rest_v4_sql_gateway.yml | 22 +++++++++++++
6 files changed, 124 insertions(+), 28 deletions(-)
diff --git a/docs/layouts/shortcodes/generated/rest_v1_dispatcher.html
b/docs/layouts/shortcodes/generated/rest_v1_dispatcher.html
index f9c2073a702..07ebf893e07 100644
--- a/docs/layouts/shortcodes/generated/rest_v1_dispatcher.html
+++ b/docs/layouts/shortcodes/generated/rest_v1_dispatcher.html
@@ -132,6 +132,10 @@
"jid" : {
"type" : "any"
},
+ "jobType" : {
+ "type" : "string",
+ "enum" : [ "BATCH", "STREAMING" ]
+ },
"last-modification" : {
"type" : "integer"
},
@@ -141,6 +145,10 @@
"pending-operators" : {
"type" : "integer"
},
+ "schedulerType" : {
+ "type" : "string",
+ "enum" : [ "Default", "Adaptive", "AdaptiveBatch" ]
+ },
"start-time" : {
"type" : "integer"
},
@@ -1549,23 +1557,23 @@ Using 'curl' you can upload a jar via 'curl -X POST -H
"Expect:" -F "jarfile=@pa
"jid" : {
"type" : "any"
},
+ "jobType" : {
+ "type" : "string",
+ "enum" : [ "BATCH", "STREAMING" ]
+ },
"last-modification" : {
"type" : "integer"
},
"name" : {
"type" : "string"
},
- "jobType" : {
- "type" : "string",
- "enum" : [ "BATCH", "STREAMING" ]
+ "pending-operators" : {
+ "type" : "integer"
},
"schedulerType" : {
"type" : "string",
"enum" : [ "Default", "Adaptive", "AdaptiveBatch" ]
},
- "pending-operators" : {
- "type" : "integer"
- },
"start-time" : {
"type" : "integer"
},
@@ -1648,10 +1656,6 @@ Using 'curl' you can upload a jar via 'curl -X POST -H
"Expect:" -F "jarfile=@pa
"type" : "string",
"enum" : [ "BATCH", "STREAMING" ]
},
- "schedulerType" : {
- "type" : "string",
- "enum" : [ "Default", "Adaptive", "AdaptiveBatch" ]
- },
"maxParallelism" : {
"type" : "integer"
},
@@ -1734,6 +1738,10 @@ Using 'curl' you can upload a jar via 'curl -X POST -H
"Expect:" -F "jarfile=@pa
}
}
},
+ "schedulerType" : {
+ "type" : "string",
+ "enum" : [ "Default", "Adaptive", "AdaptiveBatch" ]
+ },
"start-time" : {
"type" : "integer"
},
diff --git a/docs/static/generated/rest_v1_dispatcher.yml
b/docs/static/generated/rest_v1_dispatcher.yml
index 2467aa7e8ad..16df36dc728 100644
--- a/docs/static/generated/rest_v1_dispatcher.yml
+++ b/docs/static/generated/rest_v1_dispatcher.yml
@@ -921,12 +921,12 @@ paths:
description: Returns the job rescale configuration.
operationId: getJobRescaleConfig
parameters:
- - name: jobid
- in: path
- description: 32-character hexadecimal string value that identifies a
job.
- required: true
- schema:
- $ref: "#/components/schemas/JobID"
+ - name: jobid
+ in: path
+ description: 32-character hexadecimal string value that identifies a
job.
+ required: true
+ schema:
+ $ref: "#/components/schemas/JobID"
responses:
"200":
description: The request was successful.
@@ -2586,18 +2586,18 @@ components:
format: int64
jid:
$ref: "#/components/schemas/JobID"
+ jobType:
+ $ref: "#/components/schemas/JobType"
last-modification:
type: integer
format: int64
name:
type: string
- jobType:
- $ref: "#/components/schemas/JobType"
- schedulerType:
- $ref: "#/components/schemas/SchedulerType"
pending-operators:
type: integer
format: int32
+ schedulerType:
+ $ref: "#/components/schemas/SchedulerType"
start-time:
type: integer
format: int64
@@ -2625,8 +2625,6 @@ components:
$ref: "#/components/schemas/JobID"
job-type:
$ref: "#/components/schemas/JobType"
- schedulerType:
- $ref: "#/components/schemas/SchedulerType"
maxParallelism:
type: integer
format: int64
@@ -2640,6 +2638,8 @@ components:
format: int32
plan:
$ref: "#/components/schemas/Plan"
+ schedulerType:
+ $ref: "#/components/schemas/SchedulerType"
start-time:
type: integer
format: int64
@@ -3162,16 +3162,16 @@ components:
type: string
triggerId:
$ref: "#/components/schemas/TriggerId"
- SchedulerType:
- type: string
- enum:
- - Default
- - Adaptive
- - AdaptiveBatch
SchedulerExecutionMode:
type: string
enum:
- REACTIVE
+ SchedulerType:
+ type: string
+ enum:
+ - Default
+ - Adaptive
+ - AdaptiveBatch
SerializedThrowable:
type: object
properties:
diff --git a/docs/static/generated/rest_v1_sql_gateway.yml
b/docs/static/generated/rest_v1_sql_gateway.yml
index e39c1f84d24..3d89ace8a6b 100644
--- a/docs/static/generated/rest_v1_sql_gateway.yml
+++ b/docs/static/generated/rest_v1_sql_gateway.yml
@@ -259,6 +259,7 @@ components:
enum:
- PRIMARY_KEY
- UNIQUE_KEY
+ - IMMUTABLE_COLUMNS
DataType:
type: object
properties:
@@ -325,6 +326,19 @@ components:
type: object
additionalProperties:
type: string
+ ImmutableColumnsConstraint:
+ type: object
+ properties:
+ columns:
+ type: array
+ items:
+ type: string
+ enforced:
+ type: boolean
+ name:
+ type: string
+ type:
+ $ref: "#/components/schemas/ConstraintType"
Index:
type: object
properties:
@@ -388,6 +402,7 @@ components:
- UNRESOLVED
- DESCRIPTOR
- VARIANT
+ - BITMAP
OpenSessionRequestBody:
type: object
properties:
@@ -444,6 +459,13 @@ components:
type: array
items:
$ref: "#/components/schemas/Column"
+ immutableColumnIndexes:
+ type: array
+ items:
+ type: integer
+ format: int32
+ immutableColumns:
+ $ref: "#/components/schemas/ImmutableColumnsConstraint"
indexes:
type: array
items:
diff --git a/docs/static/generated/rest_v2_sql_gateway.yml
b/docs/static/generated/rest_v2_sql_gateway.yml
index 61e56c97a23..e1bb7691a30 100644
--- a/docs/static/generated/rest_v2_sql_gateway.yml
+++ b/docs/static/generated/rest_v2_sql_gateway.yml
@@ -333,6 +333,7 @@ components:
enum:
- PRIMARY_KEY
- UNIQUE_KEY
+ - IMMUTABLE_COLUMNS
DataType:
type: object
properties:
@@ -399,6 +400,19 @@ components:
type: object
additionalProperties:
type: string
+ ImmutableColumnsConstraint:
+ type: object
+ properties:
+ columns:
+ type: array
+ items:
+ type: string
+ enforced:
+ type: boolean
+ name:
+ type: string
+ type:
+ $ref: "#/components/schemas/ConstraintType"
Index:
type: object
properties:
@@ -462,6 +476,7 @@ components:
- UNRESOLVED
- DESCRIPTOR
- VARIANT
+ - BITMAP
OpenSessionRequestBody:
type: object
properties:
@@ -518,6 +533,13 @@ components:
type: array
items:
$ref: "#/components/schemas/Column"
+ immutableColumnIndexes:
+ type: array
+ items:
+ type: integer
+ format: int32
+ immutableColumns:
+ $ref: "#/components/schemas/ImmutableColumnsConstraint"
indexes:
type: array
items:
diff --git a/docs/static/generated/rest_v3_sql_gateway.yml
b/docs/static/generated/rest_v3_sql_gateway.yml
index 55edd3f8a02..3952b19a4f0 100644
--- a/docs/static/generated/rest_v3_sql_gateway.yml
+++ b/docs/static/generated/rest_v3_sql_gateway.yml
@@ -362,6 +362,7 @@ components:
enum:
- PRIMARY_KEY
- UNIQUE_KEY
+ - IMMUTABLE_COLUMNS
DataType:
type: object
properties:
@@ -428,6 +429,19 @@ components:
type: object
additionalProperties:
type: string
+ ImmutableColumnsConstraint:
+ type: object
+ properties:
+ columns:
+ type: array
+ items:
+ type: string
+ enforced:
+ type: boolean
+ name:
+ type: string
+ type:
+ $ref: "#/components/schemas/ConstraintType"
Index:
type: object
properties:
@@ -491,6 +505,7 @@ components:
- UNRESOLVED
- DESCRIPTOR
- VARIANT
+ - BITMAP
OpenSessionRequestBody:
type: object
properties:
@@ -573,6 +588,13 @@ components:
type: array
items:
$ref: "#/components/schemas/Column"
+ immutableColumnIndexes:
+ type: array
+ items:
+ type: integer
+ format: int32
+ immutableColumns:
+ $ref: "#/components/schemas/ImmutableColumnsConstraint"
indexes:
type: array
items:
diff --git a/docs/static/generated/rest_v4_sql_gateway.yml
b/docs/static/generated/rest_v4_sql_gateway.yml
index 4079ae2b105..abc68761c97 100644
--- a/docs/static/generated/rest_v4_sql_gateway.yml
+++ b/docs/static/generated/rest_v4_sql_gateway.yml
@@ -356,6 +356,7 @@ components:
enum:
- PRIMARY_KEY
- UNIQUE_KEY
+ - IMMUTABLE_COLUMNS
DataType:
type: object
properties:
@@ -438,6 +439,19 @@ components:
type: object
additionalProperties:
type: string
+ ImmutableColumnsConstraint:
+ type: object
+ properties:
+ columns:
+ type: array
+ items:
+ type: string
+ enforced:
+ type: boolean
+ name:
+ type: string
+ type:
+ $ref: "#/components/schemas/ConstraintType"
Index:
type: object
properties:
@@ -501,6 +515,7 @@ components:
- UNRESOLVED
- DESCRIPTOR
- VARIANT
+ - BITMAP
OpenSessionRequestBody:
type: object
properties:
@@ -583,6 +598,13 @@ components:
type: array
items:
$ref: "#/components/schemas/Column"
+ immutableColumnIndexes:
+ type: array
+ items:
+ type: integer
+ format: int32
+ immutableColumns:
+ $ref: "#/components/schemas/ImmutableColumnsConstraint"
indexes:
type: array
items:
