fix: self review comments

ni · Nov 7, 2024 · 5e854a2 · 5e854a2
1 parent ad7e3f0
commit 5e854a2
Show file tree

Hide file tree

Showing 4 changed files with 13 additions and 3 deletions.
diff --git a/examples/auth/get_workspace_id.py b/examples/auth/get_workspace_id.py
@@ -1,7 +1,7 @@
 """Example of getting workspace ID."""
 
 from nisystemlink.clients.auth import AuthClient
-from nisystemlink.clients.auth.utilities import get_workspace_by_name
+from nisystemlink.clients.auth.utilities._get_workspace_info import get_workspace_by_name
 from nisystemlink.clients.core import ApiException, HttpConfiguration
 
 

diff --git a/nisystemlink/clients/auth/_auth_client.py b/nisystemlink/clients/auth/_auth_client.py
@@ -29,5 +29,12 @@ def __init__(self, configuration: Optional[core.HttpConfiguration] = None):
 
     @get("auth")
     def get_auth_info(self) -> models.AuthInfo:
-        """Gets information about the authenticated API Key."""
+        """Gets information about the authenticated API Key.
+
+        Returns:
+            models.AuthInfo: Information about the caller.
+
+        Raises:
+            ApiException: if unable to communicate with the Auth Service.
+        """
         ...
diff --git a/nisystemlink/clients/auth/utilities/__init__.py b/nisystemlink/clients/auth/utilities/__init__.py
@@ -0,0 +1,3 @@
+from nisystemlink.clients.auth.utilities._get_workspace_info import get_workspace_by_name
+
+# flake8: noqa
diff --git a/nisystemlink/clients/auth/utilities.py → ...nts/auth/utilities/_get_workspace_info.py b/nisystemlink/clients/auth/utilities.py → ...nts/auth/utilities/_get_workspace_info.py
@@ -1,4 +1,4 @@
-"""Utilities for Auth Client."""
+"""Get workspace information."""
 
 from typing import List, Optional
Original file line number	Diff line number	Diff line change
		@@ -0,0 +1,3 @@
		from nisystemlink.clients.auth.utilities._get_workspace_info import get_workspace_by_name

		# flake8: noqa