[FLINK-35646][table] Exclude embedded workflow scheduler related rest api from docs
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 aa3c20c..6dd416f 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 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 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 5b4e997..01677b1 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 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 cc5ad89..59312f5 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 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 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 4a84827..000ccdc 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 static SuspendEmbeddedSchedulerWorkflowHeaders getInstance() {
return INSTANCE;
}
+
+ @Override
+ public String operationId() {
+ return "suspendWorkflow";
+ }
}
