Skip to content

Commit c8aefd4

Browse files
authored
docs: X-Quota-Reset is a UTC date, not a timestamp (#97)
## Summary The docs described `X-Quota-Reset` as an ISO-8601 timestamp (`2026-06-01T00:00:00Z`). The API sends the UTC date the calendar-month quota resets, `YYYY-MM-DD` (`api/src/lib/rate-limit.ts` builds it from `nextMonth.toISOString().split('T')[0]`), and falls back to `never` only when it has no reset date. The doc text and example now match. Found in a docs audit across every repo, checked against the API source. ## Type of change - [ ] Bug fix (no breaking change) - [ ] New feature (no breaking change) - [ ] Breaking change (existing callers must update) - [x] Docs, tests, or internal maintenance only ## Public API None. A doc comment or README example only; the field stays a string. ## Test plan Docs only. The hooks ran lint and typecheck on commit and push. ## Checklist - [x] Tests cover the new behavior, and the suite passes locally (no behavior changed) - [x] Lint, format, and type checks pass - [x] Docs and README examples updated if the public surface changed - [x] No secrets, credentials, or personal data in the diff or the tests
1 parent cd6425f commit c8aefd4

1 file changed

Lines changed: 2 additions & 2 deletions

File tree

‎src/types.ts‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -153,8 +153,8 @@ export interface QuotaInfo {
153153
limit: number | null;
154154
/** `X-Quota-Used`: current usage within the period. */
155155
used: number | null;
156-
/** `X-Quota-Reset`: ISO-8601 timestamp when the period resets, or `'never'` for lifetime
157-
* caps. The API emits the literal string `'never'` for tiers without a reset. */
156+
/** `X-Quota-Reset`: the UTC date (`YYYY-MM-DD`) the calendar-month quota resets, e.g.
157+
* `2026-06-01`, or `'never'` when the API has no reset date for the account. */
158158
reset: string | null;
159159
}
160160

0 commit comments

Comments
 (0)