Interface Contract Block
Document interface contracts between systems with operations, data types, constraints, and SLAs.
Overview
The Interface Contract block documents formal agreements between system components or services. It specifies the provider, consumer, operations, data types, constraints, and SLAs. Use this block to define clear boundaries and expectations between system components.
Synchronous API Contract
A synchronous REST API interface contract.
Asynchronous Contract
An asynchronous messaging interface contract.
Block Properties
| Property | Required | Description |
|---|---|---|
| name | Yes | Contract name |
| type | No | Interface type (sync, async, batch) |
| provider | No | Service providing the interface |
| consumer | No | Service consuming the interface |
| operations | No | Array of operation objects |
| dataTypes | No | Array of data types used in the contract |
| constraints | No | Array of constraints and rules |
| sla | No | Service level agreement |