Skip to content

[DOCS] Clean up more duplicated enum values #4458

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 3 commits into from
Jun 19, 2025
Merged

[DOCS] Clean up more duplicated enum values #4458

merged 3 commits into from
Jun 19, 2025

Conversation

lcawl
Copy link
Contributor

@lcawl lcawl commented Jun 5, 2025

Continues #4441

This PR removes the remainder of the cat -h or -s long lists of enum values from the OpenAPI document via overlay since that info is now listed (with additional details) in the description.

It also cleans up some other places where we'd listed the "valid values" in the description and thus the information was appearing twice.

Copy link
Contributor

github-actions bot commented Jun 5, 2025

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.close 🟢 49/49 49/49
indices.delete 🟢 105/105 105/105
indices.exists_alias 🟢 37/37 37/37
indices.exists 🟢 39/39 39/39
indices.flush 🟢 49/49 49/49
indices.get_alias 🟢 68/68 68/68
indices.get_data_lifecycle Missing test Missing test
indices.get_data_stream_options Missing test Missing test
indices.get_field_mapping 🟢 15/15 15/15
indices.get_mapping 🔴 148/148 146/148
indices.open 🟢 20/20 20/20
indices.put_data_lifecycle Missing test Missing test
indices.put_data_stream_options Missing test Missing test
indices.put_mapping 🔴 128/132 135/135
indices.refresh 🟢 286/286 286/286
indices.resolve_cluster 🟢 13/13 13/13
indices.resolve_index 🟢 6/6 6/6
indices.segments 🔴 6/6 5/6
indices.validate_query 🟢 12/12 12/12
ml.put_job 🟢 227/227 225/225
ml.update_datafeed 🟢 7/7 7/7
open_point_in_time 🟢 7/7 7/7
search_shards 🟢 7/7 7/7
search_template 🟢 2/2 1/1
update_by_query 🟢 5/5 4/4

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

@lcawl lcawl marked this pull request as ready for review June 5, 2025 14:15
@lcawl lcawl requested review from a team as code owners June 5, 2025 14:15
Copy link
Contributor

github-actions bot commented Jun 5, 2025

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.close 🟢 49/49 49/49
indices.delete 🟢 105/105 105/105
indices.exists_alias 🟢 37/37 37/37
indices.exists 🟢 39/39 39/39
indices.flush 🟢 41/41 41/41
indices.get_alias 🟢 68/68 68/68
indices.get_data_lifecycle Missing test Missing test
indices.get_data_stream_options Missing test Missing test
indices.get_field_mapping 🟢 15/15 15/15
indices.get_mapping 🔴 144/144 142/144
indices.open 🟢 20/20 20/20
indices.put_data_lifecycle Missing test Missing test
indices.put_data_stream_options Missing test Missing test
indices.put_mapping 🔴 124/128 131/131
indices.refresh 🟢 283/283 283/283
indices.resolve_cluster 🟢 13/13 13/13
indices.resolve_index 🟢 6/6 6/6
indices.segments 🔴 6/6 5/6
indices.validate_query 🟢 12/12 12/12
ml.put_job 🟢 227/227 225/225
ml.update_datafeed 🟢 7/7 7/7
open_point_in_time 🟢 7/7 7/7
search_shards 🟢 7/7 7/7
search_template 🟢 2/2 1/1
update_by_query 🟢 5/5 4/4

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 02327c4 into main Jun 19, 2025
8 checks passed
@lcawl lcawl deleted the cat-hide branch June 19, 2025 16:03
Copy link
Contributor

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

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

Copy link
Contributor

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

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

Copy link
Contributor

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

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

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

lcawl commented Jun 19, 2025

💚 All backports created successfully

Status Branch Result
9.0

Questions ?

Please refer to the Backport tool documentation

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

lcawl commented Jun 19, 2025

💚 All backports created successfully

Status Branch Result
8.19

Questions ?

Please refer to the Backport tool documentation

@lcawl
Copy link
Contributor Author

lcawl commented Jun 19, 2025

💚 All backports created successfully

Status Branch Result
8.18

Questions ?

Please refer to the Backport tool documentation

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