Improve swagger docs around `skipSnapshot:true`
Nobody has claimed this yet.
Assessment
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Newbie friendliness
- 42/100
- Issue type
- Documentation
- Clarity
- Mostly clear
- Activity status
- Stale
- Tech stack
- openapi
- Domain
- api, documentation
Research direction
Start with the Swagger UI documentation for Challenge/rebuildChallenge and the rebuilding-challenge-tasks documentation page. Determine what a snapshot is and the effects of skipSnapshot being true or false, then clarify the Swagger description so the flag's behavior and trade-offs are explicit.
Written by the indexing model from the issue text.
Description
The API allows to add two flags when triggering a rebuild of a the tasks of a challenge:
The swagger docs describe them like this:
The first flag (remove) is exposed in the UI as a checkbox, the second is not. The docs also only mention the remove-flag (which is fine, IMO).
My question is: What is a snapshot? What happens when set to false? Is there a disadvantage to setting it to false?
For context, I am debugging https://github.com/maproulette/maproulette-backend/issues/1180 and assume that the snapshot take more time to process because it looks like things are done synchronously so skipping the snapshot should be a good idea.
Suggestion: Clarify the swagger docs
Reference https://osmus.slack.com/archives/C1QN12RS7/p1740545612317079
- Dominant language
- SCSS
- Stars
- 5
- Forks
- 8
- PR merge metrics
- No merged PRs in 30d
Contributor guide
No contributing guide indexed for this repository
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.
More from maproulette/docs
-
Menu styling Open
Difficulty 4/5 3-5 days Newbie friendliness 35/100
maproulette/docs#61 ·
-
Difficulty 2/5 1-3 hours Newbie friendliness 35/100
maproulette/docs#55 ·
-
Difficulty 4/5 3-5 days Newbie friendliness 45/100
maproulette/docs#51 ·
-
Difficulty 3/5 1-2 days Newbie friendliness 35/100
maproulette/docs#50 ·
-
Discovering Interesting Tasks and Challenges: add detail on navigating and interpreting the map Open
Difficulty 3/5 1-2 days Newbie friendliness 35/100
maproulette/docs#49 ·
All issues in maproulette/docs
Similar issues
-
Difficulty 2/5 1-3 hours Newbie friendliness 78/100
use-agent-os/agent-os#3312 ·
-
Difficulty 2/5 1-3 hours Newbie friendliness 85/100
-
needs-acceptance wg/data-plane-networking
Difficulty 2/5 1-3 hours Newbie friendliness 78/100
vllm-project/semantic-router#4024 · 1 comment ·
-
bug good first issue
Difficulty 2/5 1-3 hours Newbie friendliness 88/100
amponce/archive-movie-browser#165 ·
-
Difficulty 2/5 1-3 hours Newbie friendliness 78/100