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

[Alerting][Docs] Updates to improve clarity of Alerting API documentation #102746

Open
ymao1 opened this issue Jun 21, 2021 · 1 comment
Open
Labels
docs estimate:small Small Estimated Level of Effort Feature:Alerting/RulesFramework Issues related to the Alerting Rules Framework Feature:Alerting Team:ResponseOps Label for the ResponseOps team (formerly the Cases and Alerting teams)

Comments

@ymao1
Copy link
Contributor

ymao1 commented Jun 21, 2021

Some of our Alerting API documentation can be improved to be clearer:

  • To create a rule through the API, you must specify a rule_type_id, but it is unclear what the possible set of rule_type_ids are. Could update the docs to explicitly list all the possibilities for rule_type_id or add a section to suggest using the List rule types API to determine which ones the user is able to create.
  • Improve documentation around throttle value:
    • Clarify what types of strings the throttle value accepts.
    • Clarify what the various options in throttle do
@botelastic botelastic bot added the needs-team Issues missing a team label label Jun 21, 2021
@azasypkin azasypkin added the Team:ResponseOps Label for the ResponseOps team (formerly the Cases and Alerting teams) label Jun 21, 2021
@elasticmachine
Copy link
Contributor

Pinging @elastic/kibana-alerting-services (Team:Alerting Services)

@botelastic botelastic bot removed the needs-team Issues missing a team label label Jun 21, 2021
@gmmorris gmmorris added the Feature:Alerting/RulesFramework Issues related to the Alerting Rules Framework label Jul 1, 2021
@gmmorris gmmorris added the loe:medium Medium Level of Effort label Jul 14, 2021
@mikecote mikecote added this to Backlog in Kibana Alerting Jul 28, 2021
@gmmorris gmmorris added the estimate:small Small Estimated Level of Effort label Aug 18, 2021
@gmmorris gmmorris removed the loe:medium Medium Level of Effort label Sep 2, 2021
@XavierM XavierM removed this from Backlog in Kibana Alerting Jan 6, 2022
@kobelb kobelb added the needs-team Issues missing a team label label Jan 31, 2022
@botelastic botelastic bot removed the needs-team Issues missing a team label label Jan 31, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
docs estimate:small Small Estimated Level of Effort Feature:Alerting/RulesFramework Issues related to the Alerting Rules Framework Feature:Alerting Team:ResponseOps Label for the ResponseOps team (formerly the Cases and Alerting teams)
Projects
No open projects
Development

No branches or pull requests

5 participants