Skip to content

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

SectionDescription
Key SchemaS3 object key structure — the foundation of the event store
Domain EventsJSON Schema for every domain event
Plugin ProtocolOpenAPI contract for source, warehouse, and customs adapters
HTTP APIOpenAPI spec for the platform HTTP surface
Conformance TestsLanguage-agnostic test scenarios every implementation must pass
ADRsArchitecture 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.

Released under the MIT License.