@juzi/wechaty-grpc 1.0.26 → 1.0.28

package/dist/cjs/out/wechaty/puppet.swagger.json

@@ -3,7 +3,7 @@
   "info": {
     "title": "Wechaty Puppet Service OpenAPI Specification",
     "description": "Wechaty is a Conversational RPA SDK for chatbot makers. With only 6 lines of code, you can create a bot on the most popular IMs like WeChat, Whatsapp, WeCom, Gitter, etc.\n\nWechaty Puppet Service is the RESTful API for Wechaty API, which is build on top of the Wechaty Puppet Abstraction and the gRPC proto definition.",
-    "version": "1.0.26",
+    "version": "1.0.28",
     "contact": {
       "name": "Wechaty",
       "url": "https://github.com/wechaty/openapi",
@@ -167,7 +167,8 @@
               "type": "object",
               "properties": {
                 "corporationRemarkStringValueDeprecated": {
-                  "type": "string"
+                  "type": "string",
+                  "title": "DEPRECATED, will be removed after Dec 31, 2022"
                 },
                 "corporationRemark": {
                   "type": "string"
@@ -213,7 +214,8 @@
               "type": "object",
               "properties": {
                 "descriptionStringValueDeprecated": {
-                  "type": "string"
+                  "type": "string",
+                  "title": "DEPRECATED, will be removed after Dec 31, 2022"
                 },
                 "description": {
                   "type": "string"
@@ -368,6 +370,7 @@
               "properties": {
                 "aliasStringValueDeprecated": {
                   "type": "string",
+                  "description": "DEPRECATED, will be removed after Dec 31, 2022",
                   "title": "nullable"
                 },
                 "alias": {
@@ -408,6 +411,7 @@
           },
           {
             "name": "fileboxStringValueDeprecated",
+            "description": "DEPRECATED, will be removed after Dec 31, 2022",
             "in": "query",
             "required": false,
             "type": "string"
@@ -460,6 +464,7 @@
               "PAYLOAD_TYPE_ROOM",
               "PAYLOAD_TYPE_ROOM_MEMBER",
               "PAYLOAD_TYPE_FRIENDSHIP",
+              "PAYLOAD_TYPE_POST",
               "PAYLOAD_TYPE_TAG",
               "PAYLOAD_TYPE_TAG_GROUP"
             ],
@@ -617,12 +622,14 @@
         "parameters": [
           {
             "name": "conversationId",
+            "description": "对话id",
             "in": "path",
             "required": true,
             "type": "string"
           },
           {
             "name": "messageId",
+            "description": "要转发的消息id",
             "in": "path",
             "required": true,
             "type": "string"
@@ -696,6 +703,7 @@
         "parameters": [
           {
             "name": "conversationId",
+            "description": "对话id",
             "in": "path",
             "required": true,
             "type": "string"
@@ -709,10 +717,12 @@
               "properties": {
                 "miniProgramDeprecated": {
                   "type": "string",
+                  "description": "deprecated after Sep 31, 2021, remove compatible code after Dec 31, 2022",
                   "title": "*\nHuan(202110): We should use payload instead of JSON.stringify string\n The compatible code will be removed after Dec 31, 2022"
                 },
                 "miniProgram": {
-                  "$ref": "#/definitions/puppetMiniProgramPayload"
+                  "$ref": "#/definitions/puppetMiniProgramPayload",
+                  "title": "小程序payload"
                 }
               }
             }
@@ -743,6 +753,7 @@
         "parameters": [
           {
             "name": "conversationId",
+            "description": "对话id",
             "in": "path",
             "required": true,
             "type": "string"
@@ -755,18 +766,22 @@
               "type": "object",
               "properties": {
                 "text": {
-                  "type": "string"
+                  "type": "string",
+                  "title": "文本内容"
                 },
                 "mentionalIds": {
                   "type": "array",
                   "items": {
                     "type": "string"
-                  }
+                  },
+                  "title": "@人id列表"
                 },
                 "quoteId": {
-                  "type": "string"
+                  "type": "string",
+                  "title": "引用消息的id"
                 }
-              }
+              },
+              "title": "发文本消息"
             }
           }
         ],
@@ -795,6 +810,7 @@
         "parameters": [
           {
             "name": "conversationId",
+            "description": "对话id",
             "in": "path",
             "required": true,
             "type": "string"
@@ -808,10 +824,12 @@
               "properties": {
                 "urlLinkDeprecated": {
                   "type": "string",
+                  "description": "deprecated after Sep 31, 2021, remove compatible code after Dec 31, 2022",
                   "title": "*\nHuan(202110): We should use payload instead of JSON.stringify string\n The compatible code will be removed after Dec 31, 2022"
                 },
                 "urlLink": {
-                  "$ref": "#/definitions/puppetUrlLinkPayload"
+                  "$ref": "#/definitions/puppetUrlLinkPayload",
+                  "title": "链接payload"
                 }
               }
             }
@@ -1014,10 +1032,12 @@
                   "type": "string"
                 },
                 "sourceRoomIdStringValueDeprecated": {
-                  "type": "string"
+                  "type": "string",
+                  "title": "Deprecated: will be removed after Dec 31, 2022"
                 },
                 "sourceContactIdStringValueDeprecated": {
-                  "type": "string"
+                  "type": "string",
+                  "title": "Deprecated: will be removed after Dec 31, 2022"
                 },
                 "referrer": {
                   "$ref": "#/definitions/puppetReferrer"
@@ -1120,7 +1140,7 @@
           },
           {
             "name": "payloadStringValueDeprecated",
-            "description": "*\nHuan(202003):\n What's the reason we need belowing payload?\n We should remove it if possible.",
+            "description": "*\nHuan(202003):\n What's the reason we need belowing payload?\n We should remove it if possible.\n\nDEPRECATED, will be removed after Dec 31, 2022",
             "in": "query",
             "required": false,
             "type": "string"
@@ -1173,6 +1193,7 @@
               "PAYLOAD_TYPE_ROOM",
               "PAYLOAD_TYPE_ROOM_MEMBER",
               "PAYLOAD_TYPE_FRIENDSHIP",
+              "PAYLOAD_TYPE_POST",
               "PAYLOAD_TYPE_TAG",
               "PAYLOAD_TYPE_TAG_GROUP"
             ],
@@ -1332,6 +1353,7 @@
               "PAYLOAD_TYPE_ROOM",
               "PAYLOAD_TYPE_ROOM_MEMBER",
               "PAYLOAD_TYPE_FRIENDSHIP",
+              "PAYLOAD_TYPE_POST",
               "PAYLOAD_TYPE_TAG",
               "PAYLOAD_TYPE_TAG_GROUP"
             ],
@@ -1513,12 +1535,14 @@
         "parameters": [
           {
             "name": "messageId",
+            "description": "要转发的消息id",
             "in": "path",
             "required": true,
             "type": "string"
           },
           {
             "name": "conversationId",
+            "description": "对话id",
             "in": "path",
             "required": true,
             "type": "string"
@@ -1749,7 +1773,7 @@
           },
           {
             "name": "payloadStringValueDeprecated",
-            "description": "*\nHuan(202002): `payload` should be removed.\n The puppet server should take the responsibilities\n for storing the unaccepted friend-request payload.\n\n@deprecated: use payload instead.\n Huan(202109): Wrapper types must not be used going forward.\n   https://cloud.google.com/apis/design/design_patterns#optional_primitive_fields",
+            "description": "*\nHuan(202002): `payload` should be removed.\n The puppet server should take the responsibilities\n for storing the unaccepted friend-request payload.\n\n@deprecated: use payload instead.\n Huan(202109): Wrapper types must not be used going forward.\n   https://cloud.google.com/apis/design/design_patterns#optional_primitive_fields\n\nDeprecated: will be removed after Dec 31, 2022",
             "in": "query",
             "required": false,
             "type": "string"
@@ -1934,12 +1958,14 @@
           },
           {
             "name": "contactId",
+            "description": "被邀请联系人id",
             "in": "path",
             "required": true,
             "type": "string"
           },
           {
             "name": "inviteOnly",
+            "description": "不明确，目前没见到使用这个的地方",
             "in": "query",
             "required": false,
             "type": "boolean"
@@ -1976,6 +2002,7 @@
           },
           {
             "name": "textStringValueDeprecated",
+            "description": "DEPRECATED, will be removed after Dec 31, 2022",
             "in": "query",
             "required": false,
             "type": "string"
@@ -2022,12 +2049,14 @@
               "type": "object",
               "properties": {
                 "textStringValueDeprecated": {
-                  "type": "string"
+                  "type": "string",
+                  "title": "DEPRECATED, will be removed after Dec 31, 2022"
                 },
                 "text": {
                   "type": "string"
                 }
-              }
+              },
+              "title": "群公告"
             }
           }
         ],
@@ -2102,6 +2131,7 @@
               "PAYLOAD_TYPE_ROOM",
               "PAYLOAD_TYPE_ROOM_MEMBER",
               "PAYLOAD_TYPE_FRIENDSHIP",
+              "PAYLOAD_TYPE_POST",
               "PAYLOAD_TYPE_TAG",
               "PAYLOAD_TYPE_TAG_GROUP"
             ],
@@ -2149,6 +2179,7 @@
               "PAYLOAD_TYPE_ROOM",
               "PAYLOAD_TYPE_ROOM_MEMBER",
               "PAYLOAD_TYPE_FRIENDSHIP",
+              "PAYLOAD_TYPE_POST",
               "PAYLOAD_TYPE_TAG",
               "PAYLOAD_TYPE_TAG_GROUP"
             ],
@@ -2186,6 +2217,7 @@
           },
           {
             "name": "contactId",
+            "description": "Deprecated, will be removed after bot updated",
             "in": "path",
             "required": true,
             "type": "string"
@@ -2330,6 +2362,7 @@
           },
           {
             "name": "topicStringValueDeprecated",
+            "description": "DEPRECATED, will be removed after Dec 31, 2022",
             "in": "query",
             "required": false,
             "type": "string"
@@ -3040,7 +3073,7 @@
         "parameters": [
           {
             "name": "body",
-            "description": " (streaming inputs)",
+            "description": "*\n Huan(202110): `oneof xxx {}` seems equal with `optional`?\n  to be confirmed. (streaming inputs)",
             "in": "body",
             "required": true,
             "schema": {
@@ -3068,29 +3101,37 @@
       "type": "object",
       "properties": {
         "avatar": {
-          "type": "string"
+          "type": "string",
+          "title": "头像"
         },
         "coverUrl": {
-          "type": "string"
+          "type": "string",
+          "title": "封面地址"
         },
         "desc": {
-          "type": "string"
+          "type": "string",
+          "title": "描述"
         },
         "extras": {
-          "type": "string"
+          "type": "string",
+          "title": "额外信息，暂不明确含义，但传错会导致无法发出（红色感叹号）。应根据收到的视频号的extras字段填入。"
         },
         "feedType": {
           "type": "integer",
-          "format": "int32"
+          "format": "int32",
+          "title": "暂不明确含义，目前请固定传4"
         },
         "nickname": {
-          "type": "string"
+          "type": "string",
+          "title": "用户名"
         },
         "thumbUrl": {
-          "type": "string"
+          "type": "string",
+          "title": "缩略图地址"
         },
         "url": {
-          "type": "string"
+          "type": "string",
+          "title": "视频号地址"
         }
       }
     },
@@ -3098,7 +3139,8 @@
       "type": "object",
       "properties": {
         "aliasStringValueDeprecated": {
-          "type": "string"
+          "type": "string",
+          "title": "DEPRECATED, will be removed after Dec 31, 2022"
         },
         "alias": {
           "type": "string"
@@ -3109,7 +3151,8 @@
       "type": "object",
       "properties": {
         "fileboxStringValueDeprecated": {
-          "type": "string"
+          "type": "string",
+          "title": "DEPRECATED, will be removed after Dec 31, 2022"
         },
         "fileBox": {
           "type": "string"
@@ -3129,7 +3172,9 @@
         "CONTACT_GENDER_MALE",
         "CONTACT_GENDER_FEMALE"
       ],
-      "default": "CONTACT_GENDER_UNSPECIFIED"
+      "default": "CONTACT_GENDER_UNSPECIFIED",
+      "description": "- CONTACT_GENDER_UNSPECIFIED: 不明确\n - CONTACT_GENDER_MALE: 男\n - CONTACT_GENDER_FEMALE: 女",
+      "title": "性别枚举"
     },
     "puppetContactListResponse": {
       "type": "object",
@@ -3149,68 +3194,86 @@
           "type": "string"
         },
         "gender": {
-          "$ref": "#/definitions/puppetContactGender"
+          "$ref": "#/definitions/puppetContactGender",
+          "title": "性别"
         },
         "type": {
-          "$ref": "#/definitions/puppetContactType"
+          "$ref": "#/definitions/puppetContactType",
+          "title": "类型"
         },
         "name": {
-          "type": "string"
+          "type": "string",
+          "title": "姓名"
         },
         "avatar": {
-          "type": "string"
+          "type": "string",
+          "title": "头像"
         },
         "address": {
-          "type": "string"
+          "type": "string",
+          "title": "地址"
         },
         "alias": {
-          "type": "string"
+          "type": "string",
+          "title": "别名，即备注"
         },
         "city": {
-          "type": "string"
+          "type": "string",
+          "title": "城市"
         },
         "friend": {
-          "type": "boolean"
+          "type": "boolean",
+          "title": "是否为好友"
         },
         "province": {
-          "type": "string"
+          "type": "string",
+          "title": "省份"
         },
         "signature": {
-          "type": "string"
+          "type": "string",
+          "title": "签名"
         },
         "star": {
-          "type": "boolean"
+          "type": "boolean",
+          "title": "是否为特别好友"
         },
         "weixin": {
           "type": "string",
-          "description": "*\nHuan(202203): in gRPC, we can freely rename the field name as long as the number keep consistent.\n so we can just rename `weixin` to `handle` here.\n\n(Huan(20220329): use `weixin` for now, until we upgrade to v2.0\n the `wechaty-grpc@1.0.0` will use the latest v1.x automatically when running `npm install`\n   which will causing a breaking change.\n @link https://github.com/wechaty/getting-started/issues/254\n\nTODO: rename `weixin` to `handle` in v2.0.0"
+          "description": "*\nHuan(202203): in gRPC, we can freely rename the field name as long as the number keep consistent.\n so we can just rename `weixin` to `handle` here.\n\n(Huan(20220329): use `weixin` for now, until we upgrade to v2.0\n the `wechaty-grpc@1.0.0` will use the latest v1.x automatically when running `npm install`\n   which will causing a breaking change.\n @link https://github.com/wechaty/getting-started/issues/254\n\nTODO: rename `weixin` to `handle` in v2.0.0\n\nIM专属id，在企微环境中特指weixinId"
         },
         "corporation": {
-          "type": "string"
+          "type": "string",
+          "title": "企业"
         },
         "title": {
-          "type": "string"
+          "type": "string",
+          "title": "头衔"
         },
         "description": {
-          "type": "string"
+          "type": "string",
+          "title": "描述"
         },
         "coworker": {
-          "type": "boolean"
+          "type": "boolean",
+          "title": "是否为同事"
         },
         "phones": {
           "type": "array",
           "items": {
             "type": "string"
-          }
+          },
+          "title": "电话号码，企微中最多5个"
         },
         "additionalInfo": {
-          "type": "string"
+          "type": "string",
+          "title": "额外信息，是由JS对象stringify得到的字符串，目前支持的内容包含addContactTime、corpId等。"
         },
         "tagIds": {
           "type": "array",
           "items": {
             "type": "string"
-          }
+          },
+          "title": "标签（的id）"
         }
       }
     },
@@ -3255,7 +3318,9 @@
         "CONTACT_TYPE_OFFICIAL",
         "CONTACT_TYPE_CORPORATION"
       ],
-      "default": "CONTACT_TYPE_UNSPECIFIED"
+      "default": "CONTACT_TYPE_UNSPECIFIED",
+      "description": "- CONTACT_TYPE_UNSPECIFIED: 不明确\n - CONTACT_TYPE_PERSONAL: 个微联系人\n - CONTACT_TYPE_OFFICIAL: 公众号\n - CONTACT_TYPE_CORPORATION: 企微联系人",
+      "title": "类型枚举"
     },
     "puppetConversationReadResponse": {
       "type": "object"
@@ -3277,7 +3342,8 @@
       }
     },
     "puppetDingResponse": {
-      "type": "object"
+      "type": "object",
+      "title": "*\n Ding has no return value\n  Puppet should emit a `ding` event when it receives a `ding()` call"
     },
     "puppetDirtyPayloadResponse": {
       "type": "object"
@@ -3299,6 +3365,7 @@
         },
         "payload": {
           "type": "string",
+          "description": "JSON.stringify({ ... })",
           "title": "TODO: Huan(202002) consider to use a PB Map?"
         }
       }
@@ -3339,9 +3406,11 @@
           "title": "oneof payload {"
         },
         "name": {
-          "type": "string"
+          "type": "string",
+          "title": "}"
         }
-      }
+      },
+      "description": "*\n Huan(202110): `oneof xxx {}` seems equal with `optional`?\n  to be confirmed."
     },
     "puppetFriendshipAcceptResponse": {
       "type": "object"
@@ -3356,22 +3425,28 @@
           "type": "string"
         },
         "contactId": {
-          "type": "string"
+          "type": "string",
+          "title": "加好友的联系人id"
         },
         "hello": {
-          "type": "string"
+          "type": "string",
+          "title": "加好友的打招呼消息"
         },
         "type": {
-          "$ref": "#/definitions/puppetFriendshipType"
+          "$ref": "#/definitions/puppetFriendshipType",
+          "title": "好友事件类型"
         },
         "stranger": {
-          "type": "string"
+          "type": "string",
+          "title": "不明确含义，wxwork中未使用"
         },
         "ticket": {
-          "type": "string"
+          "type": "string",
+          "title": "个微遗留字段，wxwork中会传corp_id"
         },
         "scene": {
-          "$ref": "#/definitions/puppetFriendshipSceneType"
+          "$ref": "#/definitions/puppetFriendshipSceneType",
+          "title": "加好友的场景（例如通过名片添加、通过群添加等），wxwork未使用"
         }
       }
     },
@@ -3391,7 +3466,8 @@
         "FRIENDSHIP_SCENE_TYPE_SHAKING",
         "FRIENDSHIP_SCENE_TYPE_QRCODE"
       ],
-      "default": "FRIENDSHIP_SCENE_TYPE_UNSPECIFIED"
+      "default": "FRIENDSHIP_SCENE_TYPE_UNSPECIFIED",
+      "title": "事件场景 wxwork中未使用"
     },
     "puppetFriendshipSearchHandleRequest": {
       "type": "object",
@@ -3408,6 +3484,7 @@
       "properties": {
         "contactIdStringValueDeprecated": {
           "type": "string",
+          "description": "DEPRECATED, will be removed after Dec 31, 2022",
           "title": "nullable"
         },
         "contactId": {
@@ -3420,6 +3497,7 @@
       "properties": {
         "contactIdStringValueDeprecated": {
           "type": "string",
+          "description": "DEPRECATED, will be removed after Dec 31, 2022",
           "title": "nullable"
         },
         "contactId": {
@@ -3437,7 +3515,9 @@
         "FRIENDSHIP_TYPE_DELETE",
         "FRIENDSHIP_TYPE_REMOVED"
       ],
-      "default": "FRIENDSHIP_TYPE_UNSPECIFIED"
+      "default": "FRIENDSHIP_TYPE_UNSPECIFIED",
+      "description": "- FRIENDSHIP_TYPE_UNSPECIFIED: 不明确\n - FRIENDSHIP_TYPE_CONFIRM: 确认——双方互加后触发\n - FRIENDSHIP_TYPE_RECEIVE: 收到——收到好友请求后触发\n - FRIENDSHIP_TYPE_VERIFY: 验证——主动加他人为好友时触发，wxwork里暂无此事件\n - FRIENDSHIP_TYPE_DELETE: 删除——主动删除好友时触发\n - FRIENDSHIP_TYPE_REMOVED: 被删除——被他人删除好友时触发",
+      "title": "事件类型"
     },
     "puppetImageType": {
       "type": "string",
@@ -3454,21 +3534,26 @@
       "properties": {
         "accuracy": {
           "type": "number",
-          "format": "float"
+          "format": "float",
+          "title": "精确度，默认为15"
         },
         "address": {
-          "type": "string"
+          "type": "string",
+          "title": "地址，xx省xx市xx区xx路xx号"
         },
         "latitude": {
           "type": "number",
-          "format": "double"
+          "format": "double",
+          "title": "纬度，北纬为正"
         },
         "longitude": {
           "type": "number",
-          "format": "double"
+          "format": "double",
+          "title": "经度，东经为正"
         },
         "name": {
-          "type": "string"
+          "type": "string",
+          "title": "地址名，例如xx大厦"
         }
       }
     },
@@ -3528,6 +3613,7 @@
       "properties": {
         "idStringValueDeprecated": {
           "type": "string",
+          "description": "Deprecated after Sep 31, 2021, will be removed after Dec 31, 2022",
           "title": "*\n@deprecated: use payload instead.\n Huan(202109): Wrapper types must not be used going forward.\n   https://cloud.google.com/apis/design/design_patterns#optional_primitive_fields"
         },
         "id": {
@@ -3542,7 +3628,8 @@
           "type": "string"
         },
         "type": {
-          "$ref": "#/definitions/puppetImageType"
+          "$ref": "#/definitions/puppetImageType",
+          "title": "获取图片的类型（缩略图、原图）"
         }
       }
     },
@@ -3586,6 +3673,7 @@
       "properties": {
         "miniProgramDeprecated": {
           "type": "string",
+          "description": "deprecated after Sep 31, 2021, remove compatible code after Dec 31, 2022",
           "title": "*\nHuan(202110): We should use payload instead of JSON.stringify string\n The compatible code will be removed after Dec 31, 2022"
         },
         "miniProgram": {
@@ -3600,10 +3688,12 @@
           "type": "string"
         },
         "filename": {
-          "type": "string"
+          "type": "string",
+          "title": "文件名"
         },
         "text": {
-          "type": "string"
+          "type": "string",
+          "title": "文本内容"
         },
         "timestampDeprecated": {
           "type": "string",
@@ -3611,29 +3701,36 @@
           "title": "*\n@deprecated will be removed after Dec 31, 2022\n Huan(202109): use receive_time(10) instead"
         },
         "type": {
-          "$ref": "#/definitions/puppetMessageType"
+          "$ref": "#/definitions/puppetMessageType",
+          "title": "类型"
         },
         "talkerId": {
-          "type": "string"
+          "type": "string",
+          "title": "发送者id"
         },
         "roomId": {
-          "type": "string"
+          "type": "string",
+          "title": "群聊id"
         },
         "listenerId": {
-          "type": "string"
+          "type": "string",
+          "title": "接受者id"
         },
         "mentionIds": {
           "type": "array",
           "items": {
             "type": "string"
-          }
+          },
+          "title": "群消息@人的id列表"
         },
         "receiveTime": {
           "type": "string",
-          "format": "date-time"
+          "format": "date-time",
+          "title": "收到消息时间"
         },
         "quoteId": {
-          "type": "string"
+          "type": "string",
+          "title": "被引用的消息id"
         }
       }
     },
@@ -3666,6 +3763,7 @@
       "properties": {
         "idStringValueDeprecated": {
           "type": "string",
+          "description": "Deprecated after Sep 31, 2021, will be removed after Dec 31, 2022",
           "title": "*\n@deprecated:\n Huan(202109): Wrapper types must not be used going forward.\n   https://cloud.google.com/apis/design/design_patterns#optional_primitive_fields"
         },
         "id": {
@@ -3677,10 +3775,12 @@
       "type": "object",
       "properties": {
         "conversationId": {
-          "type": "string"
+          "type": "string",
+          "title": "对话id"
         },
         "fileBox": {
-          "type": "string"
+          "type": "string",
+          "title": "发送文件的fileBox.toJSON()"
         }
       }
     },
@@ -3689,6 +3789,7 @@
       "properties": {
         "idStringValueDeprecated": {
           "type": "string",
+          "description": "Deprecated after Sep 31, 2021, will be removed after Dec 31, 2022",
           "title": "*\n@deprecated:\n Huan(202109): Wrapper types must not be used going forward.\n   https://cloud.google.com/apis/design/design_patterns#optional_primitive_fields"
         },
         "id": {
@@ -3704,15 +3805,18 @@
           "title": "oneof payload {"
         },
         "fileBoxChunk": {
-          "$ref": "#/definitions/puppetFileBoxChunk"
+          "$ref": "#/definitions/puppetFileBoxChunk",
+          "title": "};"
         }
-      }
+      },
+      "description": "*\n Huan(202110): `oneof xxx {}` seems equal with `optional`?\n  to be confirmed."
     },
     "puppetMessageSendFileStreamResponse": {
       "type": "object",
       "properties": {
         "idStringValueDeprecated": {
           "type": "string",
+          "description": "Deprecated after Sep 31, 2021, will be removed after Dec 31, 2022",
           "title": "*\n@deprecated:\n Huan(202109): Wrapper types must not be used going forward.\n   https://cloud.google.com/apis/design/design_patterns#optional_primitive_fields"
         },
         "id": {
@@ -3734,6 +3838,7 @@
       "properties": {
         "idStringValueDeprecated": {
           "type": "string",
+          "description": "Deprecated after Sep 31, 2021, will be removed after Dec 31, 2022",
           "title": "*\n@deprecated:\n Huan(202109): Wrapper types must not be used going forward.\n   https://cloud.google.com/apis/design/design_patterns#optional_primitive_fields"
         },
         "id": {
@@ -3746,6 +3851,7 @@
       "properties": {
         "idStringValueDeprecated": {
           "type": "string",
+          "description": "Deprecated after Sep 31, 2021, will be removed after Dec 31, 2022",
           "title": "*\n@deprecated:\n Huan(202109): Wrapper types must not be used going forward.\n   https://cloud.google.com/apis/design/design_patterns#optional_primitive_fields"
         },
         "id": {
@@ -3758,6 +3864,7 @@
       "properties": {
         "idStringValueDeprecated": {
           "type": "string",
+          "description": "Deprecated after Sep 31, 2021, will be removed after Dec 31, 2022",
           "title": "*\n@deprecated:\n Huan(202109): Wrapper types must not be used going forward.\n   https://cloud.google.com/apis/design/design_patterns#optional_primitive_fields"
         },
         "id": {
@@ -3788,13 +3895,16 @@
         "MESSAGE_TYPE_CHANNEL",
         "MESSAGE_TYPE_SYSTEM"
       ],
-      "default": "MESSAGE_TYPE_UNSPECIFIED"
+      "default": "MESSAGE_TYPE_UNSPECIFIED",
+      "description": "- MESSAGE_TYPE_ATTACHMENT: 文件消息\n - MESSAGE_TYPE_AUDIO: 音频\n - MESSAGE_TYPE_CONTACT: 名片\n - MESSAGE_TYPE_CHAT_HISTORY: 聊天记录，wxwork暂不支持\n - MESSAGE_TYPE_EMOTCION: 表情\n - MESSAGE_TYPE_IMAGE: 图片\n - MESSAGE_TYPE_TEXT: 文本\n - MESSAGE_TYPE_LOCATION: 地址\n - MESSAGE_TYPE_MINI_PROGRAM: 小程序\n - MESSAGE_TYPE_GROUP_NOTE: 群接龙消息，wxwork中没有\n - MESSAGE_TYPE_TRANSFER: 转账，wxwork中没有\n - MESSAGE_TYPE_RED_ENVELOPE: 红包，wxwork中没有\n - MESSAGE_TYPE_RECALLED: 撤回\n - MESSAGE_TYPE_URL: 链接\n - MESSAGE_TYPE_VIDEO: 视频\n - MESSAGE_TYPE_POST: 特殊的复合类型，wxwork中没有\n - MESSAGE_TYPE_CHANNEL: 视频号\n - MESSAGE_TYPE_SYSTEM: 系统消息",
+      "title": "消息类型"
     },
     "puppetMessageUrlResponse": {
       "type": "object",
       "properties": {
         "urlLinkDeprecated": {
           "type": "string",
+          "description": "deprecated after Sep 31, 2021, remove compatible code after Dec 31, 2022",
           "title": "*\nHuan(202110): We should use payload instead of JSON.stringify string\n The compatible code will be removed after Dec 31, 2022"
         },
         "urlLink": {
@@ -3806,31 +3916,40 @@
       "type": "object",
       "properties": {
         "appid": {
-          "type": "string"
+          "type": "string",
+          "title": "appId，形式如wx4ff94de0d8038c25"
         },
         "description": {
-          "type": "string"
+          "type": "string",
+          "title": "描述(副标题)"
         },
         "pagePath": {
-          "type": "string"
+          "type": "string",
+          "title": "访问路径"
         },
         "iconUrl": {
-          "type": "string"
+          "type": "string",
+          "title": "图标路径"
         },
         "shareId": {
-          "type": "string"
+          "type": "string",
+          "title": "发送小程序的用户id，可不填"
         },
         "thumbUrl": {
-          "type": "string"
+          "type": "string",
+          "title": "缩略图路径"
         },
         "title": {
-          "type": "string"
+          "type": "string",
+          "title": "标题"
         },
         "username": {
-          "type": "string"
+          "type": "string",
+          "title": "关联公众号id，形式gh_69105b80ea75@app"
         },
         "thumbKey": {
-          "type": "string"
+          "type": "string",
+          "title": "缩略图的key，可不填"
         }
       }
     },
@@ -3891,6 +4010,7 @@
         "PAYLOAD_TYPE_ROOM",
         "PAYLOAD_TYPE_ROOM_MEMBER",
         "PAYLOAD_TYPE_FRIENDSHIP",
+        "PAYLOAD_TYPE_POST",
         "PAYLOAD_TYPE_TAG",
         "PAYLOAD_TYPE_TAG_GROUP"
       ],
@@ -3900,10 +4020,12 @@
       "type": "object",
       "properties": {
         "parentId": {
-          "type": "string"
+          "type": "string",
+          "title": "转发的上一级id,评论时如果是回复，则是回复的评论的id，否则是朋友圈的id"
         },
         "rootId": {
-          "type": "string"
+          "type": "string",
+          "title": "转发的根id，评论时应该是朋友圈的id"
         },
         "type": {
           "$ref": "#/definitions/puppetPostType"
@@ -3955,10 +4077,12 @@
       "type": "object",
       "properties": {
         "parentId": {
-          "type": "string"
+          "type": "string",
+          "title": "转发的上一级id"
         },
         "rootId": {
-          "type": "string"
+          "type": "string",
+          "title": "转发的根id"
         },
         "type": {
           "$ref": "#/definitions/puppetPostType"
@@ -3998,13 +4122,15 @@
           "$ref": "#/definitions/puppetSayableType"
         },
         "id": {
-          "type": "string"
+          "type": "string",
+          "title": "服务器端获取的Post只传回id，异步进行获取"
         },
         "text": {
           "type": "string"
         },
         "fileBox": {
-          "type": "string"
+          "type": "string",
+          "title": "FileBox.toJSON()"
         },
         "urlLink": {
           "$ref": "#/definitions/puppetUrlLinkPayload"
@@ -4016,7 +4142,8 @@
           "type": "array",
           "items": {
             "type": "string"
-          }
+          },
+          "title": "文本类型的sayable可传，朋友圈暂不支持"
         }
       }
     },
@@ -4030,7 +4157,8 @@
           "$ref": "#/definitions/puppetTapType"
         },
         "tap": {
-          "type": "boolean"
+          "type": "boolean",
+          "title": "点赞还是取消"
         }
       }
     },
@@ -4050,7 +4178,8 @@
         "POST_TYPE_CHANNEL",
         "POST_TYPE_MESSAGE"
       ],
-      "default": "POST_TYPE_UNSPECIFIED"
+      "default": "POST_TYPE_UNSPECIFIED",
+      "title": "- POST_TYPE_MOMENT: 朋友圈\n - POST_TYPE_CHANNEL: 视频号——原始设计走post，实际目前采用message\n - POST_TYPE_MESSAGE: 消息——富媒体消息"
     },
     "puppetReferrer": {
       "type": "object",
@@ -4071,7 +4200,8 @@
       "type": "object",
       "properties": {
         "textStringValueDeprecated": {
-          "type": "string"
+          "type": "string",
+          "title": "DEPRECATED, will be removed after Dec 31, 2022"
         },
         "text": {
           "type": "string"
@@ -4093,10 +4223,12 @@
           "type": "array",
           "items": {
             "type": "string"
-          }
+          },
+          "title": "初始群成员id"
         },
         "topic": {
-          "type": "string"
+          "type": "string",
+          "title": "群名称"
         }
       }
     },
@@ -4121,38 +4253,47 @@
           "type": "string"
         },
         "inviterId": {
-          "type": "string"
+          "type": "string",
+          "title": "邀请者id"
         },
         "topic": {
-          "type": "string"
+          "type": "string",
+          "title": "群名称"
         },
         "memberCount": {
           "type": "integer",
-          "format": "int32"
+          "format": "int32",
+          "title": "群成员数量"
         },
         "memberIds": {
           "type": "array",
           "items": {
             "type": "string"
-          }
+          },
+          "title": "群成员id列表"
         },
         "timestampUint64Deprecated": {
           "type": "string",
           "format": "uint64",
+          "description": "Deprecated: will be removed after Dec 31, 2022",
           "title": "*\n@deprecated will be removed after Dec 31, 2022\n Huan(202109): use receive_time(10) instead"
         },
         "avatar": {
-          "type": "string"
+          "type": "string",
+          "title": "群头像"
         },
         "invitation": {
-          "type": "string"
+          "type": "string",
+          "title": "在企微中为群邀请的链接地址"
         },
         "receiverId": {
-          "type": "string"
+          "type": "string",
+          "title": "收到群邀请的成员id"
         },
         "receiveTime": {
           "type": "string",
-          "format": "date-time"
+          "format": "date-time",
+          "title": "时间戳"
         }
       }
     },
@@ -4185,16 +4326,20 @@
           "type": "string"
         },
         "roomAlias": {
-          "type": "string"
+          "type": "string",
+          "title": "联系人在群内的别名（群备注）"
         },
         "inviterId": {
-          "type": "string"
+          "type": "string",
+          "title": "邀请者id"
         },
         "avatar": {
-          "type": "string"
+          "type": "string",
+          "title": "头像"
         },
         "name": {
-          "type": "string"
+          "type": "string",
+          "title": "名称"
         },
         "additionalInfo": {
           "type": "string"
@@ -4208,28 +4353,34 @@
           "type": "string"
         },
         "topic": {
-          "type": "string"
+          "type": "string",
+          "title": "群名称"
         },
         "avatar": {
-          "type": "string"
+          "type": "string",
+          "title": "群头像"
         },
         "ownerId": {
-          "type": "string"
+          "type": "string",
+          "title": "群主id"
         },
         "adminIds": {
           "type": "array",
           "items": {
             "type": "string"
-          }
+          },
+          "title": "群管理员id列表"
         },
         "memberIds": {
           "type": "array",
           "items": {
             "type": "string"
-          }
+          },
+          "title": "群成员id列表"
         },
         "handle": {
-          "type": "string"
+          "type": "string",
+          "title": "IM内部id，企微中为群的chat_id"
         },
         "additionalInfo": {
           "type": "string"
@@ -4251,7 +4402,8 @@
       "type": "object",
       "properties": {
         "topicStringValueDeprecated": {
-          "type": "string"
+          "type": "string",
+          "title": "DEPRECATED, will be removed after Dec 31, 2022"
         },
         "topic": {
           "type": "string"
@@ -4281,13 +4433,15 @@
           "type": "array",
           "items": {
             "type": "string"
-          }
+          },
+          "title": "要打的标签的id列表"
         },
         "contactIds": {
           "type": "array",
           "items": {
             "type": "string"
-          }
+          },
+          "title": "要打标签的联系人id列表"
         }
       }
     },
@@ -4411,10 +4565,12 @@
           "type": "string"
         },
         "name": {
-          "type": "string"
+          "type": "string",
+          "title": "标签名"
         },
         "groupId": {
-          "type": "string"
+          "type": "string",
+          "title": "所属标签组的id，可为空"
         },
         "type": {
           "$ref": "#/definitions/puppetTagType"
@@ -4496,7 +4652,8 @@
         "PERSONAL",
         "CORPORATION"
       ],
-      "default": "Unspecific"
+      "default": "Unspecific",
+      "title": "- PERSONAL: 个人标签\n - CORPORATION: 企业标签"
     },
     "puppetTapType": {
       "type": "string",
@@ -4527,16 +4684,20 @@
       "type": "object",
       "properties": {
         "description": {
-          "type": "string"
+          "type": "string",
+          "title": "描述"
         },
         "thumbnailUrl": {
-          "type": "string"
+          "type": "string",
+          "title": "缩略图地址"
         },
         "title": {
-          "type": "string"
+          "type": "string",
+          "title": "标题"
         },
         "url": {
-          "type": "string"
+          "type": "string",
+          "title": "文章地址"
         }
       }
     },