From 08e0cd232dd68b38458a458213ce3ea7b2816ba3 Mon Sep 17 00:00:00 2001
From: Junyan Qin <rockchinq@gmail.com>
Date: Tue, 15 Apr 2025 22:30:45 +0800
Subject: [PATCH] perf: complete manifests for bot adapters

---
 pkg/platform/sources/aiocqhttp.yaml       | 11 ++++++++++-
 pkg/platform/sources/dingtalk.yaml        |  2 +-
 pkg/platform/sources/discord.yaml         |  2 +-
 pkg/platform/sources/gewechat.yaml        |  2 +-
 pkg/platform/sources/lark.yaml            | 11 ++++++++++-
 pkg/platform/sources/nakuru.yaml          |  2 +-
 pkg/platform/sources/officialaccount.yaml |  2 +-
 pkg/platform/sources/qqbotpy.yaml         |  2 +-
 pkg/platform/sources/qqofficial.yaml      |  2 +-
 pkg/platform/sources/telegram.yaml        |  2 +-
 pkg/platform/sources/wecom.yaml           |  5 ++++-
 11 files changed, 32 insertions(+), 11 deletions(-)

diff --git a/pkg/platform/sources/aiocqhttp.yaml b/pkg/platform/sources/aiocqhttp.yaml
index dfb0103e..b5da6a8c 100644
--- a/pkg/platform/sources/aiocqhttp.yaml
+++ b/pkg/platform/sources/aiocqhttp.yaml
@@ -7,7 +7,7 @@ metadata:
     zh_CN: OneBot v11 适配器
   description:
     en_US: OneBot v11 Adapter
-    zh_CN: OneBot v11 适配器
+    zh_CN: OneBot v11 适配器，请查看文档了解使用方式
   icon: onebot.png
 spec:
   config:
@@ -15,6 +15,9 @@ spec:
       label:
         en_US: Host
         zh_CN: 主机
+      description:
+        en_US: The host that OneBot v11 listens on for reverse WebSocket connections. Unless you know what you're doing, use 0.0.0.0
+        zh_CN: OneBot v11 监听的反向 WS 主机，除非你知道自己在做什么，否则请写 0.0.0.0
       type: string
       required: true
       default: 0.0.0.0
@@ -22,6 +25,9 @@ spec:
       label:
         en_US: Port
         zh_CN: 端口
+      description:
+        en_US: Port
+        zh_CN: 监听的端口
       type: integer
       required: true
       default: 2280
@@ -29,6 +35,9 @@ spec:
       label:
         en_US: Access Token
         zh_CN: 访问令牌
+      description:
+        en_US: Custom connection token for the protocol endpoint. If the protocol endpoint is not set, don't fill it
+        zh_CN: 自定义的与协议端的连接令牌，若协议端未设置，则不填
       type: string
       required: false
       default: ""
diff --git a/pkg/platform/sources/dingtalk.yaml b/pkg/platform/sources/dingtalk.yaml
index 9e270d6b..480d16c2 100644
--- a/pkg/platform/sources/dingtalk.yaml
+++ b/pkg/platform/sources/dingtalk.yaml
@@ -7,7 +7,7 @@ metadata:
     zh_CN: 钉钉
   description:
     en_US: DingTalk Adapter
-    zh_CN: 钉钉适配器
+    zh_CN: 钉钉适配器，请查看文档了解使用方式
   icon: dingtalk.svg
 spec:
   config:
diff --git a/pkg/platform/sources/discord.yaml b/pkg/platform/sources/discord.yaml
index d756fed2..c5aa24cc 100644
--- a/pkg/platform/sources/discord.yaml
+++ b/pkg/platform/sources/discord.yaml
@@ -7,7 +7,7 @@ metadata:
     zh_CN: Discord
   description:
     en_US: Discord Adapter
-    zh_CN: Discord 适配器
+    zh_CN: Discord 适配器，请查看文档了解使用方式
   icon: discord.svg
 spec:
   config:
diff --git a/pkg/platform/sources/gewechat.yaml b/pkg/platform/sources/gewechat.yaml
index 26ab9f14..d9473bc9 100644
--- a/pkg/platform/sources/gewechat.yaml
+++ b/pkg/platform/sources/gewechat.yaml
@@ -7,7 +7,7 @@ metadata:
     zh_CN: GeWeChat（个人微信）
   description:
     en_US: GeWeChat Adapter
-    zh_CN: GeWeChat 适配器
+    zh_CN: GeWeChat 适配器，请查看文档了解使用方式
   icon: gewechat.png
 spec:
   config:
diff --git a/pkg/platform/sources/lark.yaml b/pkg/platform/sources/lark.yaml
index 8e039988..c9bcbc69 100644
--- a/pkg/platform/sources/lark.yaml
+++ b/pkg/platform/sources/lark.yaml
@@ -7,7 +7,7 @@ metadata:
     zh_CN: 飞书
   description:
     en_US: Lark Adapter
-    zh_CN: 飞书适配器
+    zh_CN: 飞书适配器，请查看文档了解使用方式
   icon: lark.svg
 spec:
   config:
@@ -36,6 +36,9 @@ spec:
       label:
         en_US: Enable Webhook Mode
         zh_CN: 启用Webhook模式
+      description:
+        en_US: If enabled, the bot will use webhook mode to receive messages. Otherwise, it will use WS long connection mode
+        zh_CN: 如果启用，机器人将使用 Webhook 模式接收消息。否则，将使用 WS 长连接模式
       type: boolean
       required: true
       default: false
@@ -43,6 +46,9 @@ spec:
       label:
         en_US: Webhook Port
         zh_CN: Webhook端口
+      description:
+        en_US: Only valid when webhook mode is enabled, please fill in the webhook port
+        zh_CN: 仅在启用 Webhook 模式时有效，请填写 Webhook 端口
       type: integer
       required: true
       default: 2285
@@ -50,6 +56,9 @@ spec:
       label:
         en_US: Encrypt Key
         zh_CN: 加密密钥
+      description:
+        en_US: Only valid when webhook mode is enabled, please fill in the encrypt key
+        zh_CN: 仅在启用 Webhook 模式时有效，请填写加密密钥
       type: string
       required: true
       default: ""
diff --git a/pkg/platform/sources/nakuru.yaml b/pkg/platform/sources/nakuru.yaml
index cea371d1..4d1bdeff 100644
--- a/pkg/platform/sources/nakuru.yaml
+++ b/pkg/platform/sources/nakuru.yaml
@@ -7,7 +7,7 @@ metadata:
     zh_CN: Nakuru
   description:
     en_US: Nakuru Adapter
-    zh_CN: Nakuru 适配器(go-cqhttp)
+    zh_CN: Nakuru 适配器(go-cqhttp)，请查看文档了解使用方式
   icon: nakuru.png
 spec:
   config:
diff --git a/pkg/platform/sources/officialaccount.yaml b/pkg/platform/sources/officialaccount.yaml
index 3bf061d6..80b1934a 100644
--- a/pkg/platform/sources/officialaccount.yaml
+++ b/pkg/platform/sources/officialaccount.yaml
@@ -7,7 +7,7 @@ metadata:
     zh_CN: 微信公众号
   description:
     en_US: Official Account Adapter
-    zh_CN: 微信公众号适配器
+    zh_CN: 微信公众号适配器，请查看文档了解使用方式
   icon: officialaccount.png
 spec:
   config:
diff --git a/pkg/platform/sources/qqbotpy.yaml b/pkg/platform/sources/qqbotpy.yaml
index 0749fa63..524e7cdc 100644
--- a/pkg/platform/sources/qqbotpy.yaml
+++ b/pkg/platform/sources/qqbotpy.yaml
@@ -7,7 +7,7 @@ metadata:
     zh_CN: QQBotPy
   description:
     en_US: QQ Official API (WebSocket)
-    zh_CN: QQ 官方 API (WebSocket)
+    zh_CN: QQ 官方 API (WebSocket)，请查看文档了解使用方式
   icon: qqbotpy.svg
 spec:
   config:
diff --git a/pkg/platform/sources/qqofficial.yaml b/pkg/platform/sources/qqofficial.yaml
index c0cfdec3..61881e29 100644
--- a/pkg/platform/sources/qqofficial.yaml
+++ b/pkg/platform/sources/qqofficial.yaml
@@ -7,7 +7,7 @@ metadata:
     zh_CN: QQ 官方 API
   description:
     en_US: QQ Official API (Webhook)
-    zh_CN: QQ 官方 API (Webhook)
+    zh_CN: QQ 官方 API (Webhook)，请查看文档了解使用方式
   icon: qqofficial.svg
 spec:
   config:
diff --git a/pkg/platform/sources/telegram.yaml b/pkg/platform/sources/telegram.yaml
index f9eca6c3..4da2b514 100644
--- a/pkg/platform/sources/telegram.yaml
+++ b/pkg/platform/sources/telegram.yaml
@@ -7,7 +7,7 @@ metadata:
     zh_CN: 电报
   description:
     en_US: Telegram Adapter
-    zh_CN: 电报适配器
+    zh_CN: 电报适配器，请查看文档了解使用方式
   icon: telegram.svg
 spec:
   config:
diff --git a/pkg/platform/sources/wecom.yaml b/pkg/platform/sources/wecom.yaml
index 74008a3b..68f73e8a 100644
--- a/pkg/platform/sources/wecom.yaml
+++ b/pkg/platform/sources/wecom.yaml
@@ -7,7 +7,7 @@ metadata:
     zh_CN: 企业微信
   description:
     en_US: WeCom Adapter
-    zh_CN: 企业微信适配器
+    zh_CN: 企业微信适配器，请查看文档了解使用方式
   icon: wecom.png
 spec:
   config:
@@ -15,6 +15,9 @@ spec:
       label:
         en_US: Host
         zh_CN: 监听主机
+      description:
+        en_US: Webhook host, unless you know what you're doing, please write 0.0.0.0
+        zh_CN: Webhook 监听主机，除非你知道自己在做什么，否则请写 0.0.0.0
       type: string
       required: true
       default: "0.0.0.0"