Specification Overview
The Portitor specification defines the contracts that all language implementations must satisfy. An implementation is valid if it passes the conformance test suite.
Contents
| Section | Description |
|---|---|
| Key Schema | S3 object key structure — the foundation of the event store |
| Domain Events | JSON Schema for every domain event |
| Plugin Protocol | OpenAPI contract for source, warehouse, and customs adapters |
| HTTP API | OpenAPI spec for the platform HTTP surface |
| Conformance Tests | Language-agnostic test scenarios every implementation must pass |
| ADRs | Architecture Decision Records |
Versioning
The spec follows Semantic Versioning. Breaking changes to the key schema or event contracts require a major version bump. All language implementations declare which spec version they implement.