Skip to content

Add more index API examples #3430

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

Add more index API examples #3430

merged 5 commits into from
Jan 7, 2025

Conversation

lcawl
Copy link
Contributor

@lcawl lcawl commented Jan 4, 2025

Relates to #2482

This PR copies more examples from https://www.elastic.co/guide/en/elasticsearch/reference/master/indices.html
It also adds copies cluster and index privilege details and adds missing doc_id values.

Copy link
Contributor

github-actions bot commented Jan 4, 2025

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

API Status Request Response
cluster.delete_component_template 🟢 2/2 2/2
cluster.get_component_template 🔴 12/12 10/12
cluster.put_component_template 🔴 21/29 29/29
dangling_indices.delete_dangling_index Missing test Missing test
dangling_indices.import_dangling_index Missing test Missing test
dangling_indices.list_dangling_indices Missing test Missing test
field_caps 🟢 63/63 63/63
indices.analyze 🟢 243/243 243/243
indices.clear_cache 🟢 4/4 4/4
indices.clone 🟢 5/5 5/5
indices.close 🟢 49/49 49/49
indices.create 🔴 1063/1163 1163/1163
indices.delete_alias 🔴 12/12 5/12
indices.delete_index_template 🟢 1/1 1/1
indices.delete_template 🟢 9/9 9/9
indices.delete 🟢 105/105 105/105
indices.disk_usage 🟢 6/6 6/6
indices.exists_template 🟢 15/15 15/15
indices.exists 🟢 39/39 39/39
indices.field_usage_stats 🟢 5/5 5/5
indices.flush 🟢 41/41 41/41
indices.forcemerge 🟢 12/12 12/12
indices.get_alias 🟢 68/68 68/68
indices.get_field_mapping 🟢 15/15 15/15
indices.get_index_template 🔴 19/19 17/19
indices.get_mapping 🔴 133/133 131/133
indices.get_settings 🔴 74/74 71/74
indices.get_template 🟢 30/30 30/30
indices.get 🟢 55/55 55/55
indices.open 🟢 20/20 20/20
indices.put_alias 🔴 58/58 20/58
indices.put_index_template 🔴 59/68 68/68
indices.put_mapping 🔴 111/115 115/115
indices.put_template 🔴 45/46 46/46
indices.recovery 🟢 9/9 9/9
indices.refresh 🟢 271/271 271/271
indices.resolve_cluster 🔴 10/12 12/12
indices.resolve_index 🟢 6/6 6/6
indices.rollover 🔴 26/26 1/26
indices.segments 🔴 6/6 5/6
indices.shard_stores 🔴 5/5 4/5
indices.simulate_index_template 🔴 6/7 5/7
indices.simulate_template 🔴 5/5 4/5
indices.split 🟢 11/11 11/11
indices.stats 🔴 113/113 30/112
indices.unfreeze 🟢 1/1 1/1
ingest.get_pipeline 🟢 22/22 22/22
ingest.simulate 🟢 10/10 10/10

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

Copy link
Contributor

github-actions bot commented Jan 6, 2025

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

API Status Request Response
cluster.delete_component_template 🟢 2/2 2/2
cluster.get_component_template 🔴 12/12 10/12
cluster.put_component_template 🔴 21/29 29/29
dangling_indices.delete_dangling_index Missing test Missing test
dangling_indices.import_dangling_index Missing test Missing test
dangling_indices.list_dangling_indices Missing test Missing test
field_caps 🟢 63/63 63/63
indices.analyze 🟢 243/243 243/243
indices.clear_cache 🟢 4/4 4/4
indices.clone 🟢 5/5 5/5
indices.close 🟢 49/49 49/49
indices.create 🔴 1063/1163 1163/1163
indices.delete_alias 🔴 12/12 5/12
indices.delete_index_template 🟢 1/1 1/1
indices.delete_template 🟢 9/9 9/9
indices.delete 🟢 105/105 105/105
indices.disk_usage 🟢 6/6 6/6
indices.exists_template 🟢 15/15 15/15
indices.exists 🟢 39/39 39/39
indices.field_usage_stats 🟢 5/5 5/5
indices.flush 🟢 41/41 41/41
indices.forcemerge 🟢 12/12 12/12
indices.get_alias 🟢 68/68 68/68
indices.get_field_mapping 🟢 15/15 15/15
indices.get_index_template 🔴 19/19 17/19
indices.get_mapping 🔴 133/133 131/133
indices.get_settings 🔴 74/74 71/74
indices.get_template 🟢 30/30 30/30
indices.get 🟢 55/55 55/55
indices.open 🟢 20/20 20/20
indices.put_alias 🔴 58/58 20/58
indices.put_index_template 🔴 59/68 68/68
indices.put_mapping 🔴 111/115 115/115
indices.put_template 🔴 45/46 46/46
indices.recovery 🟢 9/9 9/9
indices.refresh 🟢 271/271 271/271
indices.resolve_cluster 🔴 10/12 12/12
indices.resolve_index 🟢 6/6 6/6
indices.rollover 🔴 26/26 1/26
indices.segments 🔴 6/6 5/6
indices.shard_stores 🔴 5/5 4/5
indices.simulate_index_template 🔴 6/7 5/7
indices.simulate_template 🔴 5/5 4/5
indices.split 🟢 11/11 11/11
indices.stats 🔴 113/113 30/112
indices.unfreeze 🟢 1/1 1/1
ingest.get_pipeline 🟢 22/22 22/22
ingest.simulate 🟢 10/10 10/10

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

Copy link
Contributor

github-actions bot commented Jan 6, 2025

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

API Status Request Response
cluster.delete_component_template 🟢 2/2 2/2
cluster.get_component_template 🔴 12/12 10/12
cluster.put_component_template 🔴 21/29 29/29
dangling_indices.delete_dangling_index Missing test Missing test
dangling_indices.import_dangling_index Missing test Missing test
dangling_indices.list_dangling_indices Missing test Missing test
field_caps 🟢 63/63 63/63
indices.analyze 🟢 243/243 243/243
indices.clear_cache 🟢 4/4 4/4
indices.clone 🟢 5/5 5/5
indices.close 🟢 49/49 49/49
indices.create 🔴 1063/1163 1163/1163
indices.delete_alias 🔴 12/12 5/12
indices.delete_index_template 🟢 1/1 1/1
indices.delete_template 🟢 9/9 9/9
indices.delete 🟢 105/105 105/105
indices.disk_usage 🟢 6/6 6/6
indices.exists_template 🟢 15/15 15/15
indices.exists 🟢 39/39 39/39
indices.field_usage_stats 🟢 5/5 5/5
indices.flush 🟢 41/41 41/41
indices.forcemerge 🟢 12/12 12/12
indices.get_alias 🟢 68/68 68/68
indices.get_field_mapping 🟢 15/15 15/15
indices.get_index_template 🔴 19/19 17/19
indices.get_mapping 🔴 133/133 131/133
indices.get_settings 🔴 74/74 71/74
indices.get_template 🟢 30/30 30/30
indices.get 🟢 55/55 55/55
indices.open 🟢 20/20 20/20
indices.put_alias 🔴 58/58 20/58
indices.put_index_template 🔴 59/68 68/68
indices.put_mapping 🔴 111/115 115/115
indices.put_template 🔴 45/46 46/46
indices.recovery 🟢 9/9 9/9
indices.refresh 🟢 271/271 271/271
indices.resolve_cluster 🔴 10/12 12/12
indices.resolve_index 🟢 6/6 6/6
indices.rollover 🔴 26/26 1/26
indices.segments 🔴 6/6 5/6
indices.shard_stores 🔴 5/5 4/5
indices.simulate_index_template 🔴 6/7 5/7
indices.simulate_template 🔴 5/5 4/5
indices.split 🟢 11/11 11/11
indices.stats 🔴 113/113 30/112
indices.unfreeze 🟢 1/1 1/1
ingest.get_pipeline 🟢 22/22 22/22
ingest.simulate 🟢 10/10 10/10

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

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

github-actions bot commented Jan 6, 2025

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

API Status Request Response
cluster.delete_component_template 🟢 2/2 2/2
cluster.get_component_template 🔴 12/12 10/12
cluster.put_component_template 🔴 21/29 29/29
dangling_indices.delete_dangling_index Missing test Missing test
dangling_indices.import_dangling_index Missing test Missing test
dangling_indices.list_dangling_indices Missing test Missing test
field_caps 🟢 63/63 63/63
indices.analyze 🟢 243/243 243/243
indices.clear_cache 🟢 4/4 4/4
indices.clone 🟢 5/5 5/5
indices.close 🟢 49/49 49/49
indices.create 🔴 1063/1163 1163/1163
indices.delete_alias 🔴 12/12 5/12
indices.delete_index_template 🟢 1/1 1/1
indices.delete_template 🟢 9/9 9/9
indices.delete 🟢 105/105 105/105
indices.disk_usage 🟢 6/6 6/6
indices.exists_template 🟢 15/15 15/15
indices.exists 🟢 39/39 39/39
indices.field_usage_stats 🟢 5/5 5/5
indices.flush 🟢 41/41 41/41
indices.forcemerge 🟢 12/12 12/12
indices.get_alias 🟢 68/68 68/68
indices.get_field_mapping 🟢 15/15 15/15
indices.get_index_template 🔴 19/19 17/19
indices.get_mapping 🔴 133/133 131/133
indices.get_settings 🔴 74/74 71/74
indices.get_template 🟢 30/30 30/30
indices.get 🟢 55/55 55/55
indices.open 🟢 20/20 20/20
indices.put_alias 🔴 58/58 20/58
indices.put_index_template 🔴 59/68 68/68
indices.put_mapping 🔴 111/115 115/115
indices.put_settings 🔴 55/58 58/58
indices.put_template 🔴 45/46 46/46
indices.recovery 🟢 9/9 9/9
indices.refresh 🟢 271/271 271/271
indices.resolve_cluster 🔴 10/12 12/12
indices.resolve_index 🟢 6/6 6/6
indices.rollover 🔴 26/26 1/26
indices.segments 🔴 6/6 5/6
indices.shard_stores 🔴 5/5 4/5
indices.simulate_index_template 🔴 6/7 5/7
indices.simulate_template 🔴 5/5 4/5
indices.split 🟢 11/11 11/11
indices.stats 🔴 113/113 30/112
indices.unfreeze 🟢 1/1 1/1
ingest.get_pipeline 🟢 22/22 22/22
ingest.simulate 🟢 10/10 10/10

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

@lcawl lcawl merged commit 0664ce5 into main Jan 7, 2025
8 checks passed
@lcawl lcawl deleted the index-examples branch January 7, 2025 04:26
Copy link
Contributor

github-actions bot commented Jan 7, 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-3430-to-8.x
# Cherry-pick the merged commit of this pull request and resolve the conflicts
git cherry-pick -x --mainline 1 0664ce5b80ba58d0b75f814e9a95fef2df53958c
# Push it to GitHub
git push --set-upstream origin backport-3430-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-3430-to-8.x.

Copy link
Contributor

github-actions bot commented Jan 7, 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-3430-to-8.17
# Cherry-pick the merged commit of this pull request and resolve the conflicts
git cherry-pick -x --mainline 1 0664ce5b80ba58d0b75f814e9a95fef2df53958c
# Push it to GitHub
git push --set-upstream origin backport-3430-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-3430-to-8.17.

lcawl added a commit that referenced this pull request Jan 7, 2025
(cherry picked from commit 0664ce5)
@lcawl
Copy link
Contributor Author

lcawl commented Jan 7, 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 7, 2025
(cherry picked from commit 0664ce5)
@lcawl
Copy link
Contributor Author

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