diff --git a/cmd/open_im_api/docs/docs.go b/cmd/open_im_api/docs/docs.go index 183ab0bf4..fb401960c 100644 --- a/cmd/open_im_api/docs/docs.go +++ b/cmd/open_im_api/docs/docs.go @@ -155,13 +155,6 @@ const docTemplate = `{ "summary": "用户注册", "operationId": "UserRegister", "parameters": [ - { - "type": "string", - "description": "im token", - "name": "token", - "in": "header", - "required": true - }, { "description": "secret为openIM密钥, 详细见服务端config.yaml secret字段 \u003cbr\u003e platform为平台ID \u003cbr\u003e ex为拓展字段 \u003cbr\u003e gender为性别, 0为女, 1为男", "name": "req", @@ -209,13 +202,6 @@ const docTemplate = `{ "summary": "用户登录", "operationId": "UserToken", "parameters": [ - { - "type": "string", - "description": "im token", - "name": "token", - "in": "header", - "required": true - }, { "description": "secret为openIM密钥, 详细见服务端config.yaml secret字段 \u003cbr\u003e platform为平台ID", "name": "req", @@ -4596,7 +4582,6 @@ const docTemplate = `{ "Open_IM_internal_api_manage.OANotificationElem": { "type": "object", "required": [ - "notificationFaceURL", "notificationName", "notificationType", "text" @@ -5950,9 +5935,15 @@ const docTemplate = `{ "operationID" ], "properties": { + "count": { + "type": "integer" + }, "groupID": { "type": "string" }, + "offset": { + "type": "integer" + }, "operationID": { "type": "string" } @@ -6521,7 +6512,11 @@ const docTemplate = `{ ], "properties": { "roleLevel": { - "type": "integer" + "type": "integer", + "enum": [ + 1, + 3 + ] }, "userID": { "type": "string" @@ -6652,6 +6647,12 @@ const docTemplate = `{ "groupID": { "type": "string" }, + "inviterUserID": { + "type": "string" + }, + "joinSource": { + "type": "integer" + }, "operationID": { "type": "string" }, @@ -6751,6 +6752,9 @@ const docTemplate = `{ "sessionType" ], "properties": { + "businessOperationID": { + "type": "string" + }, "contentType": { "type": "integer" }, @@ -6760,6 +6764,9 @@ const docTemplate = `{ "isOnlineOnly": { "type": "boolean" }, + "notOfflinePush": { + "type": "boolean" + }, "offlinePushInfo": { "$ref": "#/definitions/server_api_params.OfflinePushInfo" }, @@ -6798,6 +6805,9 @@ const docTemplate = `{ "sessionType" ], "properties": { + "businessOperationID": { + "type": "string" + }, "contentType": { "type": "integer" }, @@ -6807,6 +6817,9 @@ const docTemplate = `{ "isOnlineOnly": { "type": "boolean" }, + "notOfflinePush": { + "type": "boolean" + }, "offlinePushInfo": { "$ref": "#/definitions/server_api_params.OfflinePushInfo" }, @@ -7063,7 +7076,6 @@ const docTemplate = `{ "required": [ "fromUserID", "operationID", - "remark", "toUserID" ], "properties": { @@ -7129,6 +7141,9 @@ const docTemplate = `{ "operationID" ], "properties": { + "applyMemberFriend": { + "type": "integer" + }, "ex": { "type": "string" }, @@ -7144,6 +7159,9 @@ const docTemplate = `{ "introduction": { "type": "string" }, + "lookMemberInfo": { + "type": "integer" + }, "needVerification": { "type": "integer" }, @@ -7747,7 +7765,6 @@ const docTemplate = `{ "internal_api_manage.OANotificationElem": { "type": "object", "required": [ - "notificationFaceURL", "notificationName", "notificationType", "text" @@ -8231,6 +8248,9 @@ const docTemplate = `{ "server_api_params.GroupInfo": { "type": "object", "properties": { + "applyMemberFriend": { + "type": "integer" + }, "createTime": { "type": "integer" }, @@ -8255,6 +8275,9 @@ const docTemplate = `{ "introduction": { "type": "string" }, + "lookMemberInfo": { + "type": "integer" + }, "memberCount": { "type": "integer" }, @@ -8264,6 +8287,12 @@ const docTemplate = `{ "notification": { "type": "string" }, + "notificationUpdateTime": { + "type": "integer" + }, + "notificationUserID": { + "type": "string" + }, "ownerUserID": { "type": "string" }, @@ -8287,6 +8316,9 @@ const docTemplate = `{ "groupID": { "type": "string" }, + "inviterUserID": { + "type": "string" + }, "joinSource": { "type": "integer" }, @@ -8331,6 +8363,12 @@ const docTemplate = `{ "handleUserID": { "type": "string" }, + "inviterUserID": { + "type": "string" + }, + "joinSource": { + "type": "integer" + }, "reqMsg": { "type": "string" }, diff --git a/cmd/open_im_api/docs/swagger.json b/cmd/open_im_api/docs/swagger.json index d93a390f8..dad0df3fe 100644 --- a/cmd/open_im_api/docs/swagger.json +++ b/cmd/open_im_api/docs/swagger.json @@ -147,13 +147,6 @@ "summary": "用户注册", "operationId": "UserRegister", "parameters": [ - { - "type": "string", - "description": "im token", - "name": "token", - "in": "header", - "required": true - }, { "description": "secret为openIM密钥, 详细见服务端config.yaml secret字段 \u003cbr\u003e platform为平台ID \u003cbr\u003e ex为拓展字段 \u003cbr\u003e gender为性别, 0为女, 1为男", "name": "req", @@ -201,13 +194,6 @@ "summary": "用户登录", "operationId": "UserToken", "parameters": [ - { - "type": "string", - "description": "im token", - "name": "token", - "in": "header", - "required": true - }, { "description": "secret为openIM密钥, 详细见服务端config.yaml secret字段 \u003cbr\u003e platform为平台ID", "name": "req", @@ -4588,7 +4574,6 @@ "Open_IM_internal_api_manage.OANotificationElem": { "type": "object", "required": [ - "notificationFaceURL", "notificationName", "notificationType", "text" @@ -5942,9 +5927,15 @@ "operationID" ], "properties": { + "count": { + "type": "integer" + }, "groupID": { "type": "string" }, + "offset": { + "type": "integer" + }, "operationID": { "type": "string" } @@ -6513,7 +6504,11 @@ ], "properties": { "roleLevel": { - "type": "integer" + "type": "integer", + "enum": [ + 1, + 3 + ] }, "userID": { "type": "string" @@ -6644,6 +6639,12 @@ "groupID": { "type": "string" }, + "inviterUserID": { + "type": "string" + }, + "joinSource": { + "type": "integer" + }, "operationID": { "type": "string" }, @@ -6743,6 +6744,9 @@ "sessionType" ], "properties": { + "businessOperationID": { + "type": "string" + }, "contentType": { "type": "integer" }, @@ -6752,6 +6756,9 @@ "isOnlineOnly": { "type": "boolean" }, + "notOfflinePush": { + "type": "boolean" + }, "offlinePushInfo": { "$ref": "#/definitions/server_api_params.OfflinePushInfo" }, @@ -6790,6 +6797,9 @@ "sessionType" ], "properties": { + "businessOperationID": { + "type": "string" + }, "contentType": { "type": "integer" }, @@ -6799,6 +6809,9 @@ "isOnlineOnly": { "type": "boolean" }, + "notOfflinePush": { + "type": "boolean" + }, "offlinePushInfo": { "$ref": "#/definitions/server_api_params.OfflinePushInfo" }, @@ -7055,7 +7068,6 @@ "required": [ "fromUserID", "operationID", - "remark", "toUserID" ], "properties": { @@ -7121,6 +7133,9 @@ "operationID" ], "properties": { + "applyMemberFriend": { + "type": "integer" + }, "ex": { "type": "string" }, @@ -7136,6 +7151,9 @@ "introduction": { "type": "string" }, + "lookMemberInfo": { + "type": "integer" + }, "needVerification": { "type": "integer" }, @@ -7739,7 +7757,6 @@ "internal_api_manage.OANotificationElem": { "type": "object", "required": [ - "notificationFaceURL", "notificationName", "notificationType", "text" @@ -8223,6 +8240,9 @@ "server_api_params.GroupInfo": { "type": "object", "properties": { + "applyMemberFriend": { + "type": "integer" + }, "createTime": { "type": "integer" }, @@ -8247,6 +8267,9 @@ "introduction": { "type": "string" }, + "lookMemberInfo": { + "type": "integer" + }, "memberCount": { "type": "integer" }, @@ -8256,6 +8279,12 @@ "notification": { "type": "string" }, + "notificationUpdateTime": { + "type": "integer" + }, + "notificationUserID": { + "type": "string" + }, "ownerUserID": { "type": "string" }, @@ -8279,6 +8308,9 @@ "groupID": { "type": "string" }, + "inviterUserID": { + "type": "string" + }, "joinSource": { "type": "integer" }, @@ -8323,6 +8355,12 @@ "handleUserID": { "type": "string" }, + "inviterUserID": { + "type": "string" + }, + "joinSource": { + "type": "integer" + }, "reqMsg": { "type": "string" }, diff --git a/cmd/open_im_api/docs/swagger.yaml b/cmd/open_im_api/docs/swagger.yaml index 08b433cd2..c9b99dfb2 100644 --- a/cmd/open_im_api/docs/swagger.yaml +++ b/cmd/open_im_api/docs/swagger.yaml @@ -38,7 +38,6 @@ definitions: videoElem: $ref: '#/definitions/Open_IM_internal_api_manage.VideoElem' required: - - notificationFaceURL - notificationName - notificationType - text @@ -910,8 +909,12 @@ definitions: type: object base_info.GetGroupAllMemberReq: properties: + count: + type: integer groupID: type: string + offset: + type: integer operationID: type: string required: @@ -1285,6 +1288,9 @@ definitions: base_info.GroupAddMemberInfo: properties: roleLevel: + enum: + - 1 + - 3 type: integer userID: type: string @@ -1372,6 +1378,10 @@ definitions: properties: groupID: type: string + inviterUserID: + type: string + joinSource: + type: integer operationID: type: string reqMessage: @@ -1436,12 +1446,16 @@ definitions: type: object base_info.ManagementBatchSendMsgReq: properties: + businessOperationID: + type: string contentType: type: integer groupID: type: string isOnlineOnly: type: boolean + notOfflinePush: + type: boolean offlinePushInfo: $ref: '#/definitions/server_api_params.OfflinePushInfo' operationID: @@ -1468,12 +1482,16 @@ definitions: type: object base_info.ManagementSendMsgReq: properties: + businessOperationID: + type: string contentType: type: integer groupID: type: string isOnlineOnly: type: boolean + notOfflinePush: + type: boolean offlinePushInfo: $ref: '#/definitions/server_api_params.OfflinePushInfo' operationID: @@ -1657,7 +1675,6 @@ definitions: required: - fromUserID - operationID - - remark - toUserID type: object base_info.SetFriendRemarkResp: @@ -1689,6 +1706,8 @@ definitions: type: object base_info.SetGroupInfoReq: properties: + applyMemberFriend: + type: integer ex: type: string faceURL: @@ -1699,6 +1718,8 @@ definitions: type: string introduction: type: string + lookMemberInfo: + type: integer needVerification: type: integer notification: @@ -2134,7 +2155,6 @@ definitions: videoElem: $ref: '#/definitions/internal_api_manage.VideoElem' required: - - notificationFaceURL - notificationName - notificationType - text @@ -2428,6 +2448,8 @@ definitions: type: object server_api_params.GroupInfo: properties: + applyMemberFriend: + type: integer createTime: type: integer creatorUserID: @@ -2444,12 +2466,18 @@ definitions: type: integer introduction: type: string + lookMemberInfo: + type: integer memberCount: type: integer needVerification: type: integer notification: type: string + notificationUpdateTime: + type: integer + notificationUserID: + type: string ownerUserID: type: string status: @@ -2465,6 +2493,8 @@ definitions: type: string groupID: type: string + inviterUserID: + type: string joinSource: type: integer joinTime: @@ -2494,6 +2524,10 @@ definitions: type: integer handleUserID: type: string + inviterUserID: + type: string + joinSource: + type: integer reqMsg: type: string reqTime: @@ -2702,11 +2736,6 @@ paths: description: 用户注册 operationId: UserRegister parameters: - - description: im token - in: header - name: token - required: true - type: string - description: secret为openIM密钥, 详细见服务端config.yaml secret字段
platform为平台ID
ex为拓展字段
gender为性别, 0为女, 1为男 in: body @@ -2739,11 +2768,6 @@ paths: description: 获取用户的token operationId: UserToken parameters: - - description: im token - in: header - name: token - required: true - type: string - description: secret为openIM密钥, 详细见服务端config.yaml secret字段
platform为平台ID in: body name: req