Files
full/module/social/group/swagger/passport.swagger.json

337 lines
7.4 KiB
JSON
Raw Normal View History

{
"swagger": "2.0",
"info": {
"title": "blocks.proto",
"version": "version not set"
},
"tags": [
{
"name": "Basic"
},
{
"name": "Member"
}
],
"consumes": [
"application/json"
],
"produces": [
"application/json"
],
"paths": {},
"definitions": {
"groupApplyJoinGroupItem": {
"type": "object",
"properties": {
"identity": {
"type": "string",
"title": "唯一标识"
},
"groupId": {
"type": "string",
"format": "int64",
"title": "主键"
},
"from": {
"$ref": "#/definitions/groupPassportInfoDetailCard"
},
"message": {
"type": "string"
},
"createdAt": {
"type": "string",
"title": "时间"
},
"status": {
"type": "integer",
"format": "int32",
"title": "状态"
}
}
},
"groupGroupItem": {
"type": "object",
"properties": {
"id": {
"type": "string",
"format": "int64",
"title": "主键"
},
"identity": {
"type": "string",
"title": "唯一标识"
},
"number": {
"type": "string",
"format": "int64",
"title": "群组编号"
},
"avatar": {
"type": "string",
"title": "群组头像"
},
"name": {
"type": "string",
"title": "群组名称"
},
"introduce": {
"type": "string",
"title": "群组简介"
},
"creatorId": {
"type": "string",
"format": "int64",
"title": "创建者ID"
},
"cretorIdentity": {
"type": "string",
"title": "创建者Identity"
},
"memberLimit": {
"type": "integer",
"format": "int32",
"title": "最大成员数,0代表不限制"
},
"master": {
"type": "array",
"items": {
"type": "string"
},
"title": "管理员"
},
"notice": {
"type": "string",
"title": "群组公告"
},
"background": {
"type": "string",
"title": "群组背景"
},
"tags": {
"type": "array",
"items": {
"type": "string"
},
"title": "群组标签"
},
"memberTotal": {
"type": "integer",
"format": "int32",
"title": "群组成员数"
},
"enableSearchByNumber": {
"type": "boolean",
"title": "是否开启群号搜索"
},
"enableSearchByName": {
"type": "boolean",
"title": "是否开启群名搜索"
},
"createdAt": {
"type": "string",
"title": "群组创建时间"
}
}
},
"groupGroupMemberReply": {
"type": "object",
"properties": {
"total": {
"type": "integer",
"format": "int32",
"title": "总记录数"
},
"version": {
"type": "string",
"format": "int64",
"title": "版本号"
},
"members": {
"type": "array",
"items": {
"type": "object",
"$ref": "#/definitions/groupPassportInfoSimpleCard"
},
"title": "成员信息"
}
}
},
"groupGroupsReply": {
"type": "object",
"properties": {
"total": {
"type": "integer",
"format": "int32",
"title": "总记录数"
},
"version": {
"type": "string",
"format": "int64",
"title": "版本号"
},
"groups": {
"type": "array",
"items": {
"type": "object",
"$ref": "#/definitions/groupGroupItem"
},
"title": "群组信息"
}
}
},
"groupJoinFetchReply": {
"type": "object",
"properties": {
"total": {
"type": "integer",
"format": "int32",
"title": "总记录数"
},
"applys": {
"type": "array",
"items": {
"type": "object",
"$ref": "#/definitions/groupApplyJoinGroupItem"
},
"title": "群组信息"
}
}
},
"groupPassportInfoDetailCard": {
"type": "object",
"properties": {
"identity": {
"type": "string"
},
"nickname": {
"type": "string",
"title": "昵称"
},
"remarkName": {
"type": "string",
"title": "备注名称"
},
"popular": {
"type": "integer",
"format": "int32",
"title": "是否置顶"
},
"avatar": {
"type": "string"
},
"birthday": {
"type": "string",
"title": "生日"
},
"sex": {
"type": "integer",
"format": "int32",
"title": "性别1为男性2为女性"
},
"province": {
"type": "integer",
"format": "int32",
"title": "省"
},
"city": {
"type": "integer",
"format": "int32",
"title": "市"
},
"area": {
"type": "integer",
"format": "int32",
"title": "区"
},
"sign": {
"type": "string",
"title": "签名"
},
"tags": {
"type": "array",
"items": {
"type": "string"
},
"title": "所属标签组"
},
"foreignStatus": {
"type": "integer",
"format": "int32",
"title": "外表的状态值,根据表不同,值的作用不同"
}
}
},
"groupPassportInfoSimpleCard": {
"type": "object",
"properties": {
"identity": {
"type": "string"
},
"nickname": {
"type": "string",
"title": "昵称"
},
"remarkName": {
"type": "string",
"title": "备注名称"
},
"avatar": {
"type": "string"
},
"sex": {
"type": "integer",
"format": "int32",
"title": "性别1为男性2为女性"
},
"role": {
"type": "integer",
"format": "int32",
"title": "角色,主要是群组内的角色使用"
}
}
},
"groupStatusReply": {
"type": "object",
"properties": {
"data": {
"type": "string",
"title": "数据"
},
"timeseq": {
"type": "string",
"format": "int64",
"title": "响应时间序列"
}
}
},
"protobufAny": {
"type": "object",
"properties": {
"@type": {
"type": "string"
}
},
"additionalProperties": {}
},
"rpcStatus": {
"type": "object",
"properties": {
"code": {
"type": "integer",
"format": "int32"
},
"message": {
"type": "string"
},
"details": {
"type": "array",
"items": {
"type": "object",
"$ref": "#/definitions/protobufAny"
}
}
}
}
}
}