diff --git a/src/app/endpoints/authorized.py b/src/app/endpoints/authorized.py index 3a24382bb..bce5be9bd 100644 --- a/src/app/endpoints/authorized.py +++ b/src/app/endpoints/authorized.py @@ -31,6 +31,8 @@ async def authorized_endpoint_handler( Process POST requests to the /authorized endpoint, returning the authenticated user's ID and username. + The response intentionally omits any authentication token. + Returns: AuthorizedResponse: Contains the user ID and username of the authenticated user. """ diff --git a/src/app/endpoints/config.py b/src/app/endpoints/config.py index 9c464ff22..46b668fba 100644 --- a/src/app/endpoints/config.py +++ b/src/app/endpoints/config.py @@ -44,6 +44,8 @@ async def config_endpoint_handler( Process GET requests to the /config endpoint and returns the current service configuration. + Ensures the application configuration is loaded before returning it. + Returns: ConfigurationResponse: The loaded service configuration response. """ diff --git a/src/app/endpoints/info.py b/src/app/endpoints/info.py index e3cfb84ea..e28000532 100644 --- a/src/app/endpoints/info.py +++ b/src/app/endpoints/info.py @@ -44,6 +44,12 @@ async def info_endpoint_handler( Process GET requests to the /info endpoint, returning the service name, version and Llama-stack version. + Raises: + HTTPException: with status 500 and a detail object + containing `response` and `cause` when unable to connect to + Llama Stack. It can also return status 401 or 403 for + unauthorized access. + Returns: InfoResponse: An object containing the service's name and version. """