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.

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

Add more example subfolders #3505

Merged
merged 3 commits into from
Jan 15, 2025
Merged

Add more example subfolders #3505

merged 3 commits into from
Jan 15, 2025
+81 −49

Conversation

lcawl
Copy link
Contributor

@lcawl lcawl commented Jan 10, 2025 •
edited
Loading

Relates to #2482

This PR moves more examples into appropriate subfolders and updates the overlays.
It also adds advice about examples to the add-new-api.md readme.

@lcawl lcawl requested a review from a team January 10, 2025 23:33
@github-actions GitHub Actions
Copy link
Contributor

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

API Status Request Response
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
cluster.put_component_template 🔴 21/29 29/29
connector.check_in 🟢 3/3 3/3
connector.delete 🟢 21/21 21/21
connector.last_sync 🟢 7/7 7/7
connector.put 🟢 19/19 19/19
connector.sync_job_delete 🟢 4/4 4/4
connector.sync_job_error 🟢 1/1 1/1
connector.sync_job_post 🟢 50/50 50/50
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
dangling_indices.import_dangling_index ⚪ Missing test Missing test
dangling_indices.list_dangling_indices ⚪ Missing test Missing test
indices.add_block 🟢 2/2 2/2
indices.analyze 🟢 243/243 243/243
indices.clone 🟢 5/5 5/5
indices.create 🔴 1065/1165 1165/1165
indices.data_streams_stats 🟢 4/4 4/4
indices.delete_data_lifecycle ⚪ Missing test Missing test
indices.disk_usage 🟢 6/6 6/6
indices.downsample 🟢 1/1 1/1
indices.explain_data_lifecycle ⚪ Missing test Missing test
indices.field_usage_stats 🟢 5/5 5/5
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.open 🟢 20/20 20/20
indices.put_alias 🔴 58/58 20/58
indices.put_data_lifecycle ⚪ Missing test Missing test
indices.put_index_template 🔴 59/68 68/68
indices.put_mapping 🔴 111/115 115/115
indices.put_settings 🔴 55/58 58/58
indices.put_template 🔴 45/46 46/46
indices.recovery 🟢 9/9 9/9
indices.resolve_cluster 🔴 10/12 12/12
indices.rollover 🔴 26/26 1/26
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
ingest.get_pipeline 🟢 22/22 22/22
ingest.put_pipeline 🟢 60/60 60/60
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.get_pipeline ⚪ Missing test Missing test
logstash.put_pipeline ⚪ Missing test Missing test
migration.deprecations 🟢 2/2 2/2
migration.get_feature_upgrade_status 🟢 2/2 2/2
migration.post_feature_upgrade ⚪ Missing test Missing test
nodes.info 🔴 114/114 1/114
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 🟢 16/16 16/16
query_rules.test 🟢 9/9 9/9
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.post_behavioral_analytics_event 🟢 18/18 18/18
search_application.put 🔴 3/10 10/10
search_application.render_query 🟢 7/7 7/7
search_application.search 🟢 16/16 16/16
shutdown.delete_node ⚪ Missing test Missing test
shutdown.get_node ⚪ Missing test Missing test
shutdown.put_node ⚪ Missing test Missing test

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

@lcawl lcawl marked this pull request as ready for review January 11, 2025 00:11
@github-actions GitHub Actions
Copy link
Contributor

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

API Status Request Response
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
cluster.put_component_template 🔴 21/29 29/29
connector.check_in 🟢 3/3 3/3
connector.delete 🟢 21/21 21/21
connector.last_sync 🟢 7/7 7/7
connector.put 🟢 19/19 19/19
connector.sync_job_delete 🟢 4/4 4/4
connector.sync_job_error 🟢 1/1 1/1
connector.sync_job_post 🟢 50/50 50/50
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
dangling_indices.import_dangling_index ⚪ Missing test Missing test
dangling_indices.list_dangling_indices ⚪ Missing test Missing test
indices.add_block 🟢 2/2 2/2
indices.analyze 🟢 243/243 243/243
indices.clone 🟢 5/5 5/5
indices.create 🔴 1065/1165 1165/1165
indices.data_streams_stats 🟢 4/4 4/4
indices.delete_data_lifecycle ⚪ Missing test Missing test
indices.disk_usage 🟢 6/6 6/6
indices.downsample 🟢 1/1 1/1
indices.explain_data_lifecycle ⚪ Missing test Missing test
indices.field_usage_stats 🟢 5/5 5/5
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.open 🟢 20/20 20/20
indices.put_alias 🔴 58/58 20/58
indices.put_data_lifecycle ⚪ Missing test Missing test
indices.put_index_template 🔴 59/68 68/68
indices.put_mapping 🔴 111/115 115/115
indices.put_settings 🔴 55/58 58/58
indices.put_template 🔴 45/46 46/46
indices.recovery 🟢 9/9 9/9
indices.resolve_cluster 🔴 10/12 12/12
indices.rollover 🔴 26/26 1/26
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
ingest.get_pipeline 🟢 22/22 22/22
ingest.put_pipeline 🟢 60/60 60/60
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.get_pipeline ⚪ Missing test Missing test
logstash.put_pipeline ⚪ Missing test Missing test
migration.deprecations 🟢 2/2 2/2
migration.get_feature_upgrade_status 🟢 2/2 2/2
migration.post_feature_upgrade ⚪ Missing test Missing test
nodes.info 🔴 114/114 1/114
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 🟢 16/16 16/16
query_rules.test 🟢 9/9 9/9
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.post_behavioral_analytics_event 🟢 18/18 18/18
search_application.put 🔴 3/10 10/10
search_application.render_query 🟢 7/7 7/7
search_application.search 🟢 16/16 16/16
shutdown.delete_node ⚪ Missing test Missing test
shutdown.get_node ⚪ Missing test Missing test
shutdown.put_node ⚪ Missing test Missing test

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

@lcawl lcawl merged commit 84d57a4 into main Jan 15, 2025
8 checks passed
@lcawl lcawl deleted the template-examples branch January 15, 2025 18:59
github-actions bot pushed a commit that referenced this pull request Jan 15, 2025
@lcawl @github-actions
Add more example subfolders (#3505)
a84b7db 
(cherry picked from commit 84d57a4)
@github-actions github-actions bot mentioned this pull request Jan 15, 2025
Merged
github-actions bot pushed a commit that referenced this pull request Jan 15, 2025
@lcawl @github-actions
Add more example subfolders (#3505)
a3fa7da 
(cherry picked from commit 84d57a4)
@github-actions github-actions bot mentioned this pull request Jan 15, 2025
Merged
lcawl added a commit that referenced this pull request Jan 15, 2025
@github-actions @lcawl
Add more example subfolders (#3505) (#3536)
18d8a5c 
(cherry picked from commit 84d57a4)

Co-authored-by: Lisa Cawley <lcawley@elastic.co>
lcawl added a commit that referenced this pull request Jan 15, 2025
@github-actions @lcawl
Add more example subfolders (#3505) (#3537)
6c336bf 
(cherry picked from commit 84d57a4)

Co-authored-by: Lisa Cawley <lcawley@elastic.co>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@wajihaparvez wajihaparvez wajihaparvez approved these changes

Assignees
No one assigned
Labels
backport 8.x backport 8.17 documentation specification
Projects
None yet
Milestone
No milestone
Development

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