Interfaces¶
Open this section when the question is contractual: which reasoning entrypoints, artifacts, payloads, and imports are real promises rather than merely visible implementation details.
Contract Surface¶
Reason interfaces are reviewer-facing contracts. They expose how callers start a reasoning run, what artifact shapes come back, how provenance and checks are serialized, and which public imports are stable enough for downstream packages to use without copying internal policy.
flowchart LR
caller["caller or reviewer"]
cli["CLI surface"]
api["API surface"]
artifacts["claims and checks"]
serialization["serialized outputs"]
imports["public imports"]
schema["tracked schema"]
downstream["agent or runtime"]
caller --> cli --> artifacts
caller --> api --> artifacts
artifacts --> serialization --> downstream
imports --> artifacts
api --> schema
Reason interfaces matter because other tools and reviewers consume the meaning they emit. The important promise is not only that a run can be started, but that claims, checks, and provenance can be serialized and reused without copying hidden package policy.
Read These First¶
- open Data Contracts first when the issue is about claim, check, or provenance payload shape
- open Artifact Contracts when downstream tools depend on stable reasoning outputs
- open Compatibility Commitments when a reasoning-surface change may break reviewers or callers
Contract Risk¶
The main contract risk here is letting reviewer-facing reasoning artifacts drift without naming which shapes and entrypoints are actually supported.
First Proof Check¶
packages/bijux-canon-reason/src/bijux_canon_reason/interfacesfor CLI, serialization, and access guard boundariespackages/bijux-canon-reason/src/bijux_canon_reason/api/v1for HTTP route and OpenAPI model surfacesapis/bijux-canon-reason/v1/schema.yamlfor tracked schema visibilitypackages/bijux-canon-reason/testsfor claim, provenance, and compatibility evidence
Pages In This Section¶
- CLI Surface
- API Surface
- Configuration Surface
- Data Contracts
- Artifact Contracts
- Entrypoints and Examples
- Operator Workflows
- Public Imports
- Compatibility Commitments
Leave This Section When¶
- leave for Foundation when the contract dispute is really a package-boundary dispute
- leave for Architecture when a surface question reveals structural drift underneath it
- leave for Operations or Quality when the boundary is clear and the question becomes execution or proof
Design Pressure¶
If downstream tools treat a reasoning artifact as stable but this page does not name it, the contract has already escaped the docs. The interface surface has to state which outputs are intentionally reusable.