f
This commit is contained in:
92
app/main/api/desc/admin/admin_query_whitelist.api
Normal file
92
app/main/api/desc/admin/admin_query_whitelist.api
Normal file
@@ -0,0 +1,92 @@
|
||||
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 AdminQueryWhitelistOpLogList
|
||||
get /op-log/list (AdminQueryWhitelistOpLogListReq) returns (AdminQueryWhitelistOpLogListResp)
|
||||
}
|
||||
|
||||
type (
|
||||
AdminQueryWhitelistCreateReq {
|
||||
Name string `json:"name"` // 姓名,* 表示仅按身份证匹配
|
||||
IdCard string `json:"id_card"` // 身份证号
|
||||
ApiCodes []string `json:"api_codes"` // 产品编码列表
|
||||
Remark string `json:"remark,optional"` // 备注
|
||||
}
|
||||
|
||||
AdminQueryWhitelistAppendReq {
|
||||
Name string `json:"name"` // 姓名,* 表示仅按身份证匹配
|
||||
IdCard string `json:"id_card"` // 身份证号
|
||||
ApiCodes []string `json:"api_codes"` // 产品编码列表
|
||||
Remark string `json:"remark,optional"` // 备注
|
||||
}
|
||||
|
||||
AdminQueryWhitelistEntryItem {
|
||||
Id string `json:"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"`
|
||||
}
|
||||
|
||||
AdminQueryWhitelistOpResp {
|
||||
TianyuanCode int `json:"tianyuan_code"` // 天远业务码
|
||||
TianyuanMessage string `json:"tianyuan_message"` // 天远返回描述
|
||||
TransactionId string `json:"transaction_id,optional"` // 天远流水号
|
||||
Entry *AdminQueryWhitelistEntryItem `json:"entry,optional"` // 成功时规则详情
|
||||
}
|
||||
|
||||
AdminQueryWhitelistOpLogListReq {
|
||||
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
|
||||
TianyuanCode *int64 `form:"tianyuan_code,optional"` // 天远业务码,0=成功
|
||||
}
|
||||
|
||||
AdminQueryWhitelistOpLogItem {
|
||||
Id string `json:"id"`
|
||||
AdminUserId string `json:"admin_user_id"`
|
||||
AdminUserName string `json:"admin_user_name"`
|
||||
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 int `json:"tianyuan_code"`
|
||||
TianyuanMessage string `json:"tianyuan_message"`
|
||||
TransactionId string `json:"transaction_id"`
|
||||
EntryId string `json:"entry_id"`
|
||||
EntryStatus string `json:"entry_status"`
|
||||
EntryApiCodes []string `json:"entry_api_codes"`
|
||||
CreateTime string `json:"create_time"`
|
||||
}
|
||||
|
||||
AdminQueryWhitelistOpLogListResp {
|
||||
Total int64 `json:"total"`
|
||||
Items []AdminQueryWhitelistOpLogItem `json:"items"`
|
||||
}
|
||||
)
|
||||
@@ -31,6 +31,4 @@ import "./admin/admin_query.api"
|
||||
import "./admin/admin_agent.api"
|
||||
import "./admin/admin_api.api"
|
||||
import "./admin/admin_role_api.api"
|
||||
|
||||
|
||||
|
||||
import "./admin/admin_query_whitelist.api"
|
||||
|
||||
Reference in New Issue
Block a user