diff --git a/examples/auth/get_workspace_id.py b/examples/auth/get_workspace_id.py index ed6a44a1..6cff89fd 100644 --- 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 index adeb6148..2ecaccf2 100644 --- 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 new file mode 100644 index 00000000..9ef3e7e4 --- /dev/null +++ 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 \ No newline at end of file diff --git a/nisystemlink/clients/auth/utilities.py b/nisystemlink/clients/auth/utilities/_get_workspace_info.py similarity index 94% rename from nisystemlink/clients/auth/utilities.py rename to nisystemlink/clients/auth/utilities/_get_workspace_info.py index 36bc10aa..827a4824 100644 --- a/nisystemlink/clients/auth/utilities.py +++ b/nisystemlink/clients/auth/utilities/_get_workspace_info.py @@ -1,4 +1,4 @@ -"""Utilities for Auth Client.""" +"""Get workspace information.""" from typing import List, Optional