org.apache.flink.docs.rest

Class OpenApiSpecGenerator

java.lang.Object

org.apache.flink.docs.rest.OpenApiSpecGenerator

public class OpenApiSpecGenerator
extends Object

OpenAPI spec generator for the 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 %}.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	OpenApiSpecGenerator.NameClashDetectingTypeNameResolver A TypeNameResolver that detects name-clashes between top-level and inner classes.

Constructor Summary

Constructors

Constructor and Description
OpenApiSpecGenerator()

Method Summary

Methods inherited from class java.lang.Object

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

Constructor Detail

OpenApiSpecGenerator

public OpenApiSpecGenerator()