Skip to content

Commit bf10677

Browse files
committed
docs: Add names to return values for better readability
1 parent a48389a commit bf10677

File tree

1 file changed

+9
-5
lines changed
  • packages/toolbox-core/src/toolbox_core

1 file changed

+9
-5
lines changed

packages/toolbox-core/src/toolbox_core/utils.py

Lines changed: 9 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -60,11 +60,15 @@ def identify_required_authn_params(
6060
6161
Returns:
6262
A tuple containing:
63-
- A new dictionary representing the subset of required
64-
authentication parameters that are not covered by the provided
65-
`auth_service_names`.
66-
- A list of authentication service names from `auth_service_names`
67-
that were found to satisfy at least one parameter's requirements.
63+
- required_authn_params: A new dictionary representing the subset of
64+
required authentication parameters that are not covered by the
65+
provided `auth_service_names`.
66+
- required_authz_tokens: A list of required authorization tokens if
67+
no service name in `auth_service_names` matches any token in
68+
`req_authz_tokens`. If any match is found, this list is empty.
69+
- used_services: A set of service names from `auth_service_names`
70+
that were found to satisfy at least one authentication parameter's
71+
requirements or matched one of the `req_authz_tokens`.
6872
"""
6973
required_params: dict[str, list[str]] = {}
7074
used_services: set[str] = set()

0 commit comments

Comments
 (0)