Skip to content

docs(tasks): document timezone on the task read response (chat#1881 3c·api-read) - #276

Merged
sweetmantech merged 1 commit into
mainfrom
docs/task-read-timezone
Jul 22, 2026
Merged

docs(tasks): document timezone on the task read response (chat#1881 3c·api-read)#276
sweetmantech merged 1 commit into
mainfrom
docs/task-read-timezone

Conversation

@sweetmantech

@sweetmantech sweetmantech commented Jul 22, 2026

Copy link
Copy Markdown
Collaborator

What

Adds a nullable timezone to the Task schema returned by GET /api/tasks — the docs side of the 3c read path (chat#1881 item 3c·api-read).

The timezone is read from the Trigger.dev schedule (the source of truth — there's no stored column, per the 3c decision), so the chat edit UI can prefill the current timezone. null when the task has no schedule or the timezone can't be read. Mirrors the existing nullable owner_email convention. Additive diff, JSON re-validated.

Sequencing

Merge order: this → the api read-path PR (contract leads). Complements the write-side contract (timezone on CreateTaskRequest/UpdateTaskRequest, docs#275). Tracking: chat#1881 item 3c·api-read.


Summary by cubic

Added a nullable timezone field to the Task schema in the GET /api/tasks response, read from the Trigger.dev schedule. It’s an IANA time zone and is null when no schedule or unreadable; this lets the chat edit UI prefill the current timezone and aligns with chat#1881 (3c API read path).

Written for commit ce906ba. Summary will update on new commits.

Review in cubic

…c·api-read)

Adds a nullable `timezone` to the Task schema returned by GET /api/tasks, read
from the Trigger.dev schedule (the source of truth). Lets the chat edit UI
prefill the current timezone. Additive; JSON re-validated.

Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
@cursor

cursor Bot commented Jul 22, 2026

Copy link
Copy Markdown

Bugbot is not enabled for your account, so this pull request was not reviewed.

Enable Bugbot in the Cursor dashboard to get automatic reviews on future PRs.

@coderabbitai

coderabbitai Bot commented Jul 22, 2026

Copy link
Copy Markdown

Warning

Review limit reached

@sweetmantech, you've reached your PR review limit, so we couldn't start this review.

Next review available in: 3 minutes

Enable usage-based reviews in Billing to review now. Otherwise, wait until the next included review is available.
You're only billed for reviews past your plan's rate limits ($0.25/file).

How can I continue?

After more reviews become available, a review can be triggered using the @coderabbitai review command as a PR comment. Alternatively, push new commits to this PR.

To avoid repeated limits, reduce automatic review volume by pausing incremental auto-reviews earlier, using label-based review opt-in, excluding WIP or generated PR titles, or requesting reviews manually when the PR is ready. If your team needs uninterrupted high-volume reviews, an organization admin can enable usage-based reviews.

How do review limits work?

CodeRabbit enforces per-developer PR review limits for each organization. Most developers receive the normal plan review availability.

For paid Pro and Pro+ PR reviews, CodeRabbit uses adaptive limits for sustained high-volume activity. When a developer's recent PR review activity reaches the 95th percentile or higher among CodeRabbit users, additional reviews become available more gradually as earlier reviews age out of the rolling window.

Please refer docs for additional details.

Review details
⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Pro

Run ID: 066a7cc7-ffb8-43a3-8999-6130d989eab1

📥 Commits

Reviewing files that changed from the base of the PR and between 7e08310 and ce906ba.

📒 Files selected for processing (1)
  • api-reference/openapi/releases.json
✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch docs/task-read-timezone

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

Comment @coderabbitai help to get the list of available commands.

@cubic-dev-ai cubic-dev-ai Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

No issues found across 1 file

Re-trigger cubic

@sweetmantech

Copy link
Copy Markdown
Collaborator Author

✅ Local Mintlify verification — timezone renders on the Get Tasks response

Ran the docs locally (npx mintlify@latest dev) and opened Get Tasks (/api-reference/tasks/get, GET /api/tasks). The new field renders correctly in the response's tasks[] object, positioned right after schedule:

  • tasks.timezone · type string | null (nullable ✓, mirrors owner_email)
  • Description: "IANA time zone the task's cron is interpreted in, read from the Trigger.dev schedule (the source of truth). Null when the task has no schedule or the timezone can't be read."
  • Example: "America/New_York"

timezone on the Get Tasks response

Verdict: renders as intended. This is the read-side contract that api#781 fulfills (enrichTaskstask.timezone) and that chat#1883's getTaskTimezone consumes. Merge order: this → api#781. Tracking: chat#1881 3c·read·docs. (Screenshot on assets/pr276-preview-verification.)

@sweetmantech
sweetmantech merged commit ed3a821 into main Jul 22, 2026
3 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant