Reference

Flow schema

Structure of .flow.yaml files generated from prototypes.

Flow schema

Each .flow.yaml describes one user journey extracted from the prototype.

Minimal shape

id: onboarding
name: Onboarding
status: draft
entrypoint:
  route: /onboarding
  screen: onboarding_welcome
steps:
  - id: create_workspace
    screen: create_workspace
    actions:
      - id: submit_workspace
        type: command
        command: workspace.create
        requires_api: true
exitpoints:
  - route: /dashboard

Required sections

flow identity (id, name)
entrypoint
steps with explicit actions
exitpoints

Quality signals

The extractor and review step should flag:

missing error/loading states;
unresolved contracts;
sensitive actions without explicit confirmation policy.

Product schema

Canonical structure of product.yaml for the product layer.

Screen schema

Framework-agnostic structure of .screen.yaml files.

On this page

Flow schema Minimal shape Required sections Quality signals Related