[Response Ops][Rules] Version Get Rule Types API #195361

jcger · 2024-10-08T08:51:21Z

Summary

GET /api/alerting/rule_types item in #195181

…ion-route-rule-types

jcger · 2024-10-08T13:26:37Z

x-pack/plugins/alerting/common/routes/rule/apis/list_types/schemas/v1.ts

+    default_action_group_id: schema.string(),
+    does_set_recovery_context: schema.maybe(schema.boolean()),
+    enabled_in_license: schema.boolean(),
+    fields_for_a_a_d: schema.maybe(schema.arrayOf(schema.string())),


I noticed that in main the field is returned as fieldsForAAD. I guess that would be a breaking change, should I leave it with snake_case or change it to work as in main?

Unfortunately, it would be considered a breaking change so we would need to return fieldsForAAD.

jcger · 2024-10-08T13:27:56Z

...s/alerting/server/routes/rule/apis/list_types/transforms/transform_rule_types_response/v1.ts

+import { TypesRulesResponseBodyV1 } from '../../../../../../../common/routes/rule/apis/list_types';
+
+export const transformRuleTypesResponse = (
+  ruleTypes: Set<RegistryAlertTypeWithAuth>


I talked with @JiaweiWu about RegistryAlertTypeWithAuth Ideally it would be moved to be an application type but it's a complete mess. As long as it's not been used anywhere else, we should be fine. Wdyt?

I agree that it should be an application type and the rule client returns a more suitable structure. I would say it is out of the scope of this PR.

jcger · 2024-10-08T14:19:33Z

...s/alerting/server/routes/rule/apis/list_types/transforms/transform_rule_types_response/v1.ts

+    return {
+      ...(ruleType.actionGroups ? { action_groups: ruleType.actionGroups } : {}),
+      ...(ruleType.actionVariables ? { action_variables: ruleType.actionVariables } : {}),
+      ...(ruleType.alerts ? { alerts: ruleType.alerts } : {}),


This one throws an error: Property 'alerts' does not exist on type 'RegistryAlertTypeWithAuth'. I'll add it to the type (see x-pack/plugins/alerting/server/rule_type_registry.ts changes), just let me know if you have more info/know a better option

elasticmachine · 2024-10-09T07:34:09Z

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

jcger · 2024-10-09T15:09:03Z

/ci

cnasikas

LGTM! It amazes me that this is a public API that returns all this stuff. Maybe we should document only the important ones.

cnasikas · 2024-10-09T15:55:31Z

...s/alerting/server/routes/rule/apis/list_types/transforms/transform_rule_types_response/v1.ts

+      name: ruleType.name,
+      producer: ruleType.producer,
+      recovery_action_group: ruleType.recoveryActionGroup,
+      rule_task_timeout: ruleType.ruleTaskTimeout,


super nit: It seems that ruleTaskTimeout and defaultScheduleInterval can be undefined. Should we follow the same patter as above (...(ruleType.alerts ? { alerts: ruleType.alerts } : {}),)?

cnasikas · 2024-10-09T16:07:17Z

x-pack/plugins/alerting/common/routes/rule/apis/list_types/schemas/v1.ts

+  name: schema.string(),
+});
+
+export const typesRulesResponseBodySchema = schema.arrayOf(


I think the schema is missing default_schedule_interval.

…356-version-route-rule-types' of github.com:jcger/kibana into issue-187356-version-route-rule-types

cnasikas · 2024-10-12T10:32:47Z

x-pack/plugins/alerting/common/routes/rule/apis/list_types/schemas/v1.ts

+    does_set_recovery_context: schema.maybe(schema.boolean()),
+    enabled_in_license: schema.boolean(),
+    // eslint-disable-next-line @typescript-eslint/naming-convention
+    fields_for_AAD: schema.maybe(schema.arrayOf(schema.string())), // we cannot introduce breaking changes yet


Shouldn't this be fieldsForAAD?

thank you so much for catching this one 😱

…ger/kibana into issue-187356-version-route-rule-types

…ion-route-rule-types

kibanamachine · 2024-10-14T15:46:34Z

Starting backport for target branches: 8.x

https://github.com/elastic/kibana/actions/runs/11330902192

elasticmachine · 2024-10-14T15:47:13Z

💚 Build Succeeded

Buildkite Build
Commit: 887d716

Metrics [docs]

✅ unchanged

History

💚 Build #242099 succeeded 693bdc6
💔 Build #241666 failed f74aaa1
💚 Build #241069 succeeded a5e86bb
💔 Build #240768 failed 11a2387
💔 Build #240676 failed 11a2387
💔 Build #240660 failed 11a2387

## Summary `GET /api/alerting/rule_types` item in elastic#195181 (cherry picked from commit 512a31d)

kibanamachine · 2024-10-14T15:51:05Z

💚 All backports created successfully

Status	Branch	Result
✅	8.x

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

Questions ?

Please refer to the Backport tool documentation

…6175) # Backport This will backport the following commits from `main` to `8.x`: - [[Response Ops][Rules] Version Get Rule Types API (#195361)](#195361)  ### Questions ? Please refer to the [Backport tool documentation](https://github.com/sqren/backport)  Co-authored-by: Julian Gernun <17549662+jcger@users.noreply.github.com>

jcger added 5 commits September 24, 2024 12:27

move route file to apis folder

f84c695

Merge branch 'main' of github.com:jcger/kibana into issue-187356-vers…

dc89661

…ion-route-rule-types

first commit

361c464

fix types

31ca0e0

file renaming + type from schema convertion

e30a305

jcger force-pushed the issue-187356-version-route-rule-types branch from 337b487 to e30a305 Compare October 8, 2024 13:25

jcger commented Oct 8, 2024

View reviewed changes

jcger mentioned this pull request Oct 8, 2024

[ResponseOps][Rules] Version the rest of rule's public APIs #195181

Closed

jcger added 3 commits October 8, 2024 15:49

add type import

fcd0187

taking care of optionals when transforming

e315cd5

check if its boolean instead of undefined

e9203bf

jcger commented Oct 8, 2024

View reviewed changes

jcger added release_note:skip Skip the PR/issue when compiling release notes Team:ResponseOps Label for the ResponseOps team (formerly the Cases and Alerting teams) v9.0.0 backport:prev-minor Backport to (8.x) the previous minor version (i.e. one version back from main) labels Oct 9, 2024

jcger marked this pull request as ready for review October 9, 2024 07:34

jcger requested a review from a team as a code owner October 9, 2024 07:34

Merge branch 'main' into issue-187356-version-route-rule-types

11a2387

jcger added v8.16.0 backport:prev-minor Backport to (8.x) the previous minor version (i.e. one version back from main) and removed backport:prev-minor Backport to (8.x) the previous minor version (i.e. one version back from main) labels Oct 9, 2024

cnasikas self-requested a review October 9, 2024 14:47

cnasikas reviewed Oct 9, 2024

View reviewed changes

cnasikas approved these changes Oct 9, 2024

View reviewed changes

jcger added 2 commits October 10, 2024 12:18

Merge branch 'main' into issue-187356-version-route-rule-types

a5e86bb

add missing schema params and better response cleanup

314a88e

Merge branches 'issue-187356-version-route-rule-types' and 'issue-187…

f74aaa1

…356-version-route-rule-types' of github.com:jcger/kibana into issue-187356-version-route-rule-types

cnasikas reviewed Oct 12, 2024

View reviewed changes

jcger added 4 commits October 14, 2024 12:53

fix schema field name

0078888

Merge branch 'main' into issue-187356-version-route-rule-types

ca3004b

fix test

98f5dfb

Merge branch 'issue-187356-version-route-rule-types' of github.com:jc…

693bdc6

…ger/kibana into issue-187356-version-route-rule-types

jcger enabled auto-merge (squash) October 14, 2024 12:04

Merge branch 'main' of github.com:jcger/kibana into issue-187356-vers…

887d716

…ion-route-rule-types

jcger merged commit 512a31d into elastic:main Oct 14, 2024
42 of 43 checks passed

kibanamachine pushed a commit to kibanamachine/kibana that referenced this pull request Oct 14, 2024

[Response Ops][Rules] Version Get Rule Types API (elastic#195361)

d7f4942

## Summary `GET /api/alerting/rule_types` item in elastic#195181 (cherry picked from commit 512a31d)

kibanamachine mentioned this pull request Oct 14, 2024

[8.x] [Response Ops][Rules] Version Get Rule Types API (#195361) #196175

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[Response Ops][Rules] Version Get Rule Types API #195361

[Response Ops][Rules] Version Get Rule Types API #195361

jcger commented Oct 8, 2024 •

edited by kibanamachine

Loading

jcger Oct 8, 2024

cnasikas Oct 9, 2024

jcger Oct 8, 2024

cnasikas Oct 9, 2024

jcger Oct 8, 2024

elasticmachine commented Oct 9, 2024

jcger commented Oct 9, 2024

cnasikas left a comment •

edited

Loading

cnasikas Oct 9, 2024

cnasikas Oct 9, 2024

cnasikas Oct 12, 2024

jcger Oct 14, 2024

kibanamachine commented Oct 14, 2024

elasticmachine commented Oct 14, 2024

kibanamachine commented Oct 14, 2024

[Response Ops][Rules] Version Get Rule Types API #195361

[Response Ops][Rules] Version Get Rule Types API #195361

Conversation

jcger commented Oct 8, 2024 • edited by kibanamachine Loading

Summary

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

elasticmachine commented Oct 9, 2024

jcger commented Oct 9, 2024

cnasikas left a comment • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

kibanamachine commented Oct 14, 2024

elasticmachine commented Oct 14, 2024

💚 Build Succeeded

Metrics [docs]

History

kibanamachine commented Oct 14, 2024

💚 All backports created successfully

Questions ?

jcger commented Oct 8, 2024 •

edited by kibanamachine

Loading

cnasikas left a comment •

edited

Loading