Skip to content

Adds EQL, ESQL, features API example requests and responses #2879

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.

Sign up for GitHub

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

Jump to bottom
Merged
merged 4 commits into from
Sep 13, 2024
Merged

Adds EQL, ESQL, features API example requests and responses #2879

merged 4 commits into from
Sep 13, 2024

Conversation

szabosteve
Copy link
Contributor

@szabosteve szabosteve commented Sep 9, 2024 •
edited by lcawl
Loading

Overview

Related to #2482.
This PR adds request and response examples to the EQL, ES|QL, and features APIs.

It also adds overlays to apply the examples to the appropriate OpenAPI documents.

@szabosteve szabosteve requested a review from lcawl September 9, 2024 14:31
@github-actions GitHub Actions
Copy link
Contributor

github-actions bot commented Sep 9, 2024

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

API Status Request Response
eql.get_status 🟢 3/3 3/3
eql.search 🟢 32/32 32/32
esql.query 🔴 253/253 15/253
features.get_features 🟢 2/2 2/2
features.reset_features ⚪ Missing test Missing test

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

@github-actions GitHub Actions
Copy link
Contributor

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

API Status Request Response
eql.get_status 🟢 3/3 3/3
eql.search 🟢 32/32 32/32
esql.query 🔴 255/255 15/255
features.get_features 🟢 2/2 2/2
features.reset_features ⚪ Missing test Missing test

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

lcawl
lcawl approved these changes Sep 11, 2024
View reviewed changes
Copy link
Contributor

@lcawl lcawl left a comment

Choose a reason for hiding this comment

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

LGTM
I haven't tested applying them to the openAPI document, however, so lmk if you want that done here too.

@lcawl lcawl force-pushed the szabosteve/api-examples-p4 branch from a6c590d to 5dfa53f Compare September 12, 2024 20:48
@github-actions GitHub Actions
Copy link
Contributor

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

API Status Request Response
eql.get_status 🟢 3/3 3/3
eql.search 🟢 32/32 32/32
esql.query 🔴 255/255 15/255
features.get_features 🟢 2/2 2/2
features.reset_features ⚪ Missing test Missing test

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

@github-actions GitHub Actions
Copy link
Contributor

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

API Status Request Response
eql.get_status 🟢 3/3 3/3
eql.search 🟢 32/32 32/32
esql.query 🔴 255/255 15/255
features.get_features 🟢 2/2 2/2
features.reset_features ⚪ Missing test Missing test

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

@github-actions GitHub Actions
Copy link
Contributor

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

API Status Request Response
eql.get_status 🟢 3/3 3/3
eql.search 🟢 32/32 32/32
esql.query 🔴 255/255 15/255
features.get_features 🟢 2/2 2/2
features.reset_features ⚪ Missing test Missing test

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

@szabosteve szabosteve merged commit a37d021 into main Sep 13, 2024
6 checks passed
@szabosteve szabosteve deleted the szabosteve/api-examples-p4 branch September 13, 2024 14:59
github-actions bot pushed a commit that referenced this pull request Sep 16, 2024
@szabosteve @lcawl @github-actions
Adds EQL, ESQL, features API example requests and responses (#2879)
44c84bd 
Co-authored-by: lcawl <[email protected]>
(cherry picked from commit a37d021)
@github-actions github-actions bot mentioned this pull request Sep 16, 2024
Merged
szabosteve added a commit that referenced this pull request Sep 16, 2024
@github-actions @szabosteve
Adds EQL, ESQL, features API example requests and responses (#2879) (#…
b80ad1e 
…2892)

Co-authored-by: lcawl <[email protected]>
(cherry picked from commit a37d021)

Co-authored-by: István Zoltán Szabó <[email protected]>
@lcawl lcawl mentioned this pull request Sep 11, 2024
Closed
65 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@lcawl lcawl lcawl approved these changes

Assignees
No one assigned
Labels
backport 8.19 specification
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
2 participants
@szabosteve @lcawl