Plugin.spec reflecting help.md (Rapid7 Insight Agent) (#3029)

* Reflecting spec to help.md * troubleshooting header * Update plugin.spec
rapid7 · Jan 7, 2025 · dbb9d1f · dbb9d1f
1 parent 2827f77
commit dbb9d1f
Show file tree

Hide file tree

Showing 4 changed files with 12 additions and 9 deletions.
diff --git a/plugins/rapid7_insight_agent/.CHECKSUM b/plugins/rapid7_insight_agent/.CHECKSUM
@@ -1,5 +1,5 @@
 {
-	"spec": "b8b7370c8f21f0adcc0684545a186a56",
+	"spec": "068f90d6f4a93addc62a6c00ad1aa085",
 	"manifest": "fbc1b04c51c6c8816dac6cee216341c2",
 	"setup": "7f65232e4808ae89ad79c06f1b2dc5a2",
 	"schemas": [
@@ -13,7 +13,7 @@
 		},
 		{
 			"identifier": "get_all_agents_by_ip/schema.py",
-			"hash": "02cda219f562d328ac60a9540c79d3a5"
+			"hash": "8c5c177cfaf437d557a9af2b9eaa97d7"
 		},
 		{
 			"identifier": "quarantine/schema.py",

diff --git a/plugins/rapid7_insight_agent/help.md b/plugins/rapid7_insight_agent/help.md
@@ -80,7 +80,8 @@ Example output:
 
 #### Get Agent Details
 
-This action is used to find and display detailed information about a device. If additional pages of agents are available, the action should be run again with the returned next cursor
+This action is used to find and display detailed information about a device. If additional pages of agents are 
+available, the action should be run again with the returned next cursor
 
 ##### Input
 
@@ -142,8 +143,9 @@ Example output:
 ```
 
 #### Get All Agents by IP Address
-
-This action is used to find all agents that share the same public or private IP address and display details about them. If additional pages of agents are available, the action should be run again with the returned next cursor
+
+This action is used to find all agents that share the same public or private IP address and display details about them. 
+If additional pages of agents are available, the action should be run again with the returned next cursor
 
 ##### Input
 
@@ -455,7 +457,7 @@ Example output:
 
 ## Troubleshooting
 
-If the actions `Get Agent Details` and `Get All Agents by IP` return a `next cursor` value, it is an indication that more pages of data are available to be reviewed. In this instance, it is recommended to run the action multiple times and pass the `next cursor` value, recording all agents found.
+* If the actions `Get Agent Details` and `Get All Agents by IP` return a `next cursor` value, it is an indication that more pages of data are available to be reviewed. In this instance, it is recommended to run the action multiple times and pass the `next cursor` value, recording all agents found.
 
 # Version History
 

diff --git a/...ins/rapid7_insight_agent/icon_rapid7_insight_agent/actions/get_all_agents_by_ip/schema.py b/...ins/rapid7_insight_agent/icon_rapid7_insight_agent/actions/get_all_agents_by_ip/schema.py
@@ -4,7 +4,7 @@
 
 
 class Component:
-    DESCRIPTION = "Find all agents that share the same public or private IP address and display details about them. If additional pages of agents are available, the action should be run again with the returned next cursor"
+    DESCRIPTION = "This action is used to find all agents that share the same public or private IP address and display details about them. If additional pages of agents are available, the action should be run again with the returned next cursor"
 
 
 class Input:

diff --git a/plugins/rapid7_insight_agent/plugin.spec.yaml b/plugins/rapid7_insight_agent/plugin.spec.yaml
@@ -21,7 +21,8 @@ key_features:
 requirements:
   - "[Platform API Key](https://docs.rapid7.com/insight/managing-platform-api-keys/)"
   - "Administrator access to InsightIDR"
-troubleshooting: "If the actions `Get Agent Details` and `Get All Agents by IP` return a `next cursor` value, it is an indication that more pages of data are available to be reviewed. In this instance, it is recommended to run the action multiple times and pass the `next cursor` value, recording all agents found."
+troubleshooting:
+  - "If the actions `Get Agent Details` and `Get All Agents by IP` return a `next cursor` value, it is an indication that more pages of data are available to be reviewed. In this instance, it is recommended to run the action multiple times and pass the `next cursor` value, recording all agents found."
 links:
   - "[Rapid7 Insight Agent](https://docs.rapid7.com/insight-agent/overview/)"
 references:
@@ -319,7 +320,7 @@ actions:
         example: 9de5069c5afe602b2ea0a04b66beb2c0
   get_all_agents_by_ip:
     title: Get All Agents by IP Address
-    description: Find all agents that share the same public or private IP address and display details about them. If additional pages of agents are available, the action should be run again with the returned next cursor
+    description: This action is used to find all agents that share the same public or private IP address and display details about them. If additional pages of agents are available, the action should be run again with the returned next cursor
     input:
       ip_address:
         title: IP Address