org.apache.flink.docs.rest

Class RuntimeOpenApiSpecGenerator

java.lang.Object

org.apache.flink.docs.rest.RuntimeOpenApiSpecGenerator

public class RuntimeOpenApiSpecGenerator
extends Object

OpenAPI spec generator for the Runtime Rest API.

One OpenAPI yml file is generated for each RestServerEndpoint implementation that can be embedded into .md files using {% include ${generated.docs.dir}/file.yml %}.

Constructor Summary

Constructors

Constructor and Description
RuntimeOpenApiSpecGenerator()

Method Summary

Modifier and Type	Method and Description
static void	main(String[] args) Generates the Runtime REST API OpenAPI spec.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

RuntimeOpenApiSpecGenerator

public RuntimeOpenApiSpecGenerator()

Method Detail

main

public static void main(String[] args)
                 throws IOException,
                        ConfigurationException

Generates the Runtime REST API OpenAPI spec.

Parameters:

args - args[0] contains the directory into which the generated files are placed

Throws:

IOException - if any file operation failed

ConfigurationException