OpenWOP — v2 spec corpus

Start here.

Five documents, in this order, ground everything else. New to the corpus? Read them top to bottom before browsing the groups below.

1OpenWOP v2 Core — OverviewThe six axioms, the claim vocabulary, and the rule that decides what is core and what is an extension.
2Discovery and CapabilitiesOne well-known resource, one closed capability record type, generated from the single declaration file.
3Versioning and ReleaseHow a major is negotiated (OpenWOP-Version), the version axes, and the one release identity a host reports.
4RunsThe unit of execution: create, read, stream, cancel, pause, fork, diff — and the one snapshot every host projects.
5ErrorsOne error registry; clients route on the code, never the message, and unregistered codes are not protocol errors.

Core

The documents every v2 host implements: discovery, versioning, runs, events, errors, and packs. 25 documents.

Extensions

Optional features a host can add. Each is advertised under extensions.<org>.<key> and is never required. 18 documents.

Other reference material

Specs not grouped elsewhere. New additions land here until categorized. 5 documents.

The directory, in full.

The tree's own README: what lives where, and which files are generated.

Status: released · current corpus. The authoritative version is
release.json. Target v2 for new implementations.

OpenWOP v2 is the current protocol major. Its contract is this directory, schemas/v2/, and api/v2/. They are published together as @openwop/spec-artifacts and tested by @openwop/openwop-conformance 2.x.

v1 is still supported during the overlap period. core/versioning.md and core/overview.md define how a host serves both and when v1 ends.

Start here

core/overview.md — scope, conformance target, and lifecycle.
core/versioning.md — discovery and major-version negotiation.
core/capabilities.md — the discovery document.
core/runs.md, core/events.md, and core/interrupt.md — the execution model.
core/security-defaults.md and core/conformance.md — mandatory safety defaults and evidence rules.

Core documents

Area	Documents
Foundation	`overview`, `versioning`, `headers`, `identity`, `oauth`, `capabilities`, `i18n`
Execution	`runs`, `events`, `interrupt`, `conversation`, `persistence`, `idempotency`, `replay`, `execution`
Integration	`webhooks`, `interop`, `host services`, `storage`, `tool catalog`, `portability`, `packs`, `node-pack runtimes`, `connection packs`, `form-content packs`, `workflow-chain packs`, `artifact-type packs`
Reliability	`errors`, `security defaults`, `conformance`

Source-of-truth map

Path	Contents
`core/`	The normative protocol documents
`ext/`	Optional extensions and non-core notes (maturity rules)
`declaration.json`	Inventory of discovery keys, capability families, maturity, witnesses, facets, profiles, and peer-dependency ids
`declaration.schema.json`	Schema for the declaration
`facets/`	Capability facet schemas
`errors.json`	Error-code registry
`event-codemap.json`	v1-to-v2 event-name mapping
`path-manifest.json`	Canonical operation and channel paths
`profiles.json`	Profile predicates (generated)
`peer-dependency-aliases.json`	v1 alias mapping (generated)
`release.json`	Corpus release identity
`migrations.json`	Surfaces a 2.x minor replaced, and the deprecation row that retires each
`corrections.json`	Corrections that changed a v2 shape without breaking a conforming host
`surface-baseline.json`	Every v2 surface, used to check that minors only add (generated)

Do not edit generated files by hand; each names its generator in $comment or its header. Machine artifacts are published in @openwop/spec-artifacts, which the conformance package consumes as an exact-version peer dependency.