client/docs/passport/passport.swagger.json

288 lines
6.2 KiB
JSON
Raw Normal View History

2025-09-07 22:03:28 +08:00
{
"swagger": "2.0",
"info": {
"title": "blocks.proto",
"version": "version not set"
},
"tags": [
{
"name": "Forget"
},
{
"name": "Info"
},
{
"name": "Login"
},
{
"name": "Register"
}
],
"consumes": [
"application/json"
],
"produces": [
"application/json"
],
"paths": {},
"definitions": {
"passportForgetReply": {
"type": "object",
"properties": {
"identity": {
"type": "string",
"title": "用户唯一码"
},
"dataBind": {
"type": "string",
"title": "数据绑定的相关说明,PASS通过NOPHONE没有绑定手机号NOPWD没有设置密码NOBIND没有手机号同时没有密码"
},
"token": {
"type": "string",
"title": "用户凭证"
},
"extend": {
"type": "object",
"additionalProperties": {
"type": "string"
},
"title": "扩展字段"
}
}
},
"passportGetDataReply": {
"type": "object",
"properties": {
"account": {
"type": "string",
"title": "帐号"
},
"phone": {
"type": "string",
"title": "手机号"
},
"nickname": {
"type": "string",
"title": "昵称"
},
"avatar": {
"type": "string",
"title": "头像"
},
"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": "签名"
},
"approve": {
"type": "integer",
"format": "int32",
"title": "状态:-2,认证未通过0为未认证1为审核中2为认证成功"
}
}
},
"passportLoginReply": {
"type": "object",
"properties": {
"id": {
"type": "string",
"format": "int64"
},
"identity": {
"type": "string",
"title": "用户唯一码"
},
"token": {
"type": "string",
"title": "用户凭证"
},
"phone": {
"type": "string"
},
"name": {
"type": "string"
},
"extend": {
"type": "object",
"additionalProperties": {
"type": "string"
},
"title": "扩展字段"
}
}
},
"passportRegisterReply": {
"type": "object",
"properties": {
"id": {
"type": "string",
"format": "int64"
},
"identity": {
"type": "string",
"title": "用户唯一码"
},
"dataBind": {
"type": "string",
"title": "数据绑定的相关说明,PASS通过NOPHONE没有绑定手机号NOPWD没有设置密码NOBIND没有手机号同时没有密码"
},
"token": {
"type": "string",
"title": "用户Header所需Token"
},
"extend": {
"type": "object",
"additionalProperties": {
"type": "string"
},
"title": "扩展字段"
}
}
},
"passportStatisticsReply": {
"type": "object",
"properties": {
"Data": {
"type": "object",
"additionalProperties": {
"type": "string",
"format": "int64"
},
"title": "数据以Map格式输出"
}
}
},
"passportStatusReply": {
"type": "object",
"properties": {
"status": {
"type": "string",
"format": "int64",
"title": "状态码"
},
"identity": {
"type": "string",
"title": "标识码"
},
"message": {
"type": "string",
"title": "状态说明"
},
"timeseq": {
"type": "string",
"format": "int64",
"title": "响应时间序列"
}
}
},
"passportWeChatByCodeReply": {
"type": "object",
"properties": {
"sessionKey": {
"type": "string",
"title": "WeChat session key"
},
"openId": {
"type": "string",
"title": "WeChat open id"
},
"identity": {
"type": "string",
"title": "identity"
},
"account": {
"type": "string",
"title": "account"
}
}
},
"passportWeChatByPhoneReply": {
"type": "object",
"properties": {
"account": {
"type": "string",
"title": "WeChat code"
}
}
},
"passportWeChatGetUserinfoReply": {
"type": "object",
"properties": {
"id": {
"type": "string",
"format": "int64"
},
"account": {
"type": "string"
},
"identity": {
"type": "string"
},
"nickName": {
"type": "string"
},
"avatar": {
"type": "string"
},
"rights": {
"type": "string"
},
"token": {
"type": "string"
}
}
},
"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"
}
}
}
}
}
}