From a7d8ba1ef6775fa1d7e389c033752bf1a2e1fedf Mon Sep 17 00:00:00 2001
From: lisonge <i@songe.li>
Date: Wed, 7 Feb 2024 20:49:02 +0800
Subject: [PATCH] docs: api desc

---
 api/src/index.ts | 7 +++++--
 1 file changed, 5 insertions(+), 2 deletions(-)

diff --git a/api/src/index.ts b/api/src/index.ts
index 706d499..dee1ac3 100644
--- a/api/src/index.ts
+++ b/api/src/index.ts
@@ -89,6 +89,9 @@ export interface RawApp {
  * 全局规则组
  */
 export interface RawGlobalGroup extends RawGroupProps, RawGlobalRuleProps {
+  /**
+   * 全局规则组的规则列表
+   */
   rules: RawGlobalRule[];
 }
 
@@ -132,6 +135,8 @@ export interface RawAppRule extends RawRuleProps, RawAppRuleProps {}
  */
 export interface RawAppGroup extends RawGroupProps, RawAppRuleProps {
   /**
+   * 应用规则组的规则列表, 支持多种类型
+   * 
    * string => { matches: string }
    *
    * string[] => { matches: string }[]
@@ -434,8 +439,6 @@ export interface RawGroupProps extends RawCommonProps {
    *
    */
   scopeKeys?: IArray<Integer>;
-
-  // rules: RawRuleProps[];
 }
 
 /**