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

API should use whole name options, not flags #2189

Closed
RichardLitt opened this issue Jan 12, 2016 · 5 comments
Closed

API should use whole name options, not flags #2189

RichardLitt opened this issue Jan 12, 2016 · 5 comments
Labels
need/community-input Needs input from the wider community

Comments

@RichardLitt
Copy link
Member

According to feedback given in ipfs-inactive/http-api-spec#17, the API uses flags such as r and w instead of recursive and wrap-with-directory. I do not understand the logic behind this. I suggest that we move the API to either accept aliases, or to use the full names. It is awkward, documenting and using the API the way it currently exists.

cc @diasdavid @whyrusleeping

@whyrusleeping
Copy link
Member

-r and -w arent going away, you'll never get me to type --wrap-with-directory. That said, we should document both the long and short options.

@RichardLitt
Copy link
Member Author

They shouldn't go away for the CLI. However, they should for the HTTP API.

We should do more than document: we should implement the long options.

@jbenet
Copy link
Member

jbenet commented Jan 13, 2016

i think the api should accept aliases (and i think it does? if not the cmds lib then uses one as the main one, and we could switch it to the longer one)

@em-ly em-ly added the need/community-input Needs input from the wider community label Aug 25, 2016
@whyrusleeping
Copy link
Member

the api accepts aliases

@RichardLitt
Copy link
Member Author

@whyrusleeping Can we use this as a tracking issue, then, for adding aliases, or should I open up a separate issue for that?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
need/community-input Needs input from the wider community
Projects
None yet
Development

No branches or pull requests

4 participants