ipfs-docs
ipfs-docs copied to clipboard
ipfs
Add notes to commands in the HTTP API that contain options relevant to the CLI, but not to anything else.
In the HTTP API documentation, some API options' description are not accurate.
For example, /api/v0/files/ls has an option U which is only relevant to the command line as far as I know. There are serval other places.
Can we have a note in the documentation to mitigate the confusion in this case?
@pengisgood why do you say -U is not relevant in the HTTP API? If you notice any peculiarities/bugs in the documentation it'd be great if you could file a docs PR.
@pengisgood why do you say
-Uis not relevant in the HTTP API? If you notice any peculiarities/bugs in the documentation it'd be great if you could file a docs PR.
@aschmahmann Stebalien left a comment on my previous PR. I'm not sure if I understand correctly. Also, I'm not sure how to verify that. I suppose he/she is right so that I opened an issue here.
Thanks for the pointer. I'm not sure how many of those there are (could be worth doing an inventory if you're up for it). Modifying the documentation here seems pretty painful though since it's generated from the go-ipfs code. If we wanted to we may be able to add some lines to go-ipfs that spell this out, but that seems pretty gross as well.
Yea, it's not that easy to distinguish all the options. I want to help but I'm brand new to most of the APIs and don't know where to start and what's the process step by step.