English documentation of the REST API about openhds-rest HOT 5 OPEN

Here is a rough draft of English documentation, which needs to be updated: https://docs.google.com/document/d/1p4XjF50dMWj1gZzN2vpwvzKC11AMNw-6jvCAXFLtVgA/edit?usp=sharing

from openhds-rest.

We definitely want high-level documentation to explain the API.

We probably don't want to invest in hard-to-maintain documentation, like the laundry list of endpoints.

from openhds-rest.

Here is more high-level documentation:
https://docs.google.com/document/d/1XJPpzYblVe7wsw92oPNNkt7DY5xTfaqS6m7NEramru0/edit?usp=sharing

from openhds-rest.

It would be great to serve this documentation directly from openhds-rest, along side the REST API. See #17 .

from openhds-rest.

Let's box this at about 1 day. We can pull "the good stuff" from the two documents linked above.

from openhds-rest.