maproulette / maproulette/maproulette-backend
API documentation needs improvement
Open
Nobody has claimed this yet.
- Dominant language
- Scala
- Stars
- 53
- Forks
- 39
- Avg merge
- 1d 17h
- Merged PRs (30d)
- 12
Description
The Swagger based API docs can't stand on their own yet telling folks how to use the API. It exposes all the methods but does not provide any hints as to the payload and context.
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 by locating the Swagger/OpenAPI configuration and the API endpoint definitions in the Scala backend. Review how the current documentation is generated and identify the payload and context details missing from the issue's API methods. Done means the generated API documentation explains how to use each relevant method, including its payload and context.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- openapi, scala
- Domain
- api, documentation
- Issue type
- Documentation
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 35/100