Specification

Generated from specification/README.md. Edit the canonical source file, not this page.

Protocol specification artifacts for OpenFreytProtocol.

Structure

specification/
├── private-exchange-profile.md ← tender, commitment and execution-handover profile
├── protocol.md                 ← normative protocol clauses (RFC 2119 language)
├── glossary.md                 ← canonical term definitions
├── state-machines/      ← lifecycle state-transition specifications
├── schemas/             ← JSON Schema 2020-12 definitions
├── openapi/             ← OpenAPI 3.1 HTTP interface descriptions
├── events/              ← AsyncAPI / CloudEvents envelope definitions
└── errors/              ← RFC 9457 error catalogue

All artifacts here are normative. The reference implementation is not normative.

Events and webhook subscriptions (M004)

Brokers deliver domain events to subscribers as CloudEvents 1.0 binary-mode HTTP POSTs. schemas/cloud-event-envelope.schema.json defines the envelope and the closed EventType set; schemas/cloud-event-types.schema.json defines the per-event-type data payloads. Subscriptions are managed through the /webhook-subscriptions endpoints (scope webhooks:manage) documented in openapi/openapi.yaml, which is linted in CI with pnpm quality:openapi (Redocly, configured in the root redocly.yaml). See QUALITY-STRATEGY.md §4 and §11.