Skip to content

Add further summaries #2734

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

Merged
merged 8 commits into from
Jul 26, 2024
Merged

Add further summaries #2734

merged 8 commits into from
Jul 26, 2024

Conversation

shainaraskas
Copy link
Contributor

@shainaraskas shainaraskas commented Jul 22, 2024

This PR adds operation summaries for the following areas, using text from the appropriate pages from the elasticsearch API reference.

  • CAT
  • doc
  • delete by query
  • update by query
  • enrich
  • info
  • mapping
  • transform
  • validate

Also converted the messy notes into note blocks, e.g.

image

part of #2635

will regenerate the reference after #2718 is approved and merged and this PR is rebased

Copy link
Contributor

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

API Status Request Response
cat.aliases 🟢 30/30 30/30
cat.component_templates Missing test Missing test
cat.count 🟢 9/9 9/9
cat.help Missing test Missing test
cat.indices 🔴 35/35 24/34
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.transforms 🟢 7/7 7/7
create 🟢 30/30 29/29
index 🔴 1009/1025 1027/1027

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

Copy link
Contributor

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

API Status Request Response
cat.aliases 🟢 30/30 30/30
cat.component_templates Missing test Missing test
cat.count 🟢 9/9 9/9
cat.help Missing test Missing test
cat.indices 🔴 35/35 24/34
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.transforms 🟢 7/7 7/7
create 🟢 30/30 29/29
index 🔴 1009/1025 1027/1027

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

Copy link
Contributor

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

API Status Request Response
cat.aliases 🟢 30/30 30/30
cat.component_templates Missing test Missing test
cat.count 🟢 9/9 9/9
cat.help Missing test Missing test
cat.indices 🔴 35/35 24/34
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.transforms 🟢 7/7 7/7
cluster.info 🔴 4/4 2/4
create 🟢 30/30 29/29
delete_by_query 🟢 5/5 4/4
enrich.delete_policy 🟢 9/9 9/9
enrich.get_policy 🟢 6/6 6/6
enrich.put_policy 🟢 10/10 10/10
enrich.stats 🔴 5/5 4/5
index 🔴 1009/1025 1027/1027
indices.get_field_mapping 🔴 15/15 14/15
indices.put_mapping 🔴 102/103 103/103
indices.validate_query 🟢 7/7 7/7
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 🟢 19/19 19/19
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
update_by_query 🟢 5/5 4/4

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

@shainaraskas shainaraskas changed the title Add CAT and doc summaries Add further summaries Jul 22, 2024
Copy link
Contributor

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

API Status Request Response
cat.aliases 🟢 30/30 30/30
cat.component_templates Missing test Missing test
cat.count 🟢 9/9 9/9
cat.help Missing test Missing test
cat.indices 🔴 35/35 24/34
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.transforms 🟢 7/7 7/7
cluster.info 🔴 4/4 2/4
create 🟢 30/30 29/29
delete_by_query 🟢 5/5 4/4
enrich.delete_policy 🟢 9/9 9/9
enrich.get_policy 🟢 6/6 6/6
enrich.put_policy 🟢 10/10 10/10
enrich.stats 🔴 5/5 4/5
index 🔴 1009/1025 1027/1027
indices.get_field_mapping 🔴 15/15 14/15
indices.get_mapping 🔴 121/121 119/121
indices.put_mapping 🔴 102/103 103/103
indices.validate_query 🟢 7/7 7/7
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 🟢 19/19 19/19
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
update_by_query 🟢 5/5 4/4

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

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.

Cool callout additions, LGTM

Copy link
Contributor

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

API Status Request Response
cat.aliases 🟢 30/30 30/30
cat.component_templates Missing test Missing test
cat.count 🟢 9/9 9/9
cat.help Missing test Missing test
cat.indices 🔴 35/35 24/34
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.transforms 🟢 7/7 7/7
delete_by_query 🟢 5/5 4/4
enrich.delete_policy 🟢 9/9 9/9
enrich.get_policy 🟢 6/6 6/6
enrich.put_policy 🟢 10/10 10/10
enrich.stats 🔴 6/6 4/6
indices.get_field_mapping 🔴 15/15 14/15
indices.get_mapping 🔴 133/133 131/133
indices.put_mapping 🔴 114/115 115/115
indices.validate_query 🟢 7/7 7/7
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 🟢 19/19 19/19
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
update_by_query 🟢 5/5 4/4

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

1 similar comment
Copy link
Contributor

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

API Status Request Response
cat.aliases 🟢 30/30 30/30
cat.component_templates Missing test Missing test
cat.count 🟢 9/9 9/9
cat.help Missing test Missing test
cat.indices 🔴 35/35 24/34
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.transforms 🟢 7/7 7/7
delete_by_query 🟢 5/5 4/4
enrich.delete_policy 🟢 9/9 9/9
enrich.get_policy 🟢 6/6 6/6
enrich.put_policy 🟢 10/10 10/10
enrich.stats 🔴 6/6 4/6
indices.get_field_mapping 🔴 15/15 14/15
indices.get_mapping 🔴 133/133 131/133
indices.put_mapping 🔴 114/115 115/115
indices.validate_query 🟢 7/7 7/7
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 🟢 19/19 19/19
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
update_by_query 🟢 5/5 4/4

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

@shainaraskas shainaraskas merged commit c3dcedf into main Jul 26, 2024
6 checks passed
@shainaraskas shainaraskas deleted the more-summaries-0722 branch July 26, 2024 18:38
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