further description updates

rapid7 · Dec 9, 2024 · 96d9a61 · 96d9a61
1 parent 7f26785
commit 96d9a61
Show file tree

Hide file tree

Showing 4 changed files with 13 additions and 13 deletions.
diff --git a/plugins/rapid7_insightidr/.CHECKSUM b/plugins/rapid7_insightidr/.CHECKSUM
@@ -1,5 +1,5 @@
 {
-	"spec": "2600ee8def3b18618c46e2869bbf0a86",
+	"spec": "ef55d0eaab88354037eb0e7a0c1d5ca0",
 	"manifest": "a9dc8b0c15952a931013e92670cdf86b",
 	"setup": "8b4da6c79f36dd56dfc82e26d0009a8b",
 	"schemas": [
@@ -109,7 +109,7 @@
 		},
 		{
 			"identifier": "list_investigations/schema.py",
-			"hash": "f982391c22d7e69d082c25ea0406e470"
+			"hash": "cde4df172845f8378c8fa7243e60fe23"
 		},
 		{
 			"identifier": "query/schema.py",

diff --git a/plugins/rapid7_insightidr/help.md b/plugins/rapid7_insightidr/help.md
@@ -1851,22 +1851,22 @@ Example output:
 
 #### List Investigations
 
-This action is used to retrieve a page of investigations matching the given request parameters.
-
-If there is no 'start_time' and 'end_time' provided, 'start_time' will  default to 28 days prior, and 'end_time' will default to the current time.'
+This action is used to retrieve a page of investigations matching the given request parameters. If there is no 
+'start_time' and 'end_time' provided, 'start_time' will  default to 28 days prior, and 'end_time' will default to the 
+current time
 
 ##### Input
 
 |Name|Type|Default|Required|Description|Enum|Example|Placeholder|Tooltip|
 | :--- | :--- | :--- | :--- | :--- | :--- | :--- | :--- | :--- |
 |email|string|None|False|A user's email address, where only investigations assigned to that user will be included|None|user@example.com|None|None|
-|end_time|date|None|False|An optional-ISO formatted timestamp, where only investigations whose createTime is before this date will be returned|None|2020-06-01T12:11:13+05:30|None|None|
+|end_time|date|None|False|An optional-ISO formatted timestamp, where only investigations whose createTime is before this date will be returned. If there is no value provided, this will default to the current time|None|2020-06-01T12:11:13+05:30|None|None|
 |index|integer|0|True|Zero-based index of the page to retrieve, where value must be greater than or equal to 0|None|1|None|None|
 |priorities|[]string|None|False|A comma-separated list of investigation priorities to include in the result, where possible values are LOW, MEDIUM, HIGH, CRITICAL|None|["LOW", "MEDIUM", "HIGH", "CRITICAL"]|None|None|
 |size|integer|100|True|Amount of data for a page to retrieve, where its value must be greater than 0 and less than or equal to 100|None|100|None|None|
 |sort|string|None|False|A field for investigations to be sorted|["", "Created time Ascending", "Created time Descending", "Priority Ascending", "Priority Descending", "RRN Ascending", "RRN Descending", "Alerts most recent created time Ascending", "Alerts most recent created time Descending", "Alerts most recent detection created time Ascending", "Alerts most recent detection created time Descending", "Responsibility Ascending", "Responsibility Descending"]|Created time Ascending|None|None|
 |sources|[]string|None|False|A comma-separated list of investigation sources to include in the result, where possible values are USER, ALERT, HUNT, AUTOMATION|None|["USER","ALERT"]|None|None|
-|start_time|date|None|False|An optional ISO-formatted timestamp, where only investigations whose createTime is after this date will be returned|None|2020-06-01T12:11:13+05:30|None|None|
+|start_time|date|None|False|An optional ISO-formatted timestamp, where only investigations whose createTime is after this date will be returned. If there is no value provided this will default to 28 days prior|None|2020-06-01T12:11:13+05:30|None|None|
 |statuses|[]string|None|False|Comma-separated list of investigation statuses to include in the result. Possible values are OPEN, CLOSED, INVESTIGATING, WAITING|None|["CLOSED"]|None|None|
 
 Example input:

diff --git a/plugins/rapid7_insightidr/komand_rapid7_insightidr/actions/list_investigations/schema.py b/plugins/rapid7_insightidr/komand_rapid7_insightidr/actions/list_investigations/schema.py
@@ -4,7 +4,7 @@
 
 
 class Component:
-    DESCRIPTION = "Retrieve a page of investigations matching the given request parameters. If there is no 'start_time' and 'end_time' provided, 'start_time' will  default to 28 days prior, and 'end_time' will default to the current time.'"
+    DESCRIPTION = "Retrieve a page of investigations matching the given request parameters. If there is no 'start_time' and 'end_time' provided, 'start_time' will  default to 28 days prior, and 'end_time' will default to the current time"
 
 
 class Input:
@@ -41,7 +41,7 @@ class ListInvestigationsInput(insightconnect_plugin_runtime.Input):
       "format": "date-time",
       "displayType": "date",
       "title": "End Time",
-      "description": "An optional-ISO formatted timestamp, where only investigations whose createTime is before this date will be returned",
+      "description": "An optional-ISO formatted timestamp, where only investigations whose createTime is before this date will be returned. If there is no value provided, this will default to the current time",
       "order": 3
     },
     "index": {
@@ -102,7 +102,7 @@ class ListInvestigationsInput(insightconnect_plugin_runtime.Input):
       "format": "date-time",
       "displayType": "date",
       "title": "Start Time",
-      "description": "An optional ISO-formatted timestamp, where only investigations whose createTime is after this date will be returned",
+      "description": "An optional ISO-formatted timestamp, where only investigations whose createTime is after this date will be returned. If there is no value provided this will default to 28 days prior",
       "order": 2
     },
     "statuses": {

diff --git a/plugins/rapid7_insightidr/plugin.spec.yaml b/plugins/rapid7_insightidr/plugin.spec.yaml
@@ -1379,7 +1379,7 @@ actions:
         example: {"name": "bad-virus","note": "test","published": False,"indicator_count": 2}
   list_investigations:
     title: List Investigations
-    description: Retrieve a page of investigations matching the given request parameters. If there is no 'start_time' and 'end_time' provided, 'start_time' will  default to 28 days prior, and 'end_time' will default to the current time.'
+    description: Retrieve a page of investigations matching the given request parameters. If there is no 'start_time' and 'end_time' provided, 'start_time' will  default to 28 days prior, and 'end_time' will default to the current time
     input:
       statuses:
         title: Statuses
@@ -1389,13 +1389,13 @@ actions:
         example: ["CLOSED"]
       start_time:
         title: Start Time
-        description: An optional ISO-formatted timestamp, where only investigations whose createTime is after this date will be returned
+        description: An optional ISO-formatted timestamp, where only investigations whose createTime is after this date will be returned. If there is no value provided this will default to 28 days prior
         type: date
         required: false
         example: "2020-06-01T12:11:13+05:30"
       end_time:
         title: End Time
-        description: An optional-ISO formatted timestamp, where only investigations whose createTime is before this date will be returned
+        description: An optional-ISO formatted timestamp, where only investigations whose createTime is before this date will be returned. If there is no value provided, this will default to the current time
         type: date
         required: false
         example: "2020-06-01T12:11:13+05:30"