OpenListTeam / OpenListTeam/OpenList-Docs

[BUG] 分享文件API文档有误

Open
#306 2 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

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

Description

API文档里的创建文件分享接口数据有误，文档里写的是需要提供参数paths，实际参数发现应该提供files才能正常请求

Logs (required)
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.

Research direction

Open the API documentation at https://doc.oplist.org/api/apidocs and locate the create file sharing endpoint described in the issue. Update the request parameter documentation from paths to files, then verify that the endpoint example and parameter description consistently use files.

Written by the indexing model from the issue text.

Assessment

Domain
documentation
Issue type
Documentation
Difficulty
1/5
Estimated time
Under an hour
Activity status
Stale
Clarity
Clearly specified
Newbie friendliness
55/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.