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

[DOCS] Add behavioral analytics and search application examples #3392

Merged
merged 10 commits into from
Jan 3, 2025

Conversation

lcawl
Copy link
Contributor

@lcawl lcawl commented Dec 30, 2024

Relates to #2482

This PR updates the search application API docs based on information from https://www.elastic.co/guide/en/elasticsearch/reference/master/search-application-apis.html

  • Edits an operation summary
  • Adds cluster and index privilege details
  • Adds examples

It also adds an example from https://www.elastic.co/guide/en/elasticsearch/reference/master/list-analytics-collection.html

@lcawl lcawl requested a review from a team as a code owner December 31, 2024 03:17
Copy link
Contributor

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

API Status Request Response
search_application.delete 🟢 7/7 7/7
search_application.get 🔴 10/10 6/10
search_application.list 🔴 7/7 2/7
search_application.put 🔴 3/10 10/10

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

Copy link
Contributor

github-actions bot commented Jan 3, 2025

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

API Status Request Response
search_application.delete 🟢 7/7 7/7
search_application.get 🔴 10/10 6/10
search_application.list 🔴 7/7 2/7
search_application.put 🔴 3/10 10/10

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

Copy link
Contributor

github-actions bot commented Jan 3, 2025

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

API Status Request Response
search_application.delete 🟢 7/7 7/7
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.put 🔴 3/10 10/10
search_application.search 🟢 16/16 16/16

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

@lcawl lcawl changed the title [DOCS] Edit search application summaries and privileges [DOCS] Add search application examples and privileges Jan 3, 2025
@lcawl lcawl mentioned this pull request Jan 3, 2025
63 tasks
@lcawl lcawl changed the title [DOCS] Add search application examples and privileges [DOCS] Add behavioral analytics and search application examples Jan 3, 2025
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.

Added some response codes, please take or leave them. Otherwise, LGTM!

lcawl and others added 3 commits January 3, 2025 07:43
…nseExample1.yaml

Co-authored-by: István Zoltán Szabó <szabosteve@gmail.com>
…vioralAnalyticsGetResponseExample1.yaml

Co-authored-by: István Zoltán Szabó <szabosteve@gmail.com>
…sponseExample1.yaml

Co-authored-by: István Zoltán Szabó <szabosteve@gmail.com>
Copy link
Contributor

github-actions bot commented Jan 3, 2025

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

API Status Request Response
search_application.delete 🟢 7/7 7/7
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.put 🔴 3/10 10/10
search_application.search 🟢 16/16 16/16

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

2 similar comments
Copy link
Contributor

github-actions bot commented Jan 3, 2025

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

API Status Request Response
search_application.delete 🟢 7/7 7/7
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.put 🔴 3/10 10/10
search_application.search 🟢 16/16 16/16

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

Copy link
Contributor

github-actions bot commented Jan 3, 2025

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

API Status Request Response
search_application.delete 🟢 7/7 7/7
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.put 🔴 3/10 10/10
search_application.search 🟢 16/16 16/16

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

Copy link
Contributor

github-actions bot commented Jan 3, 2025

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

API Status Request Response
search_application.delete 🟢 7/7 7/7
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.put 🔴 3/10 10/10
search_application.search 🟢 16/16 16/16

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

@lcawl lcawl merged commit a83a6ed into main Jan 3, 2025
9 checks passed
@lcawl lcawl deleted the search-application branch January 3, 2025 16:12
Copy link
Contributor

github-actions bot commented Jan 3, 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-3392-to-8.x
# Cherry-pick the merged commit of this pull request and resolve the conflicts
git cherry-pick -x --mainline 1 a83a6ed7a5fdc47c9426f3d4aa47ef77fa2f9e9a
# Push it to GitHub
git push --set-upstream origin backport-3392-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-3392-to-8.x.

Copy link
Contributor

github-actions bot commented Jan 3, 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-3392-to-8.17
# Cherry-pick the merged commit of this pull request and resolve the conflicts
git cherry-pick -x --mainline 1 a83a6ed7a5fdc47c9426f3d4aa47ef77fa2f9e9a
# Push it to GitHub
git push --set-upstream origin backport-3392-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-3392-to-8.17.

lcawl added a commit that referenced this pull request Jan 3, 2025
Co-authored-by: István Zoltán Szabó <szabosteve@gmail.com>
(cherry picked from commit a83a6ed)
@lcawl
Copy link
Contributor Author

lcawl commented Jan 3, 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 3, 2025
… (#3426)

Co-authored-by: István Zoltán Szabó <szabosteve@gmail.com>
(cherry picked from commit a83a6ed)
lcawl added a commit that referenced this pull request Jan 3, 2025
Co-authored-by: István Zoltán Szabó <szabosteve@gmail.com>
(cherry picked from commit a83a6ed)
@lcawl
Copy link
Contributor Author

lcawl commented Jan 3, 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 4, 2025
… (#3427)

Co-authored-by: István Zoltán Szabó <szabosteve@gmail.com>
(cherry picked from commit a83a6ed)
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