Kubo HTTP API docs for get lists ignored output parameter

[mrd0ll4r]

The docs for the /api/v0/get HTTP endpoint, https://docs.ipfs.tech/reference/kubo/rpc/#api-v0-get, list an output parameter, which I believe is ignored:

$ curl -v -X POST "http://127.0.0.1:5001/api/v0/get?arg=/ipfs/bafybeiakou6e7hnx4ms2yangplzl6viapsoyo6phlee6bwrg4j2xt37m3q&timeout=300s"
*   Trying 127.0.0.1:5001...
* Connected to 127.0.0.1 (127.0.0.1) port 5001 (#0)
> POST /api/v0/get?arg=/ipfs/bafybeiakou6e7hnx4ms2yangplzl6viapsoyo6phlee6bwrg4j2xt37m3q&timeout=300s HTTP/1.1
> Host: 127.0.0.1:5001
> User-Agent: curl/7.81.0
> Accept: */*
>
* Mark bundle as not supporting multiuse
< HTTP/1.1 200 OK
< Access-Control-Allow-Headers: X-Stream-Output, X-Chunked-Output, X-Content-Length
< Access-Control-Expose-Headers: X-Stream-Output, X-Chunked-Output, X-Content-Length
< Content-Type: text/plain
< Server: kubo/0.18.1
< Trailer: X-Stream-Error
< Vary: Origin
< X-Content-Length: 41643
< X-Stream-Output: 1
< Date: Mon, 06 Feb 2023 09:36:04 GMT
< Transfer-Encoding: chunked
<
Warning: Binary output can mess up your terminal. Use "--output -" to tell
Warning: curl to output it to your terminal anyway, or consider "--output
Warning: <FILE>" to save to a file.
* Failure writing output to destination
* Failed reading the chunked-encoded stream
* Closing connection 0
$ curl -v -X POST "http://127.0.0.1:5001/api/v0/get?arg=/ipfs/bafybeiakou6e7hnx4ms2yangplzl6viapsoyo6phlee6bwrg4j2xt37m3q&output=/tmp/somefile&timeout=300s"
*   Trying 127.0.0.1:5001...
* Connected to 127.0.0.1 (127.0.0.1) port 5001 (#0)
> POST /api/v0/get?arg=/ipfs/bafybeiakou6e7hnx4ms2yangplzl6viapsoyo6phlee6bwrg4j2xt37m3q&output=/tmp/somefile&timeout=300s HTTP/1.1
> Host: 127.0.0.1:5001
> User-Agent: curl/7.81.0
> Accept: */*
>
* Mark bundle as not supporting multiuse
< HTTP/1.1 200 OK
< Access-Control-Allow-Headers: X-Stream-Output, X-Chunked-Output, X-Content-Length
< Access-Control-Expose-Headers: X-Stream-Output, X-Chunked-Output, X-Content-Length
< Content-Type: text/plain
< Server: kubo/0.18.1
< Trailer: X-Stream-Error
< Vary: Origin
< X-Content-Length: 41643
< X-Stream-Output: 1
< Date: Mon, 06 Feb 2023 09:36:15 GMT
< Transfer-Encoding: chunked
<
Warning: Binary output can mess up your terminal. Use "--output -" to tell
Warning: curl to output it to your terminal anyway, or consider "--output
Warning: <FILE>" to save to a file.
* Failure writing output to destination
* Failed reading the chunked-encoded stream
* Closing connection 0
$ l /tmp/somefile
ls: cannot access '/tmp/somefile': No such file or directory

See also ipfs/kubo#1210

[ElPaisano]

@lidel it seems like this issue might be related to the automated pages. Any thoughts?

[lidel]

This is UX bug: we should hide this parameter from the /api/v0 docs.
It makes no sense in the context of HTTP RPC (this parameter is only useful in CLI).

If it does not work, we should just remove it.

How to fix this

If someone has time to do this, we need to extend https://github.com/ipfs/go-ipfs-cmds/ like we did with Status (ipfs/go-ipfs-cmds#225) (here, we would be extendin type Command struct and adding an optional list of parameters that are CLI-only) and then add annotations in https://github.com/ipfs/kubo, and then update generator of https://docs.ipfs.tech/reference/kubo/rpc/ docs (sources in https://github.com/ipfs/ipfs-docs/tree/main/tools/http-api-docs) to skip parameters listed in mentioned annotations.