Enhance/add description

api/api_schemas.py

@@ -96,6 +96,8 @@ class BlockInfo(BaseModel):
     slots: List[Parameter]
     inports: List[Parameter]
     outport: str  # the output class name
+    description: str
+    examples: str
 
 
 class ApplicationBlocksResponse(APIModel):

api/application.py

@@ -147,6 +147,8 @@ def blocks(self) -> ApplicationBlocksResponse:
                         slots=self.resolve_params(self.resolver.slots(name)),
                         inports=self.resolve_params(self.resolver.inports(name)),
                         outport=self.resolver.relookup(self.resolver.outport(name)),
+                        description=self.resolver.lookup(name, "description"),
+                        examples=self.resolver.lookup(name, "examples"),
                     )
                 )
 

blocks/llm.py

@@ -10,7 +10,13 @@
 from .base import BaseBlock
 
 
-@block(name="LLM", kind="llm")
+@block(
+    name="LLM",
+    kind="llm",
+    description="""test
+test new line""",
+    examples="""this is a text""",
+)
 class LLMChain(BaseBlock):
     """
     LLMChain render template with given text and pass the result to llm model.

resolver/resolver.py

@@ -196,13 +196,17 @@ def outport(self, name: str) -> Optional[type]:
         return signature.return_annotation
 
 
-def block(name: str, kind: str, alias: str = None):
+def block(
+    name: str, kind: str, alias: str = None, description: str = "", examples: str = ""
+):
     """
     Decorator for registering a block class.
     Args:
         name: The name of the block.
         kind: The kind of the block (e.g., 'input', 'output').
         alias: An optional alias for the block name.
+        description: The description of the block.
+        examples: Examples about the usage of the block.
     Returns:
         The decorated class.
     """
@@ -215,6 +219,8 @@ def decorator(cls):
                 "category": "block",
                 "dir": kind,
                 "class": cls,
+                "description": description,
+                "examples": examples,
             }
         )
         return cls