Merge pull request #1058 from tisnik/lcore-1142-minor-updates-in-docstrings

LCORE-1142: minor updates in docstrings

Author: tisnik

src/app/endpoints/feedback.py

@@ -151,6 +151,9 @@ def store_feedback(user_id: str, feedback: dict) -> None:
     Parameters:
         user_id (str): Unique identifier of the user submitting feedback.
         feedback (dict): Feedback data to be stored, merged with user ID and timestamp.
+
+    Raises:
+        HTTPException: If writing the feedback file fails (HTTP 500).
     """
     logger.debug("Storing feedback for user %s", user_id)
     # Creates storage path only if it doesn't exist. The `exist_ok=True` prevents

src/app/endpoints/health.py

@@ -96,6 +96,11 @@ async def readiness_probe_get_method(
     If any provider reports an error status, responds with HTTP 503
     and details of unhealthy providers; otherwise, indicates the
     service is ready.
+
+    Returns:
+        ReadinessResponse: Object with `ready` indicating overall readiness,
+        `reason` explaining the outcome, and `providers` containing the list of
+        unhealthy ProviderHealthStatus entries (empty when ready).
     """
     # Used only for authorization
     _ = auth

src/app/endpoints/metrics.py

@@ -51,6 +51,10 @@ async def metrics_endpoint_handler(
     Initializes model metrics on the first request if not already
     set up, then responds with the current metrics snapshot in
     Prometheus format.
+
+    Returns:
+        PlainTextResponse: Response body containing the Prometheus metrics text
+        and the Prometheus content type.
     """
     # Used only for authorization
     _ = auth