Documenting `cat` with an example in Apiary
まだ誰も着手していません。
評価
- 難易度
- 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 にコメントします — 二人が同じ作業をするのを防げます。
- リポジトリをフォークし、ブランチを切って変更します。
- issue 番号を参照したプルリクエストを送ります。
似ている issue
-
bug
難易度 2/5 1〜3時間 初心者へのやさしさ 85/100
juice-shop/juice-shop#3686 ·
メンテナーはふだん 1 日以内に返信
-
perf(translator): Claude→Responses stream re-validates the whole request body on every SSE chunkオープン
難易度 2/5 1〜3時間 初心者へのやさしさ 72/100
router-for-me/CLIProxyAPI#6665 ·
メンテナーはふだん 1 日以内に返信
-
[Issue]: hipsparselt.h C API as shipped now requires C23 -- ONLY because of missing include or guardオープン
難易度 2/5 1〜3時間 初心者へのやさしさ 62/100
ROCm/rocm-libraries#13736 ·
メンテナーはふだん 2 日以内に返信
-
難易度 2/5 1〜3時間 初心者へのやさしさ 65/100
メンテナーはふだん 1 日以内に返信
-
難易度 2/5 1〜3時間 初心者へのやさしさ 72/100