Reference for the daemon's HTTP API

[wking]

I think we're planning on auto-generating this from the Go implementation (at least for now). Discussion in ipfs/kubo#785. I just wanted to put a reference here, because I think it's likely that folks interested in the API spec (but not necessarily interested in how it's generated) will looks for issues in this repository.

[jbenet]

Also there's the newly minted https://github.com/ipfs/api (sorry for the repo overload) -- that repo will be a sort of "testing ground" for the various APIs we want to make (including implementation independent test suites)

[daviddias]

Following:

• https://botbot.me/freenode/ipfs/2015-11-22/?msg=54685301&page=6
• Firefox is concatenating two chunks (use case, PING) ipfs-inactive/js-ipfs-http-client#135
• and more discussions that have been happening

We need more than ever a solid HTTP API documentation that go-ipfs can execute and client libraries can follow. I feel that the HTTP API should be treated as a spec (that code must follow) than trying to auto generate it from code (which will always miss to explain some of the design decisions)

@RichardLitt can you give us a status update/ETA/Roadmap for the API documentation work? Other people might be interested and available to help.

//cc @dignifiedquire

[dignifiedquire]

I've also started into looking apiary: http://docs.ipfs.apiary.io/ which can do nice things like generate a mock server to test the api against and the definitions are based on markdown.

[daviddias]

Hi @wking, we've been working on getting a IPFS API specs up to date, documenting both CLI interface, HTTP API and Core (programmatic interface).

You can find the work on:

• https://github.com/ipfs/api
• Add Group add ipfs-inactive/http-api-spec#17
• WIP: IPFS API (core+http+cli) #65

Wanna help us get this done quicker? :D

[RichardLitt]

@RichardLitt can you give us a status update/ETA/Roadmap for the API documentation work? Other people might be interested and available to help.

The most up-to-date information can be found in github.com/ipfs/api/issues. There's a lot of good work to do!