From 1b59caf5d032b14fa1b93489f3849e85177c577f Mon Sep 17 00:00:00 2001
From: Jamil RAICHOUNI <jamil.raichouni@deutschebahn.com>
Date: Thu, 18 Jul 2024 12:47:12 +0200
Subject: [PATCH] docs: Improve help message for ws restore command

Using this subcommand can easily fail, when user do not know that the
tarfile should be a gzip compressed file with one top level directory
named 'workspace'.
---
 backend/capellacollab/cli/ws.py | 11 ++++++++++-
 1 file changed, 10 insertions(+), 1 deletion(-)

diff --git a/backend/capellacollab/cli/ws.py b/backend/capellacollab/cli/ws.py
index 892cc53d9..ac3aae585 100644
--- a/backend/capellacollab/cli/ws.py
+++ b/backend/capellacollab/cli/ws.py
@@ -188,7 +188,16 @@ def backup(
 @app.command()
 def restore(
     volume_name: str,
-    tarfile: t.Annotated[pathlib.Path, typer.Argument(exists=True)],
+    tarfile: t.Annotated[
+        pathlib.Path,
+        typer.Argument(
+            exists=True,
+            help=(
+                "gzip compressed file with one top level "
+                "directory named 'workspace'"
+            ),
+        ),
+    ],
     namespace: t.Annotated[str, NamespaceOption],
     access_mode: str = "ReadWriteMany",
     storage_class_name: str = "persistent-sessions-csi",