Rethink Plugin API documentation: auto-generate JSON API spec, generate `.pyi` and `.d.ts` from there
还没有人认领这个 Issue。
评估
- 难度
- 5/5
- 预计耗时
- 一周以上
- 新手友好度
- 15/100
- Issue 类型
- 文档
- 描述清晰度
- 需要澄清
- 活跃度
- 活跃
- 技术栈
- json, python, typescript
- 领域
- api, documentation
调研方向
The payload names no files or entry points; it covers the RPC protocol as documented in the executable, Python and Node plugin guides of the Flow-Launcher docs repo. Start by reading those guides to see what protocol detail they repeat. Done would mean a decision on the spec format and tooling, agreed in the thread, before any generator for .pyi or .d.ts is written.
由索引模型根据 Issue 内容生成。
描述
Extracted from: https://github.com/Flow-Launcher/docs/pull/108#discussion_r4232118122
Documenting the RPC protocol in the various language-specific plugin guides is not ideal. Rather, we should decide on a formal, generated reference for the RPC spec, the same way you might see documentation for a C# API, or a .d.ts reference. Then these various non-C# plugin guides - executable, python, node - can stop documenting the protocol and instead reference the formal spec.
This spec can also be used to generate types for the TypeScript/JavaScript and Python libraries which make plugin development easier. Someone should be able to easily import the library in their node or python project and get rich intellisense for JSON requests and responses.
- 主要语言
- Svelte
- 星标
- 23
- 派生
- 23
- 平均合并
- 7 天 6 小时
- 30 天内合并 PR
- 5
环境准备
- 没有 Dockerfile 或 Docker Compose 文件
- 没有 Pull Request 模板
- 阅读贡献指南
从这里开始
- 先读完整个 Issue，再读项目的贡献指南。
- 在 Issue 下留言说明你要接手 —— 这能避免两个人做同样的事。
- Fork 仓库，在一个分支上完成修改。
- 提交 Pull Request，并在描述里引用这个 Issue 编号。
Flow-Launcher/docs 的其他 Issue
-
难度 2/5 1-3 小时 新手友好度 55/100
Flow-Launcher/docs#113 ·
-
难度 3/5 1-2 天 新手友好度 65/100
Flow-Launcher/docs#112 ·
-
难度 1/5 1 小时以内 新手友好度 45/100
Flow-Launcher/docs#111 ·
-
documentation
难度 3/5 1-2 天 新手友好度 25/100
Flow-Launcher/docs#99 ·
-
bug
难度 4/5 3-5 天 新手友好度 35/100
Flow-Launcher/docs#87 · 13 条评论 ·
查看 Flow-Launcher/docs 的全部 Issue
相似的 Issue
-
难度 2/5 1-3 小时 新手友好度 72/100
-
run_all sleeps after the final job despite documenting delays between jobs可能已有人在做 @Gambit-Checkmate 今天认领。 未关闭
难度 2/5 1-3 小时 新手友好度 74/100
-
bnv-manager-v2: accept_invite creates the Mailcow domain admin before the commit可能已有人在做 @myOmikron 今天认领。 未关闭bug ready-for-agent
难度 2/5 1-3 小时 新手友好度 82/100
-
BUG
难度 2/5 1-3 小时 新手友好度 70/100
Mai-with-u/MaiBot#2187 ·
维护者通常 1 天内回复
-
AG-UI bug pkg:core
难度 2/5 1-3 小时 新手友好度 72/100
pydantic/pydantic-ai#10538 ·
维护者通常 1 天内回复