Home / Docs

Documentation

How DiffMon works across monitoring, alerts, security, and API integration.

Versioning

How DiffMon versions the API, SDK, and worker behaviors to keep clients stable.

Versioning

APIs and SDKs evolve with backwards compatibility in mind.

API versioning

  • Stable base path with additive changes by default.
  • Breaking changes are announced with deprecation headers and changelog entries.

SDK releases

  • Follows semantic versioning; upgrade minor versions regularly to pick up new endpoints.
  • Release notes call out new options and required migrations.
Text
@diffmon/[email protected]
- Add retries for webhook redelivery API
- Mark legacy webhook rotate endpoint as deprecated

Worker behavior

  • Hashing and ignore rules are versioned in code; changes are announced when they affect diffs.
  • Rate limit defaults may improve, but enforcement is always surfaced in logs and alerts.