-
Notifications
You must be signed in to change notification settings - Fork 308
Open
Labels
Description
Parent Epic
Part of #6992 - Enhanced API Registry
Description
Implement API lifecycle governance features that go beyond schema storage to provide full lifecycle management, including deprecation workflows, consumer tracking, and breaking change impact analysis.
Background
Apicurio's differentiation as an "API Registry" (vs schema-only registries) requires features that support the full API lifecycle:
- Knowing who uses which APIs/schemas
- Controlled deprecation with consumer notification
- Understanding impact before making changes
Requirements
API Deprecation Workflows
-
Deprecation State Machine
- States: Active → Deprecated → Sunset → Removed
- Configurable sunset periods
- Grace periods before removal
-
Consumer Notifications
- Webhook notifications on deprecation
- Email notifications (optional)
- Subscription management for consumers
Consumer Tracking
-
Consumer Registration
- APIs for consumers to register their usage
- Automatic tracking via serdes client reporting
- Consumer metadata (team, service, contact)
-
Usage Analytics
- Which consumers use which schemas
- Usage frequency and patterns
- Last access tracking
Impact Analysis
-
Breaking Change Detection
- Pre-registration analysis of breaking changes
- List of affected consumers
- Severity assessment
-
Change Reporting
- Diff visualization between versions
- Breaking vs non-breaking change classification
- Export for review workflows
Acceptance Criteria
- Deprecation workflow can be configured
- Consumers receive notifications on deprecation
- Consumer usage is tracked
- Breaking changes show affected consumers
- UI displays lifecycle state and consumer list
Priority
P2 - Important for enterprise adoption but secondary to core differentiation features
References
jornh