What useful information can we put on the API root path?

[orangejulius]

The Pelias API root path has long included some simple static content from a Markdown file:

While the link to the docs is nice, the version is not especially useful or high signal.

What information would be more useful here?

I'll just list a bunch of ideas and people can add to it:

• Example queries
• A link to the compare app after #1416 is merged
• Config information from pelias.json
• Links to demo URLs for other Pelias services
• Debug info about the server: IP address, name, etc
• Code information: git commit, actual release version, etc

[blackmad]

some of the ES query counts seem nice, they're a good sanity check on the server's data health

git commit, release version, super into those

[orangejulius]

That's a good point. If we ever wanted to re-write the Pelias Dashboard as something a bit more similar to the rest of the project (It's written in ruby and no one who has contributed significantly to its code is still involved in the project), the API would be a good place to put it.