Skip to main content

Schema

Tasq validates entity data at the store layer on create and update operations. This reference summarizes the public field constraints that clients should respect.

Issue Tracker Entities

EntityRequired fieldsKey constraints
IssueprojectId, titletitle 1-500 chars, description max 10,000 chars, assignee max 200 chars, immutable project ownership
CommentissueId, author, bodybody 1-10,000 chars, type defaults to general
AttachmententityType, entityId, fileimage PNG/JPEG/GIF/WebP, max 5 MiB
Projectkey, name, locationkey format, name 1-200 chars, description max 10,000 chars, absolute location
ProjectWorkflowprojectId, frontmatter, body, checksumone workflow override per project, checksum is SHA256 hex

Orchestrator Entities

EntityRequired fieldsKey constraints
RunissueId, attempt, orchestratorIdrun ID generated, status defaults to queued
RunnerEventrunId, occurredAtpayload JSON must be valid when present
WorkspaceMetadataworkspaceKey, issueId, pathworkspace key max 200 chars, paths must be absolute
WorkspaceSetupFailureissueId, errorrecords setup failure context

Enums

FieldValues
Issue statusbacklog, ready, in_progress, review, done, blocked, failed, cancelled, duplicate
Queue statusbacklog, pending, queued, processing, completed, inactive
Issue prioritylow, normal, high, urgent
Comment typeprogress, blocker, handoff, general
Attachment entity typeissue, comment
Run statusqueued, running, succeeded, failed, cancelled

String and Path Limits

Absolute path fields must start with /. Clients such as tq project add check local directory existence when they can access the target filesystem.