Item schemas
The fields of each item type, as the validator checks them (netherite lint, and every write). IDs look like TASK-00042, and a field that links to another item holds its ID. Unknown fields are kept and ignored. The same JSON Schemas are served at netherite://schema/<type> and GET /api/schemas/<type>.
goal
| Field | Type | Required | Notes |
|---|---|---|---|
id | string | yes | pattern ^GOAL-\d+$ |
aliases | string[] | yes | |
type | goal | yes | |
title | string | yes | |
tags | string[] | ||
created | string | pattern ^\d{4}-\d{2}-\d{2}T\d{2}:\d{2}:\d{2}(\.\d+)?(Z|[+-]\d{2}:\d{2})$ | |
created_by | string | pattern ^@[A-Za-z0-9][A-Za-z0-9_.-]*$ | |
status | active | achieved | dropped | yes | |
area | string | ||
due | string | pattern ^\d{4}-\d{2}-\d{2}$ | |
horizon | string | ||
owner | string | pattern ^@[A-Za-z0-9][A-Za-z0-9_.-]*$ | |
position | number |
project
| Field | Type | Required | Notes |
|---|---|---|---|
id | string | yes | pattern ^PRJ-\d+$ |
aliases | string[] | yes | |
type | project | yes | |
title | string | yes | |
tags | string[] | ||
created | string | pattern ^\d{4}-\d{2}-\d{2}T\d{2}:\d{2}:\d{2}(\.\d+)?(Z|[+-]\d{2}:\d{2})$ | |
created_by | string | pattern ^@[A-Za-z0-9][A-Za-z0-9_.-]*$ | |
goals | string[] | yes | |
status | active | paused | done | archived | yes | |
due | string | pattern ^\d{4}-\d{2}-\d{2}$ | |
milestone | string | ||
owner | string | pattern ^@[A-Za-z0-9][A-Za-z0-9_.-]*$ | |
labels | string[] | ||
position | number | ||
decisions | string[] | ||
design | object[] |
task
| Field | Type | Required | Notes |
|---|---|---|---|
id | string | yes | pattern ^TASK-\d+$ |
aliases | string[] | yes | |
type | task | yes | |
title | string | yes | |
tags | string[] | ||
created | string | pattern ^\d{4}-\d{2}-\d{2}T\d{2}:\d{2}:\d{2}(\.\d+)?(Z|[+-]\d{2}:\d{2})$ | |
created_by | string | pattern ^@[A-Za-z0-9][A-Za-z0-9_.-]*$ | |
project | string | yes | pattern ^PRJ-\d+$ |
state | backlog | doing | blocked | done | yes | |
assignees | string[] | ||
labels | string[] | ||
position | number | ||
decisions | string[] | ||
depends_on | string[] | ||
related | string | string | string | string | string | string | string[] | ||
due | string | pattern ^\d{4}-\d{2}-\d{2}$ |
adr
| Field | Type | Required | Notes |
|---|---|---|---|
id | string | yes | pattern ^ADR-\d+$ |
aliases | string[] | yes | |
type | adr | yes | |
title | string | yes | |
tags | string[] | ||
created | string | pattern ^\d{4}-\d{2}-\d{2}T\d{2}:\d{2}:\d{2}(\.\d+)?(Z|[+-]\d{2}:\d{2})$ | |
created_by | string | pattern ^@[A-Za-z0-9][A-Za-z0-9_.-]*$ | |
status | proposed | accepted | deprecated | superseded | yes | |
date | string | yes | pattern ^\d{4}-\d{2}-\d{2}$ |
deciders | string[] | ||
project | string | pattern ^PRJ-\d+$ | |
supersedes | string[] | ||
superseded_by | string | pattern ^ADR-\d+$ | |
source | string | ||
imported_at | string | pattern ^\d{4}-\d{2}-\d{2}$ |
doc
| Field | Type | Required | Notes |
|---|---|---|---|
id | string | yes | pattern ^DOC-\d+$ |
aliases | string[] | yes | |
type | doc | yes | |
title | string | yes | |
tags | string[] | ||
created | string | pattern ^\d{4}-\d{2}-\d{2}T\d{2}:\d{2}:\d{2}(\.\d+)?(Z|[+-]\d{2}:\d{2})$ | |
created_by | string | pattern ^@[A-Za-z0-9][A-Za-z0-9_.-]*$ | |
owner | string | pattern ^@[A-Za-z0-9][A-Za-z0-9_.-]*$ | |
project | string | pattern ^PRJ-\d+$ | |
explains | string | string | string | string | string | string | string[] | ||
covers | string[] | ||
reviewed_at | string | pattern ^\d{4}-\d{2}-\d{2}$ | |
status | active | deprecated | superseded | ||
supersedes | string | string | string | string | string | string | string[] | ||
superseded_by | string | string | string | string | string | string | string | ||
source | string | ||
imported_at | string | pattern ^\d{4}-\d{2}-\d{2}$ |
context
| Field | Type | Required | Notes |
|---|---|---|---|
id | string | yes | pattern ^CTX-\d+$ |
aliases | string[] | yes | |
type | context | yes | |
title | string | yes | |
tags | string[] | ||
created | string | pattern ^\d{4}-\d{2}-\d{2}T\d{2}:\d{2}:\d{2}(\.\d+)?(Z|[+-]\d{2}:\d{2})$ | |
created_by | string | pattern ^@[A-Za-z0-9][A-Za-z0-9_.-]*$ | |
owner | string | pattern ^@[A-Za-z0-9][A-Za-z0-9_.-]*$ | |
project | string | pattern ^PRJ-\d+$ | |
explains | string | string | string | string | string | string | string[] | ||
covers | string[] | ||
reviewed_at | string | pattern ^\d{4}-\d{2}-\d{2}$ | |
status | active | deprecated | superseded | ||
supersedes | string | string | string | string | string | string | string[] | ||
superseded_by | string | string | string | string | string | string | string | ||
source | string | ||
imported_at | string | pattern ^\d{4}-\d{2}-\d{2}$ | |
include_in_context | boolean | ||
targets | claude | agents | mcp[] | ||
priority | high | normal | low |
runbook
| Field | Type | Required | Notes |
|---|---|---|---|
id | string | yes | pattern ^RUN-\d+$ |
aliases | string[] | yes | |
type | runbook | yes | |
title | string | yes | |
tags | string[] | ||
created | string | pattern ^\d{4}-\d{2}-\d{2}T\d{2}:\d{2}:\d{2}(\.\d+)?(Z|[+-]\d{2}:\d{2})$ | |
created_by | string | pattern ^@[A-Za-z0-9][A-Za-z0-9_.-]*$ | |
owner | string | pattern ^@[A-Za-z0-9][A-Za-z0-9_.-]*$ | |
project | string | pattern ^PRJ-\d+$ | |
explains | string | string | string | string | string | string | string[] | ||
covers | string[] | ||
reviewed_at | string | pattern ^\d{4}-\d{2}-\d{2}$ | |
status | active | deprecated | superseded | ||
supersedes | string | string | string | string | string | string | string[] | ||
superseded_by | string | string | string | string | string | string | string | ||
source | string | ||
imported_at | string | pattern ^\d{4}-\d{2}-\d{2}$ |