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

Add more summaries #2719

Merged
merged 5 commits into from
Jul 26, 2024
Merged

Add more summaries #2719

merged 5 commits into from
Jul 26, 2024

Conversation

shainaraskas
Copy link
Contributor

@shainaraskas shainaraskas commented Jul 15, 2024

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

  • component template
  • scripts
  • tasks
  • security

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
bulk 🟢 411/411 429/429
cluster.delete_component_template 🟢 2/2 2/2
cluster.exists_component_template Missing test Missing test
cluster.get_component_template 🔴 10/10 8/10
cluster.put_component_template 🔴 21/25 25/25
delete_script 🟢 8/8 8/8
get_script 🟢 12/12 12/12
put_script 🟢 41/41 41/41
scripts_painless_execute 🔴 3/4 4/4
security.authenticate 🟢 30/30 30/30
security.create_api_key 🔴 67/69 60/60
security.get_api_key 🔴 38/38 15/38
security.has_privileges 🟢 24/24 24/24
security.invalidate_api_key 🟢 12/12 12/12
security.query_api_keys 🔴 14/14 1/14
security.update_api_key 🟢 5/5 5/5
tasks.get 🟢 10/10 10/10

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

@shainaraskas shainaraskas requested a review from lcawl July 19, 2024 13:50
@shainaraskas shainaraskas marked this pull request as ready for review July 19, 2024 13:50
Copy link
Contributor

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

API Status Request Response
bulk 🟢 411/411 429/429
cluster.delete_component_template 🟢 2/2 2/2
cluster.exists_component_template Missing test Missing test
cluster.get_component_template 🔴 10/10 8/10
cluster.put_component_template 🔴 21/25 25/25
delete_script 🟢 8/8 8/8
get_script 🟢 12/12 12/12
put_script 🟢 41/41 41/41
scripts_painless_execute 🔴 3/4 4/4
security.authenticate 🟢 30/30 30/30
security.create_api_key 🔴 67/69 60/60
security.get_api_key 🔴 38/38 15/38
security.has_privileges 🟢 24/24 24/24
security.invalidate_api_key 🟢 12/12 12/12
security.query_api_keys 🔴 14/14 1/14
security.update_api_key 🟢 5/5 5/5
tasks.get 🟢 10/10 10/10

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.

LGTM!

Copy link
Contributor

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

API Status Request Response
bulk 🟢 412/412 430/430
cluster.delete_component_template 🟢 2/2 2/2
cluster.exists_component_template Missing test Missing test
cluster.get_component_template 🔴 10/10 8/10
cluster.put_component_template 🔴 21/25 25/25
delete_script 🟢 8/8 8/8
get_script 🟢 12/12 12/12
put_script 🟢 41/41 41/41
scripts_painless_execute 🔴 3/4 4/4
security.authenticate 🟢 30/30 30/30
security.create_api_key 🔴 67/69 60/60
security.get_api_key 🔴 38/38 15/38
security.has_privileges 🟢 24/24 24/24
security.invalidate_api_key 🟢 12/12 12/12
security.query_api_keys 🔴 14/14 1/14
security.update_api_key 🟢 5/5 5/5
tasks.get 🟢 10/10 10/10

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
bulk 🟢 412/412 430/430
cluster.delete_component_template 🟢 2/2 2/2
cluster.exists_component_template Missing test Missing test
cluster.get_component_template 🔴 10/10 8/10
cluster.put_component_template 🔴 21/25 25/25
delete_script 🟢 8/8 8/8
get_script 🟢 12/12 12/12
put_script 🟢 41/41 41/41
scripts_painless_execute 🔴 3/4 4/4
security.authenticate 🟢 30/30 30/30
security.create_api_key 🔴 67/69 60/60
security.get_api_key 🔴 38/38 15/38
security.has_privileges 🟢 24/24 24/24
security.invalidate_api_key 🟢 12/12 12/12
security.query_api_keys 🔴 14/14 1/14
security.update_api_key 🟢 5/5 5/5
tasks.get 🟢 10/10 10/10

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

@shainaraskas shainaraskas enabled auto-merge (squash) July 26, 2024 18:09
Copy link
Contributor

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

API Status Request Response
bulk 🟢 412/412 430/430
cluster.delete_component_template 🟢 2/2 2/2
cluster.exists_component_template Missing test Missing test
cluster.get_component_template 🔴 10/10 8/10
cluster.put_component_template 🔴 21/25 25/25
delete_script 🟢 8/8 8/8
get_script 🟢 12/12 12/12
put_script 🟢 41/41 41/41
scripts_painless_execute 🔴 3/4 4/4
security.authenticate 🟢 30/30 30/30
security.create_api_key 🔴 67/69 60/60
security.get_api_key 🔴 38/38 15/38
security.has_privileges 🟢 24/24 24/24
security.invalidate_api_key 🟢 12/12 12/12
security.query_api_keys 🔴 14/14 1/14
security.update_api_key 🟢 5/5 5/5
tasks.get 🟢 10/10 10/10

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

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