Spark/spark-server
4
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

docs(media): 微调媒体说明与 OpenAPI 描述

Browse Source
This commit is contained in:
DESKTOP-L8OUL9F\gfl0034 2026-09-24 23:58:21 +08:00
parent c26d61fd26
commit 59c73169e1
2 changed files with 8 additions and 5 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

7
docs/media.md
View File

@ -15,8 +15,8 @@
| 时机 | 位置 | 行为 | | 时机 | 位置 | 行为 |
|------|------|------| |------|------|------|
| 申请上传凭证 | `upload/logic.CreateCredential` → `checkDeclaredSize` | 按 `purpose` 校验声明 `size`；超限默认 **打 Warn 日志**，`media.user_reject=true` 时返回 `40005` | | 申请上传凭证 | `upload/logic.CreateCredential` → `checkDeclaredSize` | 按 `purpose` 校验声明 `size`；超限默认 **打 Warn 日志**，`media.user_reject=true` 时返回 `40005` |
| 广场发帖 | `square/logic.publish` → `checkPublishMedia` | 用客户端声明的图/视频宽高与 size 校验；同上 | | 广场发帖 | `square/logic.publish` → `checkMediaMeta` | 用客户端声明的图/视频宽高与 size 校验；同上 |
| 朋友圈发帖 | `moment/logic.publish` → `checkPublishMedia` | 同上 | | 朋友圈发帖 | `moment/logic.publish` → `checkMediaMeta` | 同上 |
主压缩仍在 **App 上传前**；服务端不把用户文件再压一遍（除非开启拒收）。 主压缩仍在 **App 上传前**；服务端不把用户文件再压一遍（除非开启拒收）。
@ -36,6 +36,7 @@
## 部署注意 ## 部署注意
- 视频压缩依赖主机 **`ffmpeg`**（`media.ffmpeg_path`，默认 `ffmpeg`）。 - 视频压缩依赖主机 **`ffmpeg`**（`media.ffmpeg_path`，默认 `ffmpeg`）。运行镜像 `Dockerfile` 已 `apk add ffmpeg`。
- 迁移：`migrations/0026_square_bot_rss.sql`（`source` / `source_url` / `expires_at` + `t_square_bot_links`）。 - 迁移：`migrations/0026_square_bot_rss.sql`（`source` / `source_url` / `expires_at` + `t_square_bot_links`）。
- Seed：`go run ./cmd/seed -config configs/config.yaml` 确保 `bot001@spark.bot`… 存在。 - Seed：`go run ./cmd/seed -config configs/config.yaml` 确保 `bot001@spark.bot`… 存在。
- 错误码：`40005` / `media_oversized`（`media.user_reject=true` 时拒凭证或发帖）。

6
internal/transport/http/docs/openapi.yaml
View File

@ -3262,8 +3262,10 @@ components:
12 SYNC_MESSAGES 13 SYNC_MESSAGES_FINISH 14 KICK 15 DELETE_MESSAGE 12 SYNC_MESSAGES 13 SYNC_MESSAGES_FINISH 14 KICK 15 DELETE_MESSAGE
EnvelopeCode: EnvelopeCode:
type: string type: string
enum: ["0", "40001", "40002", "40003", "40004", "40101", "40102", "40301", "40401", "40402", "40901", "42901", "42902", "42903", "49901", "50001", "50002", "50003", "50301", "50401"] enum: ["0", "40001", "40002", "40003", "40004", "40005", "40101", "40102", "40103", "40301", "40401", "40402", "40901", "42901", "42902", "42903", "49901", "50001", "50002", "50003", "50301", "50401"]
description: envelope.code。成功为 "0" description: |
envelope.code。成功为 "0"。
`40005` media_oversized：媒体分辨率/体积超限（开启 media.user_reject 时拒收）。
Envelope: Envelope:
type: object type: object
required: [code, msg, request_id, data] required: [code, msg, request_id, data]