From 75f5193fc30e573c1a2af43950e7e70cd193fdfb Mon Sep 17 00:00:00 2001
From: xlsea <m@xlsea.cn>
Date: Thu, 18 Apr 2024 16:32:38 +0800
Subject: [PATCH] =?UTF-8?q?docs:=20=E8=A1=A5=E5=85=85=E6=B3=A8=E9=87=8A?=
MIME-Version: 1.0
Content-Type: text/plain; charset=UTF-8
Content-Transfer-Encoding: 8bit

---
 src/typings/api.d.ts | 25 +++++++++++++++++++++++++
 1 file changed, 25 insertions(+)

diff --git a/src/typings/api.d.ts b/src/typings/api.d.ts
index 92f383b..1487c1f 100644
--- a/src/typings/api.d.ts
+++ b/src/typings/api.d.ts
@@ -211,7 +211,23 @@ declare namespace Api {
       total: number;
     };
 
+    /**
+     * dashboard line type
+     *
+     * - "DAY": "今日"
+     * - "WEEK": "最近一周"
+     * - "MONTH": "最近一月"
+     * - "YEAR": "全年"
+     * - "OTHERS": "自选日期"
+     */
     type DashboardLineType = 'DAY' | 'WEEK' | 'MONTH' | 'YEAR' | 'OTHERS';
+
+    /**
+     * dashboard line mode
+     *
+     * - "JOB": "job"
+     * - "WORKFLOW": "workflow"
+     */
     type DashboardLineMode = 'JOB' | 'WORKFLOW';
 
     type DashboardLineParams = {
@@ -222,10 +238,18 @@ declare namespace Api {
       endTime?: string;
     } & CommonSearchParams;
 
+    /**
+     * dashboard line mode
+     *
+     * - "1": "client"
+     * - "2": "server"
+     */
     type DashboardPodsType = 1 | 2;
 
+    /** dashboard list */
     type DashboardPodList = Common.PaginatingQueryRecord<DashboardPod>;
 
+    /** dashboard pod */
     type DashboardPod = {
       /** 路径/组 */
       consumerBuckets: number[];
@@ -249,6 +273,7 @@ declare namespace Api {
       updateDt: string;
     };
 
+    /** dashboard search params */
     type DashboardPodsParams = CommonType.RecordNullable<
       Pick<Api.Dashboard.DashboardPod, 'groupName'> & CommonSearchParams
     >;