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

[ResponseOps][Rules] Create the rule params package #196971

Open
wants to merge 6 commits into
base: main
Choose a base branch
from

Conversation

cnasikas
Copy link
Member

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: #187356
Fixes: #195183

For maintainers

@cnasikas cnasikas added Team:ResponseOps Label for the ResponseOps team (formerly the Cases and Alerting teams) v9.0.0 Feature:Alerting/RulesFramework Issues related to the Alerting Rules Framework backport:prev-minor Backport to (8.x) the previous minor version (i.e. one version back from main) v8.17.0 labels Oct 19, 2024
@cnasikas cnasikas self-assigned this Oct 19, 2024
@cnasikas cnasikas requested a review from a team as a code owner October 19, 2024 08:43
@elasticmachine
Copy link
Contributor

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

@cnasikas cnasikas added the release_note:skip Skip the PR/issue when compiling release notes label Oct 19, 2024
…t --include-path /api/status --include-path /api/alerting/rule/ --include-path /api/alerting/rules --include-path /api/actions --include-path /api/security/role --include-path /api/spaces --include-path /api/fleet --update'
@elasticmachine
Copy link
Contributor

elasticmachine commented Oct 19, 2024

💔 Build Failed

Failed CI Steps

Metrics [docs]

Public APIs missing comments

Total count of every public API that lacks a comment. Target amount is 0. Run node scripts/build_api_docs --plugin [yourplugin] --stats comments for more detailed information.

id before after diff
@kbn/response-ops-rule-params - 1 +1
Unknown metric groups

API count

id before after diff
@kbn/response-ops-rule-params - 1 +1

History

cc @cnasikas

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
backport:prev-minor Backport to (8.x) the previous minor version (i.e. one version back from main) Feature:Alerting/RulesFramework Issues related to the Alerting Rules Framework 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.17.0 v9.0.0
Projects
None yet
Development

Successfully merging this pull request may close these issues.

[ResponseOps][Rules] Create a rule's parameters package.
3 participants