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

[DOCS] Remove deprecated action variables from rule APIs #161216

Merged
merged 2 commits into from
Jul 6, 2023
Merged

[DOCS] Remove deprecated action variables from rule APIs #161216

merged 2 commits into from
Jul 6, 2023

Conversation

lcawl
Copy link
Contributor

@lcawl lcawl commented Jul 4, 2023 •
edited by kibanamachine
Loading

Summary

Relates to #161126, #160760

This PR replaces alertName with rule.name and params with rule.params in the API examples.

@lcawl lcawl added Feature:Alerting release_note:skip Skip the PR/issue when compiling release notes Team:ResponseOps Label for the ResponseOps team (formerly the Cases and Alerting teams) docs backport:all-open Backport to all branches that could still receive a release labels Jul 4, 2023
@github-actions
Copy link
Contributor

github-actions bot commented Jul 4, 2023

Documentation preview:

@apmmachine
Copy link
Contributor

🤖 GitHub comments

Expand to view the GitHub comments

Just comment with:

  • /oblt-deploy : Deploy a Kibana instance using the Observability test environments.
  • run elasticsearch-ci/docs : Re-trigger the docs validation. (use unformatted text in the comment!)

@lcawl lcawl mentioned this pull request Jul 4, 2023
Closed
@kibana-ci
Copy link
Collaborator

💚 Build Succeeded

Metrics [docs]

Unknown metric groups

ESLint disabled line counts

id before after diff
enterpriseSearch 14 16 +2
securitySolution 410 414 +4
total +6

Total ESLint disabled count

id before after diff
enterpriseSearch 15 17 +2
securitySolution 489 493 +4
total +6

To update your PR or re-run it, just comment with:
@elasticmachine merge upstream

@lcawl lcawl marked this pull request as ready for review July 4, 2023 19:41
@lcawl lcawl requested review from a team as code owners July 4, 2023 19:41
@elasticmachine
Copy link
Contributor

Pinging @elastic/response-ops (Team:ResponseOps)

pmuellr
pmuellr approved these changes Jul 5, 2023
View reviewed changes
Copy link
Member

@pmuellr pmuellr 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 tested the list of "renamed" vars by creating a rule, making it active, and adding an email action with the following body, so I could eyeball if the values were the same. I didn't have a way of testing alert.actionSubgroup (not sure if anyone is even using it anymore!), but everything else looked fine.

old name old value new value
alertId {{alertId}} {{rule.id}}
alertName {{alertName}} {{rule.name}}
spaceId {{spaceId}} {{rule.spaceId}}
tags {{tags}} {{rule.tags}}
params {{params}} {{rule.params}}
alertInstanceId {{alertInstanceId}} {{alert.id}}
alertActionGroup {{alertActionGroup}} {{alert.actionGroup}}
alertActionSubgroup {{alertActionSubgroup}} {{alert.actionSubgroup}}
alertActionGroupName {{alertActionGroupName}} {{alert.actionGroupName}}

szabosteve
szabosteve approved these changes Jul 6, 2023
View reviewed changes
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!

@lcawl lcawl merged commit 8afb9b0 into elastic:main Jul 6, 2023
@lcawl lcawl deleted the legacy-mustache branch July 6, 2023 14:49
@kibanamachine kibanamachine mentioned this pull request Jul 6, 2023
Merged
kibanamachine pushed a commit to kibanamachine/kibana that referenced this pull request Jul 6, 2023
@lcawl
[DOCS] Remove deprecated action variables from rule APIs (elastic#161216
45dc9cc 
)

(cherry picked from commit 8afb9b0)
@kibanamachine
Copy link
Contributor

💔 Some backports could not be created

Status Branch Result
❌ 7.17 Backport failed because of merge conflicts
✅ 8.9

Note: Successful backport PRs will be merged automatically after passing CI.

Manual backport

To create the backport manually run:

node scripts/backport --pr 161216

Questions ?

Please refer to the Backport tool documentation

@lcawl lcawl added the v8.9.0 label Jul 6, 2023
kibanamachine added a commit that referenced this pull request Jul 6, 2023
@kibanamachine @lcawl
[8.9] [DOCS] Remove deprecated action variables from rule APIs (#161216…
2d9104c 
…) (#161364)

# Backport

This will backport the following commits from `main` to `8.9`:
- [[DOCS] Remove deprecated action variables from rule APIs
(#161216)](#161216)

<!--- Backport version: 8.9.7 -->

### Questions ?
Please refer to the [Backport tool
documentation](https://github.com/sqren/backport)

<!--BACKPORT [{"author":{"name":"Lisa
Cawley","email":"[email protected]"},"sourceCommit":{"committedDate":"2023-07-06T14:49:49Z","message":"[DOCS]
Remove deprecated action variables from rule APIs
(#161216)","sha":"8afb9b086cb9a21601f1f0a4a0106aaebedb3b69","branchLabelMapping":{"^v8.10.0$":"main","^v(\\d+).(\\d+).\\d+$":"$1.$2"}},"sourcePullRequest":{"labels":["Feature:Alerting","release_note:skip","Team:ResponseOps","docs","backport:all-open","v8.10.0"],"number":161216,"url":"https://github.com/elastic/kibana/pull/161216","mergeCommit":{"message":"[DOCS]
Remove deprecated action variables from rule APIs
(#161216)","sha":"8afb9b086cb9a21601f1f0a4a0106aaebedb3b69"}},"sourceBranch":"main","suggestedTargetBranches":[],"targetPullRequestStates":[{"branch":"main","label":"v8.10.0","labelRegex":"^v8.10.0$","isSourceBranch":true,"state":"MERGED","url":"https://github.com/elastic/kibana/pull/161216","number":161216,"mergeCommit":{"message":"[DOCS]
Remove deprecated action variables from rule APIs
(#161216)","sha":"8afb9b086cb9a21601f1f0a4a0106aaebedb3b69"}}]}]
BACKPORT-->

Co-authored-by: Lisa Cawley <[email protected]>
@lcawl lcawl mentioned this pull request Jul 6, 2023
Merged
@lcawl
Copy link
Contributor Author

lcawl commented Jul 6, 2023

💚 All backports created successfully

Status Branch Result
✅ 8.8

Note: Successful backport PRs will be merged automatically after passing CI.

Questions ?

Please refer to the Backport tool documentation

lcawl added a commit to lcawl/kibana that referenced this pull request Jul 6, 2023
@lcawl
[DOCS] Remove deprecated action variables from rule APIs (elastic#161216
07c2bb8 
)

(cherry picked from commit 8afb9b0)
mistic pushed a commit that referenced this pull request Jul 7, 2023
@lcawl @kibanamachine
[8.8] [DOCS] Remove deprecated action variables from rule APIs (#161216…
0361f07 
…) (#161378)

# Backport

This will backport the following commits from `main` to `8.8`:
- [[DOCS] Remove deprecated action variables from rule APIs
(#161216)](#161216)

<!--- Backport version: 8.9.7 -->

### Questions ?
Please refer to the [Backport tool
documentation](https://github.com/sqren/backport)

<!--BACKPORT [{"author":{"name":"Lisa
Cawley","email":"[email protected]"},"sourceCommit":{"committedDate":"2023-07-06T14:49:49Z","message":"[DOCS]
Remove deprecated action variables from rule APIs
(#161216)","sha":"8afb9b086cb9a21601f1f0a4a0106aaebedb3b69","branchLabelMapping":{"^v8.10.0$":"main","^v(\\d+).(\\d+).\\d+$":"$1.$2"}},"sourcePullRequest":{"labels":["Feature:Alerting","release_note:skip","Team:ResponseOps","docs","backport:all-open","v8.9.0","v8.10.0"],"number":161216,"url":"https://github.com/elastic/kibana/pull/161216","mergeCommit":{"message":"[DOCS]
Remove deprecated action variables from rule APIs
(#161216)","sha":"8afb9b086cb9a21601f1f0a4a0106aaebedb3b69"}},"sourceBranch":"main","suggestedTargetBranches":[],"targetPullRequestStates":[{"branch":"8.9","label":"v8.9.0","labelRegex":"^v(\\d+).(\\d+).\\d+$","isSourceBranch":false,"url":"https://github.com/elastic/kibana/pull/161364","number":161364,"state":"MERGED","mergeCommit":{"sha":"2d9104caf92fe50363b91d444e6a562235e00cfe","message":"[8.9]
[DOCS] Remove deprecated action variables from rule APIs (#161216)
(#161364)\n\n# Backport\n\nThis will backport the following commits from
`main` to `8.9`:\n- [[DOCS] Remove deprecated action variables from rule
APIs\n(#161216)](https://github.com/elastic/kibana/pull/161216)\n\n<!---
Backport version: 8.9.7 -->\n\n### Questions ?\nPlease refer to the
[Backport
tool\ndocumentation](https://github.com/sqren/backport)\n\n<!--BACKPORT
[{\"author\":{\"name\":\"Lisa\nCawley\",\"email\":\"[email protected]\"},\"sourceCommit\":{\"committedDate\":\"2023-07-06T14:49:49Z\",\"message\":\"[DOCS]\nRemove
deprecated action variables from rule
APIs\n(#161216)\",\"sha\":\"8afb9b086cb9a21601f1f0a4a0106aaebedb3b69\",\"branchLabelMapping\":{\"^v8.10.0$\":\"main\",\"^v(\\\\d+).(\\\\d+).\\\\d+$\":\"$1.$2\"}},\"sourcePullRequest\":{\"labels\":[\"Feature:Alerting\",\"release_note:skip\",\"Team:ResponseOps\",\"docs\",\"backport:all-open\",\"v8.10.0\"],\"number\":161216,\"url\":\"https://github.com/elastic/kibana/pull/161216\",\"mergeCommit\":{\"message\":\"[DOCS]\nRemove
deprecated action variables from rule
APIs\n(#161216)\",\"sha\":\"8afb9b086cb9a21601f1f0a4a0106aaebedb3b69\"}},\"sourceBranch\":\"main\",\"suggestedTargetBranches\":[],\"targetPullRequestStates\":[{\"branch\":\"main\",\"label\":\"v8.10.0\",\"labelRegex\":\"^v8.10.0$\",\"isSourceBranch\":true,\"state\":\"MERGED\",\"url\":\"https://github.com/elastic/kibana/pull/161216\",\"number\":161216,\"mergeCommit\":{\"message\":\"[DOCS]\nRemove
deprecated action variables from rule
APIs\n(#161216)\",\"sha\":\"8afb9b086cb9a21601f1f0a4a0106aaebedb3b69\"}}]}]\nBACKPORT-->\n\nCo-authored-by:
Lisa Cawley
<[email protected]>"}},{"branch":"main","label":"v8.10.0","labelRegex":"^v8.10.0$","isSourceBranch":true,"state":"MERGED","url":"https://github.com/elastic/kibana/pull/161216","number":161216,"mergeCommit":{"message":"[DOCS]
Remove deprecated action variables from rule APIs
(#161216)","sha":"8afb9b086cb9a21601f1f0a4a0106aaebedb3b69"}}]}]
BACKPORT-->

Co-authored-by: Kibana Machine <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@szabosteve szabosteve szabosteve approved these changes

@pmuellr pmuellr pmuellr approved these changes

Assignees
No one assigned
Labels
backport:all-open Backport to all branches that could still receive a release docs Feature:Alerting release_note:skip Skip the PR/issue when compiling release notes Team:ResponseOps Label for the ResponseOps team (formerly the Cases and Alerting teams) v8.8.3 v8.9.0 v8.10.0
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
7 participants
@lcawl @apmmachine @kibana-ci @elasticmachine @kibanamachine @pmuellr @szabosteve