Add healthcheck and sessions endpoints.

Author: aacic

tiatoolbox/visualization/tileserver.py

@@ -165,6 +165,8 @@ def __init__(  # noqa: PLR0915
         self.route("/tileserver/tap_query/<x>/<y>")(self.tap_query)
         self.route("/tileserver/prop_range", methods=["PUT"])(self.prop_range)
         self.route("/tileserver/shutdown", methods=["POST"])(self.shutdown)
+        self.route("/tileserver/sessions", methods=["GET"])(self.sessions)
+        self.route("/tileserver/healthcheck", methods=["GET"])(self.healthcheck)
 
     def _get_session_id(self: TileServer) -> str:
         """Get the session_id from the request.
@@ -718,6 +720,30 @@ def prop_range(self: TileServer) -> str:
         self.renderers[session_id].score_fn = lambda x: (x - minv) / (maxv - minv)
         return "done"
 
+    def sessions(self: TileServer) -> Response:
+        """Retrieve a mapping of session keys to their corresponding slide file paths.
+
+        Returns:
+            Response: A JSON response containing a mapping of session keys
+        and their respective slide file paths.
+        """
+        session_paths = {}
+        for key, layer in self.layers.items():
+            session_paths[key] = str(layer.get("slide").info.as_dict()["file_path"])
+
+        return jsonify(session_paths)
+
+    def healthcheck(self: TileServer) -> Response:
+        """Simple health check endpoint to verify the server is running.
+
+        Useful for load balancers or uptime monitoring tools to check
+        if the service is operational.
+
+        Returns:
+            Response: A JSON response with status "OK" and HTTP status code 200.
+        """
+        return jsonify({"status": "OK"})
+
     @staticmethod
     def shutdown() -> None:
         """Shutdown the tileserver."""

tiatoolbox/visualization/tileserver_api.yml

@@ -395,6 +395,24 @@ paths:
         '200':
           description: Successful response
 
+  /tileserver/sessions:
+      get:
+          summary: Returns all session/path mappings
+          responses:
+              '200':
+                  description: A jsonified session/path mappings
+                  content:
+                      application/json:
+
+  /tileserver/healthcheck:
+      get:
+          summary: Returns Ok if server is online
+          responses:
+              '200':
+                  description: A json with status field
+                  content:
+                      application/json:
+
   /tileserver/tap_query/{x}/{y}:
     get:
       summary: Query annotation at a point