maproulette / maproulette/maproulette-backend
challenge API documentation not reflecting actual behaviour
Open
Nobody has claimed this yet.
- Dominant language
- Scala
- Stars
- 53
- Forks
- 39
- Avg merge
- 1d 17h
- Merged PRs (30d)
- 12
Description
The swagger documentation displays a different JSON object that what is actually returned for
https://maproulette.org/docs/swagger-ui/index.html?url=/assets/swagger.json#/Challenge/read
If the call is executed, say with challenge 2523, a differently structured object is returned.
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
Open the Swagger UI Challenge/read entry from the linked documentation and execute it for challenge 2523, then compare the documented schema with the returned JSON object. Update the API documentation so the response description matches the actual behavior, and verify the same endpoint displays the corrected structure.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- openapi
- Domain
- api, documentation
- Issue type
- Documentation
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 42/100