From d3d4a18aad633b08e593866ce6e25701cb211c45 Mon Sep 17 00:00:00 2001 From: rjmurray Date: Mon, 6 Jan 2025 14:40:37 +0000 Subject: [PATCH 1/3] Reflecting spec to help.md --- plugins/rapid7_insight_agent/.CHECKSUM | 6 +++--- plugins/rapid7_insight_agent/Dockerfile | 2 ++ plugins/rapid7_insight_agent/help.md | 14 ++++++++------ .../actions/get_agent_details/schema.py | 2 +- .../actions/get_all_agents_by_ip/schema.py | 2 +- plugins/rapid7_insight_agent/plugin.spec.yaml | 7 ++++--- 6 files changed, 19 insertions(+), 14 deletions(-) diff --git a/plugins/rapid7_insight_agent/.CHECKSUM b/plugins/rapid7_insight_agent/.CHECKSUM index 1b644da355..6ec71985e7 100644 --- a/plugins/rapid7_insight_agent/.CHECKSUM +++ b/plugins/rapid7_insight_agent/.CHECKSUM @@ -1,5 +1,5 @@ { - "spec": "b8b7370c8f21f0adcc0684545a186a56", + "spec": "3ea8076dfb3cb04ad6239462632ca27e", "manifest": "fbc1b04c51c6c8816dac6cee216341c2", "setup": "7f65232e4808ae89ad79c06f1b2dc5a2", "schemas": [ @@ -9,11 +9,11 @@ }, { "identifier": "get_agent_details/schema.py", - "hash": "5b09dc2d9e61e0d0f0ebedfab722b120" + "hash": "8b95862344f318fbe4593d8c9710caef" }, { "identifier": "get_all_agents_by_ip/schema.py", - "hash": "02cda219f562d328ac60a9540c79d3a5" + "hash": "8c5c177cfaf437d557a9af2b9eaa97d7" }, { "identifier": "quarantine/schema.py", diff --git a/plugins/rapid7_insight_agent/Dockerfile b/plugins/rapid7_insight_agent/Dockerfile index cfd0c6f71e..37b5d97286 100755 --- a/plugins/rapid7_insight_agent/Dockerfile +++ b/plugins/rapid7_insight_agent/Dockerfile @@ -5,6 +5,8 @@ LABEL sdk=python WORKDIR /python/src + + ADD ./plugin.spec.yaml /plugin.spec.yaml ADD ./requirements.txt /python/src/requirements.txt diff --git a/plugins/rapid7_insight_agent/help.md b/plugins/rapid7_insight_agent/help.md index f77e801bd9..49f020c38b 100644 --- a/plugins/rapid7_insight_agent/help.md +++ b/plugins/rapid7_insight_agent/help.md @@ -79,8 +79,9 @@ 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 @@ -453,9 +455,9 @@ Example output: |Hostname|string|None|False|Hostname|None| -## Troubleshooting +# 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/plugins/rapid7_insight_agent/icon_rapid7_insight_agent/actions/get_agent_details/schema.py b/plugins/rapid7_insight_agent/icon_rapid7_insight_agent/actions/get_agent_details/schema.py index 0948736c9e..376e98f793 100755 --- a/plugins/rapid7_insight_agent/icon_rapid7_insight_agent/actions/get_agent_details/schema.py +++ b/plugins/rapid7_insight_agent/icon_rapid7_insight_agent/actions/get_agent_details/schema.py @@ -4,7 +4,7 @@ class Component: - DESCRIPTION = "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" + DESCRIPTION = "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" class Input: diff --git a/plugins/rapid7_insight_agent/icon_rapid7_insight_agent/actions/get_all_agents_by_ip/schema.py b/plugins/rapid7_insight_agent/icon_rapid7_insight_agent/actions/get_all_agents_by_ip/schema.py index 54ece95306..f6ca3f7abb 100644 --- a/plugins/rapid7_insight_agent/icon_rapid7_insight_agent/actions/get_all_agents_by_ip/schema.py +++ b/plugins/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 index 5a206220db..69ebff2b8b 100644 --- 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: @@ -290,7 +291,7 @@ actions: required: false get_agent_details: title: Get Agent Details - description: 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 + description: "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: agent: title: Agent @@ -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 From 85dbd8e64802b4128f111b5db4a611863a13b4d0 Mon Sep 17 00:00:00 2001 From: rjmurray Date: Mon, 6 Jan 2025 15:46:26 +0000 Subject: [PATCH 2/3] troubleshooting header --- plugins/rapid7_insight_agent/help.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/plugins/rapid7_insight_agent/help.md b/plugins/rapid7_insight_agent/help.md index 49f020c38b..9edc4a5e89 100644 --- a/plugins/rapid7_insight_agent/help.md +++ b/plugins/rapid7_insight_agent/help.md @@ -455,7 +455,7 @@ Example output: |Hostname|string|None|False|Hostname|None| -# Troubleshooting +## 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. From a4a6515c9dcb3ac6a706985008c70c99110cd0b2 Mon Sep 17 00:00:00 2001 From: rjmurray Date: Tue, 7 Jan 2025 13:52:51 +0000 Subject: [PATCH 3/3] Update plugin.spec --- plugins/rapid7_insight_agent/.CHECKSUM | 4 ++-- plugins/rapid7_insight_agent/Dockerfile | 2 -- plugins/rapid7_insight_agent/help.md | 2 +- .../actions/get_agent_details/schema.py | 2 +- plugins/rapid7_insight_agent/plugin.spec.yaml | 2 +- 5 files changed, 5 insertions(+), 7 deletions(-) diff --git a/plugins/rapid7_insight_agent/.CHECKSUM b/plugins/rapid7_insight_agent/.CHECKSUM index 6ec71985e7..e4d759d8e6 100644 --- a/plugins/rapid7_insight_agent/.CHECKSUM +++ b/plugins/rapid7_insight_agent/.CHECKSUM @@ -1,5 +1,5 @@ { - "spec": "3ea8076dfb3cb04ad6239462632ca27e", + "spec": "068f90d6f4a93addc62a6c00ad1aa085", "manifest": "fbc1b04c51c6c8816dac6cee216341c2", "setup": "7f65232e4808ae89ad79c06f1b2dc5a2", "schemas": [ @@ -9,7 +9,7 @@ }, { "identifier": "get_agent_details/schema.py", - "hash": "8b95862344f318fbe4593d8c9710caef" + "hash": "5b09dc2d9e61e0d0f0ebedfab722b120" }, { "identifier": "get_all_agents_by_ip/schema.py", diff --git a/plugins/rapid7_insight_agent/Dockerfile b/plugins/rapid7_insight_agent/Dockerfile index 37b5d97286..cfd0c6f71e 100755 --- a/plugins/rapid7_insight_agent/Dockerfile +++ b/plugins/rapid7_insight_agent/Dockerfile @@ -5,8 +5,6 @@ LABEL sdk=python WORKDIR /python/src - - ADD ./plugin.spec.yaml /plugin.spec.yaml ADD ./requirements.txt /python/src/requirements.txt diff --git a/plugins/rapid7_insight_agent/help.md b/plugins/rapid7_insight_agent/help.md index 9edc4a5e89..15f7e3cb01 100644 --- a/plugins/rapid7_insight_agent/help.md +++ b/plugins/rapid7_insight_agent/help.md @@ -79,7 +79,7 @@ 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 diff --git a/plugins/rapid7_insight_agent/icon_rapid7_insight_agent/actions/get_agent_details/schema.py b/plugins/rapid7_insight_agent/icon_rapid7_insight_agent/actions/get_agent_details/schema.py index 376e98f793..0948736c9e 100755 --- a/plugins/rapid7_insight_agent/icon_rapid7_insight_agent/actions/get_agent_details/schema.py +++ b/plugins/rapid7_insight_agent/icon_rapid7_insight_agent/actions/get_agent_details/schema.py @@ -4,7 +4,7 @@ class Component: - DESCRIPTION = "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" + DESCRIPTION = "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" class Input: diff --git a/plugins/rapid7_insight_agent/plugin.spec.yaml b/plugins/rapid7_insight_agent/plugin.spec.yaml index 69ebff2b8b..be09740d28 100644 --- a/plugins/rapid7_insight_agent/plugin.spec.yaml +++ b/plugins/rapid7_insight_agent/plugin.spec.yaml @@ -291,7 +291,7 @@ actions: required: false get_agent_details: title: Get Agent Details - description: "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" + description: 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: agent: title: Agent