Skip to content

Commit

Permalink
Make release notes and action verbose more informative
Browse files Browse the repository at this point in the history
  • Loading branch information
alexa-phantom committed Sep 23, 2024
1 parent 5049d6b commit 7242bcb
Show file tree
Hide file tree
Showing 2 changed files with 2 additions and 2 deletions.
2 changes: 1 addition & 1 deletion phantom.json
Original file line number Diff line number Diff line change
Expand Up @@ -569,7 +569,7 @@
{
"action": "find artifacts",
"description": "Find artifacts containing a CEF value",
"verbose": "If the <b>limit_search</b> parameter is set to true, then the action will search the required artifact in the provided <b>container_ids</b> only. Otherwise, the <b>container_ids</b> parameter will be ignored.<br><br>If any non-integer value is provided in the <b>container_ids</b> parameter, then all the non-integer values will be removed and the parameter will be updated accordingly. If the value of the <b>container_ids</b> parameter is <b>current</b>, then it will be replaced by the current container's id(from which the action is being run) and the status will be reflected accordingly.<br><br>If the <b>exact_match</b> parameter is set to false, then the action will return all those artifacts for which the <b>values</b> parameter is a substring of any one of its cef values. Otherwise it will return those artifacts for which any one of its cef value matches exactly with the <b>values</b> parameter.<br><br>For the <b>values</b> of type integer, float or string, it is suggested to set the <b>exact_match</b> parameter to false.",
"verbose": "If the <b>limit_search</b> parameter is set to true, then the action will search the required artifact in the provided <b>container_ids</b> only. Otherwise, the <b>container_ids</b> parameter will be ignored.<br><br>If any non-integer value is provided in the <b>container_ids</b> parameter, then all the non-integer values will be removed and the parameter will be updated accordingly. If the value of the <b>container_ids</b> parameter is <b>current</b>, then it will be replaced by the current container's id(from which the action is being run) and the status will be reflected accordingly.<br><br>If the <b>exact_match</b> parameter is set to false, then the action will return all those artifacts for which the <b>values</b> parameter is a substring of any one of its cef values. Otherwise it will return those artifacts for which any one of its cef value matches exactly with the <b>values</b> parameter.<br><br>For the <b>values</b> of type integer, float or string, it is suggested to set the <b>exact_match</b> parameter to false.<br><br>By default, 10 artifacts are returned. If you would like to return more than 10 artifacts, update the <b>max_results</b> parameter. To return a limited number of results per page, use <b>page</b> parameter, which starts numbering at 0.",
"type": "investigate",
"identifier": "find_artifacts",
"read_only": true,
Expand Down
2 changes: 1 addition & 1 deletion release_notes/unreleased.md
Original file line number Diff line number Diff line change
@@ -1,2 +1,2 @@
**Unreleased**
* Added pagination and results per page for 'find artifacts' action [PAPP-34742]
* Added pagination and updated default number of results returned to 10 artifacts for 'find artifacts' action [PAPP-34742]

0 comments on commit 7242bcb

Please sign in to comment.