diff --git a/.github/workflows/generate-doc.yml b/.github/workflows/generate-doc.yml index 7a3ba90..9284f9d 100644 --- a/.github/workflows/generate-doc.yml +++ b/.github/workflows/generate-doc.yml @@ -5,6 +5,7 @@ on: paths: - '*.json' - 'readme.html' + - 'manual_readme_content.md' tags-ignore: - '**' branches-ignore: diff --git a/README.md b/README.md index 7e1d4df..86ec877 100644 --- a/README.md +++ b/README.md @@ -2,11 +2,11 @@ # Link Publisher: Mhike -Connector Version: 1\.1\.1 +Connector Version: 1.1.2 Product Vendor: Mhike Product Name: Link -Product Version Supported (regex): "\.\*" -Minimum Product Version: 4\.9\.0 +Product Version Supported (regex): ".\*" +Minimum Product Version: 4.9.0 Generates a widget with clickable links @@ -65,8 +65,8 @@ The below configuration variables are required for this Connector to operate. T VARIABLE | REQUIRED | TYPE | DESCRIPTION -------- | -------- | ---- | ----------- -**https\_port** | optional | string | Splunk SOAR HTTPS port if your instance uses one other than 443 -**auth\_token** | optional | password | Splunk SOAR auth token if your instance requires auth for internal 127\.0\.0\.1 calls +**https_port** | optional | string | Splunk SOAR HTTPS port if your instance uses one other than 443 +**auth_token** | optional | password | Splunk SOAR auth token if your instance requires auth for internal 127.0.0.1 calls **debug** | optional | boolean | Print debugging statements to log ### Supported Actions @@ -79,7 +79,7 @@ Generate a widget with clickable links Type: **generic** Read only: **False** -Adds the specified links with the descriptor as the link text\. Links are added to the existing link widget if one exists, otherwise a new widget will be generated\. +Adds the specified links with the descriptor as the link text. Links are added to the existing link widget if one exists, otherwise a new widget will be generated. #### Action Parameters PARAMETER | REQUIRED | DESCRIPTION | TYPE | CONTAINS @@ -93,17 +93,17 @@ PARAMETER | REQUIRED | DESCRIPTION | TYPE | CONTAINS #### Action Output DATA PATH | TYPE | CONTAINS | EXAMPLE VALUES --------- | ---- | -------- | -------------- -action\_result\.status | string | | success failed -action\_result\.parameter\.append | string | | -action\_result\.parameter\.description | string | | -action\_result\.parameter\.linkset | string | | -action\_result\.parameter\.sort | string | | -action\_result\.parameter\.url | string | | -action\_result\.data\.\*\.linkset | string | | -action\_result\.summary | string | | -action\_result\.message | string | | -summary\.total\_objects | numeric | | -summary\.total\_objects\_successful | numeric | | +action_result.status | string | | success failed +action_result.parameter.append | string | | +action_result.parameter.description | string | | +action_result.parameter.linkset | string | | +action_result.parameter.sort | string | | +action_result.parameter.url | string | | +action_result.data.\*.linkset | string | | +action_result.summary | string | | +action_result.message | string | | +summary.total_objects | numeric | | +summary.total_objects_successful | numeric | | ## action: 'test connectivity' Test connectivity to local SOAR instance @@ -117,7 +117,7 @@ No parameters are required for this action #### Action Output DATA PATH | TYPE | CONTAINS | EXAMPLE VALUES --------- | ---- | -------- | -------------- -action\_result\.status | string | | success failed -action\_result\.message | string | | -summary\.total\_objects | numeric | | -summary\.total\_objects\_successful | numeric | | \ No newline at end of file +action_result.status | string | | success failed +action_result.message | string | | +summary.total_objects | numeric | | +summary.total_objects_successful | numeric | | \ No newline at end of file diff --git a/link.json b/link.json index 674bd0f..64a505d 100644 --- a/link.json +++ b/link.json @@ -5,7 +5,7 @@ "publisher": "Mhike", "type": "devops", "main_module": "link_connector.py", - "app_version": "1.1.1", + "app_version": "1.1.2", "utctime_updated": "2023-03-10T14:03:35.000000Z", "package_name": "phantom_link", "product_vendor": "Mhike", @@ -198,4 +198,4 @@ "executable": "spawn3", "disabled": false, "custom_made": true -} +} \ No newline at end of file diff --git a/manual_readme_content.md b/manual_readme_content.md new file mode 100644 index 0000000..289b8ae --- /dev/null +++ b/manual_readme_content.md @@ -0,0 +1,48 @@ +[comment]: # " File: README.md" +[comment]: # " Copyright (c) Mhike, 2022" +[comment]: # " Licensed under the Apache License, Version 2.0 (the 'License');" +[comment]: # " you may not use this file except in compliance with the License." +[comment]: # " You may obtain a copy of the License at" +[comment]: # " http://www.apache.org/licenses/LICENSE-2.0" +[comment]: # " Unless required by applicable law or agreed to in writing, software distributed under" +[comment]: # " the License is distributed on an 'AS IS' BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND," +[comment]: # " either express or implied. See the License for the specific language governing permissions" +[comment]: # " and limitations under the License." +[comment]: # "" +---------------------------------------------------------------------------------------------------- + +---------------------------------------------------------------------------------------------------- + +This app generates a widget with links. Each link will open in a new tab. + +When adding links, they can either be appended to existing links with the append boolean or the new +links can overwrite the old links. + +You can either add a single link and description at a time or you can use json to add multiple links +at once. + +For a single link, you can add the url in the url field and the link text in the description +field. + +For multiple links at once, you can pass in a list of dictionaries in this format: + + [ + { + "descriptor":"Google Search", + "url":"https://www.google.com" + }, + { + "descriptor":"Splunk Documentation", + "url":"https://docs.splunk.com/Documentation" + }, + { + "descriptor":"VirusTotal", + "url":"https://www.virustotal.com" + } + ] + +Make sure the url begins with http(s). If you don't, your links won't open in a new window properly. + +---------------------------------------------------------------------------------------------------- + +---------------------------------------------------------------------------------------------------- diff --git a/readme.html b/readme.html deleted file mode 100755 index b817eaf..0000000 --- a/readme.html +++ /dev/null @@ -1,40 +0,0 @@ - -
-[
- {
- "descriptor":"Google Search",
- "url":"https://www.google.com"
- },
- {
- "descriptor":"Splunk Documentation",
- "url":"https://docs.splunk.com/Documentation"
- },
- {
- "descriptor":"VirusTotal",
- "url":"https://www.virustotal.com"
- }
-]
-
-
-Make sure the url begins with http(s). If you don't, your links won't open in a new window properly.
-