addf

app/main/api/desc/admin/admin_query_whitelist.api

@@ -0,0 +1,85 @@
+syntax = "v1"
+
+info (
+	title:   "查询白名单管理"
+	desc:    "代理天远查询白名单配置接口"
+	version: "v1"
+)
+
+@server (
+	prefix: /api/v1/admin/query-whitelist
+	group:  admin_query_whitelist
+	middleware: AdminAuthInterceptor
+)
+service main {
+	@doc "创建查询白名单规则"
+	@handler AdminQueryWhitelistCreate
+	post /create (AdminQueryWhitelistCreateReq) returns (AdminQueryWhitelistOpResp)
+
+	@doc "追加查询白名单产品编码"
+	@handler AdminQueryWhitelistAppend
+	post /append (AdminQueryWhitelistAppendReq) returns (AdminQueryWhitelistOpResp)
+
+	@doc "查询白名单操作记录列表"
+	@handler AdminGetQueryWhitelistOpLogList
+	get /op-log/list (AdminGetQueryWhitelistOpLogListReq) returns (AdminGetQueryWhitelistOpLogListResp)
+}
+
+type (
+	AdminQueryWhitelistCreateReq {
+		Name     string   `json:"name"` // 姓名，* 表示只按身份证匹配
+		IdCard   string   `json:"id_card"` // 18位身份证号
+		ApiCodes []string `json:"api_codes"` // 产品编码列表
+		Remark   string   `json:"remark,optional"` // 备注
+	}
+	AdminQueryWhitelistAppendReq {
+		Name     string   `json:"name"` // 姓名，* 表示只按身份证匹配
+		IdCard   string   `json:"id_card"` // 18位身份证号
+		ApiCodes []string `json:"api_codes"` // 追加的产品编码列表
+		Remark   string   `json:"remark,optional"` // 备注，非空会覆盖原备注
+	}
+	AdminQueryWhitelistOpResp {
+		TianyuanCode    int                         `json:"tianyuan_code"` // 天远业务码
+		TianyuanMessage string                      `json:"tianyuan_message"` // 天远返回描述
+		TransactionId   string                      `json:"transaction_id,optional"` // 天远流水号
+		Entry           *QueryWhitelistEntryResult  `json:"entry,optional"` // 成功时规则详情
+	}
+	QueryWhitelistEntryResult {
+		Id           string   `json:"id"` // 规则ID
+		Name         string   `json:"name"` // 姓名规则
+		IdCardMasked string   `json:"id_card_masked"` // 脱敏身份证号
+		ApiCodes     []string `json:"api_codes"` // 当前产品编码列表
+		Status       string   `json:"status"` // 规则状态
+		Remark       string   `json:"remark"` // 备注
+		CreatedAt    string   `json:"created_at"` // 创建时间
+		UpdatedAt    string   `json:"updated_at"` // 更新时间
+	}
+	AdminGetQueryWhitelistOpLogListReq {
+		Page          int64  `form:"page,default=1"` // 页码
+		PageSize      int64  `form:"page_size,default=20"` // 每页数量
+		IdCard        string `form:"id_card,optional"` // 身份证号
+		Action        string `form:"action,optional"` // 操作类型：create / append
+		TianyuanResult string `form:"tianyuan_result,optional"` // 业务结果：success / fail
+	}
+	AdminGetQueryWhitelistOpLogListResp {
+		Total int64                        `json:"total"` // 总数
+		Items []QueryWhitelistOpLogListItem `json:"items"` // 列表
+	}
+	QueryWhitelistOpLogListItem {
+		Id              int64    `json:"id"` // 主键ID
+		AdminUserId     int64    `json:"admin_user_id"` // 操作管理员ID
+		Action          string   `json:"action"` // 操作类型
+		Name            string   `json:"name"` // 姓名规则
+		IdCard          string   `json:"id_card"` // 身份证号
+		IdCardMasked    string   `json:"id_card_masked"` // 脱敏身份证号
+		ApiCodes        []string `json:"api_codes"` // 本次提交的产品编码
+		Remark          string   `json:"remark"` // 备注
+		TianyuanCode    int64    `json:"tianyuan_code"` // 天远业务码
+		TianyuanMessage string   `json:"tianyuan_message"` // 天远返回描述
+		TransactionId   string   `json:"transaction_id"` // 天远流水号
+		EntryId         string   `json:"entry_id"` // 规则ID
+		EntryStatus     string   `json:"entry_status"` // 规则状态
+		EntryApiCodes   []string `json:"entry_api_codes"` // 规则当前产品编码
+		CreateTime      string   `json:"create_time"` // 创建时间
+	}
+)