Skip to main content

Connector Lifecycle Management

Connector lifecycle metadata keeps upgrades, compatibility, and operations predictable across environments.

Versioning and compatibility​

  • Use semantic versioning for connector releases.
  • Declare the minimum Adspire core version to prevent incompatible installs.
  • Link migrations so teams can follow breaking change guidance.
{
  "version": "1.0.0",
  "compatibility": ["adspire-core:>=x.y.z"],
  "deprecation_date": "YYYY-MM-DD",
  "migration_guide": "https://docs.adspire.ai/connectors/migrations/example"
}

Deprecation policy​

  • Publish a deprecation date before removing a connector or capability.
  • Provide a migration guide for any breaking change.
  • Keep deprecated versions operational until the scheduled sunset.

Health checks​

Provide health checks that validate runtime readiness and surface operational issues without exposing internal details.