flink-sql-gateway icon indicating copy to clipboard operation
flink-sql-gateway copied to clipboard

Published 20 hours ago • verified publisher icon ververica

API Documentation

Open romainr opened this issue 4 years ago • 5 comments

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/

romainr avatar Apr 25 '20 17:04 romainr

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.

tsreaper avatar Apr 26 '20 02:04 tsreaper

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

godfreyhe avatar Apr 26 '20 03:04 godfreyhe

https://github.com/ververica/flink-sql-gateway/pull/45

romainr avatar May 20 '20 18:05 romainr

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

felixzh2020 avatar Dec 18 '20 03:12 felixzh2020

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.

yababer avatar Jun 22 '21 18:06 yababer