RFPD-22681: Splunk SOAR - Combine List Search and List Details into one action#26
Conversation
8f37fed to
b6d0467
Compare
14c0a8d to
2dc826f
Compare
nazarii-plebanskyi-rf
left a comment
There was a problem hiding this comment.
General question: does the list search action always return a list? Or is it returning an object when list_id is specified?
There was a problem hiding this comment.
Pull request overview
This PR consolidates list lookup behavior by allowing the existing list search action to optionally fetch a single list’s details via list_id, while keeping list details for backward compatibility (now deprecated) and expanding unit test coverage across connector actions.
Changes:
- Added optional
list_idparameter tolist searchto performGET /list/{list_id}/infowhen provided. - Deprecated the
list detailsaction via a visible runtime warning and updated descriptions/docs accordingly. - Added/expanded pytest coverage for a broad set of connector actions (alerts, intelligence, reputation, list actions, etc.).
Reviewed changes
Copilot reviewed 11 out of 11 changed files in this pull request and generated 2 comments.
Show a summary per file
| File | Description |
|---|---|
recordedfuture_connector.py |
Adds list_id handling to list search and emits deprecation warning for list details; small robustness fix for intelligence 404 handling. |
recordedfuture.json |
Updates action schema to include list_id on list search and marks list details as deprecated in its description. |
README.md |
Documents list_id parameter for list search and flags list details as deprecated. |
release_notes/unreleased.md |
Adds unreleased note about the list search/list details consolidation. |
tests/test_list_search.py |
Adds unit tests for list search behavior with list_id and verifies list details deprecation warning. |
tests/test_*.py (multiple) |
Adds unit tests for additional connector actions (alerts, intelligence, reputation, playbook alerts, misc). |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
Yes, the two code paths return different shapes:
|
9611278 to
3501f49
Compare
There was a problem hiding this comment.
Pull request overview
Copilot reviewed 11 out of 11 changed files in this pull request and generated 4 comments.
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
301e48c to
d241d75
Compare
c5edfe8 to
ed89f4b
Compare
Details
Consolidates
list searchandlist detailsactions by addinglist_idas an optional parameter tolist search.list_idas an optional parameter to thelist searchaction, allowing users to look up a specific list by ID without needing a separate action (when provided, returns details for a specific list via/list/{list_id}/info).list_idinstead.Summary
Two actions
list search(filter by name/type) and list details (lookup by ID) will returned identical output but served different input patterns. Rather than merging them (which would blur the architectural separation of filter-based vs. ID-based lookups),list_idwas added as an optional parameter to list search. This gives users flexibility while keeping both actions clean and focused.list detailsis preserved for backwards compatibility but marked as deprecated for future removal.