Skip to main content

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_id moved from URL path to query parameter
  • /capabilities endpoint added
  • Criticality tiers introduced
  • HTML embed support added
  • Webhook registration standardized

v1 → v2 Migration

  1. Move device_id from URL path to query parameter
  2. Implement /capabilities endpoint
  3. Add criticality field to device declarations
  4. Update /ping response to include version: "2.0"
  5. Test all endpoints with the v2 test suite

Deprecation Timeline

VersionStatusEnd of Support
v2.0Current
v1.0Deprecated6 months after v2.0 GA

Next Steps