YAML Schemas

Kiket provides JSON Schemas for all YAML configuration types. Use these schemas for editor validation, CLI linting, and IDE extensions.

Available Schemas

Type	Schema	Description
Workflow	workflow.json	State machines with states, transitions, guards, and actions
Board	board.json	Kanban/Scrum board layout with columns and swimlanes
Intake Form	intake_form.json	Public/internal forms with fields, validation, and routing
Automation	automation.json	Event-driven rules with triggers, conditions, and actions
Dashboard	dashboard.json	Analytics dashboards with panels, charts, and data bindings
Query	query.json	Analytical queries for dashboards and reports
Agent	agent.json	AI agents with context, prompts, and safety constraints

Usage

In VS Code

Add to your .vscode/settings.json:

{
  "yaml.schemas": {
    "https://docs.kiket.dev/reference/schemas/workflow.json": ".kiket/workflows/*.yaml",
    "https://docs.kiket.dev/reference/schemas/board.json": ".kiket/boards/*.yaml",
    "https://docs.kiket.dev/reference/schemas/agent.json": ".kiket/agents/*.yaml",
    "https://docs.kiket.dev/reference/schemas/dashboard.json": ".kiket/analytics/dashboards/*.yaml",
    "https://docs.kiket.dev/reference/schemas/query.json": ".kiket/analytics/queries/*.yaml"
  }
}

Requires the YAML extension.

Via API

# List all schemas
GET /api/v1/editor/schemas

# Get a specific schema
GET /api/v1/editor/schemas/workflow

# Validate YAML against a schema
POST /api/v1/editor/schemas/validate
Content-Type: application/json
{ "editor_type": "workflow", "yaml": "model_version: '1.0'\nworkflow:\n  name: test\n..." }

In the Project Editor

The project editor automatically validates YAML against these schemas in real-time via Monaco's built-in diagnostic markers.