Expand description
Schema templates execution and planning. Schema/template helpers for change artifacts.
This module reads a change directory and a schema definition (schema.yaml) and
produces JSON-friendly status and instruction payloads.
These types are designed for use by the CLI and by any web/API layer that wants to present “what should I do next?” without duplicating the filesystem logic.
Structs§
- Agent
Instruction Response - Instruction payload for agent-oriented endpoints.
- Apply
Instructions Response - Instruction payload for applying a change.
- Apply
Yaml - Apply-stage configuration from a schema.
- Artifact
Status - Status for one schema artifact for a given change directory.
- Artifact
Yaml - One artifact definition from a schema.
- Change
Status - High-level status for a change against a resolved schema.
- Dependency
Info - One dependency entry shown alongside artifact instructions.
- Export
Schemas Result - Summary of exported schema files.
- Instructions
Response - Instruction payload for building a single artifact.
- Peer
Review Context - Complete context payload for rendering peer-review instructions.
- Progress
Info - Progress totals derived from parsed tasks.
- Resolved
Schema - A fully-resolved schema (yaml + directory + source).
- Review
Affected Spec Info - Affected spec entry derived from change deltas.
- Review
Artifact Info - Artifact presence information for review instruction rendering.
- Review
Task Summary Info - Aggregate task progress summary for change review.
- Review
Testing Policy - Testing policy values injected into review instruction output.
- Review
Validation Issue Info - Serializable validation issue payload for review templates.
- Schema
List Entry - One entry in the schema listing returned by
list_schemas_detail. - Schema
List Response - Detailed schema listing suitable for agent consumption.
- Schema
Yaml - Schema file model (
schema.yaml). - Task
Diagnostic - Diagnostic message associated with a task file.
- Task
Item - One task parsed from a tracking file (e.g.
tasks.md). - Template
Info - Information about an artifact template resolved from a schema.
- Validation
Artifact Yaml - Validation rules for one schema artifact.
- Validation
Defaults Yaml - Default validation rules.
- Validation
Tracking Yaml - Validation rules for a tracking file.
- Validation
Yaml - Schema validation configuration (
validation.yaml).
Enums§
- Schema
Source - Where a schema was resolved from.
- Validation
Level Yaml - Severity level used by schema-driven validation.
- Validation
Tracking Source Yaml - Source used to locate the tracking file.
- Validator
Id - Known validator identifiers.
- Workflow
Error - Errors returned by workflow helpers.
Functions§
- compute_
apply_ instructions - Compute apply-stage instructions and progress for a change.
- compute_
change_ status - Compute the workflow status for every artifact in a change.
- compute_
review_ context - Build the context payload used by
agent/review.md.j2. - default_
schema_ name - Default schema name used when a change does not specify one.
- export_
embedded_ schemas - Export all embedded schema files into a target directory.
- list_
available_ changes - List change directory names under the
.ito/changesdirectory. - list_
available_ schemas - Lists available schema names discovered from the project, user, embedded, and package schema locations.
- list_
schemas_ detail - List all available schemas with full metadata for agent/UI consumption.
- load_
composed_ user_ guidance - Compose scoped and shared user guidance into one guidance string.
- load_
schema_ validation - Load schema validation configuration when present.
- load_
user_ guidance - Load shared user guidance text.
- load_
user_ guidance_ for_ artifact - Load artifact-scoped user guidance text from
.ito/user-prompts/<artifact-id>.md. - read_
change_ schema - Determines the schema name configured for a change by reading its metadata.
- resolve_
instructions - Produce user-facing instructions and metadata for performing a single artifact in a change.
- resolve_
schema - Resolves a schema name into a
ResolvedSchema. - resolve_
templates - Resolve template paths for every artifact in a schema.
- validate_
change_ name_ input - Validates a user-provided change name to ensure it is safe to use as a filesystem path segment.
Type Aliases§
- Templates
Error - Backward-compatible alias for callers using the renamed error type.