[Bug]: README's for integrations are statically pulled from GitHub, instead of serving it locally (#11895)

Author: setohe0909

mindsdb/api/http/namespaces/handlers.py

@@ -24,6 +24,21 @@
 logger = log.getLogger(__name__)
 
 
+def _resolve_handler_readme_path(handler_folder: str) -> Path:
+    handler_folder_name = Path(handler_folder).name
+    if handler_folder_name != handler_folder or ".." in handler_folder:
+        raise ValueError(f"Handler folder '{handler_folder}' is invalid.")
+
+    mindsdb_path = Path(importlib.util.find_spec("mindsdb").origin).parent
+    base_handlers_path = mindsdb_path.joinpath("integrations/handlers").resolve()
+    readme_path = base_handlers_path.joinpath(handler_folder_name).joinpath("README.md").resolve()
+
+    if base_handlers_path not in readme_path.parents:
+        raise ValueError(f"Handler folder '{handler_folder}' is invalid.")
+
+    return readme_path
+
+
 @ns_conf.route("/")
 class HandlersList(Resource):
     @ns_conf.doc("handlers_list")
@@ -82,6 +97,52 @@ def get(self, handler_name):
         return row
 
 
+@ns_conf.route("/<handler_name>/readme")
+class HandlerReadme(Resource):
+    @ns_conf.param("handler_name", "Handler name")
+    @api_endpoint_metrics("GET", "/handlers/handler/readme")
+    def get(self, handler_name):
+        try:
+            handler_meta = ca.integration_controller.get_handler_meta(handler_name)
+        except Exception:
+            return http_error(
+                HTTPStatus.NOT_FOUND,
+                "Readme not found",
+                f"Handler '{handler_name}' not found",
+            )
+
+        def make_response(*, error_message=None, readme=None):
+            return {"name": handler_name, "readme": readme, "error_message": error_message}
+
+        if handler_meta is None:
+            error_message = f"Handler '{handler_name}' not found"
+            logger.warning(error_message)
+            return make_response(error_message=error_message)
+
+        handler_folder = handler_meta.get("import", {}).get("folder")
+        if handler_folder is None:
+            error_message = f"Handler '{handler_name}' does not define a folder"
+            logger.warning(error_message)
+            return make_response(error_message=error_message)
+
+        try:
+            readme_path = _resolve_handler_readme_path(handler_folder)
+        except ValueError as exc:
+            error_message = str(exc)
+            logger.warning(error_message)
+            return make_response(error_message=error_message)
+
+        try:
+            with open(readme_path, "r", encoding="utf-8") as readme_file:
+                readme_content = readme_file.read()
+        except FileNotFoundError:
+            error_message = f"README.md for handler '{handler_name}' not found"
+            logger.warning(error_message)
+            return make_response(error_message=error_message)
+
+        return make_response(readme=readme_content)
+
+
 @ns_conf.route("/<handler_name>/install")
 class InstallDependencies(Resource):
     @ns_conf.param("handler_name", "Handler name")