Candidate ledger¶
Review evaluated candidates and their recorded outcomes without inferring global optimality from the selected candidate.
Contract version: 1.0.0. Download the full JSON schema.
Use the tables for exact field names, types and constraints. Wide tables scroll horizontally. How to read defaults, units and result states.
For interpretation and examples, read result interpretation.
Fields¶
Unknown fields are rejected for this object.
| Field | Type | Required | Default | Constraints / meaning |
|---|---|---|---|---|
candidates |
array of Candidate Record | No | [] |
— |
contract_suite |
string | No | "sindri.contracts" |
const: "sindri.contracts" |
contract_version |
string | No | "1.0.0" |
const: "1.0.0" |
decisions |
array of Candidate Decision | No | [] |
— |
evaluation_scope |
Evaluation Decision Scope or Study Decision Scope or null | No | null |
— |
ledger_id |
string | No | "ledger.design-candidates" |
minLength: 1maxLength: 128pattern: "^[a-z][a-z0-9]*(?:[._:-][a-z0-9]+)*$" |
schema_kind |
string | No | "candidate_ledger" |
const: "candidate_ledger" |
study_id |
string | Yes | Not specified | minLength: 1maxLength: 128pattern: "^[a-z][a-z0-9]*(?:[._:-][a-z0-9]+)*$" |
transitions |
array of Candidate Transition | No | [] |
— |
Nested definitions¶
Open a definition below, or follow a type link in a field table. Direct links open the relevant section automatically.
Candidate Decision
Candidate Decision¶
Unknown fields are rejected for this object.
| Field | Type | Required | Default | Constraints / meaning |
|---|---|---|---|---|
actor_id |
string | Yes | Not specified | minLength: 1maxLength: 128pattern: "^[a-z][a-z0-9]*(?:[._:-][a-z0-9]+)*$" |
candidate_id |
string | Yes | Not specified | minLength: 1maxLength: 128pattern: "^[a-z][a-z0-9]*(?:[._:-][a-z0-9]+)*$" |
decided_at_utc |
string | Yes | Not specified | minLength: 20maxLength: 40 |
decision_id |
string | Yes | Not specified | minLength: 1maxLength: 128pattern: "^[a-z][a-z0-9]*(?:[._:-][a-z0-9]+)*$" |
evaluation_selection |
Evaluation Selection Receipt or null | No | null |
— |
rationale |
string | Yes | Not specified | minLength: 1maxLength: 2000 |
sequence |
integer | Yes | Not specified | minimum: 1 |
status |
Decision Status | Yes | Not specified | — |
Candidate Delta
Candidate Delta¶
Unknown fields are rejected for this object.
| Field | Type | Required | Default | Constraints / meaning |
|---|---|---|---|---|
field_path |
string | Yes | Not specified | minLength: 1maxLength: 512pattern: "^[a-z][a-z0-9_]*(?:\\.[a-z0-9_]+|\\[[0-9]+\\])*$" |
value |
boolean or integer or number or string | Yes | Not specified | — |
Candidate Lifecycle
Candidate Lifecycle¶
enum: ["defined", "generated", "evaluated", "rejected", "eligible", "ranked", "proposed", "selected", "approved"]
Candidate Record
Candidate Record¶
Unknown fields are rejected for this object.
| Field | Type | Required | Default | Constraints / meaning |
|---|---|---|---|---|
candidate_id |
string | Yes | Not specified | minLength: 1maxLength: 128pattern: "^[a-z][a-z0-9]*(?:[._:-][a-z0-9]+)*$" |
changes |
array of Candidate Delta | No | [] |
— |
evaluation_binding |
Evaluation Candidate Binding or null | No | null |
— |
feasibility |
Assessment Status | No | "not_assessed" |
— |
issues |
array of Issue Record | No | [] |
— |
lifecycle |
Candidate Lifecycle | Yes | Not specified | — |
objective_values |
array of Objective Value | No | [] |
— |
parent_candidate_id |
string or null | No | null |
anyOf branch 1: minLength: 1maxLength: 128pattern: "^[a-z][a-z0-9]*(?:[._:-][a-z0-9]+)*$" |
rank |
integer or null | No | null |
anyOf branch 1: minimum: 1 |
result_ids |
array of string | No | [] |
items: minLength: 1maxLength: 128pattern: "^[a-z][a-z0-9]*(?:[._:-][a-z0-9]+)*$" |
Candidate Transition
Candidate Transition¶
Unknown fields are rejected for this object.
| Field | Type | Required | Default | Constraints / meaning |
|---|---|---|---|---|
actor_id |
string | Yes | Not specified | minLength: 1maxLength: 128pattern: "^[a-z][a-z0-9]*(?:[._:-][a-z0-9]+)*$" |
candidate_id |
string | Yes | Not specified | minLength: 1maxLength: 128pattern: "^[a-z][a-z0-9]*(?:[._:-][a-z0-9]+)*$" |
from_lifecycle |
Candidate Lifecycle | Yes | Not specified | — |
occurred_at_utc |
string | Yes | Not specified | minLength: 20maxLength: 40 |
rationale |
string | Yes | Not specified | minLength: 1maxLength: 2000 |
sequence |
integer | Yes | Not specified | minimum: 1 |
to_lifecycle |
Candidate Lifecycle | Yes | Not specified | — |
transition_id |
string | Yes | Not specified | minLength: 1maxLength: 128pattern: "^[a-z][a-z0-9]*(?:[._:-][a-z0-9]+)*$" |
Evaluation Candidate Binding
Evaluation Candidate Binding¶
Unknown fields are rejected for this object.
| Field | Type | Required | Default | Constraints / meaning |
|---|---|---|---|---|
assessment_sha256 |
string | Yes | Not specified | pattern: "^[0-9a-f]{64}$" |
selectable |
boolean | Yes | Not specified | — |
source |
Evaluation Source | Yes | Not specified | — |
warning_check_ids |
array of string | No | [] |
items: minLength: 1maxLength: 128pattern: "^[a-z][a-z0-9]*(?:[._:-][a-z0-9]+)*$" |
Evaluation Decision Scope
Evaluation Decision Scope¶
Unknown fields are rejected for this object.
| Field | Type | Required | Default | Constraints / meaning |
|---|---|---|---|---|
candidate_ids |
array of string | Yes | Not specified | minItems: 1maxItems: 100items: minLength: 1maxLength: 128pattern: "^[a-z][a-z0-9]*(?:[._:-][a-z0-9]+)*$" |
comparison_sha256 |
string | Yes | Not specified | pattern: "^[0-9a-f]{64}$" |
context_sha256 |
string | Yes | Not specified | pattern: "^[0-9a-f]{64}$" |
evaluation_id |
string | Yes | Not specified | minLength: 1maxLength: 128pattern: "^[a-z][a-z0-9]*(?:[._:-][a-z0-9]+)*$" |
manifest_sha256 |
string | Yes | Not specified | pattern: "^[0-9a-f]{64}$" |
policy_sha256 |
string | Yes | Not specified | pattern: "^[0-9a-f]{64}$" |
recommended_candidate_ids |
array of string | No | [] |
items: minLength: 1maxLength: 128pattern: "^[a-z][a-z0-9]*(?:[._:-][a-z0-9]+)*$" |
Evaluation Selection Receipt
Evaluation Selection Receipt¶
Unknown fields are rejected for this object.
| Field | Type | Required | Default | Constraints / meaning |
|---|---|---|---|---|
accepted_warning_check_ids |
array of string | No | [] |
items: minLength: 1maxLength: 128pattern: "^[a-z][a-z0-9]*(?:[._:-][a-z0-9]+)*$" |
expected_ledger_sha256 |
string | Yes | Not specified | pattern: "^[0-9a-f]{64}$" |
request_id |
string | Yes | Not specified | minLength: 1maxLength: 128pattern: "^[a-z][a-z0-9]*(?:[._:-][a-z0-9]+)*$" |
Evaluation Source
Evaluation Source¶
Unknown fields are rejected for this object.
| Field | Type | Required | Default | Constraints / meaning |
|---|---|---|---|---|
artifact_index_sha256 |
string | Yes | Not specified | pattern: "^[0-9a-f]{64}$" |
candidate_id |
string | Yes | Not specified | minLength: 1maxLength: 128pattern: "^[a-z][a-z0-9]*(?:[._:-][a-z0-9]+)*$" |
contract_version |
string | No | "1.0.0" |
const: "1.0.0" |
input_snapshot_sha256 |
string | Yes | Not specified | pattern: "^[0-9a-f]{64}$" |
manifest_sha256 |
string | Yes | Not specified | pattern: "^[0-9a-f]{64}$" |
result_index_sha256 |
string | Yes | Not specified | pattern: "^[0-9a-f]{64}$" |
run_id |
string | Yes | Not specified | minLength: 1maxLength: 128pattern: "^[a-z][a-z0-9]*(?:[._:-][a-z0-9]+)*$" |
Issue Record
Issue Record¶
Unknown fields are rejected for this object.
| Field | Type | Required | Default | Constraints / meaning |
|---|---|---|---|---|
action_hint |
string or null | No | null |
anyOf branch 1: minLength: 1maxLength: 1000 |
code |
string | Yes | Not specified | minLength: 1maxLength: 128pattern: "^[a-z][a-z0-9]*(?:[._:-][a-z0-9]+)*$" |
issue_id |
string | Yes | Not specified | minLength: 1maxLength: 128pattern: "^[a-z][a-z0-9]*(?:[._:-][a-z0-9]+)*$" |
message |
string | Yes | Not specified | minLength: 1maxLength: 2000 |
severity |
Issue Severity | Yes | Not specified | — |
source_path |
string or null | No | null |
anyOf branch 1: minLength: 1maxLength: 512 |
statement_ids |
array of string | No | [] |
items: minLength: 1maxLength: 128pattern: "^[a-z][a-z0-9]*(?:[._:-][a-z0-9]+)*$" |
Objective Value
Objective Value¶
Unknown fields are rejected for this object.
| Field | Type | Required | Default | Constraints / meaning |
|---|---|---|---|---|
direction |
string | Yes | Not specified | enum: ["minimize", "maximize"] |
metric_id |
string | Yes | Not specified | minLength: 1maxLength: 128pattern: "^[a-z][a-z0-9]*(?:[._:-][a-z0-9]+)*$" |
normalized_score |
number or null | No | null |
anyOf branch 1: minimum: 0.0maximum: 1.0 |
value |
number | Yes | Not specified | — |
Study Decision Scope
Study Decision Scope¶
Unknown fields are rejected for this object.
| Field | Type | Required | Default | Constraints / meaning |
|---|---|---|---|---|
candidate_ids |
array of string | Yes | Not specified | minItems: 1maxItems: 1024items: minLength: 1maxLength: 128pattern: "^[a-z][a-z0-9]*(?:[._:-][a-z0-9]+)*$" |
comparison_sha256 |
string | Yes | Not specified | pattern: "^[0-9a-f]{64}$" |
context_sha256 |
string | Yes | Not specified | pattern: "^[0-9a-f]{64}$" |
evaluation_id |
string | Yes | Not specified | minLength: 1maxLength: 128pattern: "^[a-z][a-z0-9]*(?:[._:-][a-z0-9]+)*$" |
manifest_sha256 |
string | Yes | Not specified | pattern: "^[0-9a-f]{64}$" |
policy_sha256 |
string | Yes | Not specified | pattern: "^[0-9a-f]{64}$" |
recommended_candidate_ids |
array of string | No | [] |
items: minLength: 1maxLength: 128pattern: "^[a-z][a-z0-9]*(?:[._:-][a-z0-9]+)*$" |
scope_kind |
string | No | "study" |
const: "study" |
shortlist_candidate_ids |
array of string | Yes | Not specified | minItems: 1maxItems: 4items: minLength: 1maxLength: 128pattern: "^[a-z][a-z0-9]*(?:[._:-][a-z0-9]+)*$" |
Schema integrity¶
Schema SHA-256: d50b9cf6636ac8dfcb40b03b588937587ed07bc1c78c1adf6e80c3fdccaa18d6.