Schemas
The JSON Schemas of the files in a vault and of the requests that change them, rendered from the validation that the CLI runs.
On this page
An agent reads these schemas from the CLI on its PATH, so they always match the
installed program. A valid shape is not yet valid architecture: a write also checks names,
identities, the claim and the complete revision.
archboard model schemaarchboard model schema model-edit > model-edit.schema.jsonCanonical model manifest #
The manifest of a model: model.json in the vault. It names the model and its current state, and holds no modules.
schemaVersion
1
required
id
string
required
matches ^[A-Za-z0-9-]{1,8}$
name
string
required
not empty, at most 120 characters
current
one of these
required
2 shapes
object with id, name and 10 more
id
string
required
matches ^[A-Za-z0-9-]{1,8}$
name
string
required
not empty, at most 120 characters
formerNames
list of string
summary
string
not empty, at most 2000 characters, not blank
documents
list of object
4 fields
repo
string
required
not empty
branch
string
not empty
commit
string
not empty
path
string
required
not empty
predecessor
one of these
2 shapes
string matching ^[A-Za-z0-9-]{1,8}$
matches ^[A-Za-z0-9-]{1,8}$
null
baseline
string
matches ^(?:[a-f0-9]{40}|[a-f0-9]{64})$
createdAt
string
matches ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d:[0-5]\d(?:\.\d+)?(?:Z))$
adoptedAt
string
matches ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d:[0-5]\d(?:\.\d+)?(?:Z))$
shelvedAt
string
matches ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d:[0-5]\d(?:\.\d+)?(?:Z))$
reason
string
not empty
previousCurrent
one of these
2 shapes
string matching ^[A-Za-z0-9-]{1,8}$
matches ^[A-Za-z0-9-]{1,8}$
null
null
retiredIds
list of string
Canonical module definition #
One module definition: a <id>.module.json file in the vault, with its parts, relationships and binding.
order
integer
required
at least 0
name
string
required
not empty, at most 120 characters
kind
string
required
not empty,
matches ^[a-z0-9]+(?:[-_.][a-z0-9]+)*$
responsibility
string
not empty, at most 200 characters, not blank
description
string
not empty, at most 2000 characters, not blank
groups
list of string
no repeats
binding
object
6 fields
repo
string
required
not empty
path
string
required
symbol
string
not empty
branch
string
not empty
commit
string
not empty
confirmedAt
string
not empty
schemaVersion
1
required
id
string
required
matches ^[A-Za-z0-9-]{1,8}(?:\/[A-Za-z0-9-]{1,8})?#[A-Za-z0-9-]{1,8}$
parent
string
matches ^[A-Za-z0-9-]{1,8}(?:\/[A-Za-z0-9-]{1,8})?#[A-Za-z0-9-]{1,8}$
formerNames
list of string
documents
list of object
4 fields
repo
string
required
not empty
branch
string
not empty
commit
string
not empty
path
string
required
not empty
references
list of object
5 fields
repo
string
required
not empty
model
string
required
matches ^[A-Za-z0-9-]{1,8}$
subject
string
required
matches ^[A-Za-z0-9-]{1,8}(?:\/[A-Za-z0-9-]{1,8})?#[A-Za-z0-9-]{1,8}$
state
one of these
required
2 shapes
string matching ^[A-Za-z0-9-]{1,8}$
matches ^[A-Za-z0-9-]{1,8}$
string matching ^[A-Za-z0-9-]{1,8}(?:\/[A-Za-z0-9-]{1,8})?#[A-Za-z0-9-]{1,8}$
matches ^[A-Za-z0-9-]{1,8}(?:\/[A-Za-z0-9-]{1,8})?#[A-Za-z0-9-]{1,8}$
checkpoint
string
matches ^(?:[a-f0-9]{40}|[a-f0-9]{64})$
outgoing
list of object
required
9 fields
order
integer
required
at least 0
kind
string
required
not empty,
matches ^[a-z0-9]+(?:[-_.][a-z0-9]+)*$
label
string
not empty, at most 60 characters
description
string
not empty, at most 2000 characters, not blank
emphasis
one of
default "normal"
"normal""hero""muted"
traffic
object
2 fields
speed
number
default 80
more than 0
volume
number
default 1
more than 0
anchor
object
3 fields
repo
string
required
not empty
path
string
required
not empty
symbol
string
required
not empty
id
string
required
matches ^[A-Za-z0-9-]{1,8}(?:\/[A-Za-z0-9-]{1,8})?#[A-Za-z0-9-]{1,8}$
to
string
required
matches ^[A-Za-z0-9-]{1,8}(?:\/[A-Za-z0-9-]{1,8})?#[A-Za-z0-9-]{1,8}$
Independent flow collection #
One flow collection: a <id>.flows.json file in the vault, with its flows and their steps.
schemaVersion
1
required
id
string
required
matches ^[A-Za-z0-9-]{1,8}$
name
string
required
not empty, at most 120 characters
formerNames
list of string
flows
list of object
required
6 fields
id
string
required
matches ^[A-Za-z0-9-]{1,8}(?:\/[A-Za-z0-9-]{1,8})?#[A-Za-z0-9-]{1,8}$
name
string
required
not empty, at most 120 characters
summary
string
not empty, at most 2000 characters, not blank
participants
list of string
required
at least 1 item
formerNames
list of string
steps
list of one of these
required
at least 1 item
3 shapes
object with from, to and 3 more
id
string
required
matches ^[A-Za-z0-9-]{1,8}(?:\/[A-Za-z0-9-]{1,8})?#[A-Za-z0-9-]{1,8}$
from
string
required
matches ^[A-Za-z0-9-]{1,8}(?:\/[A-Za-z0-9-]{1,8})?#[A-Za-z0-9-]{1,8}$
to
string
required
matches ^[A-Za-z0-9-]{1,8}(?:\/[A-Za-z0-9-]{1,8})?#[A-Za-z0-9-]{1,8}$
label
string
required
not empty, at most 60 characters
kind
one of
default "sync"
"sync""async""return""self"
note
string
not empty, at most 2000 characters, not blank
repeat
integer
at least 2
anchor
object
3 fields
repo
string
required
not empty
path
string
required
not empty
symbol
string
required
not empty
kind: "decision"
id
string
required
matches ^[A-Za-z0-9-]{1,8}(?:\/[A-Za-z0-9-]{1,8})?#[A-Za-z0-9-]{1,8}$
kind
"decision"
required
question
string
required
not empty, at most 60 characters
note
string
not empty, at most 2000 characters, not blank
alternatives
list of object
required
at least 2 items
2 fields
label
string
required
not empty, at most 60 characters
steps
list of one of these
required
The same shape as the field that holds it, one level up.
kind: "loop"
id
string
required
matches ^[A-Za-z0-9-]{1,8}(?:\/[A-Za-z0-9-]{1,8})?#[A-Za-z0-9-]{1,8}$
kind
"loop"
required
condition
string
required
not empty, at most 60 characters
note
string
not empty, at most 2000 characters, not blank
steps
list of one of these
required
The same shape as the field that holds it, one level up.
at least 1 item
Canonical initialization intent #
The request that archboard model init sends to make an empty planning model.
name
string
required
not empty
operationId
string
required
not empty
writer
string
required
not empty
doing
string
required
not empty, at most 140 characters
Claimed canonical edit intent #
The request that archboard model edit --input reads: one complete revision, a claim and a batch of changes.
object with correction
target
object
required
2 fields
model
string
required
matches ^[A-Za-z0-9-]{1,8}$
state
one of these
required
2 shapes
string matching ^[A-Za-z0-9-]{1,8}$
matches ^[A-Za-z0-9-]{1,8}$
null
expectedRevision
object
required
2 fields
digest
string
required
files
list of object
required
2 fields
path
string
required
sha256
string
required
operationId
string
required
not empty
writer
string
required
not empty
claim
string
required
matches ^[A-Za-z0-9-]{1,8}$
correction
object
required
3 fields
previous
string
required
matches ^(?:[a-f0-9]{40}|[a-f0-9]{64})$
reason
string
required
not empty
revisions
list of object
required
at least 1 item
2 fields
repo
string
required
not empty
commit
string
required
matches ^(?:[a-f0-9]{40}|[a-f0-9]{64})$
changes
list of one of these
required
at least 1 item
19 shapes
type: "remove-module"
type
"remove-module"
required
subject
string
required
not empty
type: "add-relationship"
type
"add-relationship"
required
source
string
required
not empty
relationship
object
required
8 fields
order
integer
required
at least 0
kind
string
required
not empty,
matches ^[a-z0-9]+(?:[-_.][a-z0-9]+)*$
label
string
not empty, at most 60 characters
description
string
not empty, at most 2000 characters, not blank
emphasis
one of
default "normal"
"normal""hero""muted"
traffic
object
2 fields
speed
number
default 80
more than 0
volume
number
default 1
more than 0
anchor
object
3 fields
repo
string
required
not empty
path
string
required
not empty
symbol
string
required
not empty
to
string
required
not empty
type: "remove-relationship"
type
"remove-relationship"
required
subject
string
required
matches ^[A-Za-z0-9-]{1,8}(?:\/[A-Za-z0-9-]{1,8})?#[A-Za-z0-9-]{1,8}$
type: "edit-relationship"
type
"edit-relationship"
required
subject
string
required
matches ^[A-Za-z0-9-]{1,8}(?:\/[A-Za-z0-9-]{1,8})?#[A-Za-z0-9-]{1,8}$
source
string
not empty
set
object
8 fields
order
integer
at least 0
kind
string
not empty,
matches ^[a-z0-9]+(?:[-_.][a-z0-9]+)*$
label
string
not empty, at most 60 characters
description
string
not empty, at most 2000 characters, not blank
emphasis
one of
"normal""hero""muted"
traffic
object
2 fields
speed
number
default 80
more than 0
volume
number
default 1
more than 0
anchor
object
3 fields
repo
string
required
not empty
path
string
required
not empty
symbol
string
required
not empty
to
string
not empty
clear
list of one of
type: "add-module"
type
"add-module"
required
module
object
required
10 fields
order
integer
required
at least 0
name
string
required
not empty, at most 120 characters
kind
string
required
not empty,
matches ^[a-z0-9]+(?:[-_.][a-z0-9]+)*$
responsibility
string
not empty, at most 200 characters, not blank
description
string
not empty, at most 2000 characters, not blank
groups
list of string
no repeats
binding
object
6 fields
repo
string
required
not empty
path
string
required
symbol
string
not empty
branch
string
not empty
commit
string
not empty
confirmedAt
string
not empty
parent
string
not empty
documents
list of object
4 fields
repo
string
required
not empty
branch
string
not empty
commit
string
not empty
path
string
required
not empty
references
list of object
5 fields
repo
string
required
not empty
model
string
required
matches ^[A-Za-z0-9-]{1,8}$
subject
string
required
matches ^[A-Za-z0-9-]{1,8}(?:\/[A-Za-z0-9-]{1,8})?#[A-Za-z0-9-]{1,8}$
state
one of these
required
2 shapes
string matching ^[A-Za-z0-9-]{1,8}$
matches ^[A-Za-z0-9-]{1,8}$
string matching ^[A-Za-z0-9-]{1,8}(?:\/[A-Za-z0-9-]{1,8})?#[A-Za-z0-9-]{1,8}$
matches ^[A-Za-z0-9-]{1,8}(?:\/[A-Za-z0-9-]{1,8})?#[A-Za-z0-9-]{1,8}$
checkpoint
string
matches ^(?:[a-f0-9]{40}|[a-f0-9]{64})$
type: "edit-module"
type
"edit-module"
required
subject
string
required
not empty
set
object
10 fields
order
integer
at least 0
name
string
not empty, at most 120 characters
kind
string
not empty,
matches ^[a-z0-9]+(?:[-_.][a-z0-9]+)*$
responsibility
string
not empty, at most 200 characters, not blank
description
string
not empty, at most 2000 characters, not blank
groups
list of string
no repeats
binding
object
6 fields
repo
string
required
not empty
path
string
required
symbol
string
not empty
branch
string
not empty
commit
string
not empty
confirmedAt
string
not empty
parent
string
not empty
documents
list of object
4 fields
repo
string
required
not empty
branch
string
not empty
commit
string
not empty
path
string
required
not empty
references
list of object
5 fields
repo
string
required
not empty
model
string
required
matches ^[A-Za-z0-9-]{1,8}$
subject
string
required
matches ^[A-Za-z0-9-]{1,8}(?:\/[A-Za-z0-9-]{1,8})?#[A-Za-z0-9-]{1,8}$
state
one of these
required
2 shapes
string matching ^[A-Za-z0-9-]{1,8}$
matches ^[A-Za-z0-9-]{1,8}$
string matching ^[A-Za-z0-9-]{1,8}(?:\/[A-Za-z0-9-]{1,8})?#[A-Za-z0-9-]{1,8}$
matches ^[A-Za-z0-9-]{1,8}(?:\/[A-Za-z0-9-]{1,8})?#[A-Za-z0-9-]{1,8}$
checkpoint
string
matches ^(?:[a-f0-9]{40}|[a-f0-9]{64})$
clear
list of one of
type: "add-collection"
type
"add-collection"
required
name
string
required
not empty, at most 120 characters
type: "edit-collection"
type
"edit-collection"
required
collection
string
required
not empty
name
string
required
not empty, at most 120 characters
type: "remove-collection"
type
"remove-collection"
required
collection
string
required
not empty
type: "remove-flow"
type
"remove-flow"
required
subject
string
required
not empty
type: "add-step"
type
"add-step"
required
placement
object
required
3 fields
holder
string
required
matches ^[A-Za-z0-9-]{1,8}(?:\/[A-Za-z0-9-]{1,8})?#[A-Za-z0-9-]{1,8}$
alternative
string
not empty, at most 60 characters
before
string
matches ^[A-Za-z0-9-]{1,8}(?:\/[A-Za-z0-9-]{1,8})?#[A-Za-z0-9-]{1,8}$
step
one of these
required
3 shapes
object with id, from and 4 more
id
any
from
string
required
not empty
to
string
required
not empty
label
string
required
not empty, at most 60 characters
kind
one of
default "sync"
"sync""async""return""self"
note
string
not empty, at most 2000 characters, not blank
repeat
integer
at least 2
anchor
object
3 fields
repo
string
required
not empty
path
string
required
not empty
symbol
string
required
not empty
kind: "decision"
kind
"decision"
required
question
string
required
not empty, at most 60 characters
note
string
not empty, at most 2000 characters, not blank
alternatives
list of object
required
at least 2 items
2 fields
label
string
required
not empty, at most 60 characters
steps
list of one of these
required
The same shape as the field that holds it, one level up.
kind: "loop"
kind
"loop"
required
condition
string
required
not empty, at most 60 characters
note
string
not empty, at most 2000 characters, not blank
steps
list of one of these
required
The same shape as the field that holds it, one level up.
at least 1 item
type: "edit-step"
type
"edit-step"
required
subject
string
required
matches ^[A-Za-z0-9-]{1,8}(?:\/[A-Za-z0-9-]{1,8})?#[A-Za-z0-9-]{1,8}$
set
object
10 fields
kind
one of
"sync""async""return""self"
from
string
not empty
to
string
not empty
label
string
not empty, at most 60 characters
note
string
not empty, at most 2000 characters, not blank
repeat
integer
at least 2
anchor
object
3 fields
repo
string
required
not empty
path
string
required
not empty
symbol
string
required
not empty
question
string
not empty, at most 60 characters
condition
string
not empty, at most 60 characters
alternatives
list of string
at least 2 items
clear
list of one of
type: "remove-step"
type
"remove-step"
required
subject
string
required
matches ^[A-Za-z0-9-]{1,8}(?:\/[A-Za-z0-9-]{1,8})?#[A-Za-z0-9-]{1,8}$
type: "move-step"
type
"move-step"
required
subject
string
required
matches ^[A-Za-z0-9-]{1,8}(?:\/[A-Za-z0-9-]{1,8})?#[A-Za-z0-9-]{1,8}$
placement
object
required
3 fields
holder
string
required
matches ^[A-Za-z0-9-]{1,8}(?:\/[A-Za-z0-9-]{1,8})?#[A-Za-z0-9-]{1,8}$
alternative
string
not empty, at most 60 characters
before
string
matches ^[A-Za-z0-9-]{1,8}(?:\/[A-Za-z0-9-]{1,8})?#[A-Za-z0-9-]{1,8}$
type: "add-flow"
type
"add-flow"
required
collection
string
required
not empty
flow
object
required
4 fields
name
string
required
not empty, at most 120 characters
summary
string
required
not empty, at most 2000 characters, not blank
participants
list of string
required
at least 1 item
steps
list of one of these
required
at least 1 item
3 shapes
object with id, from and 4 more
id
any
from
string
required
not empty
to
string
required
not empty
label
string
required
not empty, at most 60 characters
kind
one of
default "sync"
"sync""async""return""self"
note
string
not empty, at most 2000 characters, not blank
repeat
integer
at least 2
anchor
object
3 fields
repo
string
required
not empty
path
string
required
not empty
symbol
string
required
not empty
kind: "decision"
kind
"decision"
required
question
string
required
not empty, at most 60 characters
note
string
not empty, at most 2000 characters, not blank
alternatives
list of object
required
at least 2 items
2 fields
label
string
required
not empty, at most 60 characters
steps
list of one of these
required
The same shape as the field that holds it, one level up.
kind: "loop"
kind
"loop"
required
condition
string
required
not empty, at most 60 characters
note
string
not empty, at most 2000 characters, not blank
steps
list of one of these
required
The same shape as the field that holds it, one level up.
at least 1 item
type: "edit-flow"
type
"edit-flow"
required
subject
string
required
not empty
collection
string
not empty
set
object
3 fields
name
string
not empty, at most 120 characters
summary
string
not empty, at most 2000 characters, not blank
participants
list of string
at least 1 item
type: "add-walkthrough"
type
"add-walkthrough"
required
walkthrough
object
required
4 fields
name
string
required
not empty, at most 120 characters
summary
string
not empty, at most 2000 characters, not blank
target
one of these
required
2 shapes
object with state
state
string
required
not empty
object with checkpoint
checkpoint
string
required
matches ^(?:[a-f0-9]{40}|[a-f0-9]{64})$
beats
list of object
required
at least 1 item
3 fields
title
string
required
not empty, at most 120 characters
narrative
string
required
not empty, at most 2000 characters, not blank
reading
object
required
7 fields
visibility
object
3 fields
modules
list of string
required
relationships
list of string
required
flows
list of string
required
scope
string
matches ^[A-Za-z0-9-]{1,8}(?:\/[A-Za-z0-9-]{1,8})?#[A-Za-z0-9-]{1,8}$
selection
list of string
focus
list of string
filters
object
default {"relationships":[],"groups":[]}
2 fields
relationships
list of string
required
groups
list of string
required
grammar
one of
required
"architecture""sequence""flowchart"
flow
string
matches ^[A-Za-z0-9-]{1,8}(?:\/[A-Za-z0-9-]{1,8})?#[A-Za-z0-9-]{1,8}$
type: "edit-walkthrough"
type
"edit-walkthrough"
required
subject
string
required
matches ^[A-Za-z0-9-]{1,8}(?:\/[A-Za-z0-9-]{1,8})?#[A-Za-z0-9-]{1,8}$
set
object
3 fields
name
string
not empty, at most 120 characters
summary
string
not empty, at most 2000 characters, not blank
target
one of these
2 shapes
object with state
state
string
required
not empty
object with checkpoint
checkpoint
string
required
matches ^(?:[a-f0-9]{40}|[a-f0-9]{64})$
clear
list of "summary"
beats
list of object
at least 1 item
4 fields
title
string
required
not empty, at most 120 characters
narrative
string
required
not empty, at most 2000 characters, not blank
reading
object
required
7 fields
visibility
object
3 fields
modules
list of string
required
relationships
list of string
required
flows
list of string
required
scope
string
matches ^[A-Za-z0-9-]{1,8}(?:\/[A-Za-z0-9-]{1,8})?#[A-Za-z0-9-]{1,8}$
selection
list of string
focus
list of string
filters
object
default {"relationships":[],"groups":[]}
2 fields
relationships
list of string
required
groups
list of string
required
grammar
one of
required
"architecture""sequence""flowchart"
flow
string
matches ^[A-Za-z0-9-]{1,8}(?:\/[A-Za-z0-9-]{1,8})?#[A-Za-z0-9-]{1,8}$
id
string
matches ^[A-Za-z0-9-]{1,8}(?:\/[A-Za-z0-9-]{1,8})?#[A-Za-z0-9-]{1,8}$
type: "remove-walkthrough"
type
"remove-walkthrough"
required
subject
string
required
matches ^[A-Za-z0-9-]{1,8}(?:\/[A-Za-z0-9-]{1,8})?#[A-Za-z0-9-]{1,8}$
object with proposal
target
object
required
2 fields
model
string
required
matches ^[A-Za-z0-9-]{1,8}$
state
one of these
required
2 shapes
string matching ^[A-Za-z0-9-]{1,8}$
matches ^[A-Za-z0-9-]{1,8}$
null
expectedRevision
object
required
2 fields
digest
string
required
files
list of object
required
2 fields
path
string
required
sha256
string
required
operationId
string
required
not empty
writer
string
required
not empty
claim
string
required
matches ^[A-Za-z0-9-]{1,8}$
proposal
one of these
required
6 shapes
type: "adopt"
type
"adopt"
required
reason
string
required
not empty
force
boolean
comparison
object
8 fields
reason
one of
required
"explicit""current""predecessor"
against
one of these
required
2 shapes
object with id, name and 13 more
id
string
required
matches ^[A-Za-z0-9-]{1,8}$
name
string
required
not empty, at most 120 characters
formerNames
list of string
summary
string
not empty, at most 2000 characters, not blank
documents
list of object
4 fields
repo
string
required
not empty
branch
string
not empty
commit
string
not empty
path
string
required
not empty
predecessor
one of these
2 shapes
string matching ^[A-Za-z0-9-]{1,8}$
matches ^[A-Za-z0-9-]{1,8}$
null
baseline
string
matches ^(?:[a-f0-9]{40}|[a-f0-9]{64})$
createdAt
string
matches ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d:[0-5]\d(?:\.\d+)?(?:Z))$
adoptedAt
string
matches ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d:[0-5]\d(?:\.\d+)?(?:Z))$
shelvedAt
string
matches ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d:[0-5]\d(?:\.\d+)?(?:Z))$
reason
string
not empty
previousCurrent
one of these
2 shapes
string matching ^[A-Za-z0-9-]{1,8}$
matches ^[A-Za-z0-9-]{1,8}$
null
lifecycle
one of
required
"current""draft""historical""shelved"
standing
object
5 fields
against
string
required
matches ^[A-Za-z0-9-]{1,8}$
baseline
string
required
matches ^(?:[a-f0-9]{40}|[a-f0-9]{64})$
atRevision
string
required
matches ^[a-f0-9]{64}$
issues
list of object
required
8 fields
subject
one of these
required
2 shapes
string matching ^[A-Za-z0-9-]{1,8}(?:\/[A-Za-z0-9-]{1,8})?#[A-Za-z0-9-]{1,8}$
The same shape as the field that holds it, one level up.
matches ^[A-Za-z0-9-]{1,8}(?:\/[A-Za-z0-9-]{1,8})?#[A-Za-z0-9-]{1,8}$
string matching ^[A-Za-z0-9-]{1,8}$
The same shape as the field that holds it, one level up.
matches ^[A-Za-z0-9-]{1,8}$
what
string
required
not empty
kind
one of
required
"competing-field""competing-order""deleted-and-changed""reference-lost""left-empty"
field
string
not empty
mine
any
required
theirs
any
required
changed
list of object
3 fields
field
string
required
The same shape as the field that holds it, one level up.
not empty
before
any
required
The same shape as the field that holds it, one level up.
after
any
required
The same shape as the field that holds it, one level up.
repair
string
required
not empty
blockedBy
string
matches ^[A-Za-z0-9-]{1,8}$
corrections
list of object
5 fields
previous
string
required
matches ^(?:[a-f0-9]{40}|[a-f0-9]{64})$
reason
string
required
not empty
revisions
list of object
required
at least 1 item
2 fields
repo
string
required
not empty
commit
string
required
matches ^(?:[a-f0-9]{40}|[a-f0-9]{64})$
at
string
required
matches ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d:[0-5]\d(?:\.\d+)?(?:Z))$
checkpoint
string
required
matches ^(?:[a-f0-9]{40}|[a-f0-9]{64})$
null
revision
object
required
2 fields
digest
string
required
files
list of object
required
2 fields
path
string
required
sha256
string
required
checkpoint
string
matches ^(?:[a-f0-9]{40}|[a-f0-9]{64})$
corrections
object
2 fields
selected
list of object
required
5 fields
previous
string
required
matches ^(?:[a-f0-9]{40}|[a-f0-9]{64})$
reason
string
required
not empty
revisions
list of object
required
at least 1 item
2 fields
repo
string
required
not empty
commit
string
required
matches ^(?:[a-f0-9]{40}|[a-f0-9]{64})$
at
string
required
matches ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d:[0-5]\d(?:\.\d+)?(?:Z))$
checkpoint
string
required
matches ^(?:[a-f0-9]{40}|[a-f0-9]{64})$
against
list of object
required
5 fields
previous
string
required
matches ^(?:[a-f0-9]{40}|[a-f0-9]{64})$
reason
string
required
not empty
revisions
list of object
required
at least 1 item
2 fields
repo
string
required
not empty
commit
string
required
matches ^(?:[a-f0-9]{40}|[a-f0-9]{64})$
at
string
required
matches ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d:[0-5]\d(?:\.\d+)?(?:Z))$
checkpoint
string
required
matches ^(?:[a-f0-9]{40}|[a-f0-9]{64})$
interfaceChanges
object
required
2 fields
changed
list of object
required
8 fields
container
object
required
3 fields
id
string
required
matches ^[A-Za-z0-9-]{1,8}(?:\/[A-Za-z0-9-]{1,8})?#[A-Za-z0-9-]{1,8}$
name
string
required
kind
string
required
holdsParts
object
required
2 fields
before
boolean
required
after
boolean
required
entryPointsAdded
list of object
required
3 fields
id
string
required
matches ^[A-Za-z0-9-]{1,8}(?:\/[A-Za-z0-9-]{1,8})?#[A-Za-z0-9-]{1,8}$
name
string
required
kind
string
required
entryPointsRemoved
list of object
required
3 fields
id
string
required
matches ^[A-Za-z0-9-]{1,8}(?:\/[A-Za-z0-9-]{1,8})?#[A-Za-z0-9-]{1,8}$
name
string
required
kind
string
required
becameEntryPoints
list of object
required
3 fields
id
string
required
matches ^[A-Za-z0-9-]{1,8}(?:\/[A-Za-z0-9-]{1,8})?#[A-Za-z0-9-]{1,8}$
name
string
required
kind
string
required
becameHidden
list of object
required
3 fields
id
string
required
matches ^[A-Za-z0-9-]{1,8}(?:\/[A-Za-z0-9-]{1,8})?#[A-Za-z0-9-]{1,8}$
name
string
required
kind
string
required
callersGained
list of object
required
3 fields
id
string
required
matches ^[A-Za-z0-9-]{1,8}(?:\/[A-Za-z0-9-]{1,8})?#[A-Za-z0-9-]{1,8}$
name
string
required
kind
string
required
callersLost
list of object
required
3 fields
id
string
required
matches ^[A-Za-z0-9-]{1,8}(?:\/[A-Za-z0-9-]{1,8})?#[A-Za-z0-9-]{1,8}$
name
string
required
kind
string
required
unchanged
list of object
required
3 fields
id
string
required
matches ^[A-Za-z0-9-]{1,8}(?:\/[A-Za-z0-9-]{1,8})?#[A-Za-z0-9-]{1,8}$
name
string
required
kind
string
required
interfaceMeasures
object
required
2 fields
states
list of object
required
2 fields
state
one of these
required
2 shapes
object with id, name and 1 more
id
string
required
matches ^[A-Za-z0-9-]{1,8}$
name
string
required
not empty, at most 120 characters
lifecycle
one of
required
"current""draft""historical""shelved"
null
checkpoint
string
matches ^(?:[a-f0-9]{40}|[a-f0-9]{64})$
containers
list of object
required
2 fields
container
object
required
3 fields
id
string
required
matches ^[A-Za-z0-9-]{1,8}(?:\/[A-Za-z0-9-]{1,8})?#[A-Za-z0-9-]{1,8}$
name
string
required
kind
string
required
byState
list of one of these
required
2 shapes
holdsParts: false
holdsParts
false
required
holdsParts: true
holdsParts
true
required
measures
object
required
5 fields
entryPoints
integer
required
The same shape as the field that holds it, one level up.
hiddenParts
integer
required
The same shape as the field that holds it, one level up.
callers
integer
required
The same shape as the field that holds it, one level up.
outgoing
integer
required
The same shape as the field that holds it, one level up.
passThrough
integer
required
The same shape as the field that holds it, one level up.
entryPoints
list of object
required
3 fields
id
string
required
The same shape as the field that holds it, one level up.
matches ^[A-Za-z0-9-]{1,8}(?:\/[A-Za-z0-9-]{1,8})?#[A-Za-z0-9-]{1,8}$
name
string
required
The same shape as the field that holds it, one level up.
kind
string
required
The same shape as the field that holds it, one level up.
passThrough
list of object
required
3 fields
id
string
required
The same shape as the field that holds it, one level up.
matches ^[A-Za-z0-9-]{1,8}(?:\/[A-Za-z0-9-]{1,8})?#[A-Za-z0-9-]{1,8}$
name
string
required
The same shape as the field that holds it, one level up.
kind
string
required
The same shape as the field that holds it, one level up.
subjects
list of object
required
4 fields
id
string
required
matches ^[A-Za-z0-9-]{1,8}(?:\/[A-Za-z0-9-]{1,8})?#[A-Za-z0-9-]{1,8}$
subjectKind
one of
required
"module""relationship""collection""flow""step""walkthrough""beat"
kind
one of
required
"added""removed""changed""unchanged"
fields
list of object
required
3 fields
field
string
required
before
any
after
any
type: "shelve"
type
"shelve"
required
reason
string
required
not empty
type: "reconcile"
type
"reconcile"
required
type: "settle"
type
"settle"
required
resolutions
list of object
required
at least 1 item
3 fields
subject
one of these
required
2 shapes
string matching ^[A-Za-z0-9-]{1,8}(?:\/[A-Za-z0-9-]{1,8})?#[A-Za-z0-9-]{1,8}$
matches ^[A-Za-z0-9-]{1,8}(?:\/[A-Za-z0-9-]{1,8})?#[A-Za-z0-9-]{1,8}$
string matching ^[A-Za-z0-9-]{1,8}$
matches ^[A-Za-z0-9-]{1,8}$
field
string
take
one of
required
"mine""theirs""edited"
type: "create"
type
"create"
required
confirm
list of one of
name
string
required
not empty, at most 120 characters
summary
string
not empty, at most 2000 characters, not blank
documents
list of object
4 fields
repo
string
required
not empty
branch
string
not empty
commit
string
not empty
path
string
required
not empty
type: "edit"
type
"edit"
required
confirm
list of one of
set
object
3 fields
name
string
not empty, at most 120 characters
summary
string
not empty, at most 2000 characters, not blank
documents
list of object
4 fields
repo
string
required
not empty
branch
string
not empty
commit
string
not empty
path
string
required
not empty
clear
list of one of
changes
list of one of these
required
19 shapes
type: "remove-module"
type
"remove-module"
required
subject
string
required
not empty
type: "add-relationship"
type
"add-relationship"
required
source
string
required
not empty
relationship
object
required
8 fields
order
integer
required
at least 0
kind
string
required
not empty,
matches ^[a-z0-9]+(?:[-_.][a-z0-9]+)*$
label
string
not empty, at most 60 characters
description
string
not empty, at most 2000 characters, not blank
emphasis
one of
default "normal"
"normal""hero""muted"
traffic
object
2 fields
speed
number
default 80
more than 0
volume
number
default 1
more than 0
anchor
object
3 fields
repo
string
required
not empty
path
string
required
not empty
symbol
string
required
not empty
to
string
required
not empty
type: "remove-relationship"
type
"remove-relationship"
required
subject
string
required
matches ^[A-Za-z0-9-]{1,8}(?:\/[A-Za-z0-9-]{1,8})?#[A-Za-z0-9-]{1,8}$
type: "edit-relationship"
type
"edit-relationship"
required
subject
string
required
matches ^[A-Za-z0-9-]{1,8}(?:\/[A-Za-z0-9-]{1,8})?#[A-Za-z0-9-]{1,8}$
source
string
not empty
set
object
8 fields
order
integer
at least 0
kind
string
not empty,
matches ^[a-z0-9]+(?:[-_.][a-z0-9]+)*$
label
string
not empty, at most 60 characters
description
string
not empty, at most 2000 characters, not blank
emphasis
one of
"normal""hero""muted"
traffic
object
2 fields
speed
number
default 80
more than 0
volume
number
default 1
more than 0
anchor
object
3 fields
repo
string
required
not empty
path
string
required
not empty
symbol
string
required
not empty
to
string
not empty
clear
list of one of
type: "add-module"
type
"add-module"
required
module
object
required
10 fields
order
integer
required
at least 0
name
string
required
not empty, at most 120 characters
kind
string
required
not empty,
matches ^[a-z0-9]+(?:[-_.][a-z0-9]+)*$
responsibility
string
not empty, at most 200 characters, not blank
description
string
not empty, at most 2000 characters, not blank
groups
list of string
no repeats
binding
object
6 fields
repo
string
required
not empty
path
string
required
symbol
string
not empty
branch
string
not empty
commit
string
not empty
confirmedAt
string
not empty
parent
string
not empty
documents
list of object
4 fields
repo
string
required
not empty
branch
string
not empty
commit
string
not empty
path
string
required
not empty
references
list of object
5 fields
repo
string
required
not empty
model
string
required
matches ^[A-Za-z0-9-]{1,8}$
subject
string
required
matches ^[A-Za-z0-9-]{1,8}(?:\/[A-Za-z0-9-]{1,8})?#[A-Za-z0-9-]{1,8}$
state
one of these
required
2 shapes
string matching ^[A-Za-z0-9-]{1,8}$
matches ^[A-Za-z0-9-]{1,8}$
string matching ^[A-Za-z0-9-]{1,8}(?:\/[A-Za-z0-9-]{1,8})?#[A-Za-z0-9-]{1,8}$
matches ^[A-Za-z0-9-]{1,8}(?:\/[A-Za-z0-9-]{1,8})?#[A-Za-z0-9-]{1,8}$
checkpoint
string
matches ^(?:[a-f0-9]{40}|[a-f0-9]{64})$
type: "edit-module"
type
"edit-module"
required
subject
string
required
not empty
set
object
10 fields
order
integer
at least 0
name
string
not empty, at most 120 characters
kind
string
not empty,
matches ^[a-z0-9]+(?:[-_.][a-z0-9]+)*$
responsibility
string
not empty, at most 200 characters, not blank
description
string
not empty, at most 2000 characters, not blank
groups
list of string
no repeats
binding
object
6 fields
repo
string
required
not empty
path
string
required
symbol
string
not empty
branch
string
not empty
commit
string
not empty
confirmedAt
string
not empty
parent
string
not empty
documents
list of object
4 fields
repo
string
required
not empty
branch
string
not empty
commit
string
not empty
path
string
required
not empty
references
list of object
5 fields
repo
string
required
not empty
model
string
required
matches ^[A-Za-z0-9-]{1,8}$
subject
string
required
matches ^[A-Za-z0-9-]{1,8}(?:\/[A-Za-z0-9-]{1,8})?#[A-Za-z0-9-]{1,8}$
state
one of these
required
2 shapes
string matching ^[A-Za-z0-9-]{1,8}$
matches ^[A-Za-z0-9-]{1,8}$
string matching ^[A-Za-z0-9-]{1,8}(?:\/[A-Za-z0-9-]{1,8})?#[A-Za-z0-9-]{1,8}$
matches ^[A-Za-z0-9-]{1,8}(?:\/[A-Za-z0-9-]{1,8})?#[A-Za-z0-9-]{1,8}$
checkpoint
string
matches ^(?:[a-f0-9]{40}|[a-f0-9]{64})$
clear
list of one of
type: "add-collection"
type
"add-collection"
required
name
string
required
not empty, at most 120 characters
type: "edit-collection"
type
"edit-collection"
required
collection
string
required
not empty
name
string
required
not empty, at most 120 characters
type: "remove-collection"
type
"remove-collection"
required
collection
string
required
not empty
type: "remove-flow"
type
"remove-flow"
required
subject
string
required
not empty
type: "add-step"
type
"add-step"
required
placement
object
required
3 fields
holder
string
required
matches ^[A-Za-z0-9-]{1,8}(?:\/[A-Za-z0-9-]{1,8})?#[A-Za-z0-9-]{1,8}$
alternative
string
not empty, at most 60 characters
before
string
matches ^[A-Za-z0-9-]{1,8}(?:\/[A-Za-z0-9-]{1,8})?#[A-Za-z0-9-]{1,8}$
step
one of these
required
3 shapes
object with id, from and 4 more
id
any
from
string
required
not empty
to
string
required
not empty
label
string
required
not empty, at most 60 characters
kind
one of
default "sync"
"sync""async""return""self"
note
string
not empty, at most 2000 characters, not blank
repeat
integer
at least 2
anchor
object
3 fields
repo
string
required
not empty
path
string
required
not empty
symbol
string
required
not empty
kind: "decision"
kind
"decision"
required
question
string
required
not empty, at most 60 characters
note
string
not empty, at most 2000 characters, not blank
alternatives
list of object
required
at least 2 items
2 fields
label
string
required
not empty, at most 60 characters
steps
list of one of these
required
The same shape as the field that holds it, one level up.
kind: "loop"
kind
"loop"
required
condition
string
required
not empty, at most 60 characters
note
string
not empty, at most 2000 characters, not blank
steps
list of one of these
required
The same shape as the field that holds it, one level up.
at least 1 item
type: "edit-step"
type
"edit-step"
required
subject
string
required
matches ^[A-Za-z0-9-]{1,8}(?:\/[A-Za-z0-9-]{1,8})?#[A-Za-z0-9-]{1,8}$
set
object
10 fields
kind
one of
"sync""async""return""self"
from
string
not empty
to
string
not empty
label
string
not empty, at most 60 characters
note
string
not empty, at most 2000 characters, not blank
repeat
integer
at least 2
anchor
object
3 fields
repo
string
required
not empty
path
string
required
not empty
symbol
string
required
not empty
question
string
not empty, at most 60 characters
condition
string
not empty, at most 60 characters
alternatives
list of string
at least 2 items
clear
list of one of
type: "remove-step"
type
"remove-step"
required
subject
string
required
matches ^[A-Za-z0-9-]{1,8}(?:\/[A-Za-z0-9-]{1,8})?#[A-Za-z0-9-]{1,8}$
type: "move-step"
type
"move-step"
required
subject
string
required
matches ^[A-Za-z0-9-]{1,8}(?:\/[A-Za-z0-9-]{1,8})?#[A-Za-z0-9-]{1,8}$
placement
object
required
3 fields
holder
string
required
matches ^[A-Za-z0-9-]{1,8}(?:\/[A-Za-z0-9-]{1,8})?#[A-Za-z0-9-]{1,8}$
alternative
string
not empty, at most 60 characters
before
string
matches ^[A-Za-z0-9-]{1,8}(?:\/[A-Za-z0-9-]{1,8})?#[A-Za-z0-9-]{1,8}$
type: "add-flow"
type
"add-flow"
required
collection
string
required
not empty
flow
object
required
4 fields
name
string
required
not empty, at most 120 characters
summary
string
required
not empty, at most 2000 characters, not blank
participants
list of string
required
at least 1 item
steps
list of one of these
required
at least 1 item
3 shapes
object with id, from and 4 more
id
any
from
string
required
not empty
to
string
required
not empty
label
string
required
not empty, at most 60 characters
kind
one of
default "sync"
"sync""async""return""self"
note
string
not empty, at most 2000 characters, not blank
repeat
integer
at least 2
anchor
object
3 fields
repo
string
required
not empty
path
string
required
not empty
symbol
string
required
not empty
kind: "decision"
kind
"decision"
required
question
string
required
not empty, at most 60 characters
note
string
not empty, at most 2000 characters, not blank
alternatives
list of object
required
at least 2 items
2 fields
label
string
required
not empty, at most 60 characters
steps
list of one of these
required
The same shape as the field that holds it, one level up.
kind: "loop"
kind
"loop"
required
condition
string
required
not empty, at most 60 characters
note
string
not empty, at most 2000 characters, not blank
steps
list of one of these
required
The same shape as the field that holds it, one level up.
at least 1 item
type: "edit-flow"
type
"edit-flow"
required
subject
string
required
not empty
collection
string
not empty
set
object
3 fields
name
string
not empty, at most 120 characters
summary
string
not empty, at most 2000 characters, not blank
participants
list of string
at least 1 item
type: "add-walkthrough"
type
"add-walkthrough"
required
walkthrough
object
required
4 fields
name
string
required
not empty, at most 120 characters
summary
string
not empty, at most 2000 characters, not blank
target
one of these
required
2 shapes
object with state
state
string
required
not empty
object with checkpoint
checkpoint
string
required
matches ^(?:[a-f0-9]{40}|[a-f0-9]{64})$
beats
list of object
required
at least 1 item
3 fields
title
string
required
not empty, at most 120 characters
narrative
string
required
not empty, at most 2000 characters, not blank
reading
object
required
7 fields
visibility
object
3 fields
modules
list of string
required
relationships
list of string
required
flows
list of string
required
scope
string
matches ^[A-Za-z0-9-]{1,8}(?:\/[A-Za-z0-9-]{1,8})?#[A-Za-z0-9-]{1,8}$
selection
list of string
focus
list of string
filters
object
default {"relationships":[],"groups":[]}
2 fields
relationships
list of string
required
groups
list of string
required
grammar
one of
required
"architecture""sequence""flowchart"
flow
string
matches ^[A-Za-z0-9-]{1,8}(?:\/[A-Za-z0-9-]{1,8})?#[A-Za-z0-9-]{1,8}$
type: "edit-walkthrough"
type
"edit-walkthrough"
required
subject
string
required
matches ^[A-Za-z0-9-]{1,8}(?:\/[A-Za-z0-9-]{1,8})?#[A-Za-z0-9-]{1,8}$
set
object
3 fields
name
string
not empty, at most 120 characters
summary
string
not empty, at most 2000 characters, not blank
target
one of these
2 shapes
object with state
state
string
required
not empty
object with checkpoint
checkpoint
string
required
matches ^(?:[a-f0-9]{40}|[a-f0-9]{64})$
clear
list of "summary"
beats
list of object
at least 1 item
4 fields
title
string
required
not empty, at most 120 characters
narrative
string
required
not empty, at most 2000 characters, not blank
reading
object
required
7 fields
visibility
object
3 fields
modules
list of string
required
relationships
list of string
required
flows
list of string
required
scope
string
matches ^[A-Za-z0-9-]{1,8}(?:\/[A-Za-z0-9-]{1,8})?#[A-Za-z0-9-]{1,8}$
selection
list of string
focus
list of string
filters
object
default {"relationships":[],"groups":[]}
2 fields
relationships
list of string
required
groups
list of string
required
grammar
one of
required
"architecture""sequence""flowchart"
flow
string
matches ^[A-Za-z0-9-]{1,8}(?:\/[A-Za-z0-9-]{1,8})?#[A-Za-z0-9-]{1,8}$
id
string
matches ^[A-Za-z0-9-]{1,8}(?:\/[A-Za-z0-9-]{1,8})?#[A-Za-z0-9-]{1,8}$
type: "remove-walkthrough"
type
"remove-walkthrough"
required
subject
string
required
matches ^[A-Za-z0-9-]{1,8}(?:\/[A-Za-z0-9-]{1,8})?#[A-Za-z0-9-]{1,8}$
object with subject and description
target
object
required
2 fields
model
string
required
matches ^[A-Za-z0-9-]{1,8}$
state
one of these
required
2 shapes
string matching ^[A-Za-z0-9-]{1,8}$
matches ^[A-Za-z0-9-]{1,8}$
null
subject
string
required
matches ^[A-Za-z0-9-]{1,8}(?:\/[A-Za-z0-9-]{1,8})?#[A-Za-z0-9-]{1,8}$
expectedRevision
object
required
2 fields
digest
string
required
files
list of object
required
2 fields
path
string
required
sha256
string
required
operationId
string
required
not empty
writer
string
required
not empty
claim
string
required
matches ^[A-Za-z0-9-]{1,8}$
description
string
required
not empty, at most 2000 characters, not blank
object without correction or proposal or subject
target
object
required
2 fields
model
string
required
matches ^[A-Za-z0-9-]{1,8}$
state
one of these
required
2 shapes
string matching ^[A-Za-z0-9-]{1,8}$
matches ^[A-Za-z0-9-]{1,8}$
null
expectedRevision
object
required
2 fields
digest
string
required
files
list of object
required
2 fields
path
string
required
sha256
string
required
operationId
string
required
not empty
writer
string
required
not empty
claim
string
required
matches ^[A-Za-z0-9-]{1,8}$
changes
list of one of these
required
at least 1 item
19 shapes
type: "remove-module"
type
"remove-module"
required
subject
string
required
not empty
type: "add-relationship"
type
"add-relationship"
required
source
string
required
not empty
relationship
object
required
8 fields
order
integer
required
at least 0
kind
string
required
not empty,
matches ^[a-z0-9]+(?:[-_.][a-z0-9]+)*$
label
string
not empty, at most 60 characters
description
string
not empty, at most 2000 characters, not blank
emphasis
one of
default "normal"
"normal""hero""muted"
traffic
object
2 fields
speed
number
default 80
more than 0
volume
number
default 1
more than 0
anchor
object
3 fields
repo
string
required
not empty
path
string
required
not empty
symbol
string
required
not empty
to
string
required
not empty
type: "remove-relationship"
type
"remove-relationship"
required
subject
string
required
matches ^[A-Za-z0-9-]{1,8}(?:\/[A-Za-z0-9-]{1,8})?#[A-Za-z0-9-]{1,8}$
type: "edit-relationship"
type
"edit-relationship"
required
subject
string
required
matches ^[A-Za-z0-9-]{1,8}(?:\/[A-Za-z0-9-]{1,8})?#[A-Za-z0-9-]{1,8}$
source
string
not empty
set
object
8 fields
order
integer
at least 0
kind
string
not empty,
matches ^[a-z0-9]+(?:[-_.][a-z0-9]+)*$
label
string
not empty, at most 60 characters
description
string
not empty, at most 2000 characters, not blank
emphasis
one of
"normal""hero""muted"
traffic
object
2 fields
speed
number
default 80
more than 0
volume
number
default 1
more than 0
anchor
object
3 fields
repo
string
required
not empty
path
string
required
not empty
symbol
string
required
not empty
to
string
not empty
clear
list of one of
type: "add-module"
type
"add-module"
required
module
object
required
10 fields
order
integer
required
at least 0
name
string
required
not empty, at most 120 characters
kind
string
required
not empty,
matches ^[a-z0-9]+(?:[-_.][a-z0-9]+)*$
responsibility
string
not empty, at most 200 characters, not blank
description
string
not empty, at most 2000 characters, not blank
groups
list of string
no repeats
binding
object
6 fields
repo
string
required
not empty
path
string
required
symbol
string
not empty
branch
string
not empty
commit
string
not empty
confirmedAt
string
not empty
parent
string
not empty
documents
list of object
4 fields
repo
string
required
not empty
branch
string
not empty
commit
string
not empty
path
string
required
not empty
references
list of object
5 fields
repo
string
required
not empty
model
string
required
matches ^[A-Za-z0-9-]{1,8}$
subject
string
required
matches ^[A-Za-z0-9-]{1,8}(?:\/[A-Za-z0-9-]{1,8})?#[A-Za-z0-9-]{1,8}$
state
one of these
required
2 shapes
string matching ^[A-Za-z0-9-]{1,8}$
matches ^[A-Za-z0-9-]{1,8}$
string matching ^[A-Za-z0-9-]{1,8}(?:\/[A-Za-z0-9-]{1,8})?#[A-Za-z0-9-]{1,8}$
matches ^[A-Za-z0-9-]{1,8}(?:\/[A-Za-z0-9-]{1,8})?#[A-Za-z0-9-]{1,8}$
checkpoint
string
matches ^(?:[a-f0-9]{40}|[a-f0-9]{64})$
type: "edit-module"
type
"edit-module"
required
subject
string
required
not empty
set
object
10 fields
order
integer
at least 0
name
string
not empty, at most 120 characters
kind
string
not empty,
matches ^[a-z0-9]+(?:[-_.][a-z0-9]+)*$
responsibility
string
not empty, at most 200 characters, not blank
description
string
not empty, at most 2000 characters, not blank
groups
list of string
no repeats
binding
object
6 fields
repo
string
required
not empty
path
string
required
symbol
string
not empty
branch
string
not empty
commit
string
not empty
confirmedAt
string
not empty
parent
string
not empty
documents
list of object
4 fields
repo
string
required
not empty
branch
string
not empty
commit
string
not empty
path
string
required
not empty
references
list of object
5 fields
repo
string
required
not empty
model
string
required
matches ^[A-Za-z0-9-]{1,8}$
subject
string
required
matches ^[A-Za-z0-9-]{1,8}(?:\/[A-Za-z0-9-]{1,8})?#[A-Za-z0-9-]{1,8}$
state
one of these
required
2 shapes
string matching ^[A-Za-z0-9-]{1,8}$
matches ^[A-Za-z0-9-]{1,8}$
string matching ^[A-Za-z0-9-]{1,8}(?:\/[A-Za-z0-9-]{1,8})?#[A-Za-z0-9-]{1,8}$
matches ^[A-Za-z0-9-]{1,8}(?:\/[A-Za-z0-9-]{1,8})?#[A-Za-z0-9-]{1,8}$
checkpoint
string
matches ^(?:[a-f0-9]{40}|[a-f0-9]{64})$
clear
list of one of
type: "add-collection"
type
"add-collection"
required
name
string
required
not empty, at most 120 characters
type: "edit-collection"
type
"edit-collection"
required
collection
string
required
not empty
name
string
required
not empty, at most 120 characters
type: "remove-collection"
type
"remove-collection"
required
collection
string
required
not empty
type: "remove-flow"
type
"remove-flow"
required
subject
string
required
not empty
type: "add-step"
type
"add-step"
required
placement
object
required
3 fields
holder
string
required
matches ^[A-Za-z0-9-]{1,8}(?:\/[A-Za-z0-9-]{1,8})?#[A-Za-z0-9-]{1,8}$
alternative
string
not empty, at most 60 characters
before
string
matches ^[A-Za-z0-9-]{1,8}(?:\/[A-Za-z0-9-]{1,8})?#[A-Za-z0-9-]{1,8}$
step
one of these
required
3 shapes
object with id, from and 4 more
id
any
from
string
required
not empty
to
string
required
not empty
label
string
required
not empty, at most 60 characters
kind
one of
default "sync"
"sync""async""return""self"
note
string
not empty, at most 2000 characters, not blank
repeat
integer
at least 2
anchor
object
3 fields
repo
string
required
not empty
path
string
required
not empty
symbol
string
required
not empty
kind: "decision"
kind
"decision"
required
question
string
required
not empty, at most 60 characters
note
string
not empty, at most 2000 characters, not blank
alternatives
list of object
required
at least 2 items
2 fields
label
string
required
not empty, at most 60 characters
steps
list of one of these
required
The same shape as the field that holds it, one level up.
kind: "loop"
kind
"loop"
required
condition
string
required
not empty, at most 60 characters
note
string
not empty, at most 2000 characters, not blank
steps
list of one of these
required
The same shape as the field that holds it, one level up.
at least 1 item
type: "edit-step"
type
"edit-step"
required
subject
string
required
matches ^[A-Za-z0-9-]{1,8}(?:\/[A-Za-z0-9-]{1,8})?#[A-Za-z0-9-]{1,8}$
set
object
10 fields
kind
one of
"sync""async""return""self"
from
string
not empty
to
string
not empty
label
string
not empty, at most 60 characters
note
string
not empty, at most 2000 characters, not blank
repeat
integer
at least 2
anchor
object
3 fields
repo
string
required
not empty
path
string
required
not empty
symbol
string
required
not empty
question
string
not empty, at most 60 characters
condition
string
not empty, at most 60 characters
alternatives
list of string
at least 2 items
clear
list of one of
type: "remove-step"
type
"remove-step"
required
subject
string
required
matches ^[A-Za-z0-9-]{1,8}(?:\/[A-Za-z0-9-]{1,8})?#[A-Za-z0-9-]{1,8}$
type: "move-step"
type
"move-step"
required
subject
string
required
matches ^[A-Za-z0-9-]{1,8}(?:\/[A-Za-z0-9-]{1,8})?#[A-Za-z0-9-]{1,8}$
placement
object
required
3 fields
holder
string
required
matches ^[A-Za-z0-9-]{1,8}(?:\/[A-Za-z0-9-]{1,8})?#[A-Za-z0-9-]{1,8}$
alternative
string
not empty, at most 60 characters
before
string
matches ^[A-Za-z0-9-]{1,8}(?:\/[A-Za-z0-9-]{1,8})?#[A-Za-z0-9-]{1,8}$
type: "add-flow"
type
"add-flow"
required
collection
string
required
not empty
flow
object
required
4 fields
name
string
required
not empty, at most 120 characters
summary
string
required
not empty, at most 2000 characters, not blank
participants
list of string
required
at least 1 item
steps
list of one of these
required
at least 1 item
3 shapes
object with id, from and 4 more
id
any
from
string
required
not empty
to
string
required
not empty
label
string
required
not empty, at most 60 characters
kind
one of
default "sync"
"sync""async""return""self"
note
string
not empty, at most 2000 characters, not blank
repeat
integer
at least 2
anchor
object
3 fields
repo
string
required
not empty
path
string
required
not empty
symbol
string
required
not empty
kind: "decision"
kind
"decision"
required
question
string
required
not empty, at most 60 characters
note
string
not empty, at most 2000 characters, not blank
alternatives
list of object
required
at least 2 items
2 fields
label
string
required
not empty, at most 60 characters
steps
list of one of these
required
The same shape as the field that holds it, one level up.
kind: "loop"
kind
"loop"
required
condition
string
required
not empty, at most 60 characters
note
string
not empty, at most 2000 characters, not blank
steps
list of one of these
required
The same shape as the field that holds it, one level up.
at least 1 item
type: "edit-flow"
type
"edit-flow"
required
subject
string
required
not empty
collection
string
not empty
set
object
3 fields
name
string
not empty, at most 120 characters
summary
string
not empty, at most 2000 characters, not blank
participants
list of string
at least 1 item
type: "add-walkthrough"
type
"add-walkthrough"
required
walkthrough
object
required
4 fields
name
string
required
not empty, at most 120 characters
summary
string
not empty, at most 2000 characters, not blank
target
one of these
required
2 shapes
object with state
state
string
required
not empty
object with checkpoint
checkpoint
string
required
matches ^(?:[a-f0-9]{40}|[a-f0-9]{64})$
beats
list of object
required
at least 1 item
3 fields
title
string
required
not empty, at most 120 characters
narrative
string
required
not empty, at most 2000 characters, not blank
reading
object
required
7 fields
visibility
object
3 fields
modules
list of string
required
relationships
list of string
required
flows
list of string
required
scope
string
matches ^[A-Za-z0-9-]{1,8}(?:\/[A-Za-z0-9-]{1,8})?#[A-Za-z0-9-]{1,8}$
selection
list of string
focus
list of string
filters
object
default {"relationships":[],"groups":[]}
2 fields
relationships
list of string
required
groups
list of string
required
grammar
one of
required
"architecture""sequence""flowchart"
flow
string
matches ^[A-Za-z0-9-]{1,8}(?:\/[A-Za-z0-9-]{1,8})?#[A-Za-z0-9-]{1,8}$
type: "edit-walkthrough"
type
"edit-walkthrough"
required
subject
string
required
matches ^[A-Za-z0-9-]{1,8}(?:\/[A-Za-z0-9-]{1,8})?#[A-Za-z0-9-]{1,8}$
set
object
3 fields
name
string
not empty, at most 120 characters
summary
string
not empty, at most 2000 characters, not blank
target
one of these
2 shapes
object with state
state
string
required
not empty
object with checkpoint
checkpoint
string
required
matches ^(?:[a-f0-9]{40}|[a-f0-9]{64})$
clear
list of "summary"
beats
list of object
at least 1 item
4 fields
title
string
required
not empty, at most 120 characters
narrative
string
required
not empty, at most 2000 characters, not blank
reading
object
required
7 fields
visibility
object
3 fields
modules
list of string
required
relationships
list of string
required
flows
list of string
required
scope
string
matches ^[A-Za-z0-9-]{1,8}(?:\/[A-Za-z0-9-]{1,8})?#[A-Za-z0-9-]{1,8}$
selection
list of string
focus
list of string
filters
object
default {"relationships":[],"groups":[]}
2 fields
relationships
list of string
required
groups
list of string
required
grammar
one of
required
"architecture""sequence""flowchart"
flow
string
matches ^[A-Za-z0-9-]{1,8}(?:\/[A-Za-z0-9-]{1,8})?#[A-Za-z0-9-]{1,8}$
id
string
matches ^[A-Za-z0-9-]{1,8}(?:\/[A-Za-z0-9-]{1,8})?#[A-Za-z0-9-]{1,8}$
type: "remove-walkthrough"
type
"remove-walkthrough"
required
subject
string
required
matches ^[A-Za-z0-9-]{1,8}(?:\/[A-Za-z0-9-]{1,8})?#[A-Za-z0-9-]{1,8}$
Portable canonical installation #
The portable installation that archboard model import reads, with its retained history.
bundle
object
required
6 fields
format
"archboard-model"
required
schemaVersion
1
required
model
string
required
matches ^[A-Za-z0-9-]{1,8}$
revision
object
required
2 fields
digest
string
required
files
list of object
required
2 fields
path
string
required
sha256
string
required
inputs
list of object
required
2 fields
path
string
required
bytes
string
required
matches ^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==|[A-Za-z0-9+/]{3}=)?$
history
object
required
2 fields
tips
list of string
required
bundle
one of these
required
2 shapes
string matching ^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==|[A-Za-z0-9+/]{3}=)?$
matches ^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==|[A-Za-z0-9+/]{3}=)?$
null
expectedRevision
object
required
2 fields
digest
string
required
files
list of object
required
2 fields
path
string
required
sha256
string
required
operationId
string
required
not empty
writer
string
required
not empty
doing
string
required
not empty, at most 140 characters
Explicit legacy migration intent #
The request that moves a legacy vault to canonical models.
expectedRevision
object
required
2 fields
digest
string
required
files
list of object
required
2 fields
path
string
required
sha256
string
required
expectedContext
string
required
matches ^[a-f0-9]{64}$
origin
string
required
matches ^[A-Za-z0-9-]{1,8}$
expectedSource
object
required
2 fields
digest
string
required
files
list of object
required
2 fields
path
string
required
sha256
string
required
expectedPlan
string
required
matches ^[a-f0-9]{64}$
previewRevision
object
required
2 fields
digest
string
required
files
list of object
required
2 fields
path
string
required
sha256
string
required
authorization
"owner"
required
operationId
string
required
not empty
writer
string
required
not empty
doing
string
required
not empty, at most 140 characters
Shared semantic vocabulary #
The vocabulary of a vault: .archboard/config.yaml, with its module kinds, relationship kinds and the evidence each kind accepts.
levels
list of string
Original legacy levels retained for migration and exact historical readings. Canonical navigation uses module containment.
no repeats
nodeKinds
map
required
value
<any key>
object
3 fields
name
string
required
not empty, not blank
icon
one of
required
"Ri24HoursFill""Ri24HoursLine""Ri4kFill""Ri4kLine""RiAccessibilityFill""RiAccessibilityLine""RiAccountBox2Fill""RiAccountBox2Line""RiAccountBoxFill""RiAccountBoxLine""RiAccountCircle2Fill""RiAccountCircle2Line"
and 3064 more
color
one of
"red""orange""amber""yellow""lime""green""emerald""teal""cyan""sky""blue""indigo"
and 5 more
relationshipKinds
map
required
value
<any key>
object
5 fields
name
string
required
not empty, not blank
color
one of
"red""orange""amber""yellow""lime""green""emerald""teal""cyan""sky""blue""indigo"
and 5 more
dash
one of
required
"solid""dashed""dotted"
arrowhead
one of
required
"filled""open""none"
evidence
list of one of
The evidence kinds that prove a relationship of this kind to archboard check code (ADR 0046). A kind without the key accepts every evidence kind, and the check never judges the evidence of its relationships.
at least 1 item, no repeats
groups
map
value
<any key>
object
2 fields
name
string
required
not empty, not blank
color
one of
required
"red""orange""amber""yellow""lime""green""emerald""teal""cyan""sky""blue""indigo"
and 5 more