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] Edit index operation summaries #3268

Merged
merged 4 commits into from
Dec 11, 2024
Merged

[DOCS] Edit index operation summaries #3268

merged 4 commits into from
Dec 11, 2024

Conversation

lcawl
Copy link
Contributor

@lcawl lcawl commented Dec 10, 2024

Relates to #3226

This PR edits the index operation summaries (https://www.elastic.co/docs/api/doc/elasticsearch/group/endpoint-indices) based on information from https://www.elastic.co/guide/en/elasticsearch/reference/current/indices.html. It also adds some descriptions that existed only in the latter.

Copy link
Contributor

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

API Status Request Response
indices.clear_cache 🟢 4/4 4/4
indices.clone 🟢 5/5 5/5
indices.close 🟢 50/50 50/50
indices.disk_usage 🟢 5/5 5/5
indices.downsample 🟢 1/1 1/1
indices.field_usage_stats 🟢 5/5 5/5
indices.flush 🟢 41/41 41/41
indices.forcemerge 🟢 12/12 12/12
indices.promote_data_stream Missing test Missing test
indices.recovery 🟢 9/9 9/9
indices.reload_search_analyzers 🟢 2/2 2/2
indices.resolve_cluster 🔴 10/12 12/12
indices.segments 🔴 6/6 5/6
indices.shard_stores 🔴 5/5 4/5
indices.shrink 🟢 5/5 5/5
indices.split 🟢 11/11 11/11
indices.stats 🔴 113/113 30/112
indices.unfreeze 🟢 1/1 1/1

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

Copy link
Contributor

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

API Status Request Response
indices.clear_cache 🟢 4/4 4/4
indices.clone 🟢 5/5 5/5
indices.close 🟢 50/50 50/50
indices.disk_usage 🟢 5/5 5/5
indices.downsample 🟢 1/1 1/1
indices.field_usage_stats 🟢 5/5 5/5
indices.flush 🟢 41/41 41/41
indices.forcemerge 🟢 12/12 12/12
indices.promote_data_stream Missing test Missing test
indices.recovery 🟢 9/9 9/9
indices.reload_search_analyzers 🟢 2/2 2/2
indices.resolve_cluster 🔴 10/12 12/12
indices.segments 🔴 6/6 5/6
indices.shard_stores 🔴 5/5 4/5
indices.shrink 🟢 5/5 5/5
indices.split 🟢 11/11 11/11
indices.stats 🔴 113/113 30/112
indices.unfreeze 🟢 1/1 1/1

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

Copy link
Contributor

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

API Status Request Response
indices.clear_cache 🟢 4/4 4/4
indices.clone 🟢 5/5 5/5
indices.close 🟢 50/50 50/50
indices.disk_usage 🟢 5/5 5/5
indices.downsample 🟢 1/1 1/1
indices.field_usage_stats 🟢 5/5 5/5
indices.flush 🟢 41/41 41/41
indices.forcemerge 🟢 12/12 12/12
indices.promote_data_stream Missing test Missing test
indices.put_template 🔴 45/46 46/46
indices.recovery 🟢 9/9 9/9
indices.reload_search_analyzers 🟢 2/2 2/2
indices.resolve_cluster 🔴 10/12 12/12
indices.segments 🔴 6/6 5/6
indices.shard_stores 🔴 5/5 4/5
indices.shrink 🟢 5/5 5/5
indices.split 🟢 11/11 11/11
indices.stats 🔴 113/113 30/112
indices.unfreeze 🟢 1/1 1/1

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

@lcawl lcawl merged commit 7d436a0 into main Dec 11, 2024
7 checks passed
@lcawl lcawl deleted the index-summaries branch December 11, 2024 18:09
Copy link
Contributor

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

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

lcawl added a commit that referenced this pull request Dec 11, 2024
@lcawl
Copy link
Contributor Author

lcawl commented Dec 11, 2024

💚 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 Dec 11, 2024
@lcawl
Copy link
Contributor Author

lcawl commented Dec 11, 2024

💚 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 Dec 11, 2024
lcawl added a commit that referenced this pull request Dec 12, 2024
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