From 26a3cbe3a7f11853daa5131f365ca4fc46e7feeb Mon Sep 17 00:00:00 2001 From: Pavel Tisnovsky Date: Sun, 28 Sep 2025 16:09:12 +0200 Subject: [PATCH 1/2] LCORE-700: better docstring for root endpoint handler --- src/app/endpoints/root.py | 9 ++++++++- 1 file changed, 8 insertions(+), 1 deletion(-) diff --git a/src/app/endpoints/root.py b/src/app/endpoints/root.py index 080dd37a..3bdf01df 100644 --- a/src/app/endpoints/root.py +++ b/src/app/endpoints/root.py @@ -783,7 +783,14 @@ async def root_endpoint_handler( auth: Annotated[AuthTuple, Depends(auth_dependency)], request: Request, ) -> HTMLResponse: - """Handle request to the / endpoint.""" + """ + Handle GET requests to the root ("/") endpoint and returns the static HTML index page. + + Returns: + HTMLResponse: The HTML content of the index page, including a heading, + embedded image with the service icon, and links to the API documentation + via Swagger UI and ReDoc. + """ # Used only for authorization _ = auth From b56b7cacf3da7f0c5a1a600ba2464ff0d79fa2dd Mon Sep 17 00:00:00 2001 From: Pavel Tisnovsky Date: Sun, 28 Sep 2025 16:16:22 +0200 Subject: [PATCH 2/2] Update docstring for utils module --- src/utils/__init__.py | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/src/utils/__init__.py b/src/utils/__init__.py index b54d80e4..1ce0c0fc 100644 --- a/src/utils/__init__.py +++ b/src/utils/__init__.py @@ -1 +1 @@ -"""Utils.""" +"""Utility classes and functions for the Lightspeed Stack core service."""