Skip to content

Backport 4489 to 9.0 #4509

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.

Sign up for GitHub

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

Jump to bottom
Merged
merged 1 commit into from
Jun 10, 2025
Merged

Backport 4489 to 9.0 #4509

merged 1 commit into from
Jun 10, 2025

Conversation

miguelgrinberg
Copy link
Contributor

Backport of #4489 to 9.0

@miguelgrinberg miguelgrinberg requested review from a team as code owners June 10, 2025 09:55
@miguelgrinberg @lcawl
add example requests for endpoints that do not use bodies (#4489)
6674d2f 
* add a few example requests for endpoints that do not use bodies

* Remove x-codeSamples from overlay

* restructure existing examples w/o bodies as request examples

* skip examples w/o bodies when generating openapi examples

* add a lot of missing examples

* remove duplicate test

* more examples missed in previous commit

---------

Co-authored-by: lcawl <[email protected]>
@github-actions GitHub Actions
Copy link
Contributor

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

API Status Request Response
async_search.delete 🟢 4/4 4/4
async_search.get 🟢 6/6 6/6
async_search.status 🟢 3/3 3/3
autoscaling.delete_autoscaling_policy ⚪ Missing test Missing test
autoscaling.get_autoscaling_capacity ⚪ Missing test Missing test
autoscaling.get_autoscaling_policy ⚪ Missing test Missing test
bulk 🟢 445/445 463/463
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 🟢 11/11 11/11
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.delete_auto_follow_pattern ⚪ Missing test Missing test
ccr.follow_info ⚪ Missing test Missing test
ccr.follow_stats ⚪ Missing test Missing test
ccr.follow ⚪ Missing test Missing test
ccr.get_auto_follow_pattern ⚪ Missing test Missing test
ccr.pause_auto_follow_pattern ⚪ Missing test Missing test
ccr.pause_follow ⚪ Missing test Missing test
ccr.resume_auto_follow_pattern ⚪ Missing test Missing test
ccr.stats ⚪ Missing test Missing test
ccr.unfollow ⚪ Missing test Missing test
close_point_in_time 🟢 7/7 7/7
cluster.delete_component_template 🟢 2/2 2/2
cluster.get_component_template 🟢 12/12 12/12
cluster.get_settings 🟢 7/7 7/7
cluster.health 🟢 162/162 162/162
cluster.info 🟢 4/4 4/4
cluster.pending_tasks 🟢 3/3 3/3
cluster.remote_info 🟢 3/3 3/3
cluster.state 🟢 79/79 78/78
cluster.stats 🔴 27/27 0/27
connector.check_in 🟢 3/3 3/3
connector.delete 🟢 29/29 29/29
connector.get 🟢 64/64 64/64
connector.list 🟢 31/31 31/31
connector.sync_job_cancel 🟢 3/3 3/3
connector.sync_job_check_in 🟢 3/3 3/3
connector.sync_job_claim 🟢 3/3 3/3
connector.sync_job_delete 🟢 4/4 4/4
connector.sync_job_get 🟢 22/22 22/22
connector.sync_job_list 🟢 12/12 12/12
connector.sync_job_update_stats 🟢 5/5 5/5
count 🟢 34/34 34/34
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
delete_by_query_rethrottle 🟢 1/1 1/1
delete_by_query 🟢 5/5 4/4
delete_script 🟢 8/8 8/8
delete 🟢 37/37 37/37
enrich.delete_policy 🟢 9/9 9/9
enrich.execute_policy 🟢 9/9 9/9
enrich.get_policy 🟢 6/6 6/6
enrich.put_policy 🟢 10/10 10/10
enrich.stats 🟢 6/6 6/6
eql.delete 🟢 3/3 3/3
eql.get_status 🟢 3/3 3/3
eql.get 🟢 3/3 3/3
esql.async_query_delete ⚪ Missing test Missing test
esql.async_query_get ⚪ Missing test Missing test
esql.async_query_stop ⚪ Missing test Missing test
exists_source 🟢 3/3 3/3
exists 🟢 19/19 19/19
explain 🟢 15/15 15/15
features.get_features 🟢 2/2 2/2
features.reset_features ⚪ Missing test Missing test
field_caps 🟢 63/63 63/63
get_script_context 🟢 1/1 1/1
get_script_languages 🟢 1/1 1/1
get_script 🟢 12/12 12/12
get_source 🟢 18/18 18/18
get 🟢 299/299 296/296
health_report 🟢 4/4 4/4
ilm.delete_lifecycle 🟢 2/2 2/2
ilm.explain_lifecycle 🟢 5/5 5/5
ilm.get_lifecycle 🟢 8/8 8/8
ilm.get_status 🟢 4/4 4/4
ilm.remove_policy 🟢 5/5 5/5
ilm.retry ⚪ Missing test Missing test
ilm.start ⚪ Missing test Missing test
ilm.stop 🟢 4/4 4/4
index 🟢 1205/1205 1207/1207
indices.add_block 🟢 2/2 2/2
indices.cancel_migrate_reindex 🟢 2/2 2/2
indices.clear_cache 🟢 4/4 4/4
indices.close 🟢 49/49 49/49
indices.create_data_stream 🟢 31/31 31/31
indices.create_from 🟢 4/4 4/4
indices.data_streams_stats 🟢 4/4 4/4
indices.delete_alias 🔴 12/12 5/12
indices.delete_data_lifecycle ⚪ Missing test Missing test
indices.delete_data_stream 🟢 28/28 28/28
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_alias 🟢 37/37 37/37
indices.exists_template 🟢 15/15 15/15
indices.exists 🟢 39/39 39/39
indices.explain_data_lifecycle ⚪ Missing test Missing test
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_data_lifecycle_stats ⚪ Missing test Missing test
indices.get_data_lifecycle ⚪ Missing test Missing test
indices.get_data_stream 🟢 11/11 11/11
indices.get_field_mapping 🟢 15/15 15/15
indices.get_index_template 🟢 21/21 21/21
indices.get_mapping 🟢 135/135 135/135
indices.get_migrate_reindex_status 🟢 1/1 1/1
indices.get_settings 🔴 76/76 57/76
indices.get_template 🟢 32/32 32/32
indices.get 🟢 55/55 55/55
indices.migrate_reindex 🟢 2/2 2/2
indices.migrate_to_data_stream ⚪ Missing test Missing test
indices.modify_data_stream ⚪ Missing test Missing test
indices.open 🟢 20/20 20/20
indices.promote_data_stream ⚪ Missing test Missing test
indices.recovery 🟢 9/9 9/9
indices.refresh 🟢 279/279 279/279
indices.resolve_cluster 🟢 13/13 13/13
indices.resolve_index 🟢 6/6 6/6
indices.rollover 🔴 27/27 2/27
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.stats 🔴 116/116 30/115
indices.update_aliases 🔴 26/26 7/26
indices.validate_query 🟢 12/12 12/12
inference.completion ⚪ Missing test Missing test
inference.delete ⚪ Missing test Missing test
inference.get 🟢 1/1 1/1
inference.put_elasticsearch ⚪ Missing test Missing test
inference.put ⚪ Missing test Missing test
inference.rerank ⚪ Missing test Missing test
inference.sparse_embedding ⚪ Missing test Missing test
inference.text_embedding ⚪ Missing test Missing test
inference.update ⚪ Missing test Missing test
info 🟢 5/5 5/5
ingest.delete_ip_location_database 🟢 1/1 1/1
ingest.delete_pipeline 🟢 15/15 15/15
ingest.geo_ip_stats 🟢 1/1 1/1
ingest.get_ip_location_database 🟢 7/7 7/7
ingest.get_pipeline 🟢 22/22 22/22
ingest.processor_grok 🟢 1/1 1/1
ingest.put_ip_location_database 🟢 4/4 4/4
license.delete 🟢 3/3 3/3
license.get_basic_status 🟢 3/3 3/3
license.get_trial_status 🟢 3/3 3/3
license.get 🟢 6/6 6/6
license.post_start_basic 🟢 5/5 5/5
license.post_start_trial 🟢 2/2 2/2
logstash.delete_pipeline ⚪ Missing test Missing test
logstash.get_pipeline ⚪ Missing test Missing test
migration.deprecations 🟢 2/2 2/2
migration.get_feature_upgrade_status 🟢 1/1 1/1
migration.post_feature_upgrade 🔴 1/1 0/1
ml.clear_trained_model_deployment_cache 🟢 1/1 1/1
ml.close_job 🟢 64/64 63/63
ml.delete_calendar_event 🟢 4/4 4/4
ml.delete_calendar_job 🟢 3/3 3/3
ml.delete_calendar 🟢 5/5 5/5
ml.delete_data_frame_analytics 🟢 2/2 2/2
ml.delete_datafeed 🟢 3/3 3/3
ml.delete_expired_data 🟢 5/5 5/5
ml.delete_filter 🟢 27/27 27/27
ml.delete_forecast 🟢 3/3 3/3
ml.delete_job 🟢 47/47 47/47
ml.delete_model_snapshot 🟢 2/2 2/2
ml.delete_trained_model_alias 🟢 3/3 3/3
ml.delete_trained_model 🟢 5/5 5/5
ml.estimate_model_memory 🟢 16/16 16/16
ml.evaluate_data_frame 🟢 15/15 15/15
ml.flush_job 🟢 15/15 15/15
ml.forecast 🟢 1/1 1/1
ml.get_buckets 🟢 14/14 14/14
ml.get_calendar_events 🟢 15/15 15/15
ml.get_calendars 🟢 17/17 17/17
ml.get_categories 🟢 12/12 12/12
ml.get_data_frame_analytics_stats 🟢 12/12 12/12
ml.get_data_frame_analytics 🟢 17/17 17/17
ml.get_datafeed_stats 🟢 27/27 27/27
ml.get_datafeeds 🟢 20/20 20/20
ml.get_filters 🟢 13/13 13/13
ml.get_influencers 🟢 11/11 11/11
ml.get_job_stats 🟢 32/32 32/32
ml.get_jobs 🟢 31/31 31/31
ml.get_memory_stats 🟢 6/6 6/6
ml.get_model_snapshot_upgrade_stats 🟢 3/3 3/3
ml.get_model_snapshots 🟢 18/18 18/18
ml.get_overall_buckets 🟢 16/16 15/15
ml.get_records 🟢 8/8 8/8
ml.get_trained_models_stats 🟢 17/17 17/17
ml.get_trained_models 🟢 36/36 36/36
ml.infer_trained_model 🟢 10/10 10/10
ml.info 🟢 10/10 10/10
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_job 🟢 12/12 12/12
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_trained_model_alias 🟢 13/13 13/13
ml.put_trained_model_definition_part 🟢 1/1 1/1
ml.put_trained_model_vocabulary 🟢 1/1 1/1
ml.reset_job 🟢 2/2 2/2
ml.revert_model_snapshot 🟢 2/2 2/2
ml.set_upgrade_mode 🟢 6/6 6/6
ml.start_data_frame_analytics 🟢 1/1 1/1
ml.start_datafeed 🟢 24/24 24/24
ml.start_trained_model_deployment 🟢 14/14 14/14
ml.stop_data_frame_analytics 🟢 5/5 5/5
ml.stop_datafeed 🟢 17/17 17/17
ml.stop_trained_model_deployment 🟢 10/10 10/10
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
ml.upgrade_job_snapshot 🟢 3/3 3/3
msearch 🟢 17/17 16/16
nodes.hot_threads 🟢 5/5 5/5
nodes.info 🔴 112/112 1/112
nodes.stats 🔴 51/51 13/51
nodes.usage 🟢 1/1 1/1
open_point_in_time 🟢 7/7 7/7
query_rules.delete_rule 🟢 6/6 6/6
query_rules.delete_ruleset 🟢 7/7 7/7
query_rules.get_rule 🟢 5/5 5/5
query_rules.get_ruleset 🟢 8/8 8/8
query_rules.list_rulesets 🟢 8/8 8/8
query_rules.test 🟢 9/9 9/9
rank_eval ⚪ Missing test Missing test
reindex_rethrottle 🟢 2/2 2/2
rollup.delete_job 🟢 3/3 3/3
rollup.get_jobs 🟢 10/10 10/10
rollup.get_rollup_caps 🟢 3/3 3/3
rollup.get_rollup_index_caps 🟢 7/7 7/7
rollup.rollup_search 🟢 18/18 18/18
rollup.start_job 🟢 6/6 6/6
rollup.stop_job 🟢 5/5 5/5
scripts_painless_execute 🟢 4/4 4/4
search_application.delete_behavioral_analytics 🟢 3/3 3/3
search_application.delete 🟢 7/7 7/7
search_application.get_behavioral_analytics 🔴 2/5 5/5
search_application.get 🔴 10/10 7/10
search_application.list 🔴 7/7 2/7
search_application.put_behavioral_analytics 🟢 3/3 3/3
search_mvt ⚪ 34/34 Missing test
search_shards 🟢 7/7 7/7
search 🔴 2305/2367 2351/2351
searchable_snapshots.cache_stats ⚪ Missing test Missing test
searchable_snapshots.clear_cache 🟢 1/1 1/1
searchable_snapshots.stats 🟢 1/1 1/1
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.clear_api_key_cache 🟢 13/13 13/13
security.clear_cached_privileges 🟢 3/3 3/3
security.clear_cached_realms 🟢 1/1 1/1
security.clear_cached_roles 🟢 2/2 2/2
security.clear_cached_service_tokens 🟢 4/4 4/4
security.create_api_key 🟢 68/68 59/59
security.create_cross_cluster_api_key 🟢 3/3 3/3
security.create_service_token 🟢 3/3 3/3
security.delete_privileges 🟢 6/6 6/6
security.delete_role_mapping 🟢 9/9 9/9
security.delete_role 🟢 8/8 8/8
security.delete_service_token ⚪ Missing test Missing test
security.delete_user 🟢 9/9 9/9
security.disable_user_profile 🟢 1/1 1/1
security.disable_user 🟢 3/3 3/3
security.enable_user_profile 🟢 1/1 1/1
security.enable_user 🟢 4/4 4/4
security.enroll_kibana ⚪ Missing test Missing test
security.get_api_key 🟢 26/26 26/26
security.get_builtin_privileges 🟢 1/1 1/1
security.get_privileges 🟢 12/12 12/12
security.get_role_mapping 🔴 18/18 10/18
security.get_role 🟢 24/24 24/24
security.get_service_accounts ⚪ Missing test Missing test
security.get_service_credentials 🟢 1/1 1/1
security.get_settings 🟢 3/3 3/3
security.get_token 🟢 25/25 24/24
security.get_user_privileges 🟢 8/8 8/8
security.get_user_profile 🟢 8/8 8/8
security.get_user 🟢 25/25 25/25
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_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_user_profile_data 🟢 1/1 1/1
shutdown.delete_node ⚪ Missing test Missing test
shutdown.get_node ⚪ Missing test Missing test
slm.delete_lifecycle 🟢 4/4 4/4
slm.execute_lifecycle 🟢 4/4 4/4
slm.execute_retention 🟢 4/4 4/4
slm.get_lifecycle 🟢 16/16 16/16
slm.get_stats 🟢 4/4 4/4
slm.get_status 🟢 4/4 4/4
slm.start ⚪ Missing test Missing test
snapshot.cleanup_repository 🟢 3/3 3/3
snapshot.create 🟢 29/29 29/29
snapshot.delete_repository 🟢 10/10 10/10
snapshot.delete 🔴 21/23 23/23
snapshot.get_repository 🔴 19/19 7/19
snapshot.get 🟢 13/13 13/13
snapshot.repository_analyze ⚪ Missing test Missing test
snapshot.repository_verify_integrity ⚪ Missing test Missing test
snapshot.status 🟢 2/2 2/2
snapshot.verify_repository 🟢 2/2 2/2
sql.delete_async ⚪ Missing test Missing test
sql.get_async_status ⚪ Missing test Missing test
sql.get_async ⚪ Missing test Missing test
ssl.certificates 🟢 2/2 2/2
synonyms.delete_synonym_rule 🟢 7/7 7/7
synonyms.delete_synonym 🟢 6/6 6/6
synonyms.get_synonym_rule 🟢 4/4 4/4
synonyms.get_synonym 🟢 16/16 16/16
synonyms.get_synonyms_sets 🟢 6/6 6/6
synonyms.put_synonym_rule 🟢 4/4 4/4
synonyms.put_synonym 🟢 28/28 28/28
tasks.cancel 🟢 2/2 2/2
tasks.get 🟢 10/10 10/10
tasks.list 🟢 9/9 9/9
terms_enum 🟢 47/47 47/47
termvectors 🟢 8/8 8/8
text_structure.find_field_structure 🟢 1/1 1/1
text_structure.find_message_structure 🟢 2/2 2/2
text_structure.find_structure 🟢 2/2 2/2
text_structure.test_grok_pattern 🟢 2/2 2/2
transform.delete_transform 🟢 10/10 10/10
transform.get_transform_stats 🟢 34/34 34/34
transform.get_transform 🟢 26/26 26/26
transform.preview_transform 🟢 21/21 21/21
transform.reset_transform 🟢 4/4 4/4
transform.schedule_now_transform 🟢 3/3 3/3
transform.start_transform 🟢 29/29 29/29
transform.stop_transform 🟢 16/16 16/16
transform.upgrade_transforms 🟢 2/2 2/2
update_by_query_rethrottle 🟢 1/1 1/1
watcher.ack_watch 🟢 1/1 1/1
watcher.activate_watch 🟢 1/1 1/1
watcher.deactivate_watch 🟢 1/1 1/1
watcher.delete_watch 🟢 2/2 2/2
watcher.execute_watch 🟢 7/7 7/7
watcher.get_settings ⚪ Missing test Missing test
watcher.get_watch 🟢 9/9 9/9
watcher.query_watches ⚪ Missing test Missing test
watcher.start 🟢 1/1 1/1
watcher.stats 🟢 1/1 1/1
watcher.stop 🟢 1/1 1/1
xpack.info 🟢 8/8 4/4
xpack.usage 🔴 40/40 2/36

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

@miguelgrinberg miguelgrinberg merged commit da30074 into 9.0 Jun 10, 2025
7 checks passed
@miguelgrinberg miguelgrinberg deleted the backport-4489-to-9.0 branch June 10, 2025 10:34
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers
No reviews
Assignees
No one assigned
Labels
compiler generator:typescript specification
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
1 participant
@miguelgrinberg