splunk / splunk/contentctl

Investigate better ways to handle the typing of `baseline.tags.detections`

Open
#223 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
Python
Stars
139
Forks
52
Avg merge
1h 16m
Merged PRs (30d)
3

Description

  • Right now, we have a type for this of List[Union[Detection,str]]
  • This is not ideal, as we would rather have ti just be a list of Detections
  • However, baselines reference detections and detection reference baselines, so there's a bit of a chicken/egg issue
  • We should look into other strategies here

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start by tracing the definitions and uses of baseline.tags.detections, Detection, and baselines to understand the circular reference. Compare viable typing strategies and confirm the chosen approach preserves those relationships; done means the type no longer relies on the current List[Union[Detection,str]] form.

Written by the indexing model from the issue text.

Assessment

Tech stack
python
Domain
tooling
Issue type
Refactor
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
25/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.