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][Response Ops] Update create/update rule docs to reflect latest notify_when options #174395

Closed
ymao1 opened this issue Jan 5, 2024 · 4 comments
Assignees
Labels
docs Feature:Alerting Team:ResponseOps Label for the ResponseOps team (formerly the Cases and Alerting teams)

Comments

@ymao1
Copy link
Contributor

ymao1 commented Jan 5, 2024

As of this PR #144130 in 8.7, the top level notify_when field is now optional during rule create/update, not required as indicated in the docs: https://www.elastic.co/guide/en/kibana/current/create-rule-api.html, https://www.elastic.co/guide/en/kibana/current/update-rule-api.html. In addition, that PR added an action level frequency field with summary and notify_when entries that should be populated on rule create/update. We need to update the docs to reflect these updates.

@ymao1 ymao1 added Feature:Alerting Team:ResponseOps Label for the ResponseOps team (formerly the Cases and Alerting teams) docs labels Jan 5, 2024
@elasticmachine
Copy link
Contributor

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

@lcawl
Copy link
Contributor

lcawl commented Jan 6, 2024

In general we're not updating those manually-maintained API pages anymore, which is why there's a link to the open API specification as the source of truth. As soon as we start publishing directly from the specifications, we'll be retiring these old pages. I'll double-check that the OAS is accurate.

@lcawl lcawl self-assigned this Jan 6, 2024
@lcawl
Copy link
Contributor

lcawl commented Jan 6, 2024

@cnasikas
Copy link
Member

cnasikas commented Sep 6, 2024

I am closing this issue as the docs contain the latest API updates.

@cnasikas cnasikas closed this as completed Sep 6, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
docs Feature:Alerting Team:ResponseOps Label for the ResponseOps team (formerly the Cases and Alerting teams)
Projects
None yet
Development

No branches or pull requests

4 participants