ipfs / ipfs-docs

📚IPFS documentation platform
https://docs.ipfs.tech
299 stars 409 forks source link

Documentation for the REST ls call should enumerate what "Type" integers are or point to more information. #1736

Closed Erotemic closed 11 months ago

Erotemic commented 11 months ago

I was playing with ipfsfsspec and noticed that they failed to ls one of my directories. The error was because they didn't handle ls return entries with "Type 4". I had no idea what Type 4 was.

I find the API docs for ls here: http://docs.ipfs.tech.ipns.localhost:8080/reference/kubo/rpc/#api-v0-ls

And it tells me that Type is an int32 return value, but makes no mention of what the return values mean, nor does it point to information where I can find out.

I did find some info here: https://ipfs-search.readthedocs.io/en/latest/ipfs_datatypes.html

and here: https://github.com/ipfs/go-unixfs/blob/master/pb/unixfs.proto

and was able to infer type 4 was symlink, but the docs should be updated to make this easier for the next person who wants to figure out how ls works via the REST API.

### Tasks
welcome[bot] commented 11 months ago

Thank you for submitting your first issue to this repository! A maintainer will be here shortly to triage and review. In the meantime, please double-check that you have provided all the necessary information to make this process easy! Any information that can help save additiona round trips is useful! We currently aim to give initial feedback within two business days. If this does not happen, feel free to leave a comment. Please keep an eye on how this issue will be labeled, as labels give an overview of priorities, assignments and additional actions requested by the maintainers:

Finally, remember to use https://discuss.ipfs.tech if you just need general support.

lidel commented 11 months ago

Thank you for reporting. This seems to be a duplicate of https://github.com/ipfs/ipfs-docs/issues/1260, let's continue there.