API Documentation

[romainr]

Sorry if I missed it, but I only found https://docs.google.com/document/d/1DKpFdov1o_ObvrCmU-5xi-VrT6nR2gxq-BbswSSI9j8/edit#.

For example the Livy docs are pretty handy:

• https://livy.incubator.apache.org/docs/latest/rest-api.html
• https://livy.incubator.apache.org/examples/

[tsreaper]

Thanks for opening this issue. Flink SQL gateway is initially released as the JDBC server for the Flink JDBC driver, so we didn't expose REST API at the beginning.

But now we discover that users are willing to directly talk to the gateway. We're going to clean up the API a bit and release an API document in a day or two.

[godfreyhe]

@romainr Thanks for the suggestion, just as @tsreaper said, we will publish the API doc ASAP.

[romainr]

#45

[felixzh2020]

directly talk to the gateway seems better, because JDBC server doesn't support stream

[yababer]

We created a quick openapi 3.0.0 spec to speak to the rest interface for our use case. It would be better if that spec was part of the repo. And even better if it was served from the gateway. If it is of interest, we can create a pull request and upload it.