Version 1.0.0 • Active Support
Predictable Versioning for AI Agents and Production Integrations
Systemores Behavior Profiler exposes major REST API versions explicitly in the URL path (/api/v1/*) and advertises the active contract version via the X-API-Version: 1.0.0 response header. Automated clients and MCP hosts can rely on strict backward compatibility within each major version.
1. Non-Breaking vs. Breaking Changes
- Backwards-compatible additions (new optional JSON fields, new optional query parameters, or additional MCP tools) are released directly within
/api/v1without disrupting existing integrations. - Breaking schema or contract changes (removing fields, narrowing types, changing required parameters, or altering status semantics) always introduce a new major path prefix (such as
/api/v2) while keepingv1operational throughout its deprecation window.
2. Deprecation & Sunset Headers (Minimum 180-Day Notice)
If a versioned endpoint or MCP tool is scheduled for retirement, Systemores guarantees a minimum 180-day (6-month) sunset window before shutting down traffic. Throughout that window, every affected response emits standard machine-readable headers:
Deprecation: @1798761600 Sunset: Wed, 30 Jun 2027 23:59:59 GMT Link: <https://profile.systemores.com/developers/deprecation>; rel="deprecation"; type="text/html" Link: <https://profile.systemores.com/openapi.json>; rel="successor-version"; type="application/json"
Format complies with RFC 9745 (Deprecation) and RFC 8594 (Sunset).
3. Current Version Lifecycle Table
| Surface | Status | Contract Version | Scheduled Sunset |
|---|---|---|---|
| /api/v1/* | Active | 1.0.0 | None scheduled (min. 180-day notice) |
| /api/mcp (/mcp) | Active (MCP 2026) | 1.0.0 | None scheduled (min. 180-day notice) |