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 Watcher API examples #3489

Merged
merged 10 commits into from
Jan 9, 2025
Merged

Add Watcher API examples #3489

merged 10 commits into from
Jan 9, 2025

Conversation

lcawl
Copy link
Contributor

@lcawl lcawl commented Jan 9, 2025

Relates to #2482

This PR copies examples from https://www.elastic.co/guide/en/elasticsearch/reference/master/watcher-api.html
It also adds missing doc_id values and edits some descriptions.

Copy link
Contributor

github-actions bot commented Jan 9, 2025

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

API Status Request Response
ccr.put_auto_follow_pattern Missing test Missing test
watcher.ack_watch 🟢 1/1 1/1
watcher.activate_watch 🟢 1/1 1/1
watcher.deactivate_watch 🟢 1/1 1/1
watcher.delete_watch 🟢 2/2 2/2
watcher.execute_watch 🟢 7/7 7/7
watcher.get_settings 🟠 Missing type Missing type
watcher.get_watch 🟢 9/9 9/9
watcher.put_watch 🔴 29/38 38/38
watcher.query_watches Missing test Missing test
watcher.start 🟢 1/1 1/1
watcher.stats 🟢 1/1 1/1
watcher.stop 🟢 1/1 1/1
watcher.update_settings 🟠 Missing type Missing type

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

@lcawl lcawl marked this pull request as ready for review January 9, 2025 09:53
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.

LGTM, I left a few suggestions. Only nits, so please take or leave them.

lcawl and others added 6 commits January 9, 2025 09:17
…tchResponseExample1.yaml

Co-authored-by: István Zoltán Szabó <[email protected]>
…chResponseExample1.yaml

Co-authored-by: István Zoltán Szabó <[email protected]>
…onseExample2.yaml

Co-authored-by: István Zoltán Szabó <[email protected]>
…xecuteWatchResponseExample1.yaml

Co-authored-by: István Zoltán Szabó <[email protected]>
…onseExample1.yaml

Co-authored-by: István Zoltán Szabó <[email protected]>
Copy link
Contributor

github-actions bot commented Jan 9, 2025

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

API Status Request Response
ccr.put_auto_follow_pattern Missing test Missing test
watcher.ack_watch 🟢 1/1 1/1
watcher.activate_watch 🟢 1/1 1/1
watcher.deactivate_watch 🟢 1/1 1/1
watcher.delete_watch 🟢 2/2 2/2
watcher.execute_watch 🟢 7/7 7/7
watcher.get_settings 🟠 Missing type Missing type
watcher.get_watch 🟢 9/9 9/9
watcher.put_watch 🔴 29/38 38/38
watcher.query_watches Missing test Missing test
watcher.start 🟢 1/1 1/1
watcher.stats 🟢 1/1 1/1
watcher.stop 🟢 1/1 1/1
watcher.update_settings 🟠 Missing type Missing type

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

5 similar comments
Copy link
Contributor

github-actions bot commented Jan 9, 2025

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

API Status Request Response
ccr.put_auto_follow_pattern Missing test Missing test
watcher.ack_watch 🟢 1/1 1/1
watcher.activate_watch 🟢 1/1 1/1
watcher.deactivate_watch 🟢 1/1 1/1
watcher.delete_watch 🟢 2/2 2/2
watcher.execute_watch 🟢 7/7 7/7
watcher.get_settings 🟠 Missing type Missing type
watcher.get_watch 🟢 9/9 9/9
watcher.put_watch 🔴 29/38 38/38
watcher.query_watches Missing test Missing test
watcher.start 🟢 1/1 1/1
watcher.stats 🟢 1/1 1/1
watcher.stop 🟢 1/1 1/1
watcher.update_settings 🟠 Missing type Missing type

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

Copy link
Contributor

github-actions bot commented Jan 9, 2025

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

API Status Request Response
ccr.put_auto_follow_pattern Missing test Missing test
watcher.ack_watch 🟢 1/1 1/1
watcher.activate_watch 🟢 1/1 1/1
watcher.deactivate_watch 🟢 1/1 1/1
watcher.delete_watch 🟢 2/2 2/2
watcher.execute_watch 🟢 7/7 7/7
watcher.get_settings 🟠 Missing type Missing type
watcher.get_watch 🟢 9/9 9/9
watcher.put_watch 🔴 29/38 38/38
watcher.query_watches Missing test Missing test
watcher.start 🟢 1/1 1/1
watcher.stats 🟢 1/1 1/1
watcher.stop 🟢 1/1 1/1
watcher.update_settings 🟠 Missing type Missing type

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

Copy link
Contributor

github-actions bot commented Jan 9, 2025

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

API Status Request Response
ccr.put_auto_follow_pattern Missing test Missing test
watcher.ack_watch 🟢 1/1 1/1
watcher.activate_watch 🟢 1/1 1/1
watcher.deactivate_watch 🟢 1/1 1/1
watcher.delete_watch 🟢 2/2 2/2
watcher.execute_watch 🟢 7/7 7/7
watcher.get_settings 🟠 Missing type Missing type
watcher.get_watch 🟢 9/9 9/9
watcher.put_watch 🔴 29/38 38/38
watcher.query_watches Missing test Missing test
watcher.start 🟢 1/1 1/1
watcher.stats 🟢 1/1 1/1
watcher.stop 🟢 1/1 1/1
watcher.update_settings 🟠 Missing type Missing type

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

Copy link
Contributor

github-actions bot commented Jan 9, 2025

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

API Status Request Response
ccr.put_auto_follow_pattern Missing test Missing test
watcher.ack_watch 🟢 1/1 1/1
watcher.activate_watch 🟢 1/1 1/1
watcher.deactivate_watch 🟢 1/1 1/1
watcher.delete_watch 🟢 2/2 2/2
watcher.execute_watch 🟢 7/7 7/7
watcher.get_settings 🟠 Missing type Missing type
watcher.get_watch 🟢 9/9 9/9
watcher.put_watch 🔴 29/38 38/38
watcher.query_watches Missing test Missing test
watcher.start 🟢 1/1 1/1
watcher.stats 🟢 1/1 1/1
watcher.stop 🟢 1/1 1/1
watcher.update_settings 🟠 Missing type Missing type

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

Copy link
Contributor

github-actions bot commented Jan 9, 2025

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

API Status Request Response
ccr.put_auto_follow_pattern Missing test Missing test
watcher.ack_watch 🟢 1/1 1/1
watcher.activate_watch 🟢 1/1 1/1
watcher.deactivate_watch 🟢 1/1 1/1
watcher.delete_watch 🟢 2/2 2/2
watcher.execute_watch 🟢 7/7 7/7
watcher.get_settings 🟠 Missing type Missing type
watcher.get_watch 🟢 9/9 9/9
watcher.put_watch 🔴 29/38 38/38
watcher.query_watches Missing test Missing test
watcher.start 🟢 1/1 1/1
watcher.stats 🟢 1/1 1/1
watcher.stop 🟢 1/1 1/1
watcher.update_settings 🟠 Missing type Missing type

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

Copy link
Contributor

github-actions bot commented Jan 9, 2025

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

API Status Request Response
ccr.put_auto_follow_pattern Missing test Missing test
watcher.ack_watch 🟢 1/1 1/1
watcher.activate_watch 🟢 1/1 1/1
watcher.deactivate_watch 🟢 1/1 1/1
watcher.delete_watch 🟢 2/2 2/2
watcher.execute_watch 🟢 7/7 7/7
watcher.get_settings 🟠 Missing type Missing type
watcher.get_watch 🟢 9/9 9/9
watcher.put_watch 🔴 29/38 38/38
watcher.query_watches Missing test Missing test
watcher.start 🟢 1/1 1/1
watcher.stats 🟢 1/1 1/1
watcher.stop 🟢 1/1 1/1
watcher.update_settings 🟠 Missing type Missing type

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

2 similar comments
Copy link
Contributor

github-actions bot commented Jan 9, 2025

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

API Status Request Response
ccr.put_auto_follow_pattern Missing test Missing test
watcher.ack_watch 🟢 1/1 1/1
watcher.activate_watch 🟢 1/1 1/1
watcher.deactivate_watch 🟢 1/1 1/1
watcher.delete_watch 🟢 2/2 2/2
watcher.execute_watch 🟢 7/7 7/7
watcher.get_settings 🟠 Missing type Missing type
watcher.get_watch 🟢 9/9 9/9
watcher.put_watch 🔴 29/38 38/38
watcher.query_watches Missing test Missing test
watcher.start 🟢 1/1 1/1
watcher.stats 🟢 1/1 1/1
watcher.stop 🟢 1/1 1/1
watcher.update_settings 🟠 Missing type Missing type

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

Copy link
Contributor

github-actions bot commented Jan 9, 2025

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

API Status Request Response
ccr.put_auto_follow_pattern Missing test Missing test
watcher.ack_watch 🟢 1/1 1/1
watcher.activate_watch 🟢 1/1 1/1
watcher.deactivate_watch 🟢 1/1 1/1
watcher.delete_watch 🟢 2/2 2/2
watcher.execute_watch 🟢 7/7 7/7
watcher.get_settings 🟠 Missing type Missing type
watcher.get_watch 🟢 9/9 9/9
watcher.put_watch 🔴 29/38 38/38
watcher.query_watches Missing test Missing test
watcher.start 🟢 1/1 1/1
watcher.stats 🟢 1/1 1/1
watcher.stop 🟢 1/1 1/1
watcher.update_settings 🟠 Missing type Missing type

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

@lcawl lcawl merged commit 2da56ac into main Jan 9, 2025
8 checks passed
@lcawl lcawl deleted the watcher-examples branch January 9, 2025 17:37
Copy link
Contributor

github-actions bot commented Jan 9, 2025

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-3489-to-8.x
# Cherry-pick the merged commit of this pull request and resolve the conflicts
git cherry-pick -x --mainline 1 2da56ac7163fff7ea11f8ee5b686858f2e3e883a
# Push it to GitHub
git push --set-upstream origin backport-3489-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-3489-to-8.x.

Copy link
Contributor

github-actions bot commented Jan 9, 2025

The backport to 8.17 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.17 8.17
# Navigate to the new working tree
cd .worktrees/backport-8.17
# Create a new branch
git switch --create backport-3489-to-8.17
# Cherry-pick the merged commit of this pull request and resolve the conflicts
git cherry-pick -x --mainline 1 2da56ac7163fff7ea11f8ee5b686858f2e3e883a
# Push it to GitHub
git push --set-upstream origin backport-3489-to-8.17
# Go back to the original working tree
cd ../..
# Delete the working tree
git worktree remove .worktrees/backport-8.17

Then, create a pull request where the base branch is 8.17 and the compare/head branch is backport-3489-to-8.17.

lcawl added a commit that referenced this pull request Jan 9, 2025
Co-authored-by: István Zoltán Szabó <[email protected]>
(cherry picked from commit 2da56ac)
@lcawl
Copy link
Contributor Author

lcawl commented Jan 9, 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 9, 2025
Co-authored-by: István Zoltán Szabó <[email protected]>
(cherry picked from commit 2da56ac)
@lcawl
Copy link
Contributor Author

lcawl commented Jan 9, 2025

💚 All backports created successfully

Status Branch Result
8.17

Questions ?

Please refer to the Backport tool documentation

lcawl added a commit that referenced this pull request Jan 9, 2025
Co-authored-by: István Zoltán Szabó <[email protected]>
(cherry picked from commit 2da56ac)
lcawl added a commit that referenced this pull request Jan 9, 2025
Co-authored-by: István Zoltán Szabó <[email protected]>
(cherry picked from commit 2da56ac)
lcawl added a commit that referenced this pull request Jan 9, 2025
Co-authored-by: István Zoltán Szabó <[email protected]>
(cherry picked from commit 2da56ac)
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