Interface: VocabularyCandidateRevision
@kortexya/reasoninglayer / VocabularyCandidateRevision
Interface: VocabularyCandidateRevision
Section titled “Interface: VocabularyCandidateRevision”Defined in: src/types/vocabulary.ts:1690
A candidate revision: 201 of create, save and rebase, 200 of
GET /revisions/{id}.
Remarks
Section titled “Remarks”revisionId is also the ETag ("<revision_id>") to send as ifMatch to
save or rebase. advisoryFindings never refuse a save and are not
authoritative (an assessment is); they and mintedIds are empty on reads
and rebases.
Properties
Section titled “Properties”advisoryFindings
Section titled “advisoryFindings”advisoryFindings:
VocabularyFinding[]
Defined in: src/types/vocabulary.ts:1718
Obligation findings over the revision’s view when it was saved.
authors
Section titled “authors”authors:
string[]
Defined in: src/types/vocabulary.ts:1704
Cumulative authors (user:<uuid>), sorted.
baseline
Section titled “baseline”baseline:
VocabularyBaseline
Defined in: src/types/vocabulary.ts:1702
The baseline.
candidateId
Section titled “candidateId”candidateId:
string
Defined in: src/types/vocabulary.ts:1692
The candidate (UUID).
changeReason
Section titled “changeReason”changeReason:
string
Defined in: src/types/vocabulary.ts:1710
Why.
contentHash
Section titled “contentHash”contentHash:
string
Defined in: src/types/vocabulary.ts:1698
The content hash a decision on this revision must cite.
createdAt
Section titled “createdAt”createdAt:
string
Defined in: src/types/vocabulary.ts:1708
When (database clock, ISO 8601).
createdBy
Section titled “createdBy”createdBy:
string
Defined in: src/types/vocabulary.ts:1706
Who saved this revision.
mintedIds
Section titled “mintedIds”mintedIds:
Record<string,string>
Defined in: src/types/vocabulary.ts:1716
Client references this edit bound to newly minted ids (client reference → UUID).
outcome
Section titled “outcome”outcome:
string
Defined in: src/types/vocabulary.ts:1720
committed.
records
Section titled “records”records:
VocabularyRecordView[]
Defined in: src/types/vocabulary.ts:1712
The records the cumulative change set inserts or replaces.
removals
Section titled “removals”removals:
string[]
Defined in: src/types/vocabulary.ts:1714
The baseline records it removes (UUIDs).
replayed
Section titled “replayed”replayed:
boolean
Defined in: src/types/vocabulary.ts:1722
Whether this answer replays an earlier identical request.
revisionId
Section titled “revisionId”revisionId:
string
Defined in: src/types/vocabulary.ts:1694
The revision (UUID).
revisionNumber
Section titled “revisionNumber”revisionNumber:
number
Defined in: src/types/vocabulary.ts:1696
1-based revision number.
state:
VocabularyCandidateState
Defined in: src/types/vocabulary.ts:1700
The candidate’s state (after the edit, for a mutation).