From 3810464dd301ad572a5c0b41585fa9a89bc13dd8 Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?=E7=99=BD=E6=B1=A0?=
 <98259561+whitechi73@users.noreply.github.com>
Date: Wed, 21 Feb 2024 23:23:49 +0800
Subject: [PATCH] =?UTF-8?q?=E6=94=AF=E6=8C=81=E4=B8=BAWebSocket=E7=9A=84?=
 =?UTF-8?q?=E6=96=87=E4=BB=B6=E5=88=86=E6=AE=B5=E4=B8=8A=E4=BC=A0?=
MIME-Version: 1.0
Content-Type: text/plain; charset=UTF-8
Content-Transfer-Encoding: 8bit

---
 docs/api/shamrock.md | 33 ++++++++++++++++++++++++++++++++-
 1 file changed, 32 insertions(+), 1 deletion(-)

diff --git a/docs/api/shamrock.md b/docs/api/shamrock.md
index 447de2f..8ab743d 100644
--- a/docs/api/shamrock.md
+++ b/docs/api/shamrock.md
@@ -21,12 +21,16 @@ icon: feather-alt
 
 是否正常执行切换账号请求的响应。
 
-## 上传文件到缓存目录
+## 上传文件到缓存目录 （HTTP）
 
 ### API 端点
 
 `/upload_file`
 
+::: warning 注意
+该接口仅仅为HTTP POST提供，WebSocket请使用另外一个。
+:::
+
 ### 参数
 
 以**file**格式上传文件，不要使用**binary**。
@@ -39,6 +43,33 @@ icon: feather-alt
 }
 ```
 
+## 上传文件到缓存目录 （WebSocket）
+
+### API 端点
+
+`/upload_file_to_shamrock`
+
+::: warning 注意
+该接口仅仅为WebSocket提供。
+:::
+
+### 参数
+
+| 名称 | 类型 | 作用 |
+|------|-------|-------|
+| md5 | string | 文件`hex格式`的md5值，32长度的字符串 |
+| offset | uint64 | 文件分段上传偏移，默认值为0，从头上传 |
+| chunk | string | 文件分段上传数据块（base64），无需开头`base64://` |
+| file_size | uint64 | 总文件大小 |  
+
+### 响应数据
+
+| 名称 | 类型 | 作用 |
+|------|-------|-------|
+| file_size | uint64 | 总文件大小 | 
+| finish | bool | 是否完成上传 |
+| path | string | 该文件在安卓系统（shamrock环境）的路径 |
+
 ## 让Shamrock下载文件到缓存目录
 
 用法二选一：