reswqa commented on code in PR #20622:
URL: https://github.com/apache/flink/pull/20622#discussion_r951112029
##########
flink-docs/src/main/java/org/apache/flink/docs/rest/RestAPIDocGenerator.java:
##########
@@ -131,7 +132,7 @@ public static void main(String[] args) throws IOException,
ConfigurationExceptio
@VisibleForTesting
static void createHtmlFile(
- DocumentingRestEndpoint restEndpoint, RuntimeRestAPIVersion
apiVersion, Path outputFile)
+ DocumentingRestEndpoint restEndpoint, RestAPIVersion apiVersion,
Path outputFile)
Review Comment:
I suggest move the generation of spec and doc of `RuntimeRestAPI` from
`RestAPIDocGenerator` and `OpenApiSpecGenerator` called
`RuntimeOpenApiSpecGenerator` and `RuntimeRestAPIDocGenerator` just like
`SqlGatewayOpenApiSpecGenerator` and `SqlGatewayRestAPIDocGenerator` to make
these two classes only keep some common logic. And we can even rename
`OpenApiSpecGenerator` to `RestAPISpecGenerator`.
##########
flink-table/flink-sql-gateway/src/main/java/org/apache/flink/table/gateway/rest/header/session/TriggerSessionHeartbeatHeaders.java:
##########
@@ -76,4 +76,9 @@ public String getTargetRestEndpointURL() {
public static TriggerSessionHeartbeatHeaders getInstance() {
return INSTANCE;
}
+
+ @Override
+ public String operationId() {
+ return "TriggerSession";
Review Comment:
Why is it not return `TriggerSessionHeartbeat` here? Is there any other
document specifying the name ? I just noticed that other operationId are
generated by class name without headers.
##########
flink-table/flink-sql-gateway/src/main/java/org/apache/flink/table/gateway/rest/header/operation/CancelOperationHeaders.java:
##########
@@ -52,4 +52,9 @@ public String getTargetRestEndpointURL() {
public static CancelOperationHeaders getInstance() {
return INSTANCE;
}
+
+ @Override
+ public String operationId() {
+ return "CancelOperation";
Review Comment:
I have looked at the override of the `operationId ` method of some existing
`XXXHeaders` like `ShutdownHeaders` and found that their first letter is
lowercase, should we keep this convention?
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: [email protected]
For queries about this service, please contact Infrastructure at:
[email protected]
