Skip to content

New artifacts schema in the rule creation/update/find #216292

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

Merged
mgiota merged 103 commits into from
Apr 22, 2025
Merged

New artifacts schema in the rule creation/update/find #216292

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
103 commits
Select commit Hold shift + click to select a range
14d7073
new artifact schema, create rule updates
mgiota Mar 28, 2025
b01099c
more updates to create rule schema
mgiota Mar 28, 2025
c2db5d8
save artifacts as references in the rule SO during rule creation
mgiota Mar 30, 2025
387d72c
remove artifacts from create rule response (transformRuleToRuleResponse)
mgiota Mar 31, 2025
186d1d6
remove investigation_guide for now. it will be added later on as v6 i…
mgiota Mar 31, 2025
a3708dd
type refactoring
mgiota Mar 31, 2025
c1ab616
move denormalize_artifacts into a new file
mgiota Mar 31, 2025
21f13f1
fix failing create_rule tests
mgiota Mar 31, 2025
201a15b
add integration tests for creating a rule with dashboard artifacts
mgiota Apr 1, 2025
b9542c0
return artifacts on the internal find api (TODO: handle transforming …
mgiota Apr 1, 2025
e30f641
inject references into artifacts in the find rule api
mgiota Apr 1, 2025
d84c366
changes to the update schema
mgiota Apr 1, 2025
6f6fc54
update artifact references on rule update
mgiota Apr 1, 2025
efee3ed
Merge branch 'main' into artifacts_dashboard_schema
elasticmachine Apr 2, 2025
5328a03
[CI] Auto-commit changed files from 'node scripts/capture_oas_snapsho…
kibanamachine Apr 2, 2025
255c194
[CI] Auto-commit changed files from 'make api-docs'
kibanamachine Apr 2, 2025
9860710
[CI] Auto-commit changed files from 'node scripts/jest_integration -u…
kibanamachine Apr 2, 2025
236795d
fix bulk edit
mgiota Apr 2, 2025
31e64f1
fix transform rule domain to attributes tests
mgiota Apr 2, 2025
523fb3c
fix update rule failing tests by passing a default artifacts value
mgiota Apr 2, 2025
ce1b74a
Merge branch 'main' into artifacts_dashboard_schema
elasticmachine Apr 3, 2025
5cefd1c
fix model version
mgiota Apr 3, 2025
d39cfce
remove leftover comment
mgiota Apr 3, 2025
0be0f57
update_rule unit tests
mgiota Apr 7, 2025
98ff4ad
fix failing find rule unit tests
mgiota Apr 8, 2025
de37d9c
add find rule tests testing artifacts
mgiota Apr 8, 2025
72681f2
Fix Synthetics deployment agnostic test.
justinkambic Apr 9, 2025
62376f8
Fix types.
justinkambic Apr 7, 2025
4c315dc
Fix more tests.
justinkambic Apr 8, 2025
1aa2778
Merge remote-tracking branch 'upstream/main' into artifacts_dashboard…
justinkambic Apr 9, 2025
c67b4eb
Fix more `find_interna` tests.
justinkambic Apr 9, 2025
6318e5b
Fix most unit tests.
justinkambic Apr 2, 2025
06aae53
Still trying to fix internal find test that is broken despite passing…
justinkambic Apr 9, 2025
2439428
Temp debug logging for CI visibility.
justinkambic Apr 9, 2025
e993299
Fix unit tests.
justinkambic Apr 9, 2025
71bc4e6
Temporarily allow console.log for debug purposes.
justinkambic Apr 9, 2025
894deec
Add tests for `denormalizeArtifacts`.
justinkambic Apr 8, 2025
eb747f8
Add unit tests for `injectReferencesIntoArtifacts`.
justinkambic Apr 8, 2025
386f11d
Fix issue from downstream port.
justinkambic Apr 9, 2025
f815d8d
Remove console.log call.
justinkambic Apr 9, 2025
4837d1d
Merge remote-tracking branch 'upstream/main' into artifacts_dashboard…
justinkambic Apr 10, 2025
a85b1d4
remove refId and investigation_guide(for now)
mgiota Apr 10, 2025
7264aa8
remove investigation_guide reference in the test
mgiota Apr 10, 2025
bc647f3
unit tests for extract references
mgiota Apr 10, 2025
9fb63b0
fix find internal api failing tests
mgiota Apr 10, 2025
97d87ca
[CI] Auto-commit changed files from 'node scripts/eslint --no-cache -…
kibanamachine Apr 10, 2025
929defd
add integration tests for update rule
mgiota Apr 10, 2025
0173e0b
Merge branch 'main' into artifacts_dashboard_schema
elasticmachine Apr 10, 2025
d47828d
add integration tests for artifacts for the pubic find api
mgiota Apr 10, 2025
ad2216c
Merge branch 'main' into artifacts_dashboard_schema
elasticmachine Apr 10, 2025
0c9e072
proper clean up of rules to fix failing rule tags tests
mgiota Apr 10, 2025
3c8120c
Merge branch 'main' into artifacts_dashboard_schema
elasticmachine Apr 11, 2025
f0bc840
Merge branch 'main' into artifacts_dashboard_schema
elasticmachine Apr 14, 2025
5b055ed
use plural for dashboards and artifacts schema
mgiota Apr 14, 2025
e442794
use plural for the Artifact
mgiota Apr 14, 2025
21506d2
[CI] Auto-commit changed files from 'node scripts/eslint --no-cache -…
kibanamachine Apr 14, 2025
db1736a
more fixes
mgiota Apr 14, 2025
d3126da
Update x-pack/platform/plugins/shared/alerting/server/rules_client/co…
mgiota Apr 14, 2025
b92bab3
[CI] Auto-commit changed files from 'node scripts/eslint --no-cache -…
kibanamachine Apr 14, 2025
70c229e
address PR feedback
mgiota Apr 15, 2025
6254e0f
bulk edit changes
mgiota Apr 15, 2025
53fe032
more updates
mgiota Apr 15, 2025
a97d0bd
add artifacts as optional to the response type
mgiota Apr 15, 2025
140b953
update update_rule tests
mgiota Apr 15, 2025
69bbc53
add more tests to the update_rule method (link new dashboard)
mgiota Apr 15, 2025
7a78806
Increase limit of inspector bundle size.
justinkambic Apr 15, 2025
2d8d518
Merge branch 'artifacts_dashboard_schema' of github.com:mgiota/kibana…
justinkambic Apr 15, 2025
ebc392f
Merge branch 'main' into artifacts_dashboard_schema
elasticmachine Apr 15, 2025
d776aa0
make artifacts optional
mgiota Apr 16, 2025
6e24df3
type return value of injectReferencesIntoArtifacts
mgiota Apr 16, 2025
1e191c4
add more tests to transform_rule_attributes_to_rule_domain
mgiota Apr 16, 2025
e606da3
fix type issues
mgiota Apr 16, 2025
68cb0f0
Merge branch 'main' into artifacts_dashboard_schema
elasticmachine Apr 16, 2025
674db1a
return fake artifact along with dashboards
mgiota Apr 16, 2025
0926084
remove the call to the dashboard api
mgiota Apr 16, 2025
ec63b16
Add new `transformRawArtifactsToDomainArtifacts` function.
justinkambic Apr 16, 2025
92486e8
Add tests for `transformRawArtifactsToDomainArtifacts`.
justinkambic Apr 16, 2025
3764712
Merge branch 'artifacts_dashboard_schema' of github.com:mgiota/kibana…
justinkambic Apr 16, 2025
e625e73
Make `artifacts` a required parameter of `extractReferences`.
justinkambic Apr 16, 2025
43e0918
Add additional coverage to update artifacts test.
justinkambic Apr 16, 2025
c4efff7
rename isInternal to includeArtifacts
mgiota Apr 16, 2025
5a57446
Merge branch 'main' into artifacts_dashboard_schema
elasticmachine Apr 16, 2025
67f8302
update_rule tests updates
mgiota Apr 17, 2025
4e240fd
find_rules_route unit tests
mgiota Apr 17, 2025
e3f236a
find_internal_rules_route unit tests
mgiota Apr 17, 2025
75d463c
test that artifacts are mapped correctly
mgiota Apr 17, 2025
061777a
Merge branch 'main' into artifacts_dashboard_schema
elasticmachine Apr 17, 2025
51ebefc
import schema from artifacts_schema
mgiota Apr 17, 2025
c5ba626
Fix tests, change return value to always include dashboards array.
justinkambic Apr 18, 2025
8830c5e
Merge branch 'artifacts_dashboard_schema' of github.com:mgiota/kibana…
justinkambic Apr 18, 2025
6e5ca07
Change a word.
justinkambic Apr 18, 2025
7058cc8
Use lodash `uniqBy` to deduplicate reference list.
justinkambic Apr 18, 2025
86e52c1
Update test snapshot where there are duplicate SO ref IDs.
justinkambic Apr 18, 2025
3f8cd80
Revert "Update test snapshot where there are duplicate SO ref IDs."
justinkambic Apr 18, 2025
dba5032
Revert "Use lodash `uniqBy` to deduplicate reference list."
justinkambic Apr 18, 2025
9aede2f
Merge branch 'main' into artifacts_dashboard_schema
elasticmachine Apr 22, 2025
e57875e
move injectReferencesIntoArtifacts after hasLegacyActions
mgiota Apr 22, 2025
feeb68c
Merge branch 'main' into artifacts_dashboard_schema
elasticmachine Apr 22, 2025
9b44f70
make artifacts required
mgiota Apr 22, 2025
f3ec10b
fix lint error
mgiota Apr 22, 2025
a84329b
Merge branch 'main' into artifacts_dashboard_schema
elasticmachine Apr 22, 2025
b159a0b
do not mock denormalizeArtifacts
mgiota Apr 22, 2025
678a3df
Merge branch 'main' into artifacts_dashboard_schema
elasticmachine Apr 22, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
126 changes: 126 additions & 0 deletions oas_docs/bundle.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1094,6 +1094,27 @@
"nullable": true,
"type": "string"
},
"artifacts": {
"additionalProperties": false,
Comment thread
mgiota marked this conversation as resolved.
"properties": {
"dashboards": {
"items": {
"additionalProperties": false,
"properties": {
"id": {
"type": "string"
}
},
"required": [
"id"
],
"type": "object"
},
"type": "array"
}
},
"type": "object"
},
"consumer": {
"description": "The name of the application or feature that owns the rule. For example: `alerts`, `apm`, `discover`, `infrastructure`, `logs`, `metrics`, `ml`, `monitoring`, `securitySolution`, `siem`, `stackAlerts`, or `uptime`.",
"type": "string"
Expand Down Expand Up @@ -2173,6 +2194,27 @@
],
"type": "object"
},
"artifacts": {
"additionalProperties": false,
"properties": {
"dashboards": {
"items": {
"additionalProperties": false,
"properties": {
"id": {
"type": "string"
}
},
"required": [
"id"
],
"type": "object"
},
"type": "array"
}
},
"type": "object"
},
"consumer": {
"description": "The name of the application or feature that owns the rule. For example: `alerts`, `apm`, `discover`, `infrastructure`, `logs`, `metrics`, `ml`, `monitoring`, `securitySolution`, `siem`, `stackAlerts`, or `uptime`.",
"type": "string"
Expand Down Expand Up @@ -2820,6 +2862,27 @@
"nullable": true,
"type": "string"
},
"artifacts": {
"additionalProperties": false,
"properties": {
"dashboards": {
"items": {
"additionalProperties": false,
"properties": {
"id": {
"type": "string"
}
},
"required": [
"id"
],
"type": "object"
},
"type": "array"
}
},
"type": "object"
},
"consumer": {
"description": "The name of the application or feature that owns the rule. For example: `alerts`, `apm`, `discover`, `infrastructure`, `logs`, `metrics`, `ml`, `monitoring`, `securitySolution`, `siem`, `stackAlerts`, or `uptime`.",
"type": "string"
Expand Down Expand Up @@ -3742,6 +3805,27 @@
],
"type": "object"
},
"artifacts": {
"additionalProperties": false,
"properties": {
"dashboards": {
"items": {
"additionalProperties": false,
"properties": {
"id": {
"type": "string"
}
},
"required": [
"id"
],
"type": "object"
},
"type": "array"
}
},
"type": "object"
},
"flapping": {
"additionalProperties": false,
"description": "When flapping detection is turned on, alerts that switch quickly between active and recovered states are identified as “flapping” and notifications are reduced.",
Expand Down Expand Up @@ -4120,6 +4204,27 @@
"nullable": true,
"type": "string"
},
"artifacts": {
"additionalProperties": false,
"properties": {
"dashboards": {
"items": {
"additionalProperties": false,
"properties": {
"id": {
"type": "string"
}
},
"required": [
"id"
],
"type": "object"
},
"type": "array"
}
},
"type": "object"
},
"consumer": {
"description": "The name of the application or feature that owns the rule. For example: `alerts`, `apm`, `discover`, `infrastructure`, `logs`, `metrics`, `ml`, `monitoring`, `securitySolution`, `siem`, `stackAlerts`, or `uptime`.",
"type": "string"
Expand Down Expand Up @@ -6036,6 +6141,27 @@
"nullable": true,
"type": "string"
},
"artifacts": {
"additionalProperties": false,
"properties": {
"dashboards": {
"items": {
"additionalProperties": false,
"properties": {
"id": {
"type": "string"
}
},
"required": [
"id"
],
"type": "object"
},
"type": "array"
}
},
"type": "object"
},
"consumer": {
"description": "The name of the application or feature that owns the rule. For example: `alerts`, `apm`, `discover`, `infrastructure`, `logs`, `metrics`, `ml`, `monitoring`, `securitySolution`, `siem`, `stackAlerts`, or `uptime`.",
"type": "string"
Expand Down
126 changes: 126 additions & 0 deletions oas_docs/bundle.serverless.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1094,6 +1094,27 @@
"nullable": true,
"type": "string"
},
"artifacts": {
"additionalProperties": false,
"properties": {
"dashboards": {
"items": {
"additionalProperties": false,
"properties": {
"id": {
"type": "string"
}
},
"required": [
"id"
],
"type": "object"
},
"type": "array"
}
},
"type": "object"
},
"consumer": {
"description": "The name of the application or feature that owns the rule. For example: `alerts`, `apm`, `discover`, `infrastructure`, `logs`, `metrics`, `ml`, `monitoring`, `securitySolution`, `siem`, `stackAlerts`, or `uptime`.",
"type": "string"
Expand Down Expand Up @@ -2173,6 +2194,27 @@
],
"type": "object"
},
"artifacts": {
"additionalProperties": false,
"properties": {
"dashboards": {
"items": {
"additionalProperties": false,
"properties": {
"id": {
"type": "string"
}
},
"required": [
"id"
],
"type": "object"
},
"type": "array"
}
},
"type": "object"
},
"consumer": {
"description": "The name of the application or feature that owns the rule. For example: `alerts`, `apm`, `discover`, `infrastructure`, `logs`, `metrics`, `ml`, `monitoring`, `securitySolution`, `siem`, `stackAlerts`, or `uptime`.",
"type": "string"
Expand Down Expand Up @@ -2820,6 +2862,27 @@
"nullable": true,
"type": "string"
},
"artifacts": {
"additionalProperties": false,
"properties": {
"dashboards": {
"items": {
"additionalProperties": false,
"properties": {
"id": {
"type": "string"
}
},
"required": [
"id"
],
"type": "object"
},
"type": "array"
}
},
"type": "object"
},
"consumer": {
"description": "The name of the application or feature that owns the rule. For example: `alerts`, `apm`, `discover`, `infrastructure`, `logs`, `metrics`, `ml`, `monitoring`, `securitySolution`, `siem`, `stackAlerts`, or `uptime`.",
"type": "string"
Expand Down Expand Up @@ -3742,6 +3805,27 @@
],
"type": "object"
},
"artifacts": {
"additionalProperties": false,
"properties": {
"dashboards": {
"items": {
"additionalProperties": false,
"properties": {
"id": {
"type": "string"
}
},
"required": [
"id"
],
"type": "object"
},
"type": "array"
}
},
"type": "object"
},
"flapping": {
"additionalProperties": false,
"description": "When flapping detection is turned on, alerts that switch quickly between active and recovered states are identified as “flapping” and notifications are reduced.",
Expand Down Expand Up @@ -4120,6 +4204,27 @@
"nullable": true,
"type": "string"
},
"artifacts": {
"additionalProperties": false,
"properties": {
"dashboards": {
"items": {
"additionalProperties": false,
"properties": {
"id": {
"type": "string"
}
},
"required": [
"id"
],
"type": "object"
},
"type": "array"
}
},
"type": "object"
},
"consumer": {
"description": "The name of the application or feature that owns the rule. For example: `alerts`, `apm`, `discover`, `infrastructure`, `logs`, `metrics`, `ml`, `monitoring`, `securitySolution`, `siem`, `stackAlerts`, or `uptime`.",
"type": "string"
Expand Down Expand Up @@ -6036,6 +6141,27 @@
"nullable": true,
"type": "string"
},
"artifacts": {
"additionalProperties": false,
"properties": {
"dashboards": {
"items": {
"additionalProperties": false,
"properties": {
"id": {
"type": "string"
}
},
"required": [
"id"
],
"type": "object"
},
"type": "array"
}
},
"type": "object"
},
"consumer": {
"description": "The name of the application or feature that owns the rule. For example: `alerts`, `apm`, `discover`, `infrastructure`, `logs`, `metrics`, `ml`, `monitoring`, `securitySolution`, `siem`, `stackAlerts`, or `uptime`.",
"type": "string"
Expand Down
Loading