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

Published 20 hours ago • verified publisher icon ververica

Add detailed documentation

Open tsreaper opened this issue 5 years ago • 3 comments

This PR adds detailed documentation for the gateway, including the REST API documentation and an API usage example.

tsreaper avatar Apr 27 '20 12:04 tsreaper

Just another note: in the list of supported commands, I'll make a clear separation between commands that ends in a job execution and those that does not involve any interaction with the Flink cluster. I'd like to have this more clear when I started approaching to this project

fpompermaier avatar Apr 28 '20 07:04 fpompermaier

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

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.

That's great!

fpompermaier avatar Jun 23 '21 07:06 fpompermaier