Skip to content

add example requests for endpoints that do not use bodies #4489

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

add example requests for endpoints that do not use bodies #4489

merged 7 commits into from
Jun 10, 2025

Conversation

miguelgrinberg
Copy link
Contributor

@miguelgrinberg miguelgrinberg commented Jun 6, 2025 •
edited
Loading

This PR adds missing examples of ES endpoints that do not use bodies. These are used to generate the x-codeSamples extension for OpenAPI.

Some examples were reconstructucted from description fields used in response examples (when endpoints have them). For endpoints where there is no response example an example was obtained from an old 8.x alternatives report JSON file.

In a previous PR I added method_request fields to some responses. These are now unnecessary so they were removed.

I have also removed the x-codeSamples overlay files. In a follow up change I will be adding the client languages for all examples, using the request converter to generate them.

Preview: https://www.elastic.co/docs/api/doc/elasticsearch/version/475682a4-c607-4ca5-a63c-26c1f9b636da/

With all these changes, only the following endpoints are missing examples:

HEAD /
GET /_cat
POST /_cluster/voting_config_exclusions
DELETE /_cluster/voting_config_exclusions
HEAD /_component_template/{name}
POST /_connector
PUT /_connector/{connector_id}/_filtering/_activate
PUT /_connector/{connector_id}/_filtering/_validation
PUT /_connector/{connector_id}/_native
GET /_data_stream/{name}/_options
PUT /_data_stream/{name}/_options
DELETE /_data_stream/{name}/_options
GET /_data_stream/{name}/_settings
PUT /_data_stream/{name}/_settings
GET /_fleet/_fleet_msearch
POST /_fleet/_fleet_msearch
HEAD /_index_template/{name}
POST /_inference/{inference_id}
POST /_inference/{task_type}/{inference_id}
GET /_ingest/geoip/database
GET /_ingest/geoip/database/{id}
PUT /_ingest/geoip/database/{id}
DELETE /_ingest/geoip/database/{id}
POST /_ml/anomaly_detectors/{job_id}/_data
PUT /_ml/trained_models/{model_id}
GET /_nodes/{node_id}/_repositories_metering
DELETE /_nodes/{node_id}/_repositories_metering/{max_archive_version}
GET /_query/queries
GET /_query/queries/{id}
POST /_security/delegate_pki
GET /_security/enroll/node
POST /_slm/stop
GET /{index}/_fleet/_fleet_msearch
POST /{index}/_fleet/_fleet_msearch
GET /{index}/_fleet/_fleet_search
POST /{index}/_fleet/_fleet_search
GET /{index}/_fleet/global_checkpoints

@github-actions GitHub Actions
Copy link
Contributor

github-actions bot commented Jun 6, 2025

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

API Status Request Response
exists 🟢 19/19 19/19
indices.close 🟢 49/49 49/49
indices.data_streams_stats 🟢 4/4 4/4

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

@miguelgrinberg miguelgrinberg force-pushed the request-example-without-body branch from 0139b80 to 3eb863a Compare June 6, 2025 17:34
@github-actions GitHub Actions
Copy link
Contributor

github-actions bot commented Jun 6, 2025

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

API Status Request Response
exists 🟢 19/19 19/19
indices.close 🟢 49/49 49/49
indices.data_streams_stats 🟢 4/4 4/4

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

@github-actions GitHub Actions
Copy link
Contributor

github-actions bot commented Jun 6, 2025

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

API Status Request Response
exists 🟢 19/19 19/19
indices.close 🟢 49/49 49/49
indices.data_streams_stats 🟢 4/4 4/4

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

miguelgrinberg
miguelgrinberg commented Jun 6, 2025
View reviewed changes
docs/overlays/elasticsearch-shared-overlays.yaml
@@ -1077,17 +1077,6 @@ actions:
# update:
# aggregations:
# x-model: true
# Examples
Copy link
Contributor Author

Choose a reason for hiding this comment

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

Thanks, Lisa! I forgot to look for this. :)

lcawl
lcawl approved these changes Jun 6, 2025
View reviewed changes
Copy link
Contributor

@lcawl lcawl left a comment

Choose a reason for hiding this comment

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

Wow, this is great! LGTM

@miguelgrinberg miguelgrinberg requested review from a team as code owners June 9, 2025 11:42
@miguelgrinberg miguelgrinberg force-pushed the request-example-without-body branch from dcee65e to 5f0408b Compare June 9, 2025 11:48
@github-actions GitHub Actions
Copy link
Contributor

github-actions bot commented Jun 9, 2025

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

API Status Request Response
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 🟢 469/469 487/487
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.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.health 🟢 157/157 157/157
count 🟢 34/34 34/34
dangling_indices.import_dangling_index ⚪ Missing test Missing test
delete_by_query 🟢 5/5 4/4
delete 🟢 37/37 37/37
exists 🟢 19/19 19/19
explain 🟢 15/15 15/15
field_caps 🟢 63/63 63/63
get 🟢 299/299 296/296
index 🟢 1202/1202 1204/1204
indices.add_block 🟢 2/2 2/2
indices.close 🟢 49/49 49/49
indices.data_streams_stats 🟢 4/4 4/4
indices.disk_usage 🟢 6/6 6/6
indices.explain_data_lifecycle ⚪ Missing test Missing test
indices.field_usage_stats 🟢 5/5 5/5
indices.get_data_lifecycle_stats ⚪ Missing test Missing test
indices.get_data_lifecycle ⚪ Missing test Missing test
indices.get_field_mapping 🟢 15/15 15/15
indices.recovery 🟢 9/9 9/9
indices.resolve_cluster 🟢 13/13 13/13
indices.resolve_index 🟢 6/6 6/6
indices.rollover 🔴 27/27 2/27
indices.shard_stores 🔴 5/5 4/5
indices.simulate_index_template 🔴 6/7 5/7
indices.simulate_template 🔴 5/5 4/5
inference.completion ⚪ Missing test Missing test
inference.put_elasticsearch ⚪ Missing test Missing test
inference.rerank ⚪ Missing test Missing test
inference.sparse_embedding ⚪ Missing test Missing test
inference.text_embedding ⚪ Missing test Missing test
info 🟢 5/5 5/5
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.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 1/1
ml.estimate_model_memory 🟢 16/16 16/16
ml.evaluate_data_frame 🟢 15/15 15/15
open_point_in_time 🟢 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
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
scripts_painless_execute 🟢 4/4 4/4
search_application.get_behavioral_analytics 🔴 2/5 5/5
search_application.get 🔴 10/10 7/10
search_application.list 🔴 7/7 2/7
search_mvt ⚪ 34/34 Missing test
search_shards 🟢 7/7 7/7
search 🔴 2371/2423 2407/2407
searchable_snapshots.cache_stats ⚪ Missing test Missing test
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.create_api_key 🟢 68/68 59/59
security.create_cross_cluster_api_key 🟢 3/3 3/3
security.create_service_token 🟢 2/2 2/2
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.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_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.execute_lifecycle 🟢 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 🔴 21/23 23/23
snapshot.get_repository 🔴 19/19 7/19
snapshot.get 🟢 13/13 13/13
snapshot.status 🟢 2/2 2/2
ssl.certificates 🟢 2/2 2/2
synonyms.delete_synonym_rule 🟢 8/8 8/8
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 🟢 5/5 5/5
synonyms.put_synonym 🟢 31/31 31/31
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.preview_transform 🟢 21/21 21/21
watcher.ack_watch 🟢 1/1 1/1
watcher.delete_watch 🟢 2/2 2/2
watcher.execute_watch 🟢 7/7 7/7
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 🔴 41/41 2/37

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

@miguelgrinberg miguelgrinberg changed the title add a few example requests for endpoints that do not use bodies add example requests for endpoints that do not use bodies Jun 9, 2025
@github-actions GitHub Actions
Copy link
Contributor

github-actions bot commented Jun 9, 2025

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 🟢 469/469 487/487
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.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 🟢 157/157 157/157
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 🟢 5/5 4/4
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 🟢 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 🟢 299/299 296/296
ilm.delete_lifecycle 🟢 2/2 2/2
ilm.explain_lifecycle 🔴 5/5 4/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 🟢 1202/1202 1204/1204
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 🔴 144/144 142/144
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 🟢 283/283 283/283
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 🔴 123/123 30/122
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 1/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
nodes.hot_threads 🟢 5/5 5/5
nodes.info 🔴 112/112 1/112
nodes.stats 🔴 58/58 18/58
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
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 🔴 2371/2423 2407/2407
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 🟢 2/2 2/2
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 🟢 8/8 8/8
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 🟢 5/5 5/5
synonyms.put_synonym 🟢 31/31 31/31
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
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 🔴 41/41 2/37

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

1 similar comment
@github-actions GitHub Actions
Copy link
Contributor

github-actions bot commented Jun 9, 2025

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 🟢 469/469 487/487
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.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 🟢 157/157 157/157
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 🟢 5/5 4/4
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 🟢 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 🟢 299/299 296/296
ilm.delete_lifecycle 🟢 2/2 2/2
ilm.explain_lifecycle 🔴 5/5 4/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 🟢 1202/1202 1204/1204
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 🔴 144/144 142/144
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 🟢 283/283 283/283
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 🔴 123/123 30/122
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 1/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
nodes.hot_threads 🟢 5/5 5/5
nodes.info 🔴 112/112 1/112
nodes.stats 🔴 58/58 18/58
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
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 🔴 2371/2423 2407/2407
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 🟢 2/2 2/2
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 🟢 8/8 8/8
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 🟢 5/5 5/5
synonyms.put_synonym 🟢 31/31 31/31
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
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 🔴 41/41 2/37

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

@miguelgrinberg
Copy link
Contributor Author

miguelgrinberg commented Jun 9, 2025 •
edited
Loading

@lcawl Preview URL for the latest version: https://www.elastic.co/docs/api/doc/elasticsearch/version/475682a4-c607-4ca5-a63c-26c1f9b636da/

@miguelgrinberg miguelgrinberg requested a review from lcawl June 9, 2025 16:31
@miguelgrinberg miguelgrinberg force-pushed the request-example-without-body branch from ec158de to 4bcbf90 Compare June 9, 2025 16:33
@github-actions GitHub Actions
Copy link
Contributor

github-actions bot commented Jun 9, 2025

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 🟢 469/469 487/487
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.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 🟢 157/157 157/157
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 🟢 5/5 4/4
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 🟢 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 🟢 299/299 296/296
ilm.delete_lifecycle 🟢 2/2 2/2
ilm.explain_lifecycle 🔴 5/5 4/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 🟢 1202/1202 1204/1204
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 🔴 144/144 142/144
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 🟢 283/283 283/283
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 🔴 123/123 30/122
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 1/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
nodes.hot_threads 🟢 5/5 5/5
nodes.info 🔴 112/112 1/112
nodes.stats 🔴 58/58 18/58
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
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 🔴 2371/2423 2407/2407
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 🟢 2/2 2/2
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 🟢 8/8 8/8
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 🟢 5/5 5/5
synonyms.put_synonym 🟢 31/31 31/31
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
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 🔴 41/41 2/37

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

@github-actions GitHub Actions
Copy link
Contributor

github-actions bot commented Jun 9, 2025

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
async_search.submit 🟢 7/7 7/7
autoscaling.delete_autoscaling_policy ⚪ Missing test Missing test
autoscaling.get_autoscaling_capacity ⚪ Missing test Missing test
autoscaling.get_autoscaling_policy ⚪ Missing test Missing test
autoscaling.put_autoscaling_policy ⚪ Missing test Missing test
bulk 🟢 469/469 487/487
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.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.forget_follower ⚪ 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.put_auto_follow_pattern ⚪ Missing test Missing test
ccr.resume_auto_follow_pattern ⚪ Missing test Missing test
ccr.resume_follow ⚪ Missing test Missing test
ccr.stats ⚪ Missing test Missing test
ccr.unfollow ⚪ 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.delete_component_template 🟢 2/2 2/2
cluster.get_component_template 🟢 12/12 12/12
cluster.get_settings 🟢 7/7 7/7
cluster.health 🟢 157/157 157/157
cluster.info 🟢 4/4 4/4
cluster.pending_tasks 🟢 3/3 3/3
cluster.put_component_template 🟢 29/29 29/29
cluster.put_settings 🟢 59/59 58/58
cluster.remote_info 🟢 3/3 3/3
cluster.reroute 🟢 8/8 7/7
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.last_sync 🟢 7/7 7/7
connector.list 🟢 31/31 31/31
connector.put 🟢 20/20 20/20
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_error 🟢 1/1 1/1
connector.sync_job_get 🟢 22/22 22/22
connector.sync_job_list 🟢 12/12 12/12
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.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
eql.search 🟢 38/38 38/38
esql.async_query_delete ⚪ Missing test Missing test
esql.async_query_get ⚪ Missing test Missing test
esql.async_query_stop ⚪ Missing test Missing test
esql.async_query ⚪ Missing test Missing test
esql.query ⚪ 317/317 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
graph.explore 🟢 4/4 4/4
health_report 🟢 4/4 4/4
ilm.delete_lifecycle 🟢 2/2 2/2
ilm.explain_lifecycle 🔴 5/5 4/5
ilm.get_lifecycle 🟢 8/8 8/8
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
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 🟢 1202/1202 1204/1204
indices.add_block 🟢 2/2 2/2
indices.analyze 🟢 246/246 246/246
indices.cancel_migrate_reindex 🟢 2/2 2/2
indices.clear_cache 🟢 4/4 4/4
indices.clone 🟢 5/5 5/5
indices.close 🟢 49/49 49/49
indices.create_data_stream 🟢 31/31 31/31
indices.create_from 🟢 4/4 4/4
indices.create 🔴 1179/1230 1230/1230
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.downsample 🟢 4/4 4/4
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 🔴 144/144 142/144
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.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.refresh 🟢 283/283 283/283
indices.reload_search_analyzers 🟢 2/2 2/2
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.shrink 🟢 5/5 5/5
indices.simulate_index_template 🔴 6/7 5/7
indices.simulate_template 🔴 5/5 4/5
indices.split 🟢 11/11 11/11
indices.stats 🔴 123/123 30/122
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.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.stream_completion ⚪ 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
ingest.put_pipeline 🟢 60/60 60/60
ingest.simulate 🟢 10/10 10/10
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
license.post 🟢 1/1 1/1
logstash.delete_pipeline ⚪ Missing test Missing test
logstash.get_pipeline ⚪ Missing test Missing test
logstash.put_pipeline ⚪ Missing test Missing test
mget 🟢 51/51 50/50
migration.deprecations 🟢 2/2 2/2
migration.get_feature_upgrade_status 🟢 1/1 1/1
migration.post_feature_upgrade 🟢 1/1 1/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.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_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.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_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_job 🟢 227/227 225/225
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_template 🟢 1/1 1/1
msearch 🟢 17/17 16/16
mtermvectors 🟢 10/10 10/10
nodes.hot_threads 🟢 5/5 5/5
nodes.info 🔴 112/112 1/112
nodes.reload_secure_settings 🟢 2/2 2/2
nodes.stats 🔴 58/58 18/58
nodes.usage 🟢 1/1 1/1
open_point_in_time 🟢 7/7 7/7
put_script 🟢 41/41 41/41
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.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_rethrottle 🟢 2/2 2/2
reindex 🟢 15/15 14/14
render_search_template 🟢 1/1 1/1
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.put_job 🟢 22/22 22/22
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
scroll 🟢 69/69 20/20
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.post_behavioral_analytics_event 🟢 18/18 18/18
search_application.put_behavioral_analytics 🟢 3/3 3/3
search_application.put 🔴 6/10 10/10
search_application.render_query 🟢 7/7 7/7
search_application.search 🟢 16/16 16/16
search_mvt ⚪ 34/34 Missing test
search_shards 🟢 7/7 7/7
search_template 🟢 2/2 1/1
search 🔴 2371/2423 2407/2407
searchable_snapshots.cache_stats ⚪ Missing test Missing test
searchable_snapshots.clear_cache 🟢 1/1 1/1
searchable_snapshots.mount 🟢 4/4 4/4
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.bulk_update_api_keys 🟢 4/4 4/4
security.change_password 🟢 9/9 9/9
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 🟢 2/2 2/2
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.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.delete_node ⚪ Missing test Missing test
shutdown.get_node ⚪ Missing test Missing test
shutdown.put_node ⚪ Missing test Missing test
simulate.ingest 🔴 11/12 12/12
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.put_lifecycle 🟢 4/4 4/4
slm.start ⚪ Missing test Missing test
snapshot.cleanup_repository 🟢 3/3 3/3
snapshot.clone 🟢 5/5 5/5
snapshot.create_repository 🔴 24/29 29/29
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.restore 🟢 5/5 5/5
snapshot.status 🟢 2/2 2/2
snapshot.verify_repository 🟢 2/2 2/2
sql.clear_cursor 🟢 1/1 1/1
sql.delete_async ⚪ Missing test Missing test
sql.get_async_status ⚪ Missing test Missing test
sql.get_async ⚪ Missing test Missing test
sql.query 🟢 4/4 4/4
sql.translate 🔴 1/1 0/1
ssl.certificates 🟢 2/2 2/2
synonyms.delete_synonym_rule 🟢 8/8 8/8
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 🟢 5/5 5/5
synonyms.put_synonym 🟢 31/31 31/31
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.put_transform 🟢 28/28 28/28
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.update_transform 🟢 14/14 14/14
transform.upgrade_transforms 🟢 2/2 2/2
update_by_query_rethrottle 🟢 1/1 1/1
update_by_query 🟢 5/5 4/4
update 🟢 35/35 35/35
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.put_watch 🔴 29/38 38/38
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
watcher.update_settings ⚪ Missing test Missing test
xpack.info 🟢 8/8 4/4
xpack.usage 🔴 41/41 2/37

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

@lcawl
Copy link
Contributor

lcawl commented Jun 9, 2025 •
edited
Loading

In a previous PR I added method_request fields to same responses. These are now unnecessary so they were removed.

Is it very simple to understand now when that info is required? e.g. is it only required in at least one request or response body file (and only in the one that we want to appear in the x-codeSamples)? And if there are multiple request or response body examples that have this field, which one is picked for use in x-codeSamples? IMO we should try to make this as clear and simple as possible (and if that means we leave the method_request in all of them to avoid confusion, that's fine by me).

lcawl
lcawl reviewed Jun 9, 2025
View reviewed changes
@miguelgrinberg
Copy link
Contributor Author

miguelgrinberg commented Jun 9, 2025 •
edited
Loading

The method_request is only used in request (after this PR is merged). In the previous PR I added it to endpoints that only had responses (due to not have a request body), but now that this limitation was lifted it makes more sense to always store these in the request examples. I have moved the method_request field out of all these responses and created new examples w/o body for them. This is also included in this PR.

So to summarize. The method_request field should be used only in requests. It is ignored in responses. In a request example, it is valid to have a method_request field and omit the value field (the body).

And thanks for catching the callouts! I will do another pass to filter those out.

@miguelgrinberg miguelgrinberg force-pushed the request-example-without-body branch from 74dbefe to 89ee8fe Compare June 9, 2025 21:39
@github-actions GitHub Actions
Copy link
Contributor

github-actions bot commented Jun 9, 2025

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 🟢 469/469 487/487
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.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 🟢 157/157 157/157
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 4/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 🟢 1202/1202 1204/1204
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 🔴 144/144 142/144
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 🟢 283/283 283/283
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 🔴 123/123 30/122
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 1/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 🔴 58/58 18/58
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 🔴 2371/2423 2407/2407
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 🟢 2/2 2/2
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 🟢 8/8 8/8
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 🟢 5/5 5/5
synonyms.put_synonym 🟢 31/31 31/31
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 🔴 41/41 2/37

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

@miguelgrinberg miguelgrinberg force-pushed the request-example-without-body branch from 89ee8fe to 9ccf819 Compare June 10, 2025 09:19
@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 🟢 469/469 487/487
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.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 🟢 157/157 157/157
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 4/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 🟢 1202/1202 1204/1204
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 🔴 144/144 142/144
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 🟢 283/283 283/283
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 🔴 123/123 30/122
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 1/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 🔴 58/58 18/58
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 🔴 2371/2423 2407/2407
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 🟢 2/2 2/2
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 🟢 8/8 8/8
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 🟢 5/5 5/5
synonyms.put_synonym 🟢 31/31 31/31
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 🔴 41/41 2/37

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

@miguelgrinberg miguelgrinberg merged commit 7d0defc into main Jun 10, 2025
8 checks passed
@miguelgrinberg miguelgrinberg deleted the request-example-without-body branch June 10, 2025 09:44
@github-actions GitHub Actions
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-4489-to-9.0
# Cherry-pick the merged commit of this pull request and resolve the conflicts
git cherry-pick -x --mainline 1 7d0defc6dd27928090c93b68b0105505f009f827
# Push it to GitHub
git push --set-upstream origin backport-4489-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-4489-to-9.0.

miguelgrinberg added a commit that referenced this pull request Jun 10, 2025
@miguelgrinberg @lcawl
add example requests for endpoints that do not use bodies (#4489)
551363b 
* 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]>
@miguelgrinberg miguelgrinberg mentioned this pull request Jun 10, 2025
Merged
miguelgrinberg added a commit that referenced this pull request Jun 10, 2025
@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]>
miguelgrinberg added a commit that referenced this pull request Jun 10, 2025
@miguelgrinberg @lcawl
add example requests for endpoints that do not use bodies (#4489) (#4509
da30074 
)

* 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]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@lcawl lcawl lcawl approved these changes

Assignees
No one assigned
Labels
backport 9.0 compiler specification
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
2 participants
@miguelgrinberg @lcawl