Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[DOCS] Add missing doc_id values #3632

Merged
merged 8 commits into from
Jan 28, 2025
Merged

[DOCS] Add missing doc_id values #3632

merged 8 commits into from
Jan 28, 2025

Conversation

lcawl
Copy link
Contributor

@lcawl lcawl commented Jan 28, 2025

This PR adds the missing doc_id values so that we can subsequently update the target URLs to the new API site.

It also adds some missing descriptions and examples that were found while making these changes. In particular, copied from https://www.elastic.co/guide/en/elasticsearch/reference/current/index-modules-blocks.html#add-index-block and https://www.elastic.co/guide/en/elasticsearch/reference/current/post-inference-api.html

Copy link
Contributor

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

API Status Request Response
cat.tasks 🟢 11/11 11/11
enrich.delete_policy 🟢 9/9 9/9
enrich.get_policy 🟢 6/6 6/6
enrich.stats 🟢 6/6 6/6
eql.delete 🟢 3/3 3/3
eql.search 🟢 37/37 37/37
features.get_features 🟢 2/2 2/2
features.reset_features Missing test Missing test
fleet.global_checkpoints Missing test Missing test
fleet.msearch Missing test Missing test
fleet.search Missing test Missing test
get_script 🟢 12/12 12/12
health_report 🟢 4/4 4/4
ilm.delete_lifecycle 🟢 2/2 2/2
ilm.explain_lifecycle 🟢 5/5 5/5
ilm.get_lifecycle 🟢 8/8 8/8
ilm.get_status 🟢 4/4 4/4
ilm.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
indices.add_block 🟢 2/2 2/2
indices.clear_cache 🟢 4/4 4/4
indices.clone 🟢 5/5 5/5
indices.create_data_stream 🟢 31/31 31/31
indices.data_streams_stats 🟢 4/4 4/4
indices.delete_data_lifecycle Missing test Missing test
indices.delete_data_stream 🟢 28/28 28/28
indices.exists_alias 🟢 37/37 37/37
indices.exists_index_template Missing test Missing test
indices.explain_data_lifecycle Missing test Missing test
indices.get_data_lifecycle Missing test Missing test
indices.get_data_stream 🟢 11/11 11/11
inference.delete Missing test Missing test
inference.get 🟢 1/1 1/1
inference.inference Missing test Missing test
inference.put Missing test Missing test
ingest.delete_geoip_database 🟢 1/1 1/1
ingest.delete_ip_location_database 🟢 1/1 1/1
ingest.delete_pipeline 🟢 15/15 15/15
ingest.get_geoip_database 🟢 6/6 6/6
ingest.get_ip_location_database 🟢 7/7 7/7
ingest.get_pipeline 🟢 22/22 22/22
ingest.put_geoip_database 🟢 3/3 3/3
ingest.put_ip_location_database 🟢 4/4 4/4
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 🟢 1/1 1/1
ml.clear_trained_model_deployment_cache 🟢 1/1 1/1
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 12/17
ml.get_trained_models 🟢 37/37 37/37
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.post_data 🔴 9/11 18/18
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_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.put_trained_model 🔴 8/16 16/16
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
ml.validate_detector 🟢 2/2 2/2
monitoring.bulk 🟢 6/6 6/6
msearch 🟢 17/17 16/16
nodes.reload_secure_settings 🟢 2/2 2/2
ping 🟢 1/1 1/1
rank_eval Missing test Missing test
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 6/10
search_application.list 🔴 7/7 2/7
search_application.put_behavioral_analytics 🟢 3/3 3/3
search_application.put 🔴 3/10 10/10
search_application.search 🟢 16/16 16/16
security.bulk_delete_role 🟢 1/1 1/1
security.bulk_put_role 🟢 1/1 1/1
text_structure.test_grok_pattern 🟢 2/2 2/2
transform.delete_transform 🟢 10/10 10/10
transform.get_transform_stats 🔴 34/34 33/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

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

@lcawl lcawl marked this pull request as ready for review January 28, 2025 01:59
@lcawl lcawl requested review from a team as code owners January 28, 2025 01:59
@lcawl lcawl merged commit 89a229f into main Jan 28, 2025
12 checks passed
@lcawl lcawl deleted the docid-updates branch January 28, 2025 03:23
Copy link
Contributor

The backport to 8.x failed:

The process '/usr/bin/git' failed with exit code 1

To backport manually, run these commands in your terminal:

# Fetch latest updates from GitHub
git fetch
# Create a new working tree
git worktree add .worktrees/backport-8.x 8.x
# Navigate to the new working tree
cd .worktrees/backport-8.x
# Create a new branch
git switch --create backport-3632-to-8.x
# Cherry-pick the merged commit of this pull request and resolve the conflicts
git cherry-pick -x --mainline 1 89a229fb5b680d6c2ac79167b0063211f170df07
# Push it to GitHub
git push --set-upstream origin backport-3632-to-8.x
# Go back to the original working tree
cd ../..
# Delete the working tree
git worktree remove .worktrees/backport-8.x

Then, create a pull request where the base branch is 8.x and the compare/head branch is backport-3632-to-8.x.

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

lcawl commented Jan 28, 2025

💚 All backports created successfully

Status Branch Result
8.x

Questions ?

Please refer to the Backport tool documentation

lcawl added a commit that referenced this pull request Jan 28, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants