schema

package
v0.1.0 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Oct 3, 2026 License: MIT Imports: 8 Imported by: 0

README

Workflow Graph JSON Schema

workflow.schema.json is generated from the Go types and enum declarations in graph. Do not edit the generated file by hand.

From the repository root, regenerate it with:

go generate ./graph

Then run go test ./graph/.... The schema test regenerates in memory and fails if the committed bytes are stale. It also compiles the document as JSON Schema Draft 2020-12.

A host may consume this committed document to generate an HTTP schema or client. Frontends should use a generated host surface instead of copying graph DTOs by hand.

The root x-workflow-boundaries metadata identifies use at the graph-native source-authoring boundary and as the graph component of the separately generated serialized ExecutionPlan schema. The plan schema references these definitions, so graph Go types remain authoritative without a graph-to-compiler import cycle.

Documentation

Overview

Package schema exposes the committed graph IR JSON Schema as a strict, extraction-safe validation boundary for SDK, UI, and agent front ends.

Index

Constants

View Source
const (
	// ID is the immutable identifier carried by graph IR authoring envelopes.
	ID = "https://schemas.hollis-labs.dev/workflow/graph/v1/workflow.schema.json"
	// Version is the compact negotiation version for ID.
	Version = "1"
)

Variables

This section is empty.

Functions

func Document

func Document() []byte

Document returns a defensive copy of the committed schema bytes.

func Validate

func Validate(data []byte) error

Validate validates one JSON graph value against the committed schema.

Types

This section is empty.

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL