Rule#

This page is generated from the code and must not be edited by hand.

A named, versioned, toggleable, parameterised statement licensing one inference.

The English sentence and the executable form are two renderings of one object rather than two objects kept in sync. The sentence is a template with typed slots; a person edits slots, and the interface labels, the rendered Rulebook document and the reference documentation all come from this one declaration.

Fields#

Field

Type

Required

If left out

added_revision

whole number

no

0

candidates_within

text or null

no

null

composition

RuleComposition or null

no

null

defeated_by

list of text

no

[]

effect

RuleEffect

yes

enabled

yes or no

no

true

level

text

no

"file"

origin

text

no

"builtin"

parameters

list of ParameterSpec

no

[]

predicate

text

yes

predicate_version

text

no

""

primitive

Primitive or null

no

null

rationale

text (at least 1 character)

yes

respect

text or null

no

null

rule_id

text

yes

schema_version

text

no

"1.23"

scope

Scope

yes

specialization

text or null

no

null

statement

text

yes

status

RuleStatus

no

"active"

superseded_revision

whole number or null

no

null

tier

InferenceTier

no

"defeasible"

version

text

yes

The types named above are described on the shared types page: InferenceTier, ParameterSpec, Primitive, RuleComposition, RuleEffect, RuleStatus, Scope.