Merge branch 'tkt_77_add_doc_to_pr' into 'dev'

Add doc to PR

Closes #77

See merge request faradaysec/faraday-cli!75

Author: Nicolas Rebagliati

CHANGELOG/current/add_delete_vuln.md

@@ -0,0 +1,2 @@
+[ADD] Add vuln delete vuln-id
+

docs/docs/commands.md

@@ -446,6 +446,26 @@ Vulnerability updated
 | `--tag TAG`             | Tag to add to the vuln. In case that you want add more than one vuln you can repeat this argument |
 | `--confirmed CONFIRMED` |                                          Indicates if the Vulnerability is confirmed: True, False |
 
+### vuln delete
+
+Delete a vulnerability
+
+```
+$ faraday-cli vuln delete 46 -w test
+Vulnerability deleted
+```
+
+*Required Arguments:*
+
+| Syntax      | Description |
+|:-----	|------:	|
+| `-id/--vulnerability-id`   | Vulnerability ID       |
+
+*Optional Arguments:*
+
+| Syntax                  | Description    |
+|:------------------------|----------------|
+| `-w WORKSPACE_NAME`     | Workspace name |
 
 ## Tools and Reports
 

faraday_cli/api_client/faraday_api.py

@@ -264,6 +264,11 @@ def upload_evidence_to_vuln(
         self.faraday_api.headers = original_headers
         return response.body
 
+    @handle_errors
+    def delete_vuln(self, workspace_name: str, vuln_id):
+        response = self.faraday_api.vuln.delete(workspace_name, vuln_id)
+        return response.body
+
     @handle_errors
     def update_vuln(
         self, workspace_name: str, vulnerability_id: int, body: str

faraday_cli/api_client/resources.py

@@ -63,6 +63,7 @@ class VulnResource(Resource):
         "patch": {"method": "PATCH", "url": "v3/ws/{}/vulns/{}"},
         "list": {"method": "GET", "url": "v3/ws/{}/vulns"},
         "filter": {"method": "GET", "url": "v3/ws/{}/vulns/filter"},
+        "delete": {"method": "DELETE", "url": "v3/ws/{}/vulns/{}"},
     }
 
 

faraday_cli/shell/modules/vulnerability.py

@@ -5,6 +5,7 @@
 from pathlib import Path
 
 import cmd2
+from cmd2 import Fg as COLORS
 from simple_rest_client.exceptions import NotFoundError
 from tabulate import tabulate
 from faraday_cli.extras.halo.halo import Halo
@@ -279,3 +280,39 @@ def update_vuln(self, args: argparse.Namespace):
                 self._cmd.poutput("Vulnerability updated")
         except RequestError as e:
             self._cmd.perror(e.message)
+
+    delete_vuln_parser = cmd2.Cmd2ArgumentParser()
+    delete_vuln_parser.add_argument(
+        "vuln_id", type=int, help="ID of the vulnerability"
+    )
+    delete_vuln_parser.add_argument(
+        "-w", "--workspace-name", type=str, help="Workspace"
+    )
+
+    @cmd2.as_subcommand_to(
+        "vuln",
+        "delete",
+        delete_vuln_parser,
+        help="Delete existing vulnerability",
+    )
+    def delete_vuln(self, args: argparse.Namespace):
+        """Delete Vulnerability"""
+
+        if not args.workspace_name:
+            if active_config.workspace:
+                workspace_name = active_config.workspace
+            else:
+                self._cmd.perror("No active Workspace")
+                return
+        else:
+            workspace_name = args.workspace_name
+        try:
+            self._cmd.api_client.delete_vuln(workspace_name, args.vuln_id)
+        except NotFoundError:
+            self._cmd.perror("Vuln not found")
+        except Exception as e:
+            self._cmd.perror(f"{e}")
+        else:
+            self._cmd.poutput(
+                cmd2.style("Vulnerability deleted", fg=COLORS.GREEN)
+            )