Add streak pauses documentation - #85
Merged
Merged
Conversation
Document streak pauses from the 1.21.0 OpenAPI specs: create and archive admin endpoints, plus pauses and usedPause on the user streak response. Co-authored-by: jasontlouro <jasontlouro@users.noreply.github.com>
jasontlouro
marked this pull request as ready for review
August 21, 2026 10:14
Refresh Lingo checksums so the frozen translation gate matches the new pause pages and updated streak source files. Co-authored-by: jasontlouro <jasontlouro@users.noreply.github.com>
Update nav, Spanish pages, and i18n.lock after renaming the admin endpoint page to delete-pauses. Keep the OpenAPI operation title. Co-authored-by: jasontlouro <jasontlouro@users.noreply.github.com>
|
Preview deployment for your docs. Learn more about Mintlify Previews.
💡 Tip: Enable Workflows to automatically generate PRs for you. |
Refresh the Lingo checksum for the Admin delete-pauses page now that the OpenAPI summary is Delete streak pauses. Co-authored-by: jasontlouro <jasontlouro@users.noreply.github.com>
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Documents the new streak pauses feature from the Trophy 1.21.0 OpenAPI specs.
Pauses cover a date range and keep a user's streak length intact instead of ending the streak. They are distinct from streak freezes: freezes are consumed one missed period at a time, while a pause applies for a start/end range you create.
API surfaces
GET /users/{id}/streaknow returns upcoming/activepausesandusedPauseon eachstreakHistoryperiod.POST /streaks/pausescreates pauses (up to 100 per request; start dates in the past are rejected).DELETE /streaks/pausesarchives pauses by ID so they no longer apply.Docs updates
openapi/application.jsonandopenapi/admin.json.docs.json.pauses,usedPause).