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

Convert examples to yaml and add subfolders #3458

Merged
merged 7 commits into from
Jan 8, 2025
Merged

Convert examples to yaml and add subfolders #3458

merged 7 commits into from
Jan 8, 2025

Conversation

lcawl
Copy link
Contributor

@lcawl lcawl commented Jan 7, 2025

Relates to #2482

This PR moves existing example files to an "examples" subfolder.
It also converts existing example files from json to yaml so that we can comment out some of the content that's generating linting errors.

Copy link
Contributor

github-actions bot commented Jan 7, 2025

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

API Status Request Response
async_search.submit 🟢 7/7 7/7
ccr.follow Missing test Missing test
ccr.forget_follower Missing test Missing test
ccr.put_auto_follow_pattern Missing test Missing test
ccr.resume_follow Missing test Missing test
cluster.allocation_explain 🟢 4/4 4/4
cluster.put_settings 🟢 59/59 58/58
cluster.reroute 🟢 7/7 6/6
eql.search 🟢 37/37 37/37
indices.close 🟢 49/49 49/49
indices.resolve_index 🟢 6/6 6/6

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

Copy link
Contributor

github-actions bot commented Jan 7, 2025

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

API Status Request Response
async_search.submit 🟢 7/7 7/7
ccr.follow Missing test Missing test
ccr.forget_follower Missing test Missing test
ccr.put_auto_follow_pattern Missing test Missing test
ccr.resume_follow Missing test Missing test
cluster.allocation_explain 🟢 4/4 4/4
cluster.put_settings 🟢 59/59 58/58
cluster.reroute 🟢 7/7 6/6
eql.search 🟢 37/37 37/37
esql.query 278/278 Missing test
graph.explore 🟢 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.close 🟢 49/49 49/49
indices.resolve_index 🟢 6/6 6/6

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

Copy link
Contributor

github-actions bot commented Jan 7, 2025

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

API Status Request Response
async_search.submit 🟢 7/7 7/7
ccr.follow Missing test Missing test
ccr.forget_follower Missing test Missing test
ccr.put_auto_follow_pattern Missing test Missing test
ccr.resume_follow Missing test Missing test
cluster.allocation_explain 🟢 4/4 4/4
cluster.put_settings 🟢 59/59 58/58
cluster.reroute 🟢 7/7 6/6
eql.search 🟢 37/37 37/37
esql.query 278/278 Missing test
graph.explore 🟢 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.close 🟢 49/49 49/49
indices.resolve_index 🟢 6/6 6/6
ml.estimate_model_memory 🟢 16/16 16/16
ml.evaluate_data_frame 🟢 15/15 15/15

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

@lcawl lcawl requested a review from a team January 8, 2025 00:44
@lcawl lcawl marked this pull request as ready for review January 8, 2025 00:45
@lcawl lcawl requested review from a team as code owners January 8, 2025 00:45
Copy link
Contributor

github-actions bot commented Jan 8, 2025

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

API Status Request Response
async_search.submit 🟢 7/7 7/7
ccr.follow Missing test Missing test
ccr.forget_follower Missing test Missing test
ccr.put_auto_follow_pattern Missing test Missing test
ccr.resume_follow Missing test Missing test
cluster.allocation_explain 🟢 4/4 4/4
cluster.health 🟢 159/159 159/159
cluster.put_settings 🟢 59/59 58/58
cluster.reroute 🟢 7/7 6/6
eql.get_status 🟢 3/3 3/3
eql.search 🟢 37/37 37/37
esql.query 278/278 Missing test
features.get_features 🟢 2/2 2/2
features.reset_features Missing test Missing test
graph.explore 🟢 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.close 🟢 49/49 49/49
indices.resolve_index 🟢 6/6 6/6
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
nodes.reload_secure_settings 🟢 2/2 2/2
tasks.get 🟢 10/10 10/10
transform.preview_transform 🟢 21/21 21/21
transform.put_transform 🟢 28/28 28/28
transform.update_transform 🟢 14/14 14/14

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

1 similar comment
Copy link
Contributor

github-actions bot commented Jan 8, 2025

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

API Status Request Response
async_search.submit 🟢 7/7 7/7
ccr.follow Missing test Missing test
ccr.forget_follower Missing test Missing test
ccr.put_auto_follow_pattern Missing test Missing test
ccr.resume_follow Missing test Missing test
cluster.allocation_explain 🟢 4/4 4/4
cluster.health 🟢 159/159 159/159
cluster.put_settings 🟢 59/59 58/58
cluster.reroute 🟢 7/7 6/6
eql.get_status 🟢 3/3 3/3
eql.search 🟢 37/37 37/37
esql.query 278/278 Missing test
features.get_features 🟢 2/2 2/2
features.reset_features Missing test Missing test
graph.explore 🟢 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.close 🟢 49/49 49/49
indices.resolve_index 🟢 6/6 6/6
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
nodes.reload_secure_settings 🟢 2/2 2/2
tasks.get 🟢 10/10 10/10
transform.preview_transform 🟢 21/21 21/21
transform.put_transform 🟢 28/28 28/28
transform.update_transform 🟢 14/14 14/14

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

@l-trotta l-trotta self-assigned this Jan 8, 2025
Copy link
Contributor

@l-trotta l-trotta left a comment

Choose a reason for hiding this comment

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

looks good, thank you for taking the time to rearrange everything :)

Copy link
Contributor

github-actions bot commented Jan 8, 2025

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

API Status Request Response
async_search.submit 🟢 7/7 7/7
ccr.follow Missing test Missing test
ccr.forget_follower Missing test Missing test
ccr.put_auto_follow_pattern Missing test Missing test
ccr.resume_follow Missing test Missing test
cluster.allocation_explain 🟢 4/4 4/4
cluster.health 🟢 159/159 159/159
cluster.put_settings 🟢 59/59 58/58
cluster.reroute 🟢 7/7 6/6
eql.get_status 🟢 3/3 3/3
eql.search 🟢 37/37 37/37
esql.query 278/278 Missing test
features.get_features 🟢 2/2 2/2
features.reset_features Missing test Missing test
graph.explore 🟢 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.close 🟢 49/49 49/49
indices.resolve_index 🟢 6/6 6/6
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
nodes.reload_secure_settings 🟢 2/2 2/2
tasks.get 🟢 10/10 10/10
transform.preview_transform 🟢 21/21 21/21
transform.put_transform 🟢 28/28 28/28
transform.update_transform 🟢 14/14 14/14

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

@lcawl lcawl merged commit b457ca0 into main Jan 8, 2025
8 checks passed
@lcawl lcawl deleted the example-folders branch January 8, 2025 17:19
github-actions bot pushed a commit that referenced this pull request Jan 8, 2025
github-actions bot pushed a commit that referenced this pull request Jan 8, 2025
lcawl added a commit that referenced this pull request Jan 8, 2025
(cherry picked from commit b457ca0)

Co-authored-by: Lisa Cawley <[email protected]>
lcawl added a commit that referenced this pull request Jan 8, 2025
(cherry picked from commit b457ca0)

Co-authored-by: Lisa Cawley <[email protected]>
Copy link
Contributor

@szabosteve szabosteve left a comment

Choose a reason for hiding this comment

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

One question, otherwise LGTM!

description: A successful response for getting status information for an async EQL search.
# type: response
# response_code: 200
value: >-
Copy link
Contributor

Choose a reason for hiding this comment

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

This is the only place in the value field where > is used as a separator instead of |. I don't know if it's intentional or not, and I'm not even sure if it makes a difference at all, but I thought it might be worth pointing it out.

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.

3 participants