Skip to content

Nimi Coding Schemas

Field-level reference for the core Nimi Coding artifact schemas.

Topic Schema

.nimi/contracts/topic.schema.yaml

FieldRequiredType / values
topic_idyesYYYY-MM-DD-topic-slug pattern
stateyesproposal / ongoing / pending / closed
created_atyesISO date
last_transition_atyesISO date
last_transition_reasonyesSnake-case reason
titleyesHuman-readable
modeyesgreenfield / landed / superseding
postureyesno_legacy_hard_cut / backward_compat
design_policyyescomplete_contract_first / mvp_incremental
parallel_truthyesforbidden / admitted
layeringyesontology / time_phased
riskyeshigh / low
applicabilityyesauthority_bearing / high_risk_refactor / multi_wave_iteration / complex_remediation
entry_justificationyesOne-paragraph reason
execution_modeyesinline_manager_worker / manager_worker_auditor
selected_next_targetyeswave_id or null
current_true_close_statusyesnot_started / pending / true_closed / revoked / superseded
forbidden_shortcutsyesList from package catalog plus declared topic-local extensions
wavesoptionalList of wave entries

Wave Schema

.nimi/contracts/wave.schema.yaml

FieldRequiredType / values
wave_idyesStable wave identifier
slugyesURL-safe slug
stateyescandidate / preflight_draft / preflight_admitted / implementation_admitted / implementation_active / needs_revision / overflowed / continuation_packet_open / closed / retired / superseded
primary_closure_goalyesOne-paragraph goal
depsyesList of wave_ids; can be empty
owner_domainyesSingle primary owner domain
parallelizable_afteryesAdmitted parallelization marker
selectedyesAt most one true per topic

Packet Schema

.nimi/contracts/packet.schema.yaml

FieldRequiredType / values
packet_idyesStable packet identifier
topic_idyesParent topic
wave_idyesParent wave
packet_kindyesimplementation / authority / spec / redesign / preflight
statusyesdraft / preflight / candidate / admitted / dispatched / closed / superseded
authority_owneryesOwner domain prose
canonical_seamsyesInvariants list
forbidden_shortcutsyesCatalog keys + topic extensions
acceptance_invariantsyesVerifiable predicates
negative_testsyesConcrete checks
reopen_conditionsyesWhat would reopen
allowed_readsyesPath globs
allowed_writesyesPath globs

Result Schema

.nimi/contracts/result.schema.yaml

FieldRequiredType / values
result_idyesStable identifier
topic_idyesParent topic
wave_idyesParent wave
result_kindyespreflight / implementation / audit / judgement
verdictyesPASS / NEEDS_REVISION / FAIL / OVERFLOW
verified_atyesISO8601 UTC timestamp

Closeout Schema

.nimi/contracts/closeout.schema.yaml

FieldRequiredType / values
closeout_idyesStable identifier
topic_idyesParent topic
scopeyeswave / topic
authority_closureyesopen / closed / blocked
semantic_closureyesSame
consumer_closureyesSame (or closed_pending_user_acceptance as sub-state)
drift_resistance_closureyesSame
dispositionyescomplete / partial / deferred (or complete_pending_user_acceptance)

Topic Step Decision

.nimi/contracts/topic-step-decision.schema.yaml

FieldRequiredPurpose
decision_idyesStable id
topic_idyes
wave_idyes
decision_kindyes
stop_classyescontinue / require_human_confirmation / await_external_evidence / blocked / completed
recommended_actionyesadmit_wave / freeze_packet / dispatch_worker / dispatch_audit / record_result / open_remediation / continue_overflow / hold_topic / resume_topic / closeout_wave / closeout_topic / no_action
reason_codeyesTyped reason
requires_human_confirmationyesBool
recommended_decisionyesSuggested next
recommendation_rationaleyesShort prose
expected_artifactsyesList
next_command_refyesConcrete next command (placeholder-free for continue decisions)

Forbidden Shortcuts Catalog

The 10 admitted catalog keys (see Forbidden Shortcuts Catalog for full detail):

mvp_subset_contract, legacy_alias, compat_shim, dual_read, dual_write, placeholder_success, happy_path_only_closure, time_phased_layering, app_local_shadow_truth, silent_owner_cut_reopen.

Source Basis

Nimi AI open world platform documentation.