dignifiedquire / dignifiedquire/ipfs-http-api

Documenting `cat` with an example in Apiary

Open
#3 1 comment 0 reactions 0 assignees View on GitHub
Dominant language
API Blueprint
Stars
2
Forks
0
PR merge metrics
No merged PRs in 30d

Description

I'm unsure how to document this adequately.

``` sh
$ 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.

Contributor guide

No contributing guide indexed for this repository

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.