search

ryco117 / distort-server

A reference-implementation homeserver for the research anonymity protocol, DistoRt, with broadcasting over IPFS
https://ryco117.github.io/distort-server/
GNU General Public License v3.0
3 stars 1 forks source link

Documentation needed #3

Closed ryco117 closed 5 years ago

ryco117 commented 5 years ago

The REST API is becoming increasingly detailed and there is a need to describe the inputs, output objects, and HTTP status codes.

Edit: It is also necessary to document the inter-server communication protocol (IPFS messaging between peers).

ryco117 commented 5 years ago

As of commit cb67667f99b072dfb6184453f723c007de4dcf68, documentation is almost complete with current source. Still requires description of all JSON objects returned by API requests, including account, peer, and message objects.

ryco117 commented 5 years ago

Still require documentation of the server's configuration file, config.json. eba81eb2feff63079b84a610fe7968b095225ad3

ryco117 commented 5 years ago

Still require a technical but high-level description of what actions the node autonomously performs.

ryco117 commented 5 years ago

Finished remaining documentation with commit 7592c9797666ee02694fbd5cc9c5df0fe35d03d8 . Any remaining gaps or mistakes in documentation can be raised as new issues.