@juzi/wechaty-grpc 1.0.27 → 1.0.29

package/dist/cjs/out/wechaty/puppet.openapi.yaml

@@ -9,7 +9,7 @@ info:
 
     Wechaty 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.27
+  version: 1.0.29
   contact:
     name: Wechaty
     url: 'https://github.com/wechaty/openapi'
@@ -123,6 +123,7 @@ paths:
             properties:
               corporationRemarkStringValueDeprecated:
                 type: string
+                title: 'DEPRECATED, will be removed after Dec 31, 2022'
               corporationRemark:
                 type: string
       tags:
@@ -152,6 +153,7 @@ paths:
             properties:
               descriptionStringValueDeprecated:
                 type: string
+                title: 'DEPRECATED, will be removed after Dec 31, 2022'
               description:
                 type: string
       tags:
@@ -250,6 +252,7 @@ paths:
             properties:
               aliasStringValueDeprecated:
                 type: string
+                description: 'DEPRECATED, will be removed after Dec 31, 2022'
                 title: nullable
               alias:
                 type: string
@@ -273,6 +276,7 @@ paths:
           required: true
           type: string
         - name: fileboxStringValueDeprecated
+          description: 'DEPRECATED, will be removed after Dec 31, 2022'
           in: query
           required: false
           type: string
@@ -410,10 +414,12 @@ paths:
             $ref: '#/definitions/rpcStatus'
       parameters:
         - name: conversationId
+          description: 对话id
           in: path
           required: true
           type: string
         - name: messageId
+          description: 要转发的消息id
           in: path
           required: true
           type: string
@@ -460,6 +466,7 @@ paths:
             $ref: '#/definitions/rpcStatus'
       parameters:
         - name: conversationId
+          description: 对话id
           in: path
           required: true
           type: string
@@ -471,6 +478,9 @@ paths:
             properties:
               miniProgramDeprecated:
                 type: string
+                description: >-
+                  deprecated after Sep 31, 2021, remove compatible code after
+                  Dec 31, 2022
                 title: >-
                   *
 
@@ -479,6 +489,7 @@ paths:
                    The compatible code will be removed after Dec 31, 2022
               miniProgram:
                 $ref: '#/definitions/puppetMiniProgramPayload'
+                title: 小程序payload
       tags:
         - Puppet
   '/conversations/{conversationId}/text':
@@ -495,6 +506,7 @@ paths:
             $ref: '#/definitions/rpcStatus'
       parameters:
         - name: conversationId
+          description: 对话id
           in: path
           required: true
           type: string
@@ -506,12 +518,16 @@ paths:
             properties:
               text:
                 type: string
+                title: 文本内容
               mentionalIds:
                 type: array
                 items:
                   type: string
+                title: '@人id列表'
               quoteId:
                 type: string
+                title: 引用消息的id
+            title: 发文本消息
       tags:
         - Puppet
   '/conversations/{conversationId}/url-link':
@@ -528,6 +544,7 @@ paths:
             $ref: '#/definitions/rpcStatus'
       parameters:
         - name: conversationId
+          description: 对话id
           in: path
           required: true
           type: string
@@ -539,6 +556,9 @@ paths:
             properties:
               urlLinkDeprecated:
                 type: string
+                description: >-
+                  deprecated after Sep 31, 2021, remove compatible code after
+                  Dec 31, 2022
                 title: >-
                   *
 
@@ -547,6 +567,7 @@ paths:
                    The compatible code will be removed after Dec 31, 2022
               urlLink:
                 $ref: '#/definitions/puppetUrlLinkPayload'
+                title: 链接payload
       tags:
         - Puppet
   /currentUser:
@@ -679,8 +700,10 @@ paths:
                 type: string
               sourceRoomIdStringValueDeprecated:
                 type: string
+                title: 'Deprecated: will be removed after Dec 31, 2022'
               sourceContactIdStringValueDeprecated:
                 type: string
+                title: 'Deprecated: will be removed after Dec 31, 2022'
               referrer:
                 $ref: '#/definitions/puppetReferrer'
       tags:
@@ -761,6 +784,8 @@ paths:
             Huan(202003):
              What's the reason we need belowing payload?
              We should remove it if possible.
+
+            DEPRECATED, will be removed after Dec 31, 2022
           in: query
           required: false
           type: string
@@ -1018,10 +1043,12 @@ paths:
             $ref: '#/definitions/rpcStatus'
       parameters:
         - name: messageId
+          description: 要转发的消息id
           in: path
           required: true
           type: string
         - name: conversationId
+          description: 对话id
           in: path
           required: true
           type: string
@@ -1029,7 +1056,7 @@ paths:
         - Puppet
   /moment/coverage:
     post:
-      operationId: Puppet_momentCoverage
+      operationId: Puppet_MomentCoverage
       responses:
         '200':
           description: A successful response.
@@ -1049,7 +1076,7 @@ paths:
         - Puppet
   /moment/publish:
     post:
-      operationId: Puppet_momentPublish
+      operationId: Puppet_MomentPublish
       responses:
         '200':
           description: A successful response.
@@ -1069,7 +1096,7 @@ paths:
         - Puppet
   /moment/signature:
     post:
-      operationId: Puppet_momentSignature
+      operationId: Puppet_MomentSignature
       responses:
         '200':
           description: A successful response.
@@ -1087,9 +1114,23 @@ paths:
             $ref: '#/definitions/puppetMomentSignatureRequest'
       tags:
         - Puppet
+  /moment/visibleList:
+    get:
+      operationId: Puppet_MomentVisibleList
+      responses:
+        '200':
+          description: A successful response.
+          schema:
+            $ref: '#/definitions/puppetMomentVisibleListResponse'
+        default:
+          description: An unexpected error response.
+          schema:
+            $ref: '#/definitions/rpcStatus'
+      tags:
+        - Puppet
   /post/like:
     post:
-      operationId: Puppet_postTap
+      operationId: Puppet_PostTap
       responses:
         '200':
           description: A successful response.
@@ -1109,7 +1150,7 @@ paths:
         - Puppet
   /post/payload:
     post:
-      operationId: Puppet_postPayload
+      operationId: Puppet_PostPayload
       responses:
         '200':
           description: A successful response.
@@ -1129,7 +1170,7 @@ paths:
         - Puppet
   /post/sayable:
     post:
-      operationId: Puppet_postPayloadSayable
+      operationId: Puppet_PostPayloadSayable
       responses:
         '200':
           description: A successful response.
@@ -1176,6 +1217,8 @@ paths:
             @deprecated: use payload instead.
              Huan(202109): Wrapper types must not be used going forward.
                https://cloud.google.com/apis/design/design_patterns#optional_primitive_fields
+
+            Deprecated: will be removed after Dec 31, 2022
           in: query
           required: false
           type: string
@@ -1294,10 +1337,12 @@ paths:
           required: true
           type: string
         - name: contactId
+          description: 被邀请联系人id
           in: path
           required: true
           type: string
         - name: inviteOnly
+          description: 不明确，目前没见到使用这个的地方
           in: query
           required: false
           type: boolean
@@ -1321,6 +1366,7 @@ paths:
           required: true
           type: string
         - name: textStringValueDeprecated
+          description: 'DEPRECATED, will be removed after Dec 31, 2022'
           in: query
           required: false
           type: string
@@ -1354,8 +1400,10 @@ paths:
             properties:
               textStringValueDeprecated:
                 type: string
+                title: 'DEPRECATED, will be removed after Dec 31, 2022'
               text:
                 type: string
+            title: 群公告
       tags:
         - Puppet
   '/rooms/{id}/avatar':
@@ -1463,6 +1511,7 @@ paths:
           required: true
           type: string
         - name: contactId
+          description: 'Deprecated, will be removed after bot updated'
           in: path
           required: true
           type: string
@@ -1556,6 +1605,7 @@ paths:
           required: true
           type: string
         - name: topicStringValueDeprecated
+          description: 'DEPRECATED, will be removed after Dec 31, 2022'
           in: query
           required: false
           type: string
@@ -2021,7 +2071,10 @@ paths:
             $ref: '#/definitions/rpcStatus'
       parameters:
         - name: body
-          description: ' (streaming inputs)'
+          description: |-
+            *
+             Huan(202110): `oneof xxx {}` seems equal with `optional`?
+              to be confirmed. (streaming inputs)
           in: body
           required: true
           schema:
@@ -2040,26 +2093,35 @@ definitions:
     properties:
       avatar:
         type: string
+        title: 头像
       coverUrl:
         type: string
+        title: 封面地址
       desc:
         type: string
+        title: 描述
       extras:
         type: string
+        title: 额外信息，暂不明确含义，但传错会导致无法发出（红色感叹号）。应根据收到的视频号的extras字段填入。
       feedType:
         type: integer
         format: int32
+        title: 暂不明确含义，目前请固定传4
       nickname:
         type: string
+        title: 用户名
       thumbUrl:
         type: string
+        title: 缩略图地址
       url:
         type: string
+        title: 视频号地址
   puppetContactAliasResponse:
     type: object
     properties:
       aliasStringValueDeprecated:
         type: string
+        title: 'DEPRECATED, will be removed after Dec 31, 2022'
       alias:
         type: string
   puppetContactAvatarResponse:
@@ -2067,6 +2129,7 @@ definitions:
     properties:
       fileboxStringValueDeprecated:
         type: string
+        title: 'DEPRECATED, will be removed after Dec 31, 2022'
       fileBox:
         type: string
   puppetContactCorporationRemarkResponse:
@@ -2080,6 +2143,11 @@ definitions:
       - CONTACT_GENDER_MALE
       - CONTACT_GENDER_FEMALE
     default: CONTACT_GENDER_UNSPECIFIED
+    description: |-
+      - CONTACT_GENDER_UNSPECIFIED: 不明确
+       - CONTACT_GENDER_MALE: 男
+       - CONTACT_GENDER_FEMALE: 女
+    title: 性别枚举
   puppetContactListResponse:
     type: object
     properties:
@@ -2094,26 +2162,37 @@ definitions:
         type: string
       gender:
         $ref: '#/definitions/puppetContactGender'
+        title: 性别
       type:
         $ref: '#/definitions/puppetContactType'
+        title: 类型
       name:
         type: string
+        title: 姓名
       avatar:
         type: string
+        title: 头像
       address:
         type: string
+        title: 地址
       alias:
         type: string
+        title: 别名，即备注
       city:
         type: string
+        title: 城市
       friend:
         type: boolean
+        title: 是否为好友
       province:
         type: string
+        title: 省份
       signature:
         type: string
+        title: 签名
       star:
         type: boolean
+        title: 是否为特别好友
       weixin:
         type: string
         description: >-
@@ -2129,24 +2208,34 @@ definitions:
            @link https://github.com/wechaty/getting-started/issues/254
 
           TODO: rename `weixin` to `handle` in v2.0.0
+
+
+          IM专属id，在企微环境中特指weixinId
       corporation:
         type: string
+        title: 企业
       title:
         type: string
+        title: 头衔
       description:
         type: string
+        title: 描述
       coworker:
         type: boolean
+        title: 是否为同事
       phones:
         type: array
         items:
           type: string
+        title: 电话号码，企微中最多5个
       additionalInfo:
         type: string
+        title: 额外信息，是由JS对象stringify得到的字符串，目前支持的内容包含addContactTime、corpId等。
       tagIds:
         type: array
         items:
           type: string
+        title: 标签（的id）
   puppetContactPhoneResponse:
     type: object
     properties:
@@ -2176,6 +2265,12 @@ definitions:
       - CONTACT_TYPE_OFFICIAL
       - CONTACT_TYPE_CORPORATION
     default: CONTACT_TYPE_UNSPECIFIED
+    description: |-
+      - CONTACT_TYPE_UNSPECIFIED: 不明确
+       - CONTACT_TYPE_PERSONAL: 个微联系人
+       - CONTACT_TYPE_OFFICIAL: 公众号
+       - CONTACT_TYPE_CORPORATION: 企微联系人
+    title: 类型枚举
   puppetConversationReadResponse:
     type: object
   puppetCurrentUserResponse:
@@ -2190,6 +2285,10 @@ definitions:
         type: string
   puppetDingResponse:
     type: object
+    title: |-
+      *
+       Ding has no return value
+        Puppet should emit a `ding` event when it receives a `ding()` call
   puppetDirtyPayloadResponse:
     type: object
   puppetDownloadResponse:
@@ -2205,6 +2304,7 @@ definitions:
         $ref: '#/definitions/puppetEventType'
       payload:
         type: string
+        description: 'JSON.stringify({ ... })'
         title: 'TODO: Huan(202002) consider to use a PB Map?'
   puppetEventType:
     type: string
@@ -2240,6 +2340,11 @@ definitions:
         title: 'oneof payload {'
       name:
         type: string
+        title: '}'
+    description: |-
+      *
+       Huan(202110): `oneof xxx {}` seems equal with `optional`?
+        to be confirmed.
   puppetFriendshipAcceptResponse:
     type: object
   puppetFriendshipAddResponse:
@@ -2251,16 +2356,22 @@ definitions:
         type: string
       contactId:
         type: string
+        title: 加好友的联系人id
       hello:
         type: string
+        title: 加好友的打招呼消息
       type:
         $ref: '#/definitions/puppetFriendshipType'
+        title: 好友事件类型
       stranger:
         type: string
+        title: 不明确含义，wxwork中未使用
       ticket:
         type: string
+        title: 个微遗留字段，wxwork中会传corp_id
       scene:
         $ref: '#/definitions/puppetFriendshipSceneType'
+        title: 加好友的场景（例如通过名片添加、通过群添加等），wxwork未使用
   puppetFriendshipSceneType:
     type: string
     enum:
@@ -2277,6 +2388,7 @@ definitions:
       - FRIENDSHIP_SCENE_TYPE_SHAKING
       - FRIENDSHIP_SCENE_TYPE_QRCODE
     default: FRIENDSHIP_SCENE_TYPE_UNSPECIFIED
+    title: 事件场景 wxwork中未使用
   puppetFriendshipSearchHandleRequest:
     type: object
     properties:
@@ -2312,6 +2424,7 @@ definitions:
     properties:
       contactIdStringValueDeprecated:
         type: string
+        description: 'DEPRECATED, will be removed after Dec 31, 2022'
         title: nullable
       contactId:
         type: string
@@ -2320,6 +2433,7 @@ definitions:
     properties:
       contactIdStringValueDeprecated:
         type: string
+        description: 'DEPRECATED, will be removed after Dec 31, 2022'
         title: nullable
       contactId:
         type: string
@@ -2333,6 +2447,14 @@ definitions:
       - FRIENDSHIP_TYPE_DELETE
       - FRIENDSHIP_TYPE_REMOVED
     default: FRIENDSHIP_TYPE_UNSPECIFIED
+    description: |-
+      - FRIENDSHIP_TYPE_UNSPECIFIED: 不明确
+       - FRIENDSHIP_TYPE_CONFIRM: 确认——双方互加后触发
+       - FRIENDSHIP_TYPE_RECEIVE: 收到——收到好友请求后触发
+       - FRIENDSHIP_TYPE_VERIFY: 验证——主动加他人为好友时触发，wxwork里暂无此事件
+       - FRIENDSHIP_TYPE_DELETE: 删除——主动删除好友时触发
+       - FRIENDSHIP_TYPE_REMOVED: 被删除——被他人删除好友时触发
+    title: 事件类型
   puppetImageType:
     type: string
     enum:
@@ -2347,16 +2469,21 @@ definitions:
       accuracy:
         type: number
         format: float
+        title: 精确度，默认为15
       address:
         type: string
+        title: 地址，xx省xx市xx区xx路xx号
       latitude:
         type: number
         format: double
+        title: 纬度，北纬为正
       longitude:
         type: number
         format: double
+        title: 经度，东经为正
       name:
         type: string
+        title: 地址名，例如xx大厦
   puppetLogoutResponse:
     type: object
   puppetMessageChannelResponse:
@@ -2394,6 +2521,7 @@ definitions:
     properties:
       idStringValueDeprecated:
         type: string
+        description: 'Deprecated after Sep 31, 2021, will be removed after Dec 31, 2022'
         title: |-
           *
           @deprecated: use payload instead.
@@ -2408,6 +2536,7 @@ definitions:
         type: string
       type:
         $ref: '#/definitions/puppetImageType'
+        title: 获取图片的类型（缩略图、原图）
   puppetMessageImageResponse:
     type: object
     properties:
@@ -2435,6 +2564,9 @@ definitions:
     properties:
       miniProgramDeprecated:
         type: string
+        description: >-
+          deprecated after Sep 31, 2021, remove compatible code after Dec 31,
+          2022
         title: |-
           *
           Huan(202110): We should use payload instead of JSON.stringify string
@@ -2448,8 +2580,10 @@ definitions:
         type: string
       filename:
         type: string
+        title: 文件名
       text:
         type: string
+        title: 文本内容
       timestampDeprecated:
         type: string
         format: uint64
@@ -2459,21 +2593,30 @@ definitions:
            Huan(202109): use receive_time(10) instead
       type:
         $ref: '#/definitions/puppetMessageType'
+        title: 类型
       talkerId:
         type: string
+        title: 发送者id
       roomId:
         type: string
+        title: 群聊id
       listenerId:
         type: string
+        title: 接受者id
       mentionIds:
         type: array
         items:
           type: string
+        title: 群消息@人的id列表
       receiveTime:
         type: string
         format: date-time
+        title: 收到消息时间
       quoteId:
         type: string
+        title: 被引用的消息id
+      additionalInfo:
+        type: string
   puppetMessagePreviewResponse:
     type: object
     properties:
@@ -2494,6 +2637,7 @@ definitions:
     properties:
       idStringValueDeprecated:
         type: string
+        description: 'Deprecated after Sep 31, 2021, will be removed after Dec 31, 2022'
         title: |-
           *
           @deprecated:
@@ -2506,13 +2650,16 @@ definitions:
     properties:
       conversationId:
         type: string
+        title: 对话id
       fileBox:
         type: string
+        title: 发送文件的fileBox.toJSON()
   puppetMessageSendFileResponse:
     type: object
     properties:
       idStringValueDeprecated:
         type: string
+        description: 'Deprecated after Sep 31, 2021, will be removed after Dec 31, 2022'
         title: |-
           *
           @deprecated:
@@ -2528,11 +2675,17 @@ definitions:
         title: 'oneof payload {'
       fileBoxChunk:
         $ref: '#/definitions/puppetFileBoxChunk'
+        title: '};'
+    description: |-
+      *
+       Huan(202110): `oneof xxx {}` seems equal with `optional`?
+        to be confirmed.
   puppetMessageSendFileStreamResponse:
     type: object
     properties:
       idStringValueDeprecated:
         type: string
+        description: 'Deprecated after Sep 31, 2021, will be removed after Dec 31, 2022'
         title: |-
           *
           @deprecated:
@@ -2558,6 +2711,7 @@ definitions:
     properties:
       idStringValueDeprecated:
         type: string
+        description: 'Deprecated after Sep 31, 2021, will be removed after Dec 31, 2022'
         title: |-
           *
           @deprecated:
@@ -2570,6 +2724,7 @@ definitions:
     properties:
       idStringValueDeprecated:
         type: string
+        description: 'Deprecated after Sep 31, 2021, will be removed after Dec 31, 2022'
         title: |-
           *
           @deprecated:
@@ -2582,6 +2737,7 @@ definitions:
     properties:
       idStringValueDeprecated:
         type: string
+        description: 'Deprecated after Sep 31, 2021, will be removed after Dec 31, 2022'
         title: |-
           *
           @deprecated:
@@ -2612,11 +2768,34 @@ definitions:
       - MESSAGE_TYPE_CHANNEL
       - MESSAGE_TYPE_SYSTEM
     default: MESSAGE_TYPE_UNSPECIFIED
+    description: |-
+      - MESSAGE_TYPE_ATTACHMENT: 文件消息
+       - MESSAGE_TYPE_AUDIO: 音频
+       - MESSAGE_TYPE_CONTACT: 名片
+       - MESSAGE_TYPE_CHAT_HISTORY: 聊天记录，wxwork暂不支持
+       - MESSAGE_TYPE_EMOTCION: 表情
+       - MESSAGE_TYPE_IMAGE: 图片
+       - MESSAGE_TYPE_TEXT: 文本
+       - MESSAGE_TYPE_LOCATION: 地址
+       - MESSAGE_TYPE_MINI_PROGRAM: 小程序
+       - MESSAGE_TYPE_GROUP_NOTE: 群接龙消息，wxwork中没有
+       - MESSAGE_TYPE_TRANSFER: 转账，wxwork中没有
+       - MESSAGE_TYPE_RED_ENVELOPE: 红包，wxwork中没有
+       - MESSAGE_TYPE_RECALLED: 撤回
+       - MESSAGE_TYPE_URL: 链接
+       - MESSAGE_TYPE_VIDEO: 视频
+       - MESSAGE_TYPE_POST: 特殊的复合类型，wxwork中没有
+       - MESSAGE_TYPE_CHANNEL: 视频号
+       - 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: |-
           *
           Huan(202110): We should use payload instead of JSON.stringify string
@@ -2628,22 +2807,31 @@ definitions:
     properties:
       appid:
         type: string
+        title: appId，形式如wx4ff94de0d8038c25
       description:
         type: string
+        title: 描述(副标题)
       pagePath:
         type: string
+        title: 访问路径
       iconUrl:
         type: string
+        title: 图标路径
       shareId:
         type: string
+        title: 发送小程序的用户id，可不填
       thumbUrl:
         type: string
+        title: 缩略图路径
       title:
         type: string
+        title: 标题
       username:
         type: string
+        title: 关联公众号id，形式gh_69105b80ea75@app
       thumbKey:
         type: string
+        title: 缩略图的key，可不填
   puppetMomentCoverageRequest:
     type: object
     properties:
@@ -2674,6 +2862,13 @@ definitions:
     properties:
       text:
         type: string
+  puppetMomentVisibleListResponse:
+    type: object
+    properties:
+      contactIds:
+        type: array
+        items:
+          type: string
   puppetPayloadType:
     type: string
     enum:
@@ -2692,8 +2887,10 @@ definitions:
     properties:
       parentId:
         type: string
+        title: '转发的上一级id,评论时如果是回复，则是回复的评论的id，否则是朋友圈的id'
       rootId:
         type: string
+        title: 转发的根id，评论时应该是朋友圈的id
       type:
         $ref: '#/definitions/puppetPostType'
       sayableList:
@@ -2727,8 +2924,10 @@ definitions:
     properties:
       parentId:
         type: string
+        title: 转发的上一级id
       rootId:
         type: string
+        title: 转发的根id
       type:
         $ref: '#/definitions/puppetPostType'
       sayableList:
@@ -2757,10 +2956,12 @@ definitions:
         $ref: '#/definitions/puppetSayableType'
       id:
         type: string
+        title: 服务器端获取的Post只传回id，异步进行获取
       text:
         type: string
       fileBox:
         type: string
+        title: FileBox.toJSON()
       urlLink:
         $ref: '#/definitions/puppetUrlLinkPayload'
       channel:
@@ -2769,6 +2970,7 @@ definitions:
         type: array
         items:
           type: string
+        title: 文本类型的sayable可传，朋友圈暂不支持
   puppetPostTapRequest:
     type: object
     properties:
@@ -2778,6 +2980,7 @@ definitions:
         $ref: '#/definitions/puppetTapType'
       tap:
         type: boolean
+        title: 点赞还是取消
   puppetPostTapResponse:
     type: object
     properties:
@@ -2791,6 +2994,10 @@ definitions:
       - POST_TYPE_CHANNEL
       - POST_TYPE_MESSAGE
     default: POST_TYPE_UNSPECIFIED
+    title: |-
+      - POST_TYPE_MOMENT: 朋友圈
+       - POST_TYPE_CHANNEL: 视频号——原始设计走post，实际目前采用message
+       - POST_TYPE_MESSAGE: 消息——富媒体消息
   puppetReferrer:
     type: object
     properties:
@@ -2811,6 +3018,7 @@ definitions:
     properties:
       textStringValueDeprecated:
         type: string
+        title: 'DEPRECATED, will be removed after Dec 31, 2022'
       text:
         type: string
   puppetRoomAvatarResponse:
@@ -2825,8 +3033,10 @@ definitions:
         type: array
         items:
           type: string
+        title: 初始群成员id
       topic:
         type: string
+        title: 群名称
   puppetRoomCreateResponse:
     type: object
     properties:
@@ -2843,31 +3053,40 @@ definitions:
         type: string
       inviterId:
         type: string
+        title: 邀请者id
       topic:
         type: string
+        title: 群名称
       memberCount:
         type: integer
         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: |-
           *
           @deprecated will be removed after Dec 31, 2022
            Huan(202109): use receive_time(10) instead
       avatar:
         type: string
+        title: 群头像
       invitation:
         type: string
+        title: 在企微中为群邀请的链接地址
       receiverId:
         type: string
+        title: 收到群邀请的成员id
       receiveTime:
         type: string
         format: date-time
+        title: 时间戳
   puppetRoomListResponse:
     type: object
     properties:
@@ -2889,12 +3108,16 @@ definitions:
         type: string
       roomAlias:
         type: string
+        title: 联系人在群内的别名（群备注）
       inviterId:
         type: string
+        title: 邀请者id
       avatar:
         type: string
+        title: 头像
       name:
         type: string
+        title: 名称
       additionalInfo:
         type: string
   puppetRoomPayloadResponse:
@@ -2904,20 +3127,26 @@ definitions:
         type: string
       topic:
         type: string
+        title: 群名称
       avatar:
         type: string
+        title: 群头像
       ownerId:
         type: string
+        title: 群主id
       adminIds:
         type: array
         items:
           type: string
+        title: 群管理员id列表
       memberIds:
         type: array
         items:
           type: string
+        title: 群成员id列表
       handle:
         type: string
+        title: IM内部id，企微中为群的chat_id
       additionalInfo:
         type: string
   puppetRoomQRCodeResponse:
@@ -2932,6 +3161,7 @@ definitions:
     properties:
       topicStringValueDeprecated:
         type: string
+        title: 'DEPRECATED, will be removed after Dec 31, 2022'
       topic:
         type: string
   puppetSayableType:
@@ -2953,10 +3183,12 @@ definitions:
         type: array
         items:
           type: string
+        title: 要打的标签的id列表
       contactIds:
         type: array
         items:
           type: string
+        title: 要打标签的联系人id列表
   puppetTagContactTagAddResponse:
     type: object
   puppetTagContactTagListResponse:
@@ -3036,8 +3268,10 @@ definitions:
         type: string
       name:
         type: string
+        title: 标签名
       groupId:
         type: string
+        title: 所属标签组的id，可为空
       type:
         $ref: '#/definitions/puppetTagType'
   puppetTagPayloadRequest:
@@ -3090,6 +3324,9 @@ definitions:
       - PERSONAL
       - CORPORATION
     default: Unspecific
+    title: |-
+      - PERSONAL: 个人标签
+       - CORPORATION: 企业标签
   puppetTapType:
     type: string
     enum:
@@ -3112,12 +3349,16 @@ definitions:
     properties:
       description:
         type: string
+        title: 描述
       thumbnailUrl:
         type: string
+        title: 缩略图地址
       title:
         type: string
+        title: 标题
       url:
         type: string
+        title: 文章地址
   puppetVersionResponse:
     type: object
     properties: