Skip to content

Add SQL API examples #3479

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

Merged
merged 4 commits into from
Jan 9, 2025
Merged

Add SQL API examples #3479

merged 4 commits into from
Jan 9, 2025

Conversation

lcawl
Copy link
Contributor

@lcawl lcawl commented Jan 8, 2025

Relates to #2482

This PR copies examples from https://www.elastic.co/guide/en/elasticsearch/reference/master/sql-apis.html
It also adds missing doc_id values, sorts some properties (required properties first, then optional properties alphabetically).
It also edits and augments some descriptions based on what was in the documentation.

Copy link
Contributor

github-actions bot commented Jan 8, 2025

Following you can find the validation results for the APIs you have changed.

API Status Request Response
sql.clear_cursor 🟢 1/1 1/1
sql.delete_async Missing test Missing test

You can validate these APIs yourself by using the make validate target.

@lcawl lcawl requested a review from a team January 8, 2025 21:03
Copy link
Contributor

github-actions bot commented Jan 8, 2025

Following you can find the validation results for the APIs you have changed.

API Status Request Response
sql.clear_cursor 🟢 1/1 1/1
sql.delete_async Missing test Missing test
sql.get_async_status Missing test Missing test
sql.get_async Missing test Missing test
sql.query 🟢 4/4 4/4
sql.translate 🔴 1/1 0/1

You can validate these APIs yourself by using the make validate target.

@lcawl lcawl marked this pull request as ready for review January 8, 2025 21:04
Copy link
Contributor

@marciw marciw left a comment

Choose a reason for hiding this comment

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

LGTM w/ a li'l typo 🦝

Copy link
Contributor

github-actions bot commented Jan 9, 2025

Following you can find the validation results for the APIs you have changed.

API Status Request Response
sql.clear_cursor 🟢 1/1 1/1
sql.delete_async Missing test Missing test
sql.get_async_status Missing test Missing test
sql.get_async Missing test Missing test
sql.query 🟢 4/4 4/4
sql.translate 🔴 1/1 0/1

You can validate these APIs yourself by using the make validate target.

1 similar comment
Copy link
Contributor

github-actions bot commented Jan 9, 2025

Following you can find the validation results for the APIs you have changed.

API Status Request Response
sql.clear_cursor 🟢 1/1 1/1
sql.delete_async Missing test Missing test
sql.get_async_status Missing test Missing test
sql.get_async Missing test Missing test
sql.query 🟢 4/4 4/4
sql.translate 🔴 1/1 0/1

You can validate these APIs yourself by using the make validate target.

@lcawl lcawl merged commit 28adc40 into main Jan 9, 2025
8 checks passed
@lcawl lcawl deleted the sql-examples branch January 9, 2025 20:12
github-actions bot pushed a commit that referenced this pull request Jan 9, 2025
Co-authored-by: Marci W <[email protected]>
(cherry picked from commit 28adc40)
github-actions bot pushed a commit that referenced this pull request Jan 9, 2025
Co-authored-by: Marci W <[email protected]>
(cherry picked from commit 28adc40)
lcawl added a commit that referenced this pull request Jan 9, 2025
Co-authored-by: Marci W <[email protected]>
(cherry picked from commit 28adc40)

Co-authored-by: Lisa Cawley <[email protected]>
lcawl added a commit that referenced this pull request Jan 9, 2025
Co-authored-by: Marci W <[email protected]>
(cherry picked from commit 28adc40)

Co-authored-by: Lisa Cawley <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants