OpenListTeam / OpenListTeam/OpenList-Docs

[Feature] API文档中增加task接口的介绍

Open
#291 1 comment 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

API enhancement
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处理,而非第三方。

  • 我已确认此功能尚未被实现。

  • 我已确认此功能是合理的,且有普遍需求,并非我个人需要。

需求描述

API文档中增加task接口的介绍,我已在实现思路中给出copy和move的接口文档,麻烦修改一下或者可以直接在在线文档中使用。

实现思路

api_task_copy_done.md
api_task_copy_undone.md
api_task_move_done.md
api_task_move_undone.md

附加信息

No response

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

Start by reading api_task_copy_done.md, api_task_copy_undone.md, api_task_move_done.md, and api_task_move_undone.md, then find the API documentation entry point in OpenList-Docs. Add the task API introduction using the supplied copy and move details, and verify that the online documentation presents the task endpoints and their completed or unfinished states.

Written by the indexing model from the issue text.

Assessment

Domain
api, documentation
Issue type
Documentation
Difficulty
2/5
Estimated time
1-3 hours
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
48/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.