Added a Notes object and an array of notes to the Findings classes.#1670
Added a Notes object and an array of notes to the Findings classes.#1670pagbabian-splunk wants to merge 7 commits into
Conversation
…ded the notes attribute to the Finding and Incident classes. Signed-off-by: Paul Agbabian <paul@macran.com>
…d findings include it, but override the description. Changed the detection_finding group from context to primary, as with all of the other Finding extended classes. Signed-off-by: Paul Agbabian <paul@macran.com>
Schema Description ReviewAutomated suggestions for improving description clarity for LLM consumption. These are advisory — not required changes. Looking at the compiled schema output and comparing it to my previous review, I can see that all the changes remain consistent with my earlier assessment. The PR introduces a well-structured Previous Suggestions Status✅ All previous suggestions were already addressed - My previous review found no issues, and the current state maintains that quality level. Current ReviewSuggestionsNone - all descriptions remain clear and self-contained. CHANGELOG IssuesNone - all entries follow proper conventions with correct PR references and proper sectioning. SummaryThe changes continue to demonstrate good schema design principles. The ✅ No description issues found — descriptions look clear for LLM consumption. |
Signed-off-by: Paul Agbabian <paul@macran.com>
Signed-off-by: Paul Agbabian <pagbabian@splunk.com>
|
@pagbabian-splunk do we want to deprecate |
Yes, that probably makes sense. I'll update with the deprecation. I wasn't sure whether for simple cases the single comment might be useful, but it's better that there is one place to view comments. |
…avor of the notes array. Replaced the user attribute with the owner attribute in the Note object to emphasize that the same user that created the Note is who can modify the Note. Signed-off-by: Paul Agbabian <pagbabian@splunk.com>
…te in finding and incident_finding.. Signed-off-by: Paul Agbabian <pagbabian@splunk.com>
Signed-off-by: Paul Agbabian <pagbabian@splunk.com>
Related Issue: 1659
Description of changes:
As mentioned in the above Issue, a simple
commentattribute is not sufficient for findings that are modified over time, especially by multiple analysts.This PR creates a
Noteobject that includes acommentattribute but also aowner,created_timeandmodified_timeto capture the details of who made the comment and when. TheFindingclasses and theIncident Findingclass include anotesattribute with an array ofNoteobjects to track comments over the lifecyle of the finding or incident.The
commentattribute is deprecated in favor ofnotes.One small structural change was made: the
Findingbase class has adeviceattribute whose comment refers toresourceswhich only appeared in the extended classes. This PR adds theresourcesattribute toFindingbut preserves the overriddent descriptions in each of the extended finding classes.