From 874638be484a87c9ff339390e1a49cce2dc0e2f8 Mon Sep 17 00:00:00 2001 From: Jackson Date: Thu, 27 Jun 2024 16:04:09 +0200 Subject: [PATCH] clarify that v2 room delete is async and default Resolves: https://github.com/JOJ0/synadm/issues/145 --- synadm/cli/room.py | 8 +++++++- 1 file changed, 7 insertions(+), 1 deletion(-) diff --git a/synadm/cli/room.py b/synadm/cli/room.py index 119afcba..e9a9c668 100644 --- a/synadm/cli/room.py +++ b/synadm/cli/room.py @@ -253,12 +253,18 @@ def members(helper, room_id): as it could leave those users' clients in a confused state.""") @click.option( "--v1", is_flag=True, default=False, show_default=True, - help="""Use version 1 of the room delete API instead of version 2""") + help="""Use version 1 of the room delete API instead of version 2, which + will wait until the room deletion is complete.""") @click.pass_obj @click.pass_context def delete(ctx, helper, room_id, new_room_user_id, room_name, message, block, no_purge, force_purge, v1): """ Delete and possibly purge a room. + + By default, the v2 API is used, which will return a delete_id and delete + the room asynchronously instead of waiting for a room to be deleted (the + v1 API will wait for the room to be deleted). You can check the status + of the room deletion with synadm room delete-status. """ if no_purge and force_purge: click.echo("--force-purge will be ignored as --no-purge is set")