Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

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

Closed
Erotemic opened this issue Oct 17, 2023 · 2 comments
Labels
kind/suggestion Something that you'd like to see in the docs. This can be written content, web design, or imagery. need/triage Needs initial labeling and prioritization

Comments

@Erotemic
Copy link

Erotemic commented Oct 17, 2023

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

No tasks being tracked yet.
@Erotemic Erotemic added kind/suggestion Something that you'd like to see in the docs. This can be written content, web design, or imagery. need/triage Needs initial labeling and prioritization labels Oct 17, 2023
@welcome

This comment was marked as outdated.

@lidel
Copy link
Member

lidel commented Oct 30, 2023

Thank you for reporting.
This seems to be a duplicate of #1260, let's continue there.

@lidel lidel closed this as not planned Won't fix, can't repro, duplicate, stale Oct 30, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
kind/suggestion Something that you'd like to see in the docs. This can be written content, web design, or imagery. need/triage Needs initial labeling and prioritization
Projects
None yet
Development

No branches or pull requests

2 participants