diff --git a/build/openrpc/full.json.gz b/build/openrpc/full.json.gz index 1e4efea1a..a15f7d23f 100644 Binary files a/build/openrpc/full.json.gz and b/build/openrpc/full.json.gz differ diff --git a/build/openrpc/miner.json.gz b/build/openrpc/miner.json.gz index 08f41f3c5..e205226dd 100644 Binary files a/build/openrpc/miner.json.gz and b/build/openrpc/miner.json.gz differ diff --git a/build/openrpc/worker.json.gz b/build/openrpc/worker.json.gz index edfabcc6b..7049571e9 100644 Binary files a/build/openrpc/worker.json.gz and b/build/openrpc/worker.json.gz differ diff --git a/documentation/en/api-v0-methods-miner.md b/documentation/en/api-v0-methods-miner.md index b6819d2d9..2173d3641 100644 --- a/documentation/en/api-v0-methods-miner.md +++ b/documentation/en/api-v0-methods-miner.md @@ -528,7 +528,16 @@ Inputs: ] ``` -Response: `null` +Response: +```json +[ + { + "Key": "baga6ea4seaqecmtz7iak33dsfshi627abz4i4665dfuzr3qfs4bmad6dx3iigdq", + "State": "ShardStateAvailable", + "Error": "\u003cerror\u003e" + } +] +``` ### DagstorePieceIndexSize DagstorePieceIndexSize returns the size of the piece index. diff --git a/documentation/en/cli-lotus.md b/documentation/en/cli-lotus.md index 7dfb16ffe..4b5196f56 100644 --- a/documentation/en/cli-lotus.md +++ b/documentation/en/cli-lotus.md @@ -561,37 +561,36 @@ CATEGORY: DESCRIPTION: Retrieve data from the Filecoin network. - -The retrieve command will attempt to find a provider make a retrieval deal with -them. In case a provider can't be found, it can be specified with the --provider -flag. - -By default the data will be interpreted as DAG-PB UnixFSv1 File. Alternatively -a CAR file containing the raw IPLD graph can be exported by setting the --car -flag. - -Partial Retrieval: - -The --data-selector flag can be used to specify a sub-graph to fetch. The -selector can be specified as either IPLD datamodel text-path selector, or IPLD -json selector. - -In case of unixfs retrieval, the selector must point at a single root node, and -match the entire graph under that node. - -In case of CAR retrieval, the selector must have one common "sub-root" node. - -Examples: - -- Retrieve a file by CID - $ lotus client retrieve Qm... my-file.txt - -- Retrieve a file by CID from f0123 - $ lotus client retrieve --provider f0123 Qm... my-file.txt - -- Retrieve a first file from a specified directory - $ lotus client retrieve --data-selector /Links/0/Hash Qm... my-file.txt - + + The retrieve command will attempt to find a provider make a retrieval deal with + them. In case a provider can't be found, it can be specified with the --provider + flag. + + By default the data will be interpreted as DAG-PB UnixFSv1 File. Alternatively + a CAR file containing the raw IPLD graph can be exported by setting the --car + flag. + + Partial Retrieval: + + The --data-selector flag can be used to specify a sub-graph to fetch. The + selector can be specified as either IPLD datamodel text-path selector, or IPLD + json selector. + + In case of unixfs retrieval, the selector must point at a single root node, and + match the entire graph under that node. + + In case of CAR retrieval, the selector must have one common "sub-root" node. + + Examples: + + - Retrieve a file by CID + $ lotus client retrieve Qm... my-file.txt + + - Retrieve a file by CID from f0123 + $ lotus client retrieve --provider f0123 Qm... my-file.txt + + - Retrieve a first file from a specified directory + $ lotus client retrieve --data-selector /Links/0/Hash Qm... my-file.txt OPTIONS: --car Export to a car file instead of a regular file (default: false)