Kubo RPC API - Pin ls response is not as described

オープン
#2,181 コメント 1 件 リアクション 0 件 担当者 0 名 GitHub で見る

まだ誰も着手していません。

評価

難易度
1/5
見積もり時間
1時間未満
初心者へのやさしさ
58/100
issue の種類
ドキュメント
明瞭さ
明確に書かれている
活発さ
停滞
領域
api, documentation

調査の方向性

リンク先のドキュメントページで Kubo RPC API v0 pin ls セクションを開き、そのレスポンススキーマを issue に実際に示されているレスポンスと比較します。観測された API に一致するようにドキュメントのレスポンス構造を更新し、その後、例が存在しない root フィールドを存在すると主張していないことを確認します。

索引モデルが issue の本文から書いたものです。

説明

need/triage

https://docs.ipfs.tech/reference/kubo/rpc/#api-v0-pin-ls
says the response is:

{
  "PinLsList": {
    "Keys": {
      "<string>": {
        "Name": "<string>",
        "Type": "<string>"
      }
    }
  },
  "PinLsObject": {
    "Cid": "<string>",
    "Name": "<string>",
    "Type": "<string>"
  }
}

But an actual response is:

{
  "Keys" : {
    "QmUNLLsPACCz1vLxQVkXqqLX5R1X345qqfHbsf67hvA3Nn" : {
      "Type" : "recursive"
    },
    "bafybeibpimca4f75fxe7mcetxs3ajuwrrc3ss3np4pvhamqtj3icxsuppa" : {
      "Type" : "recursive"
    }
  }
}

So, there is no "PinLsList" and "PinLsObject" root fields; it is directly "PinLsList.Keys".

Kubo version v0.38.1 desktop ; UI: c14b38a

主要言語
Go
スター
334
フォーク
503
PR マージ指標
30日以内にマージされた PR はありません

環境構築

はじめの一歩

  1. issue を最後まで読み、次にプロジェクトのコントリビューションガイドを読みます。
  2. 着手することを issue にコメントします — 二人が同じ作業をするのを防げます。
  3. リポジトリをフォークし、ブランチを切って変更します。
  4. issue 番号を参照したプルリクエストを送ります。

ipfs/ipfs-docs のほかの issue

ipfs/ipfs-docs の issue をすべて見る

似ている issue

Go の issue をもっと見る

新しい issue をメールで受け取る

初心者向けの GitHub issue を短くまとめたダイジェスト。