Skip to content

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 ​

FieldTypeRequiredNotes
idstringyespattern ^GOAL-\d+$
aliasesstring[]yes
typegoalyes
titlestringyes
tagsstring[]
createdstringpattern ^\d{4}-\d{2}-\d{2}T\d{2}:\d{2}:\d{2}(\.\d+)?(Z|[+-]\d{2}:\d{2})$
created_bystringpattern ^@[A-Za-z0-9][A-Za-z0-9_.-]*$
statusactive | achieved | droppedyes
areastring
duestringpattern ^\d{4}-\d{2}-\d{2}$
horizonstring
ownerstringpattern ^@[A-Za-z0-9][A-Za-z0-9_.-]*$
positionnumber

project ​

FieldTypeRequiredNotes
idstringyespattern ^PRJ-\d+$
aliasesstring[]yes
typeprojectyes
titlestringyes
tagsstring[]
createdstringpattern ^\d{4}-\d{2}-\d{2}T\d{2}:\d{2}:\d{2}(\.\d+)?(Z|[+-]\d{2}:\d{2})$
created_bystringpattern ^@[A-Za-z0-9][A-Za-z0-9_.-]*$
goalsstring[]yes
statusactive | paused | done | archivedyes
duestringpattern ^\d{4}-\d{2}-\d{2}$
milestonestring
ownerstringpattern ^@[A-Za-z0-9][A-Za-z0-9_.-]*$
labelsstring[]
positionnumber
decisionsstring[]
designobject[]

task ​

FieldTypeRequiredNotes
idstringyespattern ^TASK-\d+$
aliasesstring[]yes
typetaskyes
titlestringyes
tagsstring[]
createdstringpattern ^\d{4}-\d{2}-\d{2}T\d{2}:\d{2}:\d{2}(\.\d+)?(Z|[+-]\d{2}:\d{2})$
created_bystringpattern ^@[A-Za-z0-9][A-Za-z0-9_.-]*$
projectstringyespattern ^PRJ-\d+$
statebacklog | doing | blocked | doneyes
assigneesstring[]
labelsstring[]
positionnumber
decisionsstring[]
depends_onstring[]
relatedstring | string | string | string | string | string | string[]
duestringpattern ^\d{4}-\d{2}-\d{2}$

adr ​

FieldTypeRequiredNotes
idstringyespattern ^ADR-\d+$
aliasesstring[]yes
typeadryes
titlestringyes
tagsstring[]
createdstringpattern ^\d{4}-\d{2}-\d{2}T\d{2}:\d{2}:\d{2}(\.\d+)?(Z|[+-]\d{2}:\d{2})$
created_bystringpattern ^@[A-Za-z0-9][A-Za-z0-9_.-]*$
statusproposed | accepted | deprecated | supersededyes
datestringyespattern ^\d{4}-\d{2}-\d{2}$
decidersstring[]
projectstringpattern ^PRJ-\d+$
supersedesstring[]
superseded_bystringpattern ^ADR-\d+$
sourcestring
imported_atstringpattern ^\d{4}-\d{2}-\d{2}$

doc ​

FieldTypeRequiredNotes
idstringyespattern ^DOC-\d+$
aliasesstring[]yes
typedocyes
titlestringyes
tagsstring[]
createdstringpattern ^\d{4}-\d{2}-\d{2}T\d{2}:\d{2}:\d{2}(\.\d+)?(Z|[+-]\d{2}:\d{2})$
created_bystringpattern ^@[A-Za-z0-9][A-Za-z0-9_.-]*$
ownerstringpattern ^@[A-Za-z0-9][A-Za-z0-9_.-]*$
projectstringpattern ^PRJ-\d+$
explainsstring | string | string | string | string | string | string[]
coversstring[]
reviewed_atstringpattern ^\d{4}-\d{2}-\d{2}$
statusactive | deprecated | superseded
supersedesstring | string | string | string | string | string | string[]
superseded_bystring | string | string | string | string | string | string
sourcestring
imported_atstringpattern ^\d{4}-\d{2}-\d{2}$

context ​

FieldTypeRequiredNotes
idstringyespattern ^CTX-\d+$
aliasesstring[]yes
typecontextyes
titlestringyes
tagsstring[]
createdstringpattern ^\d{4}-\d{2}-\d{2}T\d{2}:\d{2}:\d{2}(\.\d+)?(Z|[+-]\d{2}:\d{2})$
created_bystringpattern ^@[A-Za-z0-9][A-Za-z0-9_.-]*$
ownerstringpattern ^@[A-Za-z0-9][A-Za-z0-9_.-]*$
projectstringpattern ^PRJ-\d+$
explainsstring | string | string | string | string | string | string[]
coversstring[]
reviewed_atstringpattern ^\d{4}-\d{2}-\d{2}$
statusactive | deprecated | superseded
supersedesstring | string | string | string | string | string | string[]
superseded_bystring | string | string | string | string | string | string
sourcestring
imported_atstringpattern ^\d{4}-\d{2}-\d{2}$
include_in_contextboolean
targetsclaude | agents | mcp[]
priorityhigh | normal | low

runbook ​

FieldTypeRequiredNotes
idstringyespattern ^RUN-\d+$
aliasesstring[]yes
typerunbookyes
titlestringyes
tagsstring[]
createdstringpattern ^\d{4}-\d{2}-\d{2}T\d{2}:\d{2}:\d{2}(\.\d+)?(Z|[+-]\d{2}:\d{2})$
created_bystringpattern ^@[A-Za-z0-9][A-Za-z0-9_.-]*$
ownerstringpattern ^@[A-Za-z0-9][A-Za-z0-9_.-]*$
projectstringpattern ^PRJ-\d+$
explainsstring | string | string | string | string | string | string[]
coversstring[]
reviewed_atstringpattern ^\d{4}-\d{2}-\d{2}$
statusactive | deprecated | superseded
supersedesstring | string | string | string | string | string | string[]
superseded_bystring | string | string | string | string | string | string
sourcestring
imported_atstringpattern ^\d{4}-\d{2}-\d{2}$

MIT licensed. Nothing is sent anywhere: it runs on your machine.