Skip to content

Improve swagger docs around skipSnapshot:true #54

@tordans

Description

@tordans

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:

Image

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 maproulette/maproulette-backend#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

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    Status

    Backlog

    Status

    To triage

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions