Skip to content

add Java language examples #4580

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 24 commits into
base: main
Choose a base branch
from
Open

add Java language examples #4580

wants to merge 24 commits into from

Conversation

l-trotta
Copy link
Contributor

@l-trotta l-trotta commented Jun 16, 2025

Followup of #4514, adding java client examples for the docs.
Out of 652 examples, 388 were generated by the java-request-converter, while the others are skipped for a number of reasons (APIs not supported by the client, unions the client cannot deserialize, classes that don't support json deserialization directly).
Out of those 388 examples, 12 had to be fixed manually (because of missing string escapes or missing/wrong brackets). I'm not 100% sure these will all compile, but in that case, changes should be minimal.

Unlike the other language examples, these won't be regenerated each time the openapi files are updated, since they rely on the experimental java-request-converter, so they will be generated locally when needed, using the new new generate-language-examples-with-java make command.

Copy link
Contributor

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

API Status Request Response
async_search.submit 🟢 7/7 7/7
autoscaling.put_autoscaling_policy Missing test Missing test
cat.aliases 🟢 29/29 29/29
cat.allocation 🟢 12/12 12/12
cat.component_templates 🟢 3/3 3/3
cat.count 🟢 9/9 9/9
cat.fielddata 🟢 6/6 6/6
cat.health 🟢 3/3 3/3
cat.indices 🟢 33/33 32/32
cat.master 🟢 1/1 1/1
cat.ml_data_frame_analytics 🟢 5/5 5/5
cat.ml_datafeeds 🟢 4/4 4/4
cat.ml_jobs 🟢 4/4 4/4
cat.ml_trained_models 🟢 1/1 1/1
cat.nodeattrs 🟢 5/5 5/5
cat.nodes 🟢 11/11 11/11
cat.pending_tasks 🟢 1/1 1/1
cat.plugins 🟢 2/2 2/2
cat.recovery 🟢 6/6 6/6
cat.repositories 🟢 6/6 6/6
cat.segments 🟢 9/9 9/9
cat.shards 🟢 16/16 16/16
cat.snapshots 🟢 4/4 4/4
cat.tasks 🟢 11/11 11/11
cat.templates 🟢 17/17 17/17
cat.thread_pool 🟢 9/9 9/9
cat.transforms 🟢 7/7 7/7
ccr.follow Missing test Missing test
ccr.forget_follower Missing test Missing test
ccr.put_auto_follow_pattern Missing test Missing test
ccr.resume_follow Missing test Missing test
clear_scroll 🟢 17/17 17/17
close_point_in_time 🟢 7/7 7/7
cluster.allocation_explain 🟢 4/4 4/4
cluster.get_settings 🟢 7/7 7/7
cluster.put_settings 🟢 59/59 58/58
cluster.remote_info 🟢 3/3 3/3
cluster.state 🟢 79/79 78/78
cluster.stats 🔴 27/27 0/27
connector.put 🟢 20/20 20/20
connector.sync_job_claim 🟢 3/3 3/3
connector.sync_job_error 🟢 1/1 1/1
connector.sync_job_post 🟢 50/50 50/50
connector.sync_job_update_stats 🟢 5/5 5/5
connector.update_api_key_id 🟢 4/4 4/4
connector.update_configuration 🟢 8/8 8/8
connector.update_error 🟢 4/4 4/4
connector.update_features 🟢 4/4 4/4
connector.update_filtering 🟢 12/12 12/12
connector.update_index_name 🟢 5/5 5/5
connector.update_name 🟢 4/4 4/4
connector.update_pipeline 🟢 3/3 3/3
connector.update_scheduling 🟢 3/3 3/3
connector.update_service_type 🟢 2/2 2/2
connector.update_status 🟢 3/3 3/3
count 🟢 34/34 34/34
create 🟢 24/24 23/23
dangling_indices.list_dangling_indices Missing test Missing test
delete_by_query 🟢 5/5 4/4
enrich.put_policy 🟢 10/10 10/10
eql.search 🟢 38/38 38/38
esql.query 317/317 Missing test
explain 🟢 15/15 15/15
get_script_context 🟢 1/1 1/1
get_script_languages 🟢 1/1 1/1
graph.explore 🟢 4/4 4/4
ilm.get_status 🟢 4/4 4/4
ilm.migrate_to_data_tiers Missing test Missing test
ilm.move_to_step Missing test Missing test
ilm.put_lifecycle 🟢 6/6 6/6
index 🟢 1203/1203 1205/1205
indices.analyze 🟢 246/246 246/246
indices.clone 🟢 5/5 5/5
indices.create_from 🟢 4/4 4/4
indices.create 🔴 1180/1231 1231/1231
indices.downsample 🟢 4/4 4/4
indices.get_data_lifecycle_stats Missing test Missing test
indices.get_data_lifecycle Missing test Missing test
indices.get_index_template 🟢 21/21 21/21
indices.migrate_reindex 🟢 2/2 2/2
indices.modify_data_stream Missing test Missing test
indices.put_alias 🔴 58/58 20/58
indices.put_data_lifecycle Missing test Missing test
indices.put_index_template 🟢 68/68 68/68
indices.put_mapping 🔴 124/128 131/131
indices.put_settings 🔴 56/58 58/58
indices.put_template 🔴 45/46 46/46
indices.recovery 🟢 9/9 9/9
indices.rollover 🔴 27/27 2/27
indices.shrink 🟢 5/5 5/5
indices.simulate_template 🔴 5/5 4/5
indices.split 🟢 11/11 11/11
indices.stats 🔴 125/125 30/124
indices.update_aliases 🔴 26/26 7/26
indices.validate_query 🟢 12/12 12/12
inference.chat_completion_unified Missing test Missing test
inference.completion Missing test Missing test
inference.put_alibabacloud Missing test Missing test
inference.put_amazonbedrock Missing test Missing test
inference.put_anthropic Missing test Missing test
inference.put_azureaistudio Missing test Missing test
inference.put_azureopenai Missing test Missing test
inference.put_cohere Missing test Missing test
inference.put_elasticsearch Missing test Missing test
inference.put_elser Missing test Missing test
inference.put_googleaistudio Missing test Missing test
inference.put_googlevertexai Missing test Missing test
inference.put_hugging_face Missing test Missing test
inference.put_jinaai Missing test Missing test
inference.put_mistral Missing test Missing test
inference.put_openai Missing test Missing test
inference.put_voyageai Missing test Missing test
inference.put_watsonx Missing test Missing test
inference.put Missing test Missing test
inference.rerank Missing test Missing test
inference.sparse_embedding Missing test Missing test
inference.stream_completion Missing test Missing test
inference.text_embedding Missing test Missing test
info 🟢 5/5 5/5
ingest.geo_ip_stats 🟢 1/1 1/1
ingest.processor_grok 🟢 1/1 1/1
ingest.put_ip_location_database 🟢 4/4 4/4
ingest.put_pipeline 🟢 60/60 60/60
ingest.simulate 🟢 10/10 10/10
license.get_basic_status 🟢 3/3 3/3
license.get_trial_status 🟢 3/3 3/3
license.post 🟢 1/1 1/1
logstash.put_pipeline Missing test Missing test
mget 🟢 51/51 50/50
migration.get_feature_upgrade_status 🟢 1/1 1/1
migration.post_feature_upgrade 🟢 1/1 1/1
ml.close_job 🟢 64/64 63/63
ml.delete_expired_data 🟢 5/5 5/5
ml.estimate_model_memory 🟢 16/16 16/16
ml.evaluate_data_frame 🟢 15/15 15/15
ml.explain_data_frame_analytics 🟢 7/7 7/7
ml.flush_job 🟢 15/15 15/15
ml.forecast 🟢 1/1 1/1
ml.get_buckets 🟢 14/14 14/14
ml.get_calendars 🟢 17/17 17/17
ml.get_categories 🟢 12/12 12/12
ml.get_influencers 🟢 11/11 11/11
ml.get_memory_stats 🟢 6/6 6/6
ml.get_model_snapshots 🟢 18/18 18/18
ml.get_overall_buckets 🟢 16/16 15/15
ml.get_records 🟢 8/8 8/8
ml.infer_trained_model 🟢 10/10 10/10
ml.info 🟢 10/10 10/10
ml.open_job 🟢 83/83 83/83
ml.post_calendar_events 🟢 12/12 12/12
ml.preview_data_frame_analytics 🟢 3/3 3/3
ml.preview_datafeed 🟢 17/17 17/17
ml.put_calendar 🟢 135/135 135/135
ml.put_data_frame_analytics 🟢 33/33 33/33
ml.put_datafeed 🟢 71/71 71/71
ml.put_filter 🟢 27/27 27/27
ml.put_job 🟢 227/227 225/225
ml.put_trained_model_vocabulary 🟢 1/1 1/1
ml.revert_model_snapshot 🟢 2/2 2/2
ml.start_datafeed 🟢 24/24 24/24
ml.start_trained_model_deployment 🟢 14/14 14/14
ml.stop_datafeed 🟢 17/17 17/17
ml.update_data_frame_analytics 🟢 2/2 2/2
ml.update_datafeed 🟢 7/7 7/7
ml.update_filter 🟢 3/3 3/3
ml.update_job 🟢 5/5 5/5
ml.update_model_snapshot 🟢 3/3 3/3
ml.update_trained_model_deployment 🟢 4/4 4/4
mtermvectors 🟢 10/10 10/10
nodes.reload_secure_settings 🟢 2/2 2/2
nodes.stats 🔴 58/58 18/58
open_point_in_time 🟢 7/7 7/7
put_script 🟢 41/41 41/41
query_rules.put_rule 🟢 7/7 7/7
query_rules.put_ruleset 🟢 17/17 17/17
query_rules.test 🟢 9/9 9/9
rank_eval Missing test Missing test
reindex 🟢 15/15 14/14
render_search_template 🟢 1/1 1/1
rollup.put_job 🟢 22/22 22/22
rollup.rollup_search 🟢 18/18 18/18
scripts_painless_execute 🟢 4/4 4/4
scroll 🟢 69/69 20/20
search_application.post_behavioral_analytics_event 🟢 18/18 18/18
search_application.put 🔴 6/10 10/10
search_application.render_query 🟢 7/7 7/7
search_application.search 🟢 16/16 16/16
search_template 🟢 2/2 1/1
search 🔴 2380/2432 2416/2416
searchable_snapshots.mount 🟢 4/4 4/4
security.activate_user_profile 🟢 9/9 9/9
security.authenticate 🟢 30/30 30/30
security.bulk_delete_role 🟢 1/1 1/1
security.bulk_put_role 🟢 1/1 1/1
security.bulk_update_api_keys 🟢 4/4 4/4
security.change_password 🟢 9/9 9/9
security.create_api_key 🟢 68/68 59/59
security.create_cross_cluster_api_key 🟢 3/3 3/3
security.delegate_pki Missing test Missing test
security.enroll_kibana Missing test Missing test
security.get_builtin_privileges 🟢 1/1 1/1
security.get_token 🟢 25/25 24/24
security.grant_api_key 🟢 7/7 7/7
security.has_privileges_user_profile 🟢 3/3 3/3
security.has_privileges 🟢 24/24 24/24
security.invalidate_api_key 🟢 12/12 12/12
security.invalidate_token 🟢 11/11 11/11
security.oidc_authenticate Missing test Missing test
security.oidc_logout Missing test Missing test
security.oidc_prepare_authentication Missing test Missing test
security.put_privileges 🟢 10/10 10/10
security.put_role_mapping 🔴 2/11 11/11
security.put_role 🟢 39/39 38/38
security.put_user 🟢 48/48 47/47
security.query_api_keys 🟢 14/14 14/14
security.query_role 🟢 2/2 2/2
security.query_user 🟢 4/4 4/4
security.saml_authenticate Missing test Missing test
security.saml_complete_logout Missing test Missing test
security.saml_invalidate Missing test Missing test
security.saml_logout Missing test Missing test
security.saml_prepare_authentication Missing test Missing test
security.saml_service_provider_metadata Missing test Missing test
security.suggest_user_profiles 🟢 1/1 1/1
security.update_api_key 🟢 5/5 5/5
security.update_cross_cluster_api_key 🟢 2/2 2/2
security.update_settings 🟢 2/2 2/2
security.update_user_profile_data 🟢 1/1 1/1
shutdown.put_node Missing test Missing test
simulate.ingest 🔴 11/12 12/12
slm.get_lifecycle 🟢 16/16 16/16
slm.put_lifecycle 🟢 4/4 4/4
snapshot.clone 🟢 5/5 5/5
snapshot.create_repository 🔴 24/29 29/29
snapshot.create 🟢 29/29 29/29
snapshot.restore 🟢 5/5 5/5
sql.clear_cursor 🟢 1/1 1/1
sql.query 🟢 4/4 4/4
sql.translate 🔴 1/1 0/1
ssl.certificates 🟢 2/2 2/2
synonyms.put_synonym_rule 🟢 5/5 5/5
terms_enum 🟢 47/47 47/47
termvectors 🟢 8/8 8/8
text_structure.find_message_structure 🟢 2/2 2/2
text_structure.test_grok_pattern 🟢 2/2 2/2
transform.preview_transform 🟢 21/21 21/21
transform.put_transform 🟢 28/28 28/28
transform.update_transform 🟢 14/14 14/14
update_by_query 🟢 5/5 4/4
update 🟢 35/35 35/35
watcher.execute_watch 🟢 7/7 7/7
watcher.put_watch 🔴 29/38 38/38
watcher.query_watches Missing test Missing test
watcher.update_settings Missing test Missing test

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
async_search.submit 🟢 7/7 7/7
autoscaling.put_autoscaling_policy Missing test Missing test
cat.aliases 🟢 29/29 29/29
cat.allocation 🟢 12/12 12/12
cat.component_templates 🟢 3/3 3/3
cat.count 🟢 9/9 9/9
cat.fielddata 🟢 6/6 6/6
cat.health 🟢 3/3 3/3
cat.indices 🟢 33/33 32/32
cat.master 🟢 1/1 1/1
cat.ml_data_frame_analytics 🟢 5/5 5/5
cat.ml_datafeeds 🟢 4/4 4/4
cat.ml_jobs 🟢 4/4 4/4
cat.ml_trained_models 🟢 1/1 1/1
cat.nodeattrs 🟢 5/5 5/5
cat.nodes 🟢 11/11 11/11
cat.pending_tasks 🟢 1/1 1/1
cat.plugins 🟢 2/2 2/2
cat.recovery 🟢 6/6 6/6
cat.repositories 🟢 6/6 6/6
cat.segments 🟢 9/9 9/9
cat.shards 🟢 16/16 16/16
cat.snapshots 🟢 4/4 4/4
cat.tasks 🟢 11/11 11/11
cat.templates 🟢 17/17 17/17
cat.thread_pool 🟢 9/9 9/9
cat.transforms 🟢 7/7 7/7
ccr.follow Missing test Missing test
ccr.forget_follower Missing test Missing test
ccr.put_auto_follow_pattern Missing test Missing test
ccr.resume_follow Missing test Missing test
clear_scroll 🟢 17/17 17/17
close_point_in_time 🟢 7/7 7/7
cluster.allocation_explain 🟢 4/4 4/4
cluster.get_settings 🟢 7/7 7/7
cluster.put_settings 🟢 59/59 58/58
cluster.remote_info 🟢 3/3 3/3
cluster.state 🟢 79/79 78/78
cluster.stats 🔴 27/27 0/27
connector.put 🟢 20/20 20/20
connector.sync_job_claim 🟢 3/3 3/3
connector.sync_job_error 🟢 1/1 1/1
connector.sync_job_post 🟢 50/50 50/50
connector.sync_job_update_stats 🟢 5/5 5/5
connector.update_api_key_id 🟢 4/4 4/4
connector.update_configuration 🟢 8/8 8/8
connector.update_error 🟢 4/4 4/4
connector.update_features 🟢 4/4 4/4
connector.update_filtering 🟢 12/12 12/12
connector.update_index_name 🟢 5/5 5/5
connector.update_name 🟢 4/4 4/4
connector.update_pipeline 🟢 3/3 3/3
connector.update_scheduling 🟢 3/3 3/3
connector.update_service_type 🟢 2/2 2/2
connector.update_status 🟢 3/3 3/3
count 🟢 34/34 34/34
create 🟢 24/24 23/23
dangling_indices.list_dangling_indices Missing test Missing test
delete_by_query 🟢 5/5 4/4
enrich.put_policy 🟢 10/10 10/10
eql.search 🟢 38/38 38/38
esql.query 317/317 Missing test
explain 🟢 15/15 15/15
get_script_context 🟢 1/1 1/1
get_script_languages 🟢 1/1 1/1
graph.explore 🟢 4/4 4/4
ilm.get_status 🟢 4/4 4/4
ilm.migrate_to_data_tiers Missing test Missing test
ilm.move_to_step Missing test Missing test
ilm.put_lifecycle 🟢 6/6 6/6
index 🟢 1212/1212 1214/1214
indices.analyze 🟢 246/246 246/246
indices.clone 🟢 5/5 5/5
indices.create_from 🟢 4/4 4/4
indices.create 🔴 1184/1235 1235/1235
indices.downsample 🟢 4/4 4/4
indices.get_data_lifecycle_stats Missing test Missing test
indices.get_data_lifecycle Missing test Missing test
indices.get_index_template 🟢 21/21 21/21
indices.migrate_reindex 🟢 2/2 2/2
indices.modify_data_stream Missing test Missing test
indices.put_alias 🔴 58/58 20/58
indices.put_data_lifecycle Missing test Missing test
indices.put_index_template 🟢 68/68 68/68
indices.put_mapping 🔴 128/132 135/135
indices.put_settings 🔴 56/58 58/58
indices.put_template 🔴 45/46 46/46
indices.recovery 🟢 9/9 9/9
indices.rollover 🔴 27/27 2/27
indices.shrink 🟢 5/5 5/5
indices.simulate_template 🔴 5/5 4/5
indices.split 🟢 11/11 11/11
indices.stats 🔴 125/125 30/124
indices.update_aliases 🔴 26/26 7/26
indices.validate_query 🟢 12/12 12/12
inference.chat_completion_unified Missing test Missing test
inference.completion Missing test Missing test
inference.put_alibabacloud Missing test Missing test
inference.put_amazonbedrock Missing test Missing test
inference.put_anthropic Missing test Missing test
inference.put_azureaistudio Missing test Missing test
inference.put_azureopenai Missing test Missing test
inference.put_cohere Missing test Missing test
inference.put_elasticsearch Missing test Missing test
inference.put_elser Missing test Missing test
inference.put_googleaistudio Missing test Missing test
inference.put_googlevertexai Missing test Missing test
inference.put_hugging_face Missing test Missing test
inference.put_jinaai Missing test Missing test
inference.put_mistral Missing test Missing test
inference.put_openai Missing test Missing test
inference.put_voyageai Missing test Missing test
inference.put_watsonx Missing test Missing test
inference.put Missing test Missing test
inference.rerank Missing test Missing test
inference.sparse_embedding Missing test Missing test
inference.stream_completion Missing test Missing test
inference.text_embedding Missing test Missing test
info 🟢 5/5 5/5
ingest.geo_ip_stats 🟢 1/1 1/1
ingest.processor_grok 🟢 1/1 1/1
ingest.put_ip_location_database 🟢 4/4 4/4
ingest.put_pipeline 🟢 60/60 60/60
ingest.simulate 🟢 10/10 10/10
license.get_basic_status 🟢 3/3 3/3
license.get_trial_status 🟢 3/3 3/3
license.post 🟢 1/1 1/1
logstash.put_pipeline Missing test Missing test
mget 🟢 51/51 50/50
migration.get_feature_upgrade_status 🟢 1/1 1/1
migration.post_feature_upgrade 🟢 1/1 1/1
ml.close_job 🟢 64/64 63/63
ml.delete_expired_data 🟢 5/5 5/5
ml.estimate_model_memory 🟢 16/16 16/16
ml.evaluate_data_frame 🟢 15/15 15/15
ml.explain_data_frame_analytics 🟢 7/7 7/7
ml.flush_job 🟢 15/15 15/15
ml.forecast 🟢 1/1 1/1
ml.get_buckets 🟢 14/14 14/14
ml.get_calendars 🟢 17/17 17/17
ml.get_categories 🟢 12/12 12/12
ml.get_influencers 🟢 11/11 11/11
ml.get_memory_stats 🟢 6/6 6/6
ml.get_model_snapshots 🟢 18/18 18/18
ml.get_overall_buckets 🟢 16/16 15/15
ml.get_records 🟢 8/8 8/8
ml.infer_trained_model 🟢 10/10 10/10
ml.info 🟢 10/10 10/10
ml.open_job 🟢 83/83 83/83
ml.post_calendar_events 🟢 12/12 12/12
ml.preview_data_frame_analytics 🟢 3/3 3/3
ml.preview_datafeed 🟢 17/17 17/17
ml.put_calendar 🟢 135/135 135/135
ml.put_data_frame_analytics 🟢 33/33 33/33
ml.put_datafeed 🟢 71/71 71/71
ml.put_filter 🟢 27/27 27/27
ml.put_job 🟢 227/227 225/225
ml.put_trained_model_vocabulary 🟢 1/1 1/1
ml.revert_model_snapshot 🟢 2/2 2/2
ml.start_datafeed 🟢 24/24 24/24
ml.start_trained_model_deployment 🟢 14/14 14/14
ml.stop_datafeed 🟢 17/17 17/17
ml.update_data_frame_analytics 🟢 2/2 2/2
ml.update_datafeed 🟢 7/7 7/7
ml.update_filter 🟢 3/3 3/3
ml.update_job 🟢 5/5 5/5
ml.update_model_snapshot 🟢 3/3 3/3
ml.update_trained_model_deployment 🟢 4/4 4/4
mtermvectors 🟢 10/10 10/10
nodes.reload_secure_settings 🟢 2/2 2/2
nodes.stats 🔴 58/58 18/58
open_point_in_time 🟢 7/7 7/7
put_script 🟢 41/41 41/41
query_rules.put_rule 🟢 7/7 7/7
query_rules.put_ruleset 🟢 17/17 17/17
query_rules.test 🟢 9/9 9/9
rank_eval Missing test Missing test
reindex 🟢 15/15 14/14
render_search_template 🟢 1/1 1/1
rollup.put_job 🟢 22/22 22/22
rollup.rollup_search 🟢 18/18 18/18
scripts_painless_execute 🟢 4/4 4/4
scroll 🟢 69/69 20/20
search_application.post_behavioral_analytics_event 🟢 18/18 18/18
search_application.put 🔴 6/10 10/10
search_application.render_query 🟢 7/7 7/7
search_application.search 🟢 16/16 16/16
search_template 🟢 2/2 1/1
search 🔴 2383/2435 2419/2419
searchable_snapshots.mount 🟢 4/4 4/4
security.activate_user_profile 🟢 9/9 9/9
security.authenticate 🟢 30/30 30/30
security.bulk_delete_role 🟢 1/1 1/1
security.bulk_put_role 🟢 1/1 1/1
security.bulk_update_api_keys 🟢 4/4 4/4
security.change_password 🟢 9/9 9/9
security.create_api_key 🟢 68/68 59/59
security.create_cross_cluster_api_key 🟢 3/3 3/3
security.delegate_pki Missing test Missing test
security.enroll_kibana Missing test Missing test
security.get_builtin_privileges 🟢 1/1 1/1
security.get_token 🟢 25/25 24/24
security.grant_api_key 🟢 7/7 7/7
security.has_privileges_user_profile 🟢 3/3 3/3
security.has_privileges 🟢 24/24 24/24
security.invalidate_api_key 🟢 12/12 12/12
security.invalidate_token 🟢 11/11 11/11
security.oidc_authenticate Missing test Missing test
security.oidc_logout Missing test Missing test
security.oidc_prepare_authentication Missing test Missing test
security.put_privileges 🟢 10/10 10/10
security.put_role_mapping 🔴 2/11 11/11
security.put_role 🟢 39/39 38/38
security.put_user 🟢 48/48 47/47
security.query_api_keys 🟢 14/14 14/14
security.query_role 🟢 2/2 2/2
security.query_user 🟢 4/4 4/4
security.saml_authenticate Missing test Missing test
security.saml_complete_logout Missing test Missing test
security.saml_invalidate Missing test Missing test
security.saml_logout Missing test Missing test
security.saml_prepare_authentication Missing test Missing test
security.saml_service_provider_metadata Missing test Missing test
security.suggest_user_profiles 🟢 1/1 1/1
security.update_api_key 🟢 5/5 5/5
security.update_cross_cluster_api_key 🟢 2/2 2/2
security.update_settings 🟢 2/2 2/2
security.update_user_profile_data 🟢 1/1 1/1
shutdown.put_node Missing test Missing test
simulate.ingest 🔴 11/12 12/12
slm.get_lifecycle 🟢 16/16 16/16
slm.put_lifecycle 🟢 4/4 4/4
snapshot.clone 🟢 5/5 5/5
snapshot.create_repository 🔴 24/29 29/29
snapshot.create 🟢 30/30 30/30
snapshot.restore 🟢 5/5 5/5
sql.clear_cursor 🟢 1/1 1/1
sql.query 🟢 4/4 4/4
sql.translate 🔴 1/1 0/1
ssl.certificates 🟢 2/2 2/2
synonyms.put_synonym_rule 🟢 5/5 5/5
terms_enum 🟢 47/47 47/47
termvectors 🟢 8/8 8/8
text_structure.find_message_structure 🟢 2/2 2/2
text_structure.test_grok_pattern 🟢 2/2 2/2
transform.preview_transform 🟢 21/21 21/21
transform.put_transform 🟢 28/28 28/28
transform.update_transform 🟢 14/14 14/14
update_by_query 🟢 5/5 4/4
update 🟢 35/35 35/35
watcher.execute_watch 🟢 7/7 7/7
watcher.put_watch 🔴 29/38 38/38
watcher.query_watches Missing test Missing test
watcher.update_settings Missing test Missing test

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

1 similar comment
Copy link
Contributor

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

API Status Request Response
async_search.submit 🟢 7/7 7/7
autoscaling.put_autoscaling_policy Missing test Missing test
cat.aliases 🟢 29/29 29/29
cat.allocation 🟢 12/12 12/12
cat.component_templates 🟢 3/3 3/3
cat.count 🟢 9/9 9/9
cat.fielddata 🟢 6/6 6/6
cat.health 🟢 3/3 3/3
cat.indices 🟢 33/33 32/32
cat.master 🟢 1/1 1/1
cat.ml_data_frame_analytics 🟢 5/5 5/5
cat.ml_datafeeds 🟢 4/4 4/4
cat.ml_jobs 🟢 4/4 4/4
cat.ml_trained_models 🟢 1/1 1/1
cat.nodeattrs 🟢 5/5 5/5
cat.nodes 🟢 11/11 11/11
cat.pending_tasks 🟢 1/1 1/1
cat.plugins 🟢 2/2 2/2
cat.recovery 🟢 6/6 6/6
cat.repositories 🟢 6/6 6/6
cat.segments 🟢 9/9 9/9
cat.shards 🟢 16/16 16/16
cat.snapshots 🟢 4/4 4/4
cat.tasks 🟢 11/11 11/11
cat.templates 🟢 17/17 17/17
cat.thread_pool 🟢 9/9 9/9
cat.transforms 🟢 7/7 7/7
ccr.follow Missing test Missing test
ccr.forget_follower Missing test Missing test
ccr.put_auto_follow_pattern Missing test Missing test
ccr.resume_follow Missing test Missing test
clear_scroll 🟢 17/17 17/17
close_point_in_time 🟢 7/7 7/7
cluster.allocation_explain 🟢 4/4 4/4
cluster.get_settings 🟢 7/7 7/7
cluster.put_settings 🟢 59/59 58/58
cluster.remote_info 🟢 3/3 3/3
cluster.state 🟢 79/79 78/78
cluster.stats 🔴 27/27 0/27
connector.put 🟢 20/20 20/20
connector.sync_job_claim 🟢 3/3 3/3
connector.sync_job_error 🟢 1/1 1/1
connector.sync_job_post 🟢 50/50 50/50
connector.sync_job_update_stats 🟢 5/5 5/5
connector.update_api_key_id 🟢 4/4 4/4
connector.update_configuration 🟢 8/8 8/8
connector.update_error 🟢 4/4 4/4
connector.update_features 🟢 4/4 4/4
connector.update_filtering 🟢 12/12 12/12
connector.update_index_name 🟢 5/5 5/5
connector.update_name 🟢 4/4 4/4
connector.update_pipeline 🟢 3/3 3/3
connector.update_scheduling 🟢 3/3 3/3
connector.update_service_type 🟢 2/2 2/2
connector.update_status 🟢 3/3 3/3
count 🟢 34/34 34/34
create 🟢 24/24 23/23
dangling_indices.list_dangling_indices Missing test Missing test
delete_by_query 🟢 5/5 4/4
enrich.put_policy 🟢 10/10 10/10
eql.search 🟢 38/38 38/38
esql.query 317/317 Missing test
explain 🟢 15/15 15/15
get_script_context 🟢 1/1 1/1
get_script_languages 🟢 1/1 1/1
graph.explore 🟢 4/4 4/4
ilm.get_status 🟢 4/4 4/4
ilm.migrate_to_data_tiers Missing test Missing test
ilm.move_to_step Missing test Missing test
ilm.put_lifecycle 🟢 6/6 6/6
index 🟢 1212/1212 1214/1214
indices.analyze 🟢 246/246 246/246
indices.clone 🟢 5/5 5/5
indices.create_from 🟢 4/4 4/4
indices.create 🔴 1184/1235 1235/1235
indices.downsample 🟢 4/4 4/4
indices.get_data_lifecycle_stats Missing test Missing test
indices.get_data_lifecycle Missing test Missing test
indices.get_index_template 🟢 21/21 21/21
indices.migrate_reindex 🟢 2/2 2/2
indices.modify_data_stream Missing test Missing test
indices.put_alias 🔴 58/58 20/58
indices.put_data_lifecycle Missing test Missing test
indices.put_index_template 🟢 68/68 68/68
indices.put_mapping 🔴 128/132 135/135
indices.put_settings 🔴 56/58 58/58
indices.put_template 🔴 45/46 46/46
indices.recovery 🟢 9/9 9/9
indices.rollover 🔴 27/27 2/27
indices.shrink 🟢 5/5 5/5
indices.simulate_template 🔴 5/5 4/5
indices.split 🟢 11/11 11/11
indices.stats 🔴 125/125 30/124
indices.update_aliases 🔴 26/26 7/26
indices.validate_query 🟢 12/12 12/12
inference.chat_completion_unified Missing test Missing test
inference.completion Missing test Missing test
inference.put_alibabacloud Missing test Missing test
inference.put_amazonbedrock Missing test Missing test
inference.put_anthropic Missing test Missing test
inference.put_azureaistudio Missing test Missing test
inference.put_azureopenai Missing test Missing test
inference.put_cohere Missing test Missing test
inference.put_elasticsearch Missing test Missing test
inference.put_elser Missing test Missing test
inference.put_googleaistudio Missing test Missing test
inference.put_googlevertexai Missing test Missing test
inference.put_hugging_face Missing test Missing test
inference.put_jinaai Missing test Missing test
inference.put_mistral Missing test Missing test
inference.put_openai Missing test Missing test
inference.put_voyageai Missing test Missing test
inference.put_watsonx Missing test Missing test
inference.put Missing test Missing test
inference.rerank Missing test Missing test
inference.sparse_embedding Missing test Missing test
inference.stream_completion Missing test Missing test
inference.text_embedding Missing test Missing test
info 🟢 5/5 5/5
ingest.geo_ip_stats 🟢 1/1 1/1
ingest.processor_grok 🟢 1/1 1/1
ingest.put_ip_location_database 🟢 4/4 4/4
ingest.put_pipeline 🟢 60/60 60/60
ingest.simulate 🟢 10/10 10/10
license.get_basic_status 🟢 3/3 3/3
license.get_trial_status 🟢 3/3 3/3
license.post 🟢 1/1 1/1
logstash.put_pipeline Missing test Missing test
mget 🟢 51/51 50/50
migration.get_feature_upgrade_status 🟢 1/1 1/1
migration.post_feature_upgrade 🟢 1/1 1/1
ml.close_job 🟢 64/64 63/63
ml.delete_expired_data 🟢 5/5 5/5
ml.estimate_model_memory 🟢 16/16 16/16
ml.evaluate_data_frame 🟢 15/15 15/15
ml.explain_data_frame_analytics 🟢 7/7 7/7
ml.flush_job 🟢 15/15 15/15
ml.forecast 🟢 1/1 1/1
ml.get_buckets 🟢 14/14 14/14
ml.get_calendars 🟢 17/17 17/17
ml.get_categories 🟢 12/12 12/12
ml.get_influencers 🟢 11/11 11/11
ml.get_memory_stats 🟢 6/6 6/6
ml.get_model_snapshots 🟢 18/18 18/18
ml.get_overall_buckets 🟢 16/16 15/15
ml.get_records 🟢 8/8 8/8
ml.infer_trained_model 🟢 10/10 10/10
ml.info 🟢 10/10 10/10
ml.open_job 🟢 83/83 83/83
ml.post_calendar_events 🟢 12/12 12/12
ml.preview_data_frame_analytics 🟢 3/3 3/3
ml.preview_datafeed 🟢 17/17 17/17
ml.put_calendar 🟢 135/135 135/135
ml.put_data_frame_analytics 🟢 33/33 33/33
ml.put_datafeed 🟢 71/71 71/71
ml.put_filter 🟢 27/27 27/27
ml.put_job 🟢 227/227 225/225
ml.put_trained_model_vocabulary 🟢 1/1 1/1
ml.revert_model_snapshot 🟢 2/2 2/2
ml.start_datafeed 🟢 24/24 24/24
ml.start_trained_model_deployment 🟢 14/14 14/14
ml.stop_datafeed 🟢 17/17 17/17
ml.update_data_frame_analytics 🟢 2/2 2/2
ml.update_datafeed 🟢 7/7 7/7
ml.update_filter 🟢 3/3 3/3
ml.update_job 🟢 5/5 5/5
ml.update_model_snapshot 🟢 3/3 3/3
ml.update_trained_model_deployment 🟢 4/4 4/4
mtermvectors 🟢 10/10 10/10
nodes.reload_secure_settings 🟢 2/2 2/2
nodes.stats 🔴 58/58 18/58
open_point_in_time 🟢 7/7 7/7
put_script 🟢 41/41 41/41
query_rules.put_rule 🟢 7/7 7/7
query_rules.put_ruleset 🟢 17/17 17/17
query_rules.test 🟢 9/9 9/9
rank_eval Missing test Missing test
reindex 🟢 15/15 14/14
render_search_template 🟢 1/1 1/1
rollup.put_job 🟢 22/22 22/22
rollup.rollup_search 🟢 18/18 18/18
scripts_painless_execute 🟢 4/4 4/4
scroll 🟢 69/69 20/20
search_application.post_behavioral_analytics_event 🟢 18/18 18/18
search_application.put 🔴 6/10 10/10
search_application.render_query 🟢 7/7 7/7
search_application.search 🟢 16/16 16/16
search_template 🟢 2/2 1/1
search 🔴 2383/2435 2419/2419
searchable_snapshots.mount 🟢 4/4 4/4
security.activate_user_profile 🟢 9/9 9/9
security.authenticate 🟢 30/30 30/30
security.bulk_delete_role 🟢 1/1 1/1
security.bulk_put_role 🟢 1/1 1/1
security.bulk_update_api_keys 🟢 4/4 4/4
security.change_password 🟢 9/9 9/9
security.create_api_key 🟢 68/68 59/59
security.create_cross_cluster_api_key 🟢 3/3 3/3
security.delegate_pki Missing test Missing test
security.enroll_kibana Missing test Missing test
security.get_builtin_privileges 🟢 1/1 1/1
security.get_token 🟢 25/25 24/24
security.grant_api_key 🟢 7/7 7/7
security.has_privileges_user_profile 🟢 3/3 3/3
security.has_privileges 🟢 24/24 24/24
security.invalidate_api_key 🟢 12/12 12/12
security.invalidate_token 🟢 11/11 11/11
security.oidc_authenticate Missing test Missing test
security.oidc_logout Missing test Missing test
security.oidc_prepare_authentication Missing test Missing test
security.put_privileges 🟢 10/10 10/10
security.put_role_mapping 🔴 2/11 11/11
security.put_role 🟢 39/39 38/38
security.put_user 🟢 48/48 47/47
security.query_api_keys 🟢 14/14 14/14
security.query_role 🟢 2/2 2/2
security.query_user 🟢 4/4 4/4
security.saml_authenticate Missing test Missing test
security.saml_complete_logout Missing test Missing test
security.saml_invalidate Missing test Missing test
security.saml_logout Missing test Missing test
security.saml_prepare_authentication Missing test Missing test
security.saml_service_provider_metadata Missing test Missing test
security.suggest_user_profiles 🟢 1/1 1/1
security.update_api_key 🟢 5/5 5/5
security.update_cross_cluster_api_key 🟢 2/2 2/2
security.update_settings 🟢 2/2 2/2
security.update_user_profile_data 🟢 1/1 1/1
shutdown.put_node Missing test Missing test
simulate.ingest 🔴 11/12 12/12
slm.get_lifecycle 🟢 16/16 16/16
slm.put_lifecycle 🟢 4/4 4/4
snapshot.clone 🟢 5/5 5/5
snapshot.create_repository 🔴 24/29 29/29
snapshot.create 🟢 30/30 30/30
snapshot.restore 🟢 5/5 5/5
sql.clear_cursor 🟢 1/1 1/1
sql.query 🟢 4/4 4/4
sql.translate 🔴 1/1 0/1
ssl.certificates 🟢 2/2 2/2
synonyms.put_synonym_rule 🟢 5/5 5/5
terms_enum 🟢 47/47 47/47
termvectors 🟢 8/8 8/8
text_structure.find_message_structure 🟢 2/2 2/2
text_structure.test_grok_pattern 🟢 2/2 2/2
transform.preview_transform 🟢 21/21 21/21
transform.put_transform 🟢 28/28 28/28
transform.update_transform 🟢 14/14 14/14
update_by_query 🟢 5/5 4/4
update 🟢 35/35 35/35
watcher.execute_watch 🟢 7/7 7/7
watcher.put_watch 🔴 29/38 38/38
watcher.query_watches Missing test Missing test
watcher.update_settings Missing test Missing test

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

else {
const alternative_java = [];
alternative_java.push({
language: "java",
Copy link
Contributor

@miguelgrinberg miguelgrinberg Jun 17, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Should it be "Java", capitalized? This is exactly what the docs are going to show in the dropdown.

@@ -30975,6 +30975,66 @@
"summary": "Reindex multiple sources",
"description": "Run `POST _reindex` to reindex from multiple sources. The `index` attribute in source can be a list, which enables you to copy from lots of sources in one request. This example copies documents from the `my-index-000001` and `my-index-000002` indices.\n",
"value": "{\n \"source\": {\n \"index\": [\"my-index-000001\", \"my-index-000002\"]\n },\n \"dest\": {\n \"index\": \"my-new-index-000002\"\n }\n}"
},
"ReindexRequestExample10": {
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Why are all these new reindex examples part of this PR?

@@ -25965,6 +25985,10 @@
{
"code": "curl -X POST -H \"Authorization: ApiKey $ELASTIC_API_KEY\" -H \"Content-Type: application/json\" -d '{\"query\":{\"term\":{\"user.id\":\"kimchy\"}},\"max_docs\":1}' \"$ELASTICSEARCH_URL/my-index-000001/_delete_by_query\"",
"language": "curl"
},
{
"code": "client.deleteByQuery(d -> d\n\t.index(\"my-index-000001\")\n\t.maxDocs(1L)\n\t.query(q -> q\n\t\t.term(t -> t\n\t\t\t.field(\"user.id\")\n\t\t\t.value(FieldValue.of(\"kimchy\"))\n\t\t)\n\t)\n);\n",
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It looks like your code generator outputs tabs for indentation. I do not know how bump.sh interprets tabs when it renders code. I think it would be safer to produce spaces, if you can.

Copy link
Contributor

@miguelgrinberg miguelgrinberg left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I have left minor comments, but overall this looks good.

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.

3 participants