Add API Gateway summary & description

Author: MU-Software

runtime/chalicelib/route/health_check.py

@@ -6,12 +6,14 @@
 
 
 @health_check_api.route("/readyz", methods=["GET"])
+@chalice_util.api_gateway_desc(summary="Readiness probe", description="Check if the service is ready")
 @chalice_util.exception_catcher
 def readyz() -> dict[str, str]:
     return {"status": "ok"}
 
 
 @health_check_api.route("/livez", methods=["GET"])
+@chalice_util.api_gateway_desc(summary="Liveness probe", description="Check if the service is live")
 @chalice_util.exception_catcher
 def livez() -> dict[str, str]:
     return {"status": "ok"}

runtime/chalicelib/route/index.py

@@ -6,6 +6,7 @@
 
 
 @index_api.route("/service", methods=["GET"])
+@chalice_util.api_gateway_desc(summary="Service identity", description="Get service identity")
 @chalice_util.exception_catcher
 def get_service_identity() -> dict[str, str]:
     return {"service": "notico"}

runtime/chalicelib/route/send_manager.py

@@ -11,6 +11,7 @@
 
 
 @send_manager_api.route("/", methods=["GET"])
+@chalice_util.api_gateway_desc(summary="List send manager services", description="List all send manager services")
 @chalice_util.exception_catcher
 def list_send_manager_services() -> list[dict[str, str | bool | dict]]:
     return [
@@ -24,6 +25,7 @@ def list_send_manager_services() -> list[dict[str, str | bool | dict]]:
 
 
 @send_manager_api.route("/{service_name}", methods=["POST"])
+@chalice_util.api_gateway_desc(summary="Send message", description="Send message using the service")
 @chalice_util.exception_catcher
 def send_message(service_name: str) -> dict[str, str | None]:
     request: chalice.app.Request = send_manager_api.current_request

runtime/chalicelib/route/template_manager.py

@@ -12,6 +12,10 @@
 
 
 @template_manager_api.route("/", methods=["GET"])
+@chalice_util.api_gateway_desc(
+    summary="List template manager services",
+    description="List all template manager services",
+)
 @chalice_util.exception_catcher
 def list_template_manager_services() -> list[dict[str, str]]:
     return [
@@ -25,6 +29,7 @@ def list_template_manager_services() -> list[dict[str, str]]:
 
 
 @template_manager_api.route("/{service_name}", methods=["GET"])
+@chalice_util.api_gateway_desc(summary="List templates", description="List all templates in the service")
 @chalice_util.exception_catcher
 def list_templates(service_name: str) -> list[dict[str, str]]:
     if service_name not in template_manager.template_managers:
@@ -33,6 +38,7 @@ def list_templates(service_name: str) -> list[dict[str, str]]:
 
 
 @template_manager_api.route("/{service_name}/{template_code}", methods=["GET", "POST", "PUT", "DELETE"])
+@chalice_util.api_gateway_desc(summary="CRUD template", description="Create, Read, Update, Delete template")
 @chalice_util.exception_catcher
 def crud_template(service_name: str, template_code: str) -> dict[str, str]:
     request: chalice.app.Request = template_manager_api.current_request
@@ -62,6 +68,7 @@ def crud_template(service_name: str, template_code: str) -> dict[str, str]:
 
 
 @template_manager_api.route("/{service_name}/{template_code}/render", methods=["POST"])
+@chalice_util.api_gateway_desc(summary="Render template", description="Render template with given context")
 @chalice_util.exception_catcher
 def render_template(service_name: str, template_code: str) -> dict[str, str]:
     request: chalice.app.Request = template_manager_api.current_request

runtime/chalicelib/util/chalice_util.py

@@ -6,9 +6,18 @@
 
 Param = typing.ParamSpec("Param")
 RetType = typing.TypeVar("RetType")
+FuncType = typing.Callable[Param, RetType]
 ReqHandlerType = typing.Callable[[chalice.app.Request], chalice.app.Response]
 
 
+def api_gateway_desc(summary: str, description: str | None = None) -> typing.Callable[[FuncType], FuncType]:
+    def decorator(func: FuncType) -> FuncType:
+        func.__doc__ = f"{summary}\n{description}" if description else summary
+        return func
+
+    return decorator
+
+
 def exception_catcher(func: typing.Callable[Param, RetType]) -> typing.Callable[Param, RetType]:
     @functools.wraps(wrapped=func)
     def wrapper(*args: Param.args, **kwargs: Param.kwargs) -> RetType: