API compatibility
The API reference is the complete public v1 operation and schema inventory. Process health probes are not part of that external product contract.
This site publishes the exact sync-v1.json contract at
/openapi/sync-v1.json. The accompanying
/compatibility.json records its OpenAPI version and
SHA-256 digest so clients can verify which contract accompanies a documentation
release.
Versioning
Section titled “Versioning”The sync-v1.json filename identifies the first API family. Within v1, new
optional operations and fields may be added without changing existing request
or response meaning. A breaking wire change requires a new API family and
migration guidance.
Clients should rely only on operations and values present in the published
contract. Treat closed enums as closed, preserve opaque cursors and resource
links exactly, and use returned ETag and idempotency requirements for guarded
mutations.
Liveness is not connection readiness. Use the repository-scoped connection, import, ref, and incident resources to determine whether work is active, paused, complete, or awaiting a decision.