Expand description
The robot NDJSON contract — defined once, consumed three ways.
Agent users are the primary consumers of ftts (goal G5), so the event stream is a
promised interface, not incidental logging. The catalogue below is the only place that
definition lives:
ftts robot schemaserialises it viaschema_document, so the machine-readable self-description cannot drift from what the binary actually emits;validate_eventchecks emitted objects against it, so an event that grew a field or lost one fails a test rather than silently changing an agent’s parse;- the frozen fixture in
ftts-conformancepins it, so a schema change is a deliberate fixture update and never a silent one.
Validation is strict in both directions: a missing required field and an unknown field are both violations. A contract that only checks for absence lets the surface grow silently, which is the failure mode that breaks downstream parsers.
Bead: frankentts-p0-robot-82c.
Structs§
- Event
Spec - Field
Spec - One field of one event.
- RunContext
- Run-scoped emitter state: the shared
run_idand the run’s own clock.
Enums§
- Event
Type - A named event, as a constructor for a partially-filled object.
- Kind
- Stream events describe a run in progress; replies answer a one-shot query.
- Stream
- Which stream an object is written to.
Constants§
- COMMON_
FIELDS - Present on every object, so the per-event lists below do not repeat them.
- DOCUMENTED_
ENVIRONMENT - Environment recognised by the CLI, as reported by
robot schema. - EVENTS
- SCHEMA_
VERSION - Version carried by every emitted object. Bump deliberately; the frozen fixture will fail.
Functions§
- event_
spec - Look up one event’s specification by name.
- health_
violation_ event - The machine-readable self-description emitted by
ftts robot schema. Render an engine health signal as its robot event. - schema_
document - validate_
event - Check one emitted object against the catalogue. An empty result means it conforms.
- validate_
ndjson - Validate a whole NDJSON stream, reporting the line number of each violation.