Add openapi.json so it can be viewed by OCS-API Viewer app
维护者通常 1 天内回复
还没有人认领这个 Issue。
评估
- 难度
- 4/5
- 预计耗时
- 3-5 天
- 新手友好度
- 48/100
- Issue 类型
- 功能
- 描述清晰度
- 基本清楚
- 活跃度
- 冷清
- 技术栈
- openapi
- 领域
- api, documentation
调研方向
首先，将 Deck 可用的 API 端点与 deck.readthedocs.io 上现有的 API 文档以及 OCS-API Viewer 应用的要求进行比较。当 Deck 发布了 openapi.json，并且 viewer 和其他 OpenAPI 工具可以使用它时，即视为完成。
由索引模型根据 Issue 内容生成。
描述
How to use GitHub
- Please use the 👍 reaction to show that you are affected by the same issue.
- Please don't comment if you have no relevant information to add. It's just extra noise for everyone subscribed to this issue.
- Subscribe to receive notifications on status change and new comments.
Is your feature request related to a problem? Please describe.
When using external automation tools or if you are scripting knowing API endpoints is very important. Currently, there is a quite old API documentation at https://deck.readthedocs.io/en/latest/API/ but e.g. Talk relies on the OCS-API Viewer app for Nextcloud, always displaying the latest API docs. Deck isn't available there.
Describe the solution you'd like
Publish an openapi.json which can be read by the OCS-API Viewer app.
Describe alternatives you've considered
Since I can't find any openapi.json file I can't even use other viewers. Now it's try and error with the old documentation.
Additional context
- 主要语言
- JavaScript
- 星标
- 1.4k
- 派生
- 360
- 平均合并
- 1 天 22 小时
- 30 天内合并 PR
- 101
环境准备
在浏览器里用你自己的 GitHub 账号启动这个项目的开发容器。
- 没有 Dockerfile 或 Docker Compose 文件
- 有 Pull Request 模板
- 阅读贡献指南
从这里开始
- 先读完整个 Issue，再读项目的贡献指南。
- 在 Issue 下留言说明你要接手 —— 这能避免两个人做同样的事。
- Fork 仓库，在一个分支上完成修改。
- 提交 Pull Request，并在描述里引用这个 Issue 编号。
nextcloud/deck 的其他 Issue
-
难度 2/5 1-3 小时 新手友好度 68/100
维护者通常 1 天内回复
-
CSV export leaves trailing commas in tags and assigned-user fields可能已有人在做 @Kumar-s75 于 42 天前认领。 未关闭
难度 2/5 1-3 小时 新手友好度 88/100
维护者通常 1 天内回复
-
Board clone API failure is treated as a successful board response可能已有人在做 @Kumar-s75 于 42 天前认领。 未关闭
难度 2/5 1-3 小时 新手友好度 88/100
维护者通常 1 天内回复
-
难度 2/5 1-3 小时 新手友好度 78/100
维护者通常 1 天内回复
-
1. to develop bug
难度 2/5 1-3 小时 新手友好度 78/100
nextcloud/deck#8146 · 2 条评论 · 2 个 reaction ·
维护者通常 1 天内回复
相似的 Issue
-
难度 2/5 1-3 小时 新手友好度 84/100
Jason-Vaughan/TangleClaw#2546 ·
维护者通常 1 天内回复
-
area:integration enhancement good first issue help wanted
难度 2/5 1-3 小时 新手友好度 74/100
-
Documentation status: needs triage
难度 2/5 1-3 小时 新手友好度 72/100
mastra-ai/mastra#28194 · 1 条评论 ·
维护者通常 1 天内回复
-
ai-authored
难度 2/5 1-3 小时 新手友好度 69/100
维护者通常 1 天内回复
-
security(chat): require user confirmation before executing assistant-suggested package installations未关闭
难度 2/5 1-3 小时 新手友好度 78/100
francordel/myrtia#77 ·
维护者通常 1 天内回复