DOCUMENTATION / API COMPATIBILITY

How to detect API contract drift before it breaks consumers

By Soumik Ghosh ยท Published

API contract drift is the gap between the interface a consumer expects and the contract or behavior available upstream.

Capture the contract your consumer actually uses

Record the source URL, fetch date, declared version, and content hash. An upstream specification can change while keeping the same version. Check runtime observations separately and avoid assuming that every documented change has already deployed.

From contract changes to affected callers

  1. Compare two revisions and identify the changed operation, field, and direction.
  2. Trace the operation into supported SDK and HTTP call sites at the scanned commit.
  3. Review matching limits and replay representative requests and responses before merging any change.

See how a removed Sentry query value changes request acceptance, or replay a finding in the OpenAPI checker.

API compatibility guides and tools

Use public API change evidence in your IDE with MCP

Browse public API change history, including OpenAI and Sentry.

Rule reference