fix(cli): add help message to alert get cmd (#901)

keephq · Mar 6, 2024 · 3f219af · 3f219af
1 parent d930b9a
commit 3f219af
Show file tree

Hide file tree

Showing 2 changed files with 9 additions and 0 deletions.
diff --git a/docs/mint.json b/docs/mint.json
@@ -257,6 +257,14 @@
                 }
               ]
             },
+            {
+              "group": "keep mappings",
+              "pages": [
+                "cli/commands/mappings-list",
+                "cli/commands/mappings-create",
+                "cli/commands/mappings-delete"
+              ]
+            },
             "cli/commands/cli-api",
             "cli/commands/cli-config",
             "cli/commands/cli-version",

diff --git a/keep/cli/cli.py b/keep/cli/cli.py
@@ -1067,6 +1067,7 @@ def alert(info: Info):
 )
 @pass_info
 def get_alert(info: Info, fingerprint: str):
+    """Get an alert by fingerprint."""
     resp = _get_alert_by_fingerprint(info.keep_api_url, info.api_key, fingerprint)
     if not resp.ok:
         raise Exception(f"Error getting alert: {resp.text}")