Skip to content

Add searchable snapshot API examples #3459

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 2 commits into from
Jan 8, 2025
Merged

Add searchable snapshot API examples #3459

merged 2 commits into from
Jan 8, 2025

Conversation

lcawl
Copy link
Contributor

@lcawl lcawl commented Jan 8, 2025

Relates to #2482

This PR copies examples and descriptions from https://www.elastic.co/guide/en/elasticsearch/reference/master/searchable-snapshots-apis.html.
It also adds doc_id values in preparation for redirects.

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
searchable_snapshots.cache_stats Missing test Missing test
searchable_snapshots.clear_cache 🟢 1/1 1/1
searchable_snapshots.mount 🟢 4/4 4/4
searchable_snapshots.stats 🟢 1/1 1/1

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

@lcawl lcawl changed the title Add search snapshot API examples Add searchable snapshot API examples Jan 8, 2025
@lcawl lcawl marked this pull request as ready for review January 8, 2025 03:28
@lcawl lcawl force-pushed the snapshot-examples branch from d09b646 to 2ac27de Compare January 8, 2025 18:28
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
searchable_snapshots.cache_stats Missing test Missing test
searchable_snapshots.clear_cache 🟢 1/1 1/1
searchable_snapshots.mount 🟢 4/4 4/4
searchable_snapshots.stats 🟢 1/1 1/1

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

@lcawl lcawl merged commit fd32ef0 into main Jan 8, 2025
8 checks passed
@lcawl lcawl deleted the snapshot-examples branch January 8, 2025 18:38
Copy link
Contributor

github-actions bot commented Jan 8, 2025

The backport to 8.x 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.x 8.x
# Navigate to the new working tree
cd .worktrees/backport-8.x
# Create a new branch
git switch --create backport-3459-to-8.x
# Cherry-pick the merged commit of this pull request and resolve the conflicts
git cherry-pick -x --mainline 1 fd32ef05ff46091c0a91be83866f2430b2e6229d
# Push it to GitHub
git push --set-upstream origin backport-3459-to-8.x
# Go back to the original working tree
cd ../..
# Delete the working tree
git worktree remove .worktrees/backport-8.x

Then, create a pull request where the base branch is 8.x and the compare/head branch is backport-3459-to-8.x.

Copy link
Contributor

github-actions bot commented Jan 8, 2025

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-3459-to-8.17
# Cherry-pick the merged commit of this pull request and resolve the conflicts
git cherry-pick -x --mainline 1 fd32ef05ff46091c0a91be83866f2430b2e6229d
# Push it to GitHub
git push --set-upstream origin backport-3459-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-3459-to-8.17.

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

lcawl commented Jan 8, 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 8, 2025
@lcawl
Copy link
Contributor Author

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