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

[ResponseOps][Rules] Create a rule's parameters package. #195183

Closed
3 tasks done
cnasikas opened this issue Oct 7, 2024 · 1 comment · Fixed by #196971
Closed
3 tasks done

[ResponseOps][Rules] Create a rule's parameters package. #195183

cnasikas opened this issue Oct 7, 2024 · 1 comment · Fixed by #196971
Assignees
@cnasikas
Labels
Feature:Alerting/RulesFramework Issues related to the Alerting Rules Framework Team:ResponseOps Label for the ResponseOps team (formerly the Cases and Alerting teams)

Comments

@cnasikas
Copy link
Member

cnasikas commented Oct 7, 2024 •
edited
Loading

Each rule has its own parameters. To be able to document (OAS) each rule's parameters, we need to move the schema definition of the parameter of each rule to a package where the alerting plugin will import.

DoD
Preview Give feedback
@cnasikas cnasikas added Feature:Alerting/RulesFramework Issues related to the Alerting Rules Framework Team:ResponseOps Label for the ResponseOps team (formerly the Cases and Alerting teams) labels Oct 7, 2024
@elasticmachine
Copy link
Contributor

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

This was referenced Oct 7, 2024
Closed
Closed
Open
Closed
Open
Open
Open
@cnasikas cnasikas changed the title [Rules] Create a rule's parameters package. [ResponseOps][Rules] Create a rule's parameters package. Oct 7, 2024
@cnasikas cnasikas self-assigned this Oct 19, 2024
@cnasikas cnasikas mentioned this issue Oct 19, 2024
Merged
2 tasks
kibanamachine pushed a commit to kibanamachine/kibana that referenced this issue Oct 23, 2024
@cnasikas
[ResponseOps][Rules] Create the rule params package (elastic#196971)
a6c470a 
## Summary

This PR creates a package containing the schema of the params of all
rule types. It starts as `schema.recordOf(schema.string(),
schema.maybe(schema.any()))` which is the current one. In subsequent
PRs, the schema will be updated to `schema.oneOf([apmRuleType,
esQueryRuleType, ....])`. I also substituted the definition of `params`
in the alerting plugin with the `params` exported from the package.

Towards: elastic#187356
Fixes: elastic#195183

### For maintainers

- [x] This was checked for breaking API changes and was [labeled
appropriately](https://www.elastic.co/guide/en/kibana/master/contributing.html#_add_your_labels)
- [ ] This will appear in the **Release Notes** and follow the
[guidelines](https://www.elastic.co/guide/en/kibana/master/contributing.html#kibana-release-notes-process)

---------

Co-authored-by: kibanamachine <[email protected]>
(cherry picked from commit a7a81c2)
@cnasikas cnasikas mentioned this issue Oct 24, 2024
Open
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@cnasikas cnasikas

Labels
Feature:Alerting/RulesFramework Issues related to the Alerting Rules Framework Team:ResponseOps Label for the ResponseOps team (formerly the Cases and Alerting teams)
Projects
None yet
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

[ResponseOps][Rules] Create the rule params package cnasikas/kibana
2 participants
@cnasikas @elasticmachine