Open
Task
Listed in
Description
Epics: https://github.com/elastic/security-team/issues/1974 (internal), #179907
Summary
Currently, our API Rule Schemas and our schema for DiffableRule
s are completely disconnected: our Rule Schemas are auto-generated via our OpenAPI specs, while the DiffableRule schema (used in our Prebuilt Rule upgrade workflow) is created manually by listing its diffable fields.
This means that whenever a new field is added (or modified or removed) to our Rule Schemas, that change can go completely unnoticed (and the change merged to main
) without the engineer realising that the DiffableRule
should be adapted in a similar way.
Task
- Create either (or both):
- types that statically check that the fields in our Rule Schema are included -or considered in some way or another- in our
DiffableRule
. - tests that break if a change is introduced in our Rule Schema that is not reflected in the
DiffableRule
.
- types that statically check that the fields in our Rule Schema are included -or considered in some way or another- in our
- The files with types or tests should be set to be owned by the Detection Rules Management team, in order to prompt the involvement of one engineer from the team during this change.
Metadata
Metadata
Assignees
Labels
Type
Projects
Milestone
Relationships
Development
No branches or pull requests
Activity
elasticmachine commentedon Sep 30, 2024
Pinging @elastic/security-solution (Team: SecuritySolution)
elasticmachine commentedon Sep 30, 2024
Pinging @elastic/security-detection-rule-management (Team:Detection Rule Management)
elasticmachine commentedon Sep 30, 2024
Pinging @elastic/security-detections-response (Team:Detections and Resp)