Skip to main content

Interfaces and Data Contracts

Overview​

Contract domain documents: the design standards every interface follows and the contract catalog itself. Not every project is a REST API — this domain covers whatever kind of interface the project exposes: REST, gRPC/RPC, CLI, event/message schemas, or a library/SDK's public interface.

Documents​

DocumentDescription
contract-design-standards.mdNaming, versioning, error handling, and format conventions for the chosen contract type(s)
contract-catalog.mdCatalog of interfaces/operations and shared schemas

Record contract-relevant decisions in 04-decisions and link them here as they are accepted.