增加API注释

2026-02-19 07:05:37 +08:00 · 2023-06-17 21:05:03 +08:00
parent f436763c8d
commit fe9bc332c1
10 changed files with 116 additions and 25 deletions
--- a/pkg/rpc/jsons/origin_refs.md
+++ b/pkg/rpc/jsons/origin_refs.md
@@ -0,0 +1,33 @@
+# 源站引用列表
+
+## 定义
+~~~json
+[
+  {
+	"isOn": "是否启用",
+	"originId": "源站ID 1"
+  },
+  {
+    "isOn": "是否启用",
+    "originId": "源站ID 2"
+  },
+  ...
+]
+~~~
+
+其中：
+* `originId` - 源站ID，可以通过 `/OriginService/createOrigin` 接口创建源站后获得
+
+## 示例
+~~~json
+[
+  {
+	"isOn": true,
+	"originId": 1
+  },
+  {
+    "isOn": true,
+    "originId": 2,
+  }
+]
+~~~