Ensure severity info matches working values in code. Closes #8

iteratec · Oct 1, 2024 · c815b71 · c815b71
1 parent 546e20a
commit c815b71
Show file tree

Hide file tree

Showing 2 changed files with 2 additions and 2 deletions.
diff --git a/docs/usage.md b/docs/usage.md
@@ -30,7 +30,7 @@ There are several optional parameters to customize the execution:
 |-----------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------|
 | `--format`                  | The output format of the findings. Can be plain text (`txt`), `csv` or `json`.                                                                          |
 | `--output`                  | The path to the output file. If not provided, the output will be printed on stdout.                                                                     |
-| `--min-severity`            | The minimum severity of findings that should be reported. Can be one of INFO, WARNING, ERROR, CRITICAL.                                                 |
+| `--min-severity`            | The minimum severity of findings that should be reported. Can be one of INFO, LOW, MEDIUM, HIGH, CRITICAL.                                                 |
 | `--auditors`                | Specify the exact auditors to run, separated by space (others will be ignored).                                                                         |
 | `--config`                  | Provide a config file with auditor-specific exclusions and parameters. Generate a template using [generate-config-template](#generate-config-template). |
 | `--ignore-disabled-clients` | When set, will not audit disabled OIDC clients.                                                                                                         |

diff --git a/kcwarden/cli.py b/kcwarden/cli.py
@@ -73,7 +73,7 @@ def add_audit_parser(subparsers):
     parser_audit.add_argument(
         "-s",
         "--min-severity",
-        help="The minimum severity of findings that should be reported. Can be one of INFO, WARNING, ERROR, CRITICAL.",
+        help="The minimum severity of findings that should be reported. Can be one of INFO, LOW, MEDIUM, HIGH, CRITICAL.",
         type=str,
     )
     add_plugin_directory_argument(parser_audit)