doc: 文档修改

Author: zhukai

README.md

@@ -19,7 +19,7 @@
 - [x] 支持 Blend(图片混合) 指令和相关动作
 - [x] 支持 Describe(图生文) 指令和相关动作
 - [x] 支持 Shorten 指令和相关动作
-- [x] 支持 Remix 模式，参考 [API接口说明](./docs/api.md) 的`/mj/submit/modal`
+- [x] 支持 Remix 模式，参考 [API接口说明](./docs/api.md) 的`/mj/submit/action`
 - [x] 支持获取图片的seed值
 - [x] 中英文翻译额外支持deepl
 - [x] 账号池持久化，动态维护

docs/api.md

@@ -37,7 +37,10 @@
     {
       "code": 1,
       "description": "提交成功",
-      "result": "14001929738841620"
+      "result": "14001929738841620",
+      "properties": {
+          "discordInstanceId": "1118138338562560102"
+      }
     }
     ```
 - code=22: 提交成功，进入队列等待
@@ -47,7 +50,19 @@
         "description": "排队中，前面还有1个任务",
         "result": "14001929738841620",
         "properties": {
-            "numberOfQueues": 1
+            "numberOfQueues": 1,
+            "discordInstanceId": "1118138338562560102"
+         }
+    }
+    ```
+- code=23: 队列已满，请稍后尝试
+    ```json
+    {
+        "code": 23,
+        "description": "队列已满，请稍后尝试",
+        "result": "14001929738841620",
+        "properties": {
+            "discordInstanceId": "1118138338562560102"
          }
     }
     ```
@@ -77,13 +92,21 @@
   "customId": "MJ::JOB::reroll::0::1c6dff5e-5632-40c6-9d4c-afb261705313::SOLO"
 }
 ```
-⚠️ 注意: 某些场景需要modal确认，提交后任务状态会变为MODAL，需调用`/mj/submit/modal`进行二次提交
+⚠️ 注意: 某些场景需要modal弹框确认
 - 执行CustomZoom(自定义变焦)
 - 执行PicReader(Describe后选择生图)
 - 执行PromptAnalyzer(Shorten后选择生图)
 - 账号开启了Remix & 执行Reroll、Variation、Pan
 
-调用 `/mj/submit/modal`
+这时返回的code为 21，示例:
+```json
+{
+  "code": 21,
+  "description": "窗口等待",
+  "result": "14001929738841620"
+}
+```
+该任务状态为MODAL，但不会进队列影响并发。需调用`/mj/submit/modal`提交最终任务
 ```json
 {
   // 需确认的任务ID
@@ -92,13 +115,13 @@
   "prompt": "Cat"
 }
 ```
-CustomZoom的prompt需要设置`--ar` 和 `--zoom`(1到2之间)，例如: `Cat --ar 1:1 --zoom 1.5`
+CustomZoom的prompt需要设置`--zoom`(1到2之间)，例如: `Cat --zoom 1.5`
 
 ## 4. `/mj/submit/describe` 图生文
 ```json
 {
-  // 图片的base64字符串
-  "base64": "data:image/png;base64,xxx"
+    // 图片的base64字符串
+    "base64": "data:image/png;base64,xxx"
 }
 ```
 
@@ -158,7 +181,7 @@ CustomZoom的prompt需要设置`--ar` 和 `--zoom`(1到2之间)，例如: `Cat -
 
 绘图任务执行后，不会设置seed，如需获取seed，需要执行 `/mj/task/{id}/image-seed`
 
-⚠️ 注意: 必须配置账号的 [Midjourney Bot私信ID](./discord-params.md#4-获取mj私信id)，否则无法调用
+⚠️ 注意: 必须配置账号的Midjourney Bot私信ID，否则无法调用
 
 - code=1: 获取成功，result为图片对应的seed
     ```json

docs/config.md

@@ -6,6 +6,8 @@
 | mj.account-store-type | 否 | 账号存储方式，默认in_memory(内存\重启后丢失)，可选redis |
 | mj.account-choose-rule | 否 | 账号选择策略：默认 BestWaitIdleRule(最少等待空闲)、RoundRobinRule(轮循) |
 | mj.api-secret | 否 | 接口密钥，为空不启用鉴权；调用接口时需要加请求头 mj-api-secret |
+| mj.username | 否 | 后台管理登录的用户名 |
+| mj.password | 否 | 后台管理登录的密码，默认为接口密钥(两者均未设置默认admin) |
 | mj.task-store.type | 否 | 任务存储方式，默认in_memory(内存\重启后丢失)，可选redis |
 | mj.task-store.timeout | 否 | 任务存储过期时间，过期后删除，默认30天 |
 | mj.notify-hook | 否 | 全局的任务状态变更回调地址 |
@@ -60,6 +62,7 @@ mj:
 | core-size | 否 | 并发数，默认3 |
 | queue-size | 否 | 等待队列长度，默认10 |
 | timeout-minutes | 否 | 任务超时时间(分钟)，默认5 |
+| remark | 否 | 备注说明 |
 
 ### spring.redis配置参考
 ```yaml

docs/start.md

@@ -2,7 +2,7 @@
 
 ### Docker
 
-1. 创建/xxx/xxx/config，docker用户需要有读写权限，目录文件如下
+1. /xxx/xxx/config目录下创建
    > 注意: /xxx/xxx是 服务器目录示例，需自行修改
    - `app.jar` 项目jar包，https://github.com/litter-coder/midjourney-proxy-plus/releases 下找到最新的jar包，下载并命名为app.jar
    - `application.yml` mj配置项，参考 https://github.com/litter-coder/midjourney-proxy-plus/blob/main/resources/application.yml
@@ -17,7 +17,7 @@
     ```
 
 3. 在API文档页 `http://ip:port/doc` 服务激活 -> 获取机器码，联系作者获取激活码，激活服务
-4. 访问 `http://ip:port` 查看管理页面，用户名是admin，密码是设置的接口密钥（未设置默认密码是admin）
+4. 访问 `http://ip:port` 查看管理页面，用户名默认是admin，密码默认是设置的接口密钥（未设置默认密码是admin）
 5. 后续升级版本，直接替换config目录下的app.jar，重启容器即可，不需要重新激活
     ```shell
     docker restart midjourney-proxy-plus