Check APIs and Docs are up-to-date

[dora-gt]

The following 3 might not be consistent:

• The current implementation
• Candidate RFC
• docs/api.md

We might need to check and correct.

https://interledger.slack.com/archives/CHC51E54J/p1566498083177700

[dora-gt]

It might be better to generate API docs from the source codes though I haven't checked it is possible or not.

[emschwartz]

The HTTP API doc is definitely out of date because it has not been updated to use username instead of id

[dora-gt]

Things I noticed around the settlement RFC and the implementation are:

• settlement-engines does not implement delete for accounts, which is defined in the RFC.
• send_money, receive_message, do_receive_settlement and do_send_outgoing_message should return 201 according to the RFC, but it seems that it returns 200.
  • Also I feel a bit strange that ethereum-ledger returns HTTP Status codes. They should not know about HTTP. They just do settlements. That's the responsibility of API endpoints IMO.
• Shouldn't we define incoming messages more in detail?
  • If I were an implementor of a settlement engine, I might feel curious about the detail. How should I use it? or What is the typical implementations?

Hmmm I'll post issues anyway.

[dora-gt]

API docs will be updated by #444

[emschwartz]

Shouldn't we define incoming messages more in detail?

This should go in the docs for implementing a settlement engine, rather than the API docs

[emschwartz]

@dora-gt can this be closed now?

[dora-gt]

Yes, API doc is up-to-date now and other issues are reported.