Переглянути джерело

feat: api文件注释更新

BaiLuoYan 4 днів тому
батько
коміт
5f748e6984
1 змінених файлів з 4 додано та 4 видалено
  1. 4 4
      perm.api

+ 4 - 4
perm.api

@@ -373,11 +373,11 @@ service perm-api {
 	middleware: AdminLoginRateLimit
 )
 service perm-api {
-	// AdminLogin 管理后台登录。仅限超级管理员通过 managementKey + 用户名密码登录管理后台,返回 JWT 令牌对
+	// AdminLogin 管理后台登录。仅限超级管理员通过 managementKey + 用户名密码登录管理后台,返回 JWT 令牌对。cap.js 启用时拒绝此接口(必须走 adminLogin/cap)
 	@handler AdminLogin
 	post /auth/adminLogin (AdminLoginReq) returns (LoginResp)
 
-	// AdminLoginByCap 使用 cap.js 人机验证令牌登录管理后台,验证通过后执行与 AdminLogin 相同的业务逻辑
+	// AdminLoginByCap 使用 cap.js 人机验证令牌登录管理后台。cap.js 未启用时拒绝此接口(必须走 adminLogin),验证通过后执行与 AdminLogin 相同的业务逻辑
 	@handler AdminLoginByCap
 	post /auth/adminLogin/cap (AdminLoginByCapReq) returns (LoginResp)
 }
@@ -389,11 +389,11 @@ service perm-api {
 	middleware: ProductLoginRateLimit
 )
 service perm-api {
-	// Login 产品端登录。产品成员通过用户名密码 + productCode 登录指定产品,返回 JWT 令牌对及用户权限信息
+	// Login 产品端登录。产品成员通过用户名密码 + productCode 登录指定产品,返回 JWT 令牌对及用户权限信息。cap.js 启用时拒绝此接口(必须走 login/cap)
 	@handler Login
 	post /auth/login (LoginReq) returns (LoginResp)
 
-	// LoginByCap 使用 cap.js 人机验证令牌登录,验证通过后执行与 Login 相同的业务逻辑
+	// LoginByCap 使用 cap.js 人机验证令牌登录。cap.js 未启用时拒绝此接口(必须走 login),验证通过后执行与 Login 相同的业务逻辑
 	@handler LoginByCap
 	post /auth/login/cap (LoginByCapReq) returns (LoginResp)
 }