Merge pull request #8749 from OpenMined/endpoint_markdown_descriptions

Endpoint markdown descriptions
OpenMined · Apr 29, 2024 · 156635f · 156635f
2 parents 821d97e + a8d2654
commit 156635f
Show file tree

Hide file tree

Showing 2 changed files with 16 additions and 7 deletions.
diff --git a/packages/syft/src/syft/client/api.py b/packages/syft/src/syft/client/api.py
@@ -369,7 +369,7 @@ def _repr_markdown_(self, wrap_as_python: bool = False, indent: int = 0) -> str:
             str_repr = "## API: " + custom_path + "\n"
             str_repr += (
                 "### Description: "
-                + f'<span style="font-weight: lighter;">{endpoint.description}</span><br>'
+                + f'<span style="font-weight: lighter;">{endpoint.description.text}</span><br>'
                 + "\n"
             )
             str_repr += "#### Private Code:\n"

diff --git a/packages/syft/src/syft/service/api/api.py b/packages/syft/src/syft/service/api/api.py
@@ -32,6 +32,7 @@
 from ...types.transforms import transform
 from ...types.uid import UID
 from ..context import AuthedServiceContext
+from ..dataset.dataset import MarkdownDescription
 from ..response import SyftError
 from ..user.user import UserView
 
@@ -84,7 +85,7 @@ class TwinAPIEndpointView(SyftObject):
     access: str = "Public"
     mock_function: str | None = None
     private_function: str | None = None
-    description: str | None = None
+    description: MarkdownDescription | None = None
     mock_helper_functions: list[str] | None = None
     private_helper_functions: list[str] | None = None
     worker_pool: str | None = None
@@ -328,7 +329,7 @@ class UpdateTwinAPIEndpoint(PartialSyftObject, BaseTwinAPIEndpoint):
     path: str
     private_function: PrivateAPIEndpoint | None = None
     mock_function: PublicAPIEndpoint
-    description: str | None = None
+    description: MarkdownDescription | None = None
     endpoint_timeout: int = 60
 
 
@@ -342,10 +343,18 @@ class CreateTwinAPIEndpoint(BaseTwinAPIEndpoint):
     private_function: PrivateAPIEndpoint | None = None
     mock_function: PublicAPIEndpoint
     signature: Signature
-    description: str | None = None
+    description: MarkdownDescription | None = None
     worker_pool: str | None = None
     endpoint_timeout: int = 60
 
+    def __init__(
+        self, description: str | MarkdownDescription | None = "", **kwargs: Any
+    ) -> None:
+        if isinstance(description, str):
+            description = MarkdownDescription(text=description)
+
+        super().__init__(**kwargs, description=description)
+
 
 @serializable()
 class TwinAPIEndpoint(SyncableSyftObject):
@@ -360,7 +369,7 @@ def __init__(self, **kwargs: Any) -> None:
     private_function: PrivateAPIEndpoint | None = None
     mock_function: PublicAPIEndpoint
     signature: Signature
-    description: str | None = None
+    description: MarkdownDescription | None = None
     action_object_id: UID
     worker_pool: str | None = None
     endpoint_timeout: int = 60
@@ -626,7 +635,7 @@ def api_endpoint(
     path: str,
     settings: dict[str, str] | None = None,
     helper_functions: list[Callable] | None = None,
-    description: str | None = None,
+    description: MarkdownDescription | None = None,
     worker_pool: str | None = None,
     endpoint_timeout: int = 60,
 ) -> Callable[..., TwinAPIEndpoint | SyftError]:
@@ -687,7 +696,7 @@ def create_new_api_endpoint(
     path: str,
     mock_function: Endpoint,
     private_function: Endpoint | None = None,
-    description: str | None = None,
+    description: MarkdownDescription | None = None,
     worker_pool: str | None = None,
     endpoint_timeout: int = 60,
 ) -> CreateTwinAPIEndpoint | SyftError: