Skip to content

Commit

Permalink
docs: Improve help message for ws restore command
Browse files Browse the repository at this point in the history
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'.
  • Loading branch information
jamilraichouni committed Jul 18, 2024
1 parent 92041c3 commit 1b59caf
Showing 1 changed file with 10 additions and 1 deletion.
11 changes: 10 additions & 1 deletion backend/capellacollab/cli/ws.py
Original file line number Diff line number Diff line change
Expand Up @@ -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",
Expand Down

0 comments on commit 1b59caf

Please sign in to comment.