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

[DOCS] Add examples for delete by query API #3574

Merged
merged 1 commit into from
Jan 23, 2025
Merged

Conversation

lcawl
Copy link
Contributor

@lcawl lcawl commented Jan 23, 2025

Relates to #2482

This PR adds examples copied from https://www.elastic.co/guide/en/elasticsearch/reference/master/docs-delete-by-query.html. It also edits the descriptions and adds missing @doc_id details.

Copy link
Contributor

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

API Status Request Response
delete_by_query_rethrottle 🟢 1/1 1/1
delete_by_query 🟢 5/5 4/4
tasks.get 🟢 10/10 10/10

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

Copy link
Contributor

@szabosteve szabosteve left a comment

Choose a reason for hiding this comment

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

LGTM

@lcawl lcawl merged commit 083284a into main Jan 23, 2025
14 checks passed
@lcawl lcawl deleted the delete-by-query-examples branch January 23, 2025 15:31
github-actions bot pushed a commit that referenced this pull request Jan 23, 2025
Copy link
Contributor

The backport to 8.17 failed:

The process '/usr/bin/git' failed with exit code 1

To backport manually, run these commands in your terminal:

# Fetch latest updates from GitHub
git fetch
# Create a new working tree
git worktree add .worktrees/backport-8.17 8.17
# Navigate to the new working tree
cd .worktrees/backport-8.17
# Create a new branch
git switch --create backport-3574-to-8.17
# Cherry-pick the merged commit of this pull request and resolve the conflicts
git cherry-pick -x --mainline 1 083284a72e4c62753fadcf83a69dbc0504e3a7e4
# Push it to GitHub
git push --set-upstream origin backport-3574-to-8.17
# Go back to the original working tree
cd ../..
# Delete the working tree
git worktree remove .worktrees/backport-8.17

Then, create a pull request where the base branch is 8.17 and the compare/head branch is backport-3574-to-8.17.

lcawl added a commit that referenced this pull request Jan 23, 2025
@lcawl
Copy link
Contributor Author

lcawl commented Jan 23, 2025

💚 All backports created successfully

Status Branch Result
8.x

Questions ?

Please refer to the Backport tool documentation

lcawl added a commit that referenced this pull request Jan 23, 2025
@lcawl
Copy link
Contributor Author

lcawl commented Jan 23, 2025

💚 All backports created successfully

Status Branch Result
8.17

Questions ?

Please refer to the Backport tool documentation

lcawl added a commit that referenced this pull request Jan 23, 2025
lcawl added a commit that referenced this pull request Jan 23, 2025
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