Versioning & Migration
Version Policy
The adapter protocol follows semantic versioning:
- Major (e.g., v1 → v2): Breaking changes. Migration guide provided. Deprecation timeline: 6 months.
- Minor (e.g., v2.0 → v2.1): New optional features. Backward compatible.
- Patch: Bug fixes only. No behavioral changes.
Current Version: 2.0
Key changes from v1.0:
device_idmoved from URL path to query parameter/capabilitiesendpoint added- Criticality tiers introduced
- HTML embed support added
- Webhook registration standardized
v1 → v2 Migration
- Move
device_idfrom URL path to query parameter - Implement
/capabilitiesendpoint - Add
criticalityfield to device declarations - Update
/pingresponse to includeversion: "2.0" - Test all endpoints with the v2 test suite
Deprecation Timeline
| Version | Status | End of Support |
|---|---|---|
| v2.0 | Current | — |
| v1.0 | Deprecated | 6 months after v2.0 GA |
Next Steps
- Contract Specification — v2.0 spec
- Overview — Protocol overview