What useful information can we put on the API root path?
Open
Nobody has claimed this yet.
enhancement
question
- Dominant language
- JavaScript
- Stars
- 259
- Forks
- 168
- Avg merge
- 6h 15m
- Merged PRs (30d)
- 1
Description
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
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start with the existing root-path content in public/apiDoc.md and review how the Pelias API serves it. Consider the listed information ideas, including the possible compare-app link after #1416, and look for discussion that establishes a preferred direction. Done means the project has agreed on what the root path should provide and defined the resulting implementation scope.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- javascript
- Domain
- api
- Issue type
- Feature
- Difficulty
- 5/5
- Estimated time
- Over a week
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 25/100