Generate API docs directly from go-ipfs

[hsanjuan]

Since Apiary does not really adapt to our needs and it is one more place
that needed manual maintenance, it is just better to automatically generate
documentation from go-ipfs and have this implementation as the source
of truth. This commit replaces the API reference page with a new
autogenerated one.

This comes out of efforts around:

• Align HTTP APIs and the documentation ipfs/team-mgmt#227
• Fix Apiary spec and align it with js-ipfs API http-api-spec#122

Some screenshots:

---

---

---

[dignifiedquire]

@hsanjuan cool, how did you generate this?

[hsanjuan]

@dignifiedquire https://github.com/hsanjuan/ipfs-http-api-docs . Sorry about the lack of readme/docs, waiting for feedback to see if it's actually worth including it in go-ipfs or can leave as a separate repo.

[hsanjuan]

So what's the process to merge? Do I need someones approval? Is there any more feedback?

[RichardLitt]

I like this very much. I think this is fine as a separate repo, as we try to make go-ipfs as small as possible (right, @whyrusleeping?).

I think this is good to merge. @lgierth should be able to do that.

I am trying to get the site working so that I can see how this looks on the site, but am unable to do so at the moment (see #140). There's no greater process to merge: I believe that my sign off and @lgierth's merge should be enough to push it out.

[RichardLitt]

Nevermind, got it working using venv. This looks great.

I still would like a specification that we can refer to. But I may be behind on that conversation.

[hsanjuan]

@RichardLitt as weird as it sounds, the go-code is the de-facto spec for this (http api).

[RichardLitt]

@hsanjuan That works. Just want to make sure that that is explicit, because that was not clear from the other http-api docs. :)

[ghost]

This LGTM 👍

Need to move hsanjuan/ipfs-http-api-docs to the ipfs organization, so that the link in line 20 works

[hsanjuan]

Thanks @lgierth

Need to move hsanjuan/ipfs-http-api-docs to the ipfs organization, so that the link in line 20 works

Yes, I'll do it today and will ping here when it's ready