Skip to content
This repository has been archived by the owner on Apr 29, 2020. It is now read-only.

API spec and API functionality disparity #14

Closed
RichardLitt opened this issue Dec 26, 2015 · 2 comments
Closed

API spec and API functionality disparity #14

RichardLitt opened this issue Dec 26, 2015 · 2 comments

Comments

@RichardLitt
Copy link
Contributor

I'm going through #13 again, and I'm still a bit confused about what to do if the API spec does not match the API functionality. Often, it may be me now knowing how to work Postman. Sometimes, however, the disparity is caused by a poorly formed API, I think.

For instance, ipfs bitswap unwant should return at 204, not a 200. It doesn't return anything. Should I leave this as a 200, or change it to a 204 and open an issue in go-ipfs?

@daviddias
Copy link
Contributor

From Sprint of January 5th call -> ipfs/team-mgmt#77 (comment)

Let's have the current spec, which describes what is implemented and have the PR's to the current spec with the changes that make sense for each endpoint and open issues in go-ipfs to fix those endpoints

@RichardLitt
Copy link
Contributor Author

Thanks for posting that here. This can be closed. Current workflow:

  • Add in all current functionality, broken or not, in apiary format. This involves drawing from the draft on feature/add and PRing each method into master.
  • Get feedback on issues in the PRs into master.
  • Merge PRs into master, then PR separate issues where functionality does not match spec (currently undefined), with links to issues on go-ipfs which would enable PRs to be merged.

Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants