Skip to main content
  • Within v1, changes only add things: new fields, routes, statuses, widget types and error types.
  • A breaking change means a new major version, such as /v2, published alongside v1.
  • Anything being retired is announced first: its responses carry Deprecation and Sunset headers before it goes.
  • v1 is a draft until it’s agreed. Until the reference reaches version 1.0, its shapes can still change.