AegisAegis
Dashboard
AegisAegis Developer Portal

Developer Search

Press ⌘K or Ctrl+K to jump through guides and public API docs for user-owned master key and scoped credential flows.

Versioning

Versioning and Deprecation Policy

API compatibility is managed at the protobuf contract layer and reflected into generated OpenAPI artifacts. Deprecations must be announced before removal and include migration guidance.

Compatibility Contract

  • Public RPC semantics remain stable within a major version.
  • Field additions are preferred over removals.
  • Breaking changes require versioned replacement endpoints.
  • OpenAPI artifacts are regenerated from proto on each release.

Deprecation Stages

  1. Announce deprecation in changelog and migration docs.
  2. Mark in docs explorer and SDK notes.
  3. Provide minimum 2 release windows before removal.
  4. Remove only after usage telemetry confirms migration.

Release Expectations

  • Every release note includes impacted endpoints and migration action.
  • Security-sensitive changes include incident-safe rollout guidance.
  • SDK release tags map to compatible API contract snapshots.
Open Changelog