增加API文档注释

pkg/rpc/protos/models/model_user.proto

@@ -16,14 +16,14 @@ message User {
 	string email = 6; // 联系邮箱
 	string verifiedEmail = 20; // 已验证邮箱
 	string verifiedMobile = 23; // 已验证手机号码
-	string remark = 7;
-	bool isOn = 8;
-	int64 createdAt = 9;
-	string registeredIP = 12;
-	bool isVerified = 13;
-	bool isRejected = 14;
-	string rejectReason = 15;
-	bool isDeleted = 16;
+	string remark = 7; // 备注
+	bool isOn = 8; // 是否启用
+	int64 createdAt = 9; // 创建时间
+	string registeredIP = 12; // 注册IP
+	bool isVerified = 13; // 是否已实名认证
+	bool isRejected = 14; // 实名认证是否已拒绝
+	string rejectReason = 15; // 实名认证拒绝理由
+	bool isDeleted = 16; // 是否已删除
 	bool isIndividualIdentified = 17; // 是否已通过个人验证
 	bool isEnterpriseIdentified = 18; // 是否已通过企业验证
 	string bandwidthAlgo = 21; // 带宽算法
@@ -31,6 +31,6 @@ message User {
 
 	Login otpLogin = 19; // OTP认证
 
-	NodeCluster nodeCluster = 10;
-	repeated UserFeature features = 11;
+	NodeCluster nodeCluster = 10; // 集群信息
+	repeated UserFeature features = 11; // 开通功能
 }

pkg/rpc/protos/models/model_user_account.proto

@@ -6,10 +6,10 @@ package pb;
 import "models/model_user.proto";
 
 message UserAccount {
-	int64 id = 1;
-	int64 userId = 2;
-	double total = 3;
-	double totalFrozen = 4;
+	int64 id = 1; // 账户ID
+	int64 userId = 2; // 用户ID
+	double total = 3; // 总可用余额
+	double totalFrozen = 4; // 总冻结余额
 
-	User user = 30;
+	User user = 30; // 用户信息
 }

pkg/rpc/protos/service_reverse_proxy.proto

@@ -38,43 +38,43 @@ message CreateReverseProxyRequest {
 }
 
 message CreateReverseProxyResponse {
-	int64 reverseProxyId = 1;
+	int64 reverseProxyId = 1; // 反向代理ID
 }
 
 // 查找反向代理
 message FindEnabledReverseProxyRequest {
-	int64 reverseProxyId = 1;
+	int64 reverseProxyId = 1; // 反向代理ID
 }
 
 message FindEnabledReverseProxyResponse {
-	ReverseProxy reverseProxy = 1;
+	ReverseProxy reverseProxy = 1; // 反向代理信息
 }
 
 // 查找反向代理配置
 message FindEnabledReverseProxyConfigRequest {
-	int64 reverseProxyId = 1;
+	int64 reverseProxyId = 1; // 反向代理ID
 }
 
 message FindEnabledReverseProxyConfigResponse {
-	bytes reverseProxyJSON = 1;
+	bytes reverseProxyJSON = 1; // 反向代理配置
 }
 
 // 修改反向代理调度算法
 message UpdateReverseProxySchedulingRequest {
-	int64 reverseProxyId = 1;
-	bytes schedulingJSON = 2;
+	int64 reverseProxyId = 1; // 反向代理ID
+	bytes schedulingJSON = 2; // 调度配置 @link json:scheduling
 }
 
 // 修改主要源站信息
 message UpdateReverseProxyPrimaryOriginsRequest {
-	int64 reverseProxyId = 1;
-	bytes originsJSON = 2;
+	int64 reverseProxyId = 1; // 反向代理ID
+	bytes originsJSON = 2; // 源站配置 @link json:origin_refs
 }
 
 // 修改备用源站信息
 message UpdateReverseProxyBackupOriginsRequest {
-	int64 reverseProxyId = 1;
-	bytes originsJSON = 2;
+	int64 reverseProxyId = 1; // 反向代理ID
+	bytes originsJSON = 2; // 源站配置 @link json:origin_refs
 }
 
 // 修改反向代理设置

pkg/rpc/protos/service_user_account.proto

@@ -26,43 +26,43 @@ service UserAccountService {
 
 // 计算账户数量
 message CountUserAccountsRequest {
-	string keyword = 1;
+	string keyword = 1; // 关键词
 }
 
 // 列出单页账户
 message ListUserAccountsRequest  {
-	string keyword = 1;
+	string keyword = 1; // 关键词
 	int64 offset = 2;
 	int64 size = 3;
 }
 
 message ListUserAccountsResponse {
-	repeated UserAccount userAccounts = 1;
+	repeated UserAccount userAccounts = 1; // 用户账户列表
 }
 
 // 根据用户ID查找单个账户
 message FindEnabledUserAccountWithUserIdRequest {
-	int64 userId = 1;
+	int64 userId = 1; // 用户ID
 }
 
 message FindEnabledUserAccountWithUserIdResponse {
-	UserAccount userAccount = 1;
+	UserAccount userAccount = 1; // 用户账户
 }
 
 // 查找单个账户
 message FindEnabledUserAccountRequest {
-	int64 userAccountId = 1;
+	int64 userAccountId = 1; // 用户账户ID
 }
 
 message FindEnabledUserAccountResponse {
-	UserAccount userAccount = 1;
+	UserAccount userAccount = 1; // 用户账户
 }
 
 // 修改用户账户
 message UpdateUserAccountRequest {
-	int64 userAccountId = 1;
-	double delta = 2;
-	string eventType = 3;
-	string description = 4;
-	bytes paramsJSON = 5;
+	int64 userAccountId = 1; // 用户账户ID（非用户ID）
+	double delta = 2; // 操作的数值，正值表示增加，负值表示减少
+	string eventType = 3; // 事件类型：charge, award, buyPlan, payBill, refund, withdraw, buyNSPlan, buyTrafficPackage, buyAntiDDoSPackage, renewAntiDDoSPackage
+	string description = 4; // 描述
+	bytes paramsJSON = 5; // 相关参数
 }