Improve swagger docs around `skipSnapshot:true`
Chưa có ai nhận issue này.
Đánh giá
- Độ khó
- 2/5
- Thời gian dự kiến
- 1-3 giờ
- Mức phù hợp với người mới
- 42/100
- Loại issue
- Tài liệu
- Độ rõ ràng
- Khá rõ ràng
- Mức độ hoạt động
- Đình trệ
- Công nghệ
- openapi
- Lĩnh vực
- api, documentation
Hướng nghiên cứu
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.
Do mô hình lập chỉ mục viết ra từ nội dung của issue.
Mô tả
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
- Ngôn ngữ chính
- SCSS
- Star
- 5
- Fork
- 8
- Chỉ số merge pull request
- Không có pull request nào được merge trong 30 ngày
Hướng dẫn đóng góp
Chưa lập chỉ mục được hướng dẫn đóng góp cho kho mã nguồn này
Bắt đầu từ đâu
- Đọc hết issue, rồi đọc hướng dẫn đóng góp của dự án.
- Bình luận trên issue rằng bạn sẽ nhận — tránh hai người làm cùng một việc.
- Fork repository và làm thay đổi trên một nhánh.
- Mở pull request có tham chiếu số hiệu của issue.
Issue khác của maproulette/docs
-
Menu styling Đang mở
Độ khó 4/5 3-5 ngày Mức phù hợp với người mới 35/100
maproulette/docs#61 ·
-
Độ khó 2/5 1-3 giờ Mức phù hợp với người mới 35/100
maproulette/docs#55 ·
-
Độ khó 4/5 3-5 ngày Mức phù hợp với người mới 45/100
maproulette/docs#51 ·
-
Clarify GeoJSONL spec Đang mở
Độ khó 3/5 1-2 ngày Mức phù hợp với người mới 35/100
maproulette/docs#50 ·
-
Discovering Interesting Tasks and Challenges: add detail on navigating and interpreting the map Đang mở
Độ khó 3/5 1-2 ngày Mức phù hợp với người mới 35/100
maproulette/docs#49 ·
Tất cả issue của maproulette/docs
Issue tương tự
-
[Bug]: Matrix progress drafts fail with "Matrix runtime not initialized" during tool activity Đang mởbug clawsweeper:linked-pr-open clawsweeper:needs-live-repro clawsweeper:no-new-fix-pr impact:message-loss issue-rating: 🐚 platinum hermit P2 regression
Độ khó 2/5 1-3 giờ Mức phù hợp với người mới 78/100
-
Độ khó 1/5 Dưới một giờ Mức phù hợp với người mới 90/100
AXERA-TECH/ax-llm#77 ·
-
Độ khó 1/5 Dưới một giờ Mức phù hợp với người mới 90/100
games-on-whales/wolf#509 ·
-
Độ khó 2/5 1-3 giờ Mức phù hợp với người mới 78/100
-
enhancement
Độ khó 2/5 1-3 giờ Mức phù hợp với người mới 72/100