WencongLiu commented on code in PR #20622: URL: https://github.com/apache/flink/pull/20622#discussion_r959152410
########## flink-docs/src/main/java/org/apache/flink/docs/rest/SqlGatewayOpenApiSpecGenerator.java: ########## @@ -0,0 +1,61 @@ +/* + * Licensed to the Apache Software Foundation (ASF) under one + * or more contributor license agreements. See the NOTICE file + * distributed with this work for additional information + * regarding copyright ownership. The ASF licenses this file + * to you under the Apache License, Version 2.0 (the + * "License"); you may not use this file except in compliance + * with the License. You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ + +package org.apache.flink.docs.rest; + +import org.apache.flink.runtime.rest.RestServerEndpoint; +import org.apache.flink.table.gateway.rest.util.DocumentingSqlGatewayRestEndpoint; +import org.apache.flink.table.gateway.rest.util.SqlGatewayRestAPIVersion; +import org.apache.flink.util.ConfigurationException; + +import java.io.IOException; +import java.nio.file.Paths; + +import static org.apache.flink.docs.rest.OpenApiSpecGenerator.createDocumentationFile; + +/** + * OpenAPI spec generator for the Sql Gateway Rest API. + * + * <p>One OpenAPI yml file is generated for each {@link RestServerEndpoint} implementation that can + * be embedded into .md files using {@code {% include ${generated.docs.dir}/file.yml %}}. + */ +public class SqlGatewayOpenApiSpecGenerator { + + /** + * Generates the Sql Gateway REST API OpenAPI spec. + * + * @param args args[0] contains the directory into which the generated files are placed + * @throws IOException if any file operation failed + */ + public static void main(String[] args) throws IOException, ConfigurationException { + String outputDirectory = args[0]; + + for (final SqlGatewayRestAPIVersion apiVersion : SqlGatewayRestAPIVersion.values()) { + if (apiVersion == SqlGatewayRestAPIVersion.V0) { + // this version exists only for testing purposes + continue; + } + createDocumentationFile( + new DocumentingSqlGatewayRestEndpoint(), + apiVersion, + Paths.get( + outputDirectory, + "sql_gateway_rest_" + apiVersion.getURLVersionPrefix() + ".yml")); Review Comment: Done. ########## flink-docs/src/main/java/org/apache/flink/docs/rest/SqlGatewayRestAPIDocGenerator.java: ########## @@ -0,0 +1,85 @@ +/* + * Licensed to the Apache Software Foundation (ASF) under one + * or more contributor license agreements. See the NOTICE file + * distributed with this work for additional information + * regarding copyright ownership. The ASF licenses this file + * to you under the Apache License, Version 2.0 (the + * "License"); you may not use this file except in compliance + * with the License. You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ + +package org.apache.flink.docs.rest; + +import org.apache.flink.runtime.rest.RestServerEndpoint; +import org.apache.flink.table.gateway.rest.util.DocumentingSqlGatewayRestEndpoint; +import org.apache.flink.table.gateway.rest.util.SqlGatewayRestAPIVersion; +import org.apache.flink.util.ConfigurationException; + +import java.io.IOException; +import java.nio.file.Paths; + +import static org.apache.flink.docs.rest.RestAPIDocGenerator.createHtmlFile; + +/** + * Generator for the Sql Gateway Rest API documentation. + * + * <p>One HTML file is generated for each {@link RestServerEndpoint} implementation that can be + * embedded into .md files using {@code {% include ${generated.docs.dir}/file.html %}}. Each file + * contains a series of HTML tables, one for each REST call. + * + * <p>The generated table for each REST call looks like this: + * + * <pre> + * ---------------------------------------------------------- + * | URL | + * ---------------------------------------------------------- + * | Verb: verb (GET|POST|...) | Response code: responseCode| + * ---------------------------------------------------------- + * | Path parameters (if any are defined) | + * ---------------------------------------------------------- + * | - parameterName: description | + * | ... | + * ---------------------------------------------------------- + * | Query parameters (if any are defined) | + * ---------------------------------------------------------- + * | - parameterName (requisiteness): description | + * | ... | + * ---------------------------------------------------------- + * | Request json schema (a collapsible "Request" button) | + * ---------------------------------------------------------- + * | Response json schema (a collapsible "Response" button) | + * ---------------------------------------------------------- + * </pre> + */ +public class SqlGatewayRestAPIDocGenerator { + + /** + * Generates the Sql Gateway REST API documentation. + * + * @param args args[0] contains the directory into which the generated files are placed + * @throws IOException if any file operation failed + */ + public static void main(String[] args) throws IOException, ConfigurationException { + String outputDirectory = args[0]; + for (final SqlGatewayRestAPIVersion apiVersion : SqlGatewayRestAPIVersion.values()) { + if (apiVersion == SqlGatewayRestAPIVersion.V0) { + // this version exists only for testing purposes + continue; + } + createHtmlFile( + new DocumentingSqlGatewayRestEndpoint(), + apiVersion, + Paths.get( + outputDirectory, + "sql_gateway_rest_" + apiVersion.getURLVersionPrefix() + ".html")); Review Comment: Done. -- 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: issues-unsubscr...@flink.apache.org For queries about this service, please contact Infrastructure at: us...@infra.apache.org
