Docs: preview start_date defaults to the household-local today

The occurrence-preview request docstring and the admin client's
startDate comment still said the default is the API host's today. The
route defaults to the household-local today in the configured
timezone, and uses the host's local time only when that setting is empty.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
This commit is contained in:
2026-09-26 10:15:44 -04:00
co-authored by Claude Opus 5.5
parent 4e6f9b339c
commit 37eba91191
2 changed files with 8 additions and 4 deletions
+4 -1
View File
@@ -150,7 +150,10 @@ export async function updateDefinition(
export const OCCURRENCES_PREVIEW_PATH = `${DEFINITIONS_PATH}/occurrences-preview`; export const OCCURRENCES_PREVIEW_PATH = `${DEFINITIONS_PATH}/occurrences-preview`;
export interface OccurrencesPreviewOptions { export interface OccurrencesPreviewOptions {
/** "YYYY-MM-DD"; the API defaults to its host's today. */ /**
* "YYYY-MM-DD"; the API defaults to the household-local today in the
* configured `timezone` (the API host's local time when that is empty).
*/
startDate?: string; startDate?: string;
/** 1..50; the API defaults to 10. */ /** 1..50; the API defaults to 10. */
count?: number; count?: number;
+4 -3
View File
@@ -536,9 +536,10 @@ class AdminOccurrencesPreviewRequest(BaseModel):
``rule`` is the SAME object create/edit take. ``start_date`` is an ``rule`` is the SAME object create/edit take. ``start_date`` is an
optional strict ``YYYY-MM-DD`` (validated by the core; default the optional strict ``YYYY-MM-DD`` (validated by the core; default the
API host's today). ``count`` is a strict JSON integer in household-local today in the configured ``timezone``, empty falling
1..``_PREVIEW_MAX_COUNT`` — anything else is 422 before any handler back to the API host's local time). ``count`` is a strict JSON
code runs. integer in 1..``_PREVIEW_MAX_COUNT`` — anything else is 422 before
any handler code runs.
""" """
rule: AdminRuleRequest rule: AdminRuleRequest