client/docs/passport/passport.swagger.json

346 lines
7.5 KiB
JSON
Raw Permalink Blame History

This file contains ambiguous Unicode characters

This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

{
"swagger": "2.0",
"info": {
"title": "blocks.proto",
"version": "version not set"
},
"tags": [
{
"name": "Account"
},
{
"name": "Forget"
},
{
"name": "Login"
},
{
"name": "Register"
},
{
"name": "Verify"
}
],
"consumes": [
"application/json"
],
"produces": [
"application/json"
],
"paths": {},
"definitions": {
"passportDocument": {
"type": "object",
"properties": {
"status": {
"type": "string",
"description": "\"APPROVED_VERIFIED\", \"DENIED_FRAUD\", etc."
},
"type": {
"type": "string",
"description": "\"PASSPORT\", \"DRIVER_LICENSE\", etc."
},
"issuingCountry": {
"type": "string"
},
"number": {
"type": "string"
}
}
},
"passportFaceMap": {
"type": "object",
"properties": {
"status": {
"type": "string"
},
"similarity": {
"type": "number",
"format": "float",
"title": "人脸比对相似度"
}
}
},
"passportGetFullReply": {
"type": "object",
"properties": {
"identity": {
"type": "string",
"title": "唯一标识"
},
"account": {
"type": "string",
"title": "帐号"
},
"phone": {
"type": "string",
"title": "手机号码 必填"
},
"email": {
"type": "string",
"title": "验证码"
},
"rights": {
"type": "string",
"title": "权限"
},
"nickname": {
"type": "string",
"title": "昵称"
},
"avatar": {
"type": "string",
"title": "头像"
},
"birthday": {
"type": "string",
"title": "生日"
},
"sex": {
"type": "integer",
"format": "int32",
"title": "性别1为男性2为女性"
},
"country": {
"type": "string",
"title": "国家"
},
"province": {
"type": "string",
"title": "省"
},
"city": {
"type": "string",
"title": "市"
},
"area": {
"type": "string",
"title": "区"
},
"sign": {
"type": "string",
"title": "签名"
},
"cover": {
"type": "string",
"title": "背景\u0026封面"
},
"score": {
"type": "integer",
"format": "int32",
"title": "积分"
},
"level": {
"type": "integer",
"format": "int32",
"title": "等级"
},
"verifyStatus": {
"$ref": "#/definitions/passportVerifyStatus",
"title": "用户验证状态"
},
"tags": {
"type": "array",
"items": {
"type": "object",
"$ref": "#/definitions/passportTagItem"
},
"title": "用户标签"
}
},
"title": "获取会员的完整信息"
},
"passportLoginReply": {
"type": "object",
"properties": {
"id": {
"type": "string",
"format": "int64"
},
"identity": {
"type": "string",
"title": "用户唯一码"
},
"token": {
"type": "string",
"title": "用户凭证"
},
"extend": {
"type": "object",
"additionalProperties": {
"type": "string"
},
"title": "扩展字段"
},
"verifyStatus": {
"$ref": "#/definitions/passportVerifyStatus",
"title": "用户验证状态"
}
}
},
"passportPersonalInformation": {
"type": "object",
"properties": {
"firstName": {
"type": "string"
},
"lastName": {
"type": "string"
},
"dateOfBirth": {
"type": "string"
},
"nationality": {
"type": "string"
}
}
},
"passportRegisterReply": {
"type": "object",
"properties": {
"id": {
"type": "string",
"format": "int64"
},
"identity": {
"type": "string",
"title": "用户唯一码"
},
"token": {
"type": "string",
"title": "用户Header所需Token"
},
"extend": {
"type": "object",
"additionalProperties": {
"type": "string"
},
"title": "扩展字段"
},
"verifyStatus": {
"$ref": "#/definitions/passportVerifyStatus",
"title": "用户验证状态"
}
}
},
"passportStatisticsReply": {
"type": "object",
"properties": {
"Data": {
"type": "object",
"additionalProperties": {
"type": "string",
"format": "int64"
},
"title": "数据以Map格式输出"
}
}
},
"passportStatusReply": {
"type": "object",
"properties": {
"code": {
"type": "integer",
"format": "int32",
"title": "状态码"
},
"message": {
"type": "string",
"title": "状态说明"
},
"details": {
"type": "string",
"title": "数据"
},
"timeseq": {
"type": "string",
"format": "int64",
"title": "响应时间序列"
}
}
},
"passportTagItem": {
"type": "object",
"properties": {
"name": {
"type": "string"
},
"icon": {
"type": "string"
}
}
},
"passportVerificationStatus": {
"type": "object",
"properties": {
"state": {
"type": "string",
"title": "\"PENDING\", \"DONE\", \"FAILED\""
},
"reason": {
"type": "string",
"title": "可选字段,失败原因"
}
}
},
"passportVerifyStatus": {
"type": "object",
"properties": {
"emailVerify": {
"type": "integer",
"format": "int32",
"title": "邮箱是否已验证"
},
"phoneVerify": {
"type": "integer",
"format": "int32",
"title": "手机是否已验证"
},
"faceVerify": {
"type": "integer",
"format": "int32",
"title": "人脸或照片是否已验证"
},
"documentVerify": {
"type": "integer",
"format": "int32",
"title": "证件是否已验证"
},
"kycVerify": {
"type": "integer",
"format": "int32",
"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"
}
}
}
}
}
}