docs: comment on api.setup_authenticated_client

dreadnode · Oct 16, 2024 · 3f21bcd · 3f21bcd
1 parent 6a9f03d
commit 3f21bcd
Showing 1 changed file with 2 additions and 0 deletions.
diff --git a/dreadnode_cli/api.py b/dreadnode_cli/api.py
@@ -214,6 +214,8 @@ async def list_challenges(self) -> Any:
 
 
 async def setup_authenticated_client(config: ServerConfig, force_refresh: bool = False) -> Client:
+    """Create an API client and refresh the authentication data if it is close to expiry."""
+
     # load existing auth data
     auth = Authentication(config.access_token, config.refresh_token)
     client = Client(base_url=config.url, auth=auth)