Integration Guide

Compatibility rules

Build clients that tolerate additive API evolution without breaking when HealthSherpa introduces new optional response fields.

Compatibility rules

Public object schemas are intentionally open so the platform can add optional fields over time without forcing a version bump for every enhancement.

Clients should
  • Ignore response properties they do not recognize.
  • Assume object responses may gain new optional fields over time.
  • Preserve the fields they understand and safely ignore the rest.
Clients should not
  • Use strict serialization or strict deserialization settings that fail on unknown fields.
  • Assume object property order is meaningful.
  • Treat current response shapes as permanently closed or exhaustive.