Skip to content

Contracts

Document only the contracts this service exposes or consumes.

Examples:

  • openapi.yaml for HTTP APIs
  • *.proto for gRPC boundaries
  • events.md for async message schemas and versioning

Each contract should define:

  • Versioning / compatibility rules
  • Error semantics
  • Idempotency requirements
  • Verification checks