Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Flint async api doc #2387

Open
wants to merge 7 commits into
base: main
Choose a base branch
from

Conversation

YANG-DB
Copy link
Member

@YANG-DB YANG-DB commented Oct 27, 2023

Description

Add swagger API & documentation for the _async_sql query endpoint.

# Async Query Interface API Documentation

The Async Query Interface API enables the execution of queries on top of a Spark engine. This is specifically designed to work with the `S3Glue` data source connector and allows queries to be run asynchronously.

The Async Query Interface is especially useful for running complex, time-consuming queries without blocking the main thread. The API provides endpoints for query creation, result retrieval, and query cancellation.

--- Swagger ---

Screenshot 2023-10-26 at 9 19 25 PM

Check List

  • New functionality includes testing.
    • All tests pass, including unit test, integration test and doctest
  • New functionality has been documented.
    • New functionality has javadoc added
    • New functionality has user manual doc added
  • Commits are signed per the DCO using --signoff

By submitting this pull request, I confirm that my contribution is made under the terms of the Apache 2.0 license.
For more information on following Developer Certificate of Origin and signing off your commits, please check here.

@codecov
Copy link

codecov bot commented Oct 27, 2023

Codecov Report

Merging #2387 (9db4bd2) into main (a5512f5) will decrease coverage by 0.01%.
Report is 4 commits behind head on main.
The diff coverage is n/a.

@@             Coverage Diff              @@
##               main    #2387      +/-   ##
============================================
- Coverage     96.47%   96.46%   -0.01%     
- Complexity     4915     4918       +3     
============================================
  Files           465      465              
  Lines         13519    13522       +3     
  Branches        910      913       +3     
============================================
+ Hits          13042    13044       +2     
  Misses          458      458              
- Partials         19       20       +1     
Flag Coverage Δ
sql-engine 96.46% <ø> (-0.01%) ⬇️

Flags with carried forward coverage won't be shown. Click here to find out more.

see 4 files with indirect coverage changes

type: object
properties:
status:
type: string
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Should we add enum here for status?

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

sure

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants