OpenListTeam / OpenListTeam/OpenList-Docs

[BUG] API doc中 Upload file的参数错误及缺漏

Open
#232 1 comment 0 reactions 1 assignee View on GitHub

@ILoveScratch2 is already working on this.

Since Dec 29, 2025.

API bug
Dominant language
Vue
Stars
63
Forks
130
Avg merge
1d 2h
Merged PRs (30d)
6

Description

请确认以下事项
  • 我已确认阅读并同意 AGPL-3.0 第15条
    本程序不提供任何明示或暗示的担保,使用风险由您自行承担。

  • 我已确认阅读并同意 AGPL-3.0 第16条
    无论何种情况,版权持有人或其他分发者均不对使用本程序所造成的任何损失承担责任。

  • 我确认我的描述清晰,语法礼貌,能帮助开发者快速定位问题,并符合社区规则。

  • 我已确认阅读了OpenList文档

  • 我已确认没有重复的问题或讨论。

  • 我已确认是OpenList的问题,而不是其他原因(例如 网络依赖操作)。

  • 我认为此问题必须由OpenList处理,而非第三方。

  • 我已确认这个问题在最新版本中没有被修复。

OpenList 版本(必填)

v4.1.6 (Commit: 08574785) - Frontend: v4.1.6 - Build at: 2025-11-03 03:31:13 +0000

使用的存储驱动(必填)

Local

问题描述(必填)
目前官方的API doc(fox.oplist.org及fox.oplist.org.cn)中关于上传文件的两个api(Upload file (stream)及Upload file (form))中的path参数是不正确的,这会导致根据此文档进行api操作的用户得到错误反馈。并且文档中缺少了"覆盖现有文件"的header值。 

文档中提供的上传路径为header->path, 实际为header->File-Path, 且缺少的是"覆盖现有文件"的header->Overwrite, 下面附上截图:  

API文档提供的参数:

Image Image

实际使用的参数:

Image
配置文件内容(必填)

日志(可选)

复现链接(可选)

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.