Knowledge Portal · engineering documentation

Skip to content

API / Contract Surface Template

Status: Template · Copy to API/{contract-name}.md


markdown
# ContractName

**Type:** PlatformContract | ProductContract | ReadContract
**Owner:** PL-XXX / PRD-XXX
**Package:** `zaixos/contracts`
**Version:** contracts@N
**Last updated:** YYYY-MM-DD

---

## Purpose

What this contract exposes and who may call it.

## Methods

| Method | Input DTO | Output DTO | Notes |

## Consumers

| Consumer | Module | Access pattern |

## Implementation

| Adapter / Service | Repository |

## Versioning

Semver policy; breaking change process.

## Examples

## Related

- [REFERENCE/contracts-index.md](../REFERENCE/contracts-index.md)

## Breadcrumbs
Home → API → ContractName

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