Knowledge Portal · engineering documentation

Skip to content

Contract Rules

Status: Canonical
Last updated: 2026-07-05


Principles

  1. One primary *PlatformContract per platform — consumers import contracts package only
  2. Methods return DTOs — never Eloquent models across boundaries
  3. Versioned packagescontracts@N semver; breaking changes require ADR
  4. Registry ownership — metadata in zaixos-registry, not duplicated in consumers

Consumer pattern

mermaid
sequenceDiagram
    participant M as Product Module
    participant C as PlatformContract
    participant A as Platform Adapter
    M->>C: invoke(DTO)
    C->>A: delegate
    A-->>M: ResponseDTO

Product contracts

Products may expose product contracts for federation (e.g. Agent Operations export). These live in product or packages/contracts and are indexed in REFERENCE/contracts-index.md.


Breadcrumbs: Home → Engineering → Contract Rules

ZAIXOS Knowledge Portal — public engineering docs at /docs · Staff operations at /admin