API Governance

Versioning and Deprecation Policy

Stable integrations require predictable change windows. This policy defines how Aegis Core ships additive changes, breaking changes, and deprecations.

Versioning Model

  • Current stable major version: v1.
  • Additive changes (new optional fields/endpoints) may ship within v1.
  • Breaking changes require a new major version (for example, v2).

Compatibility Commitments

  • Existing request fields in a stable major version are not repurposed.
  • Existing response fields are not removed without deprecation notice.
  • Auth mechanisms are preserved through the lifetime of a major version.

Deprecation Window

  • Deprecated features receive advance notice in the public changelog.
  • Minimum target notice window for removals: 90 days.
  • Critical security exceptions may require accelerated timelines.

How Changes Are Announced

  • Public release notes: /changelog.
  • Machine-readable contract: OpenAPI specification.
  • Authenticated docs updates: dashboard docs for implementation details.
Need migration guidance for a pending change? Contact hello@aegiscoreapi.com.