client/docs/passport/passport.swagger.json

264 lines
5.6 KiB
JSON
Raw Normal View History

2025-09-07 22:03:28 +08:00
{
"swagger": "2.0",
"info": {
2025-09-13 21:01:25 +08:00
"title": "blocks.proto",
2025-09-07 22:03:28 +08:00
"version": "version not set"
},
"tags": [
{
2025-09-13 21:01:25 +08:00
"name": "Account"
2025-09-07 22:03:28 +08:00
},
{
2025-09-13 21:01:25 +08:00
"name": "Forget"
2025-09-07 22:03:28 +08:00
},
{
2025-09-13 21:01:25 +08:00
"name": "Login"
},
{
"name": "Register"
2025-09-07 22:03:28 +08:00
}
],
"consumes": [
"application/json"
],
"produces": [
"application/json"
],
"paths": {},
"definitions": {
2025-09-13 21:01:25 +08:00
"passportForgetReply": {
2025-09-07 22:03:28 +08:00
"type": "object",
"properties": {
2025-09-13 21:01:25 +08:00
"identity": {
2025-09-07 22:03:28 +08:00
"type": "string",
2025-09-13 21:01:25 +08:00
"title": "用户唯一码"
2025-09-07 22:03:28 +08:00
},
2025-09-13 21:01:25 +08:00
"dataBind": {
2025-09-07 22:03:28 +08:00
"type": "string",
2025-09-13 21:01:25 +08:00
"title": "数据绑定的相关说明,PASS通过NOPHONE没有绑定手机号NOPWD没有设置密码NOBIND没有手机号同时没有密码"
2025-09-07 22:03:28 +08:00
},
2025-09-13 21:01:25 +08:00
"token": {
2025-09-07 22:03:28 +08:00
"type": "string",
2025-09-13 21:01:25 +08:00
"title": "用户凭证"
2025-09-07 22:03:28 +08:00
},
2025-09-13 21:01:25 +08:00
"extend": {
"type": "object",
"additionalProperties": {
"type": "string"
},
"title": "扩展字段"
}
}
},
"passportGetFullReply": {
"type": "object",
"properties": {
"identity": {
"type": "string",
2025-09-13 21:01:25 +08:00
"title": "唯一标识"
},
2025-09-13 21:01:25 +08:00
"account": {
2025-09-07 22:03:28 +08:00
"type": "string",
2025-09-13 21:01:25 +08:00
"title": "帐号"
2025-09-07 22:03:28 +08:00
},
2025-09-13 21:01:25 +08:00
"phone": {
2025-09-07 22:03:28 +08:00
"type": "string",
2025-09-13 21:01:25 +08:00
"title": "手机号码 必填"
},
2025-09-13 21:01:25 +08:00
"email": {
"type": "string",
2025-09-13 21:01:25 +08:00
"title": "验证码"
},
2025-09-13 21:01:25 +08:00
"rights": {
"type": "string",
2025-09-13 21:01:25 +08:00
"title": "权限"
2025-09-07 22:03:28 +08:00
},
2025-09-13 21:01:25 +08:00
"nickname": {
2025-09-07 22:03:28 +08:00
"type": "string",
2025-09-13 21:01:25 +08:00
"title": "昵称"
2025-09-07 22:03:28 +08:00
},
2025-09-13 21:01:25 +08:00
"avatar": {
2025-09-07 22:03:28 +08:00
"type": "string",
2025-09-13 21:01:25 +08:00
"title": "头像"
2025-09-07 22:03:28 +08:00
},
2025-09-13 21:01:25 +08:00
"birthday": {
2025-09-07 22:03:28 +08:00
"type": "string",
2025-09-13 21:01:25 +08:00
"title": "生日"
},
2025-09-13 21:01:25 +08:00
"sex": {
"type": "integer",
"format": "int32",
"title": "性别1为男性2为女性"
2025-09-07 22:03:28 +08:00
},
2025-09-13 21:01:25 +08:00
"country": {
"type": "integer",
"format": "int32",
"title": "国家"
2025-09-07 22:03:28 +08:00
},
2025-09-13 21:01:25 +08:00
"province": {
"type": "integer",
"format": "int32",
"title": "省"
},
"city": {
"type": "integer",
"format": "int32",
"title": "市"
},
"area": {
"type": "integer",
"format": "int32",
"title": "区"
2025-09-07 22:03:28 +08:00
},
2025-09-13 21:01:25 +08:00
"sign": {
"type": "string",
2025-09-13 21:01:25 +08:00
"title": "签名"
},
2025-09-13 21:01:25 +08:00
"cover": {
2025-09-13 15:59:10 +08:00
"type": "string",
2025-09-13 21:01:25 +08:00
"title": "背景\u0026封面"
},
2025-09-13 21:01:25 +08:00
"score": {
"type": "integer",
"format": "int32",
2025-09-13 21:01:25 +08:00
"title": "积分"
},
"level": {
"type": "integer",
"format": "int32",
"title": "等级"
},
"verify": {
"type": "object",
"additionalProperties": {
"type": "boolean"
},
"title": "数据"
},
"tags": {
"type": "array",
"items": {
"type": "object",
"$ref": "#/definitions/passportTagItem"
}
2025-09-07 22:03:28 +08:00
}
2025-09-13 21:01:25 +08:00
},
"title": "获取会员的完整信息"
2025-09-07 22:03:28 +08:00
},
2025-09-13 21:01:25 +08:00
"passportLoginReply": {
2025-09-07 22:03:28 +08:00
"type": "object",
"properties": {
2025-09-13 21:01:25 +08:00
"id": {
"type": "string",
"format": "int64"
},
"identity": {
"type": "string",
"title": "用户唯一码"
},
"token": {
"type": "string",
"title": "用户凭证"
},
"extend": {
"type": "object",
"additionalProperties": {
"type": "string"
},
"title": "扩展字段"
2025-09-07 22:03:28 +08:00
}
}
},
2025-09-13 21:01:25 +08:00
"passportRegisterReply": {
2025-09-07 22:03:28 +08:00
"type": "object",
"properties": {
2025-09-13 21:01:25 +08:00
"id": {
"type": "string",
"format": "int64"
},
"identity": {
"type": "string",
"title": "用户唯一码"
},
"token": {
"type": "string",
"title": "用户Header所需Token"
},
"extend": {
"type": "object",
"additionalProperties": {
"type": "string"
},
"title": "扩展字段"
2025-09-07 22:03:28 +08:00
}
}
},
2025-09-13 21:01:25 +08:00
"passportStatisticsReply": {
2025-09-07 22:03:28 +08:00
"type": "object",
"properties": {
2025-09-13 21:01:25 +08:00
"Data": {
"type": "object",
"additionalProperties": {
"type": "string",
"format": "int64"
},
"title": "数据以Map格式输出"
2025-09-07 22:03:28 +08:00
}
}
},
2025-09-13 21:01:25 +08:00
"passportStatusReply": {
2025-09-07 22:03:28 +08:00
"type": "object",
"properties": {
2025-09-13 21:01:25 +08:00
"data": {
2025-09-07 22:03:28 +08:00
"type": "string",
2025-09-13 21:01:25 +08:00
"title": "数据"
2025-09-07 22:03:28 +08:00
},
"timeseq": {
"type": "string",
"format": "int64",
"title": "响应时间序列"
}
}
},
2025-09-13 21:01:25 +08:00
"passportTagItem": {
"type": "object",
"properties": {
"name": {
"type": "string"
},
"icon": {
"type": "string"
}
}
},
2025-09-07 22:03:28 +08:00
"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"
}
}
}
}
}
}