Documenting `cat` with an example in Apiary
还没有人认领这个 Issue。
评估
- 难度
- 3/5
- 预计耗时
- 1-2 天
- 新手友好度
- 30/100
- Issue 类型
- 文档
- 描述清晰度
- 需要澄清
- 活跃度
- 停滞
- 领域
- api, documentation
调研方向
从 Apiary 中的 /api/v0/cat 示例开始，将显示的 curl 响应与链接的 go-ipfs PR 1776 进行比较。明确预期输出以及 MIME 和传输标头，然后更新 Apiary 文档，使示例准确描述 cat。
由索引模型根据 Issue 内容生成。
描述
I'm unsure how to document this adequately.
$ curl -i http://localhost:5001/api/v0/cat?arg=QmeomffUNfmQy76CQGy9NdmqEnnHU9soCexBnGU3ezPHVH
HTTP/1.1 200 OK
Content-Length: 5
Transfer-Encoding: chunked
X-Stream-Output: 1
test
What is the output of a cat command? What is the mime-type of a chunked file? I don't know, and I'm having difficulty googling it.
Further, cat shouldn't return both content-length and transfer-encoding. See https://github.com/ipfs/go-ipfs/pull/1776 for more on that.
- 主要语言
- API Blueprint
- 星标
- 2
- 派生
- 0
- PR 合并指标
- 30 天内没有已合并 PR
环境准备
这个项目没有提供开发容器、Dockerfile 或贡献指南，环境需要你自己搭建：先看它的 README，通用步骤见我们的新手贡献指南。
从这里开始
- 先读完整个 Issue，再读项目的贡献指南。
- 在 Issue 下留言说明你要接手 —— 这能避免两个人做同样的事。
- Fork 仓库，在一个分支上完成修改。
- 提交 Pull Request，并在描述里引用这个 Issue 编号。
相似的 Issue
-
难度 2/5 1-3 小时 新手友好度 72/100
维护者通常 2 天内回复
-
难度 2/5 1-3 小时 新手友好度 66/100
python-caldav/caldav#735 ·
维护者通常 1 天内回复
-
bug triage
难度 2/5 1-3 小时 新手友好度 68/100
mealie-recipes/mealie#8682 ·
维护者通常 1 天内回复
-
难度 1/5 1-3 小时 新手友好度 82/100
PhilflowIO/dav-mcp#146 ·
维护者通常 1 天内回复
-
Component: Python API
难度 2/5 1-3 小时 新手友好度 70/100
Vector35/binaryninja-api#8649 ·
维护者通常 3 天内回复