Documentation generators

This module contains generators that create HTML files directly from Flink's source code.

REST API documentation

The RestAPIDocGenerator can be used to generate a full reference of the REST API of a RestServerEndpoint. A separate file is generated for each endpoint.

To integrate a new endpoint into the generator

1. Add a new DocumentingRestEndpoint class to RestAPIDocGenerator that extends the new endpoint class
2. Add another call to createHtmlFile in RestAPIDocGenerator#main
3. Regenerate the documentation by running mvn package -Dgenerate-rest-docs -nsu
4. Integrate the generated file into the REST API documentation by adding {% include generated/<file-name>.html %} to the corresponding markdown file.

The documentation must be regenerated whenever

• a handler is added to/removed from a RestServerEndpoint
• any used MessageHeaders class or any referenced RequestBody, ResponseBody, MessageParameters or MessageParameter class is modified.