Improve swagger docs around `skipSnapshot:true`
Nadie ha tomado este issue todavía.
Evaluación
- Dificultad
- 2/5
- Tiempo estimado
- 1-3 horas
- Aptitud para principiantes
- 42/100
- Tipo de issue
- Documentación
- Claridad
- Bastante claro
- Estado de actividad
- Estancado
- Stack tecnológico
- openapi
- Área
- api, documentation
Línea de trabajo
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.
Escrito por el modelo de indexación a partir del texto del issue.
Descripción
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
- Lenguaje dominante
- SCSS
- Estrellas
- 5
- Forks
- 8
- Métricas de merge de PR
- Sin PR fusionados en 30 d
Guía de contribución
No hay ninguna guía de contribución indexada para este repositorio
Primeros pasos
- Lee el issue completo y luego la guía de contribución del proyecto.
- Comenta en el issue que vas a ocuparte — evita que dos personas hagan lo mismo.
- Haz un fork del repositorio y trabaja en una rama.
- Abre un pull request que haga referencia al número del issue.
Más de maproulette/docs
-
Menu styling Abierto
Dificultad 4/5 3-5 días Aptitud para principiantes 35/100
maproulette/docs#61 ·
-
Dificultad 2/5 1-3 horas Aptitud para principiantes 35/100
maproulette/docs#55 ·
-
Dificultad 4/5 3-5 días Aptitud para principiantes 45/100
maproulette/docs#51 ·
-
Clarify GeoJSONL spec Abierto
Dificultad 3/5 1-2 días Aptitud para principiantes 35/100
maproulette/docs#50 ·
-
Discovering Interesting Tasks and Challenges: add detail on navigating and interpreting the map Abierto
Dificultad 3/5 1-2 días Aptitud para principiantes 35/100
maproulette/docs#49 ·
Todos los issues de maproulette/docs
Issues similares
-
has_tail_capacity wraps and get_writable_raw_unchecked commits raw_len before the bounds check Abierto
Dificultad 2/5 1-3 horas Aptitud para principiantes 82/100
stratum-mining/stratum#2404 ·
-
Dificultad 2/5 1-3 horas Aptitud para principiantes 76/100
-
documentation
Dificultad 2/5 Medio día Aptitud para principiantes 62/100
inmanta/inmanta-core#10835 ·
-
opensubtitlescom: moviehash never sent when opensubtitles (.org) is not in the provider list Abierto
Dificultad 2/5 1-3 horas Aptitud para principiantes 86/100
Diaoul/subliminal#1382 ·
-
fix(errors): EHOSTUNREACH from a happy-eyeballs connect is reported as a resolver error (STAMP-80) Abierto
Dificultad 2/5 1-3 horas Aptitud para principiantes 90/100
snapshot-labs/stamp#666 ·