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

Open
wants to merge 4 commits into
base: main
Choose a base branch
from
Open

[DOCS] Clean up more duplicated enum values #4458

wants to merge 4 commits into from

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 🟢 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.

@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.

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.

1 participant