Interface: TermVersionDto
@kortexya/reasoninglayer / TermVersionDto
Interface: TermVersionDto
Section titled “Interface: TermVersionDto”Defined in: src/types/terms.ts:729
One recorded state of a term.
Properties
Section titled “Properties”actor?
Section titled “actor?”
optionalactor?:string|null
Defined in: src/types/terms.ts:756
Who wrote it, when the request said.
changedFeatures
Section titled “changedFeatures”changedFeatures:
string[]
Defined in: src/types/terms.ts:760
Which features this version touched.
optionaldiff?:VersionDiffDto|null
Defined in: src/types/terms.ts:762
The before/after detail, when the engine recorded one.
etag:
string
Defined in: src/types/terms.ts:758
The ETag this state had.
followsAGap?
Section titled “followsAGap?”
optionalfollowsAGap?:boolean
Defined in: src/types/terms.ts:771
History is missing between the previous version and this one.
Remarks
Section titled “Remarks”Recording can be switched off and back on, so a gap is a real state the response reports rather than a hole a reader has to infer from the version numbers.
forkedTo?
Section titled “forkedTo?”
optionalforkedTo?:string|null
Defined in: src/types/terms.ts:773
The term this version was forked into, when it was.
kind:
string
Defined in: src/types/terms.ts:735
What kind of write produced it: created, updated or deleted.
recordedAt
Section titled “recordedAt”recordedAt:
string
Defined in: src/types/terms.ts:737
When it was recorded (RFC 3339): the instant the write committed.
seeded
Section titled “seeded”seeded:
boolean
Defined in: src/types/terms.ts:754
This row is the SEED of the chain: the first row of a term that existed before its history recorded anything.
Remarks
Section titled “Remarks”A seed’s recordedAt dates the write that first RECORDED the term, not
the term — the term may have held long before. A seed therefore answers an
as-of read for every earlier instant too, and OSFQL AS OF never excludes
the term.
false on a row that dates the term (a created row whose write brought
the term into existence) and on every later row. Both kinds of first row
read kind: 'created', so this flag is the only way to tell “created
then” from “first recorded then” — and so whether getTerm(id, { asOf })
before recordedAt answers the term or a 404.
term:
TermDto
Defined in: src/types/terms.ts:733
The term as it stood at this version.
version
Section titled “version”version:
number
Defined in: src/types/terms.ts:731
Monotonic version number, 1-based.