RelynkLearn
Builder API

Versioning

Why a function's path never changes its contract, and how new versions are added.

A function's path is a contract: what it takes and returns never changes.

  • Every function has a version in its path: /points.timeseries/v2.
  • A path takes and returns the same shapes for as long as it exists. Descriptions may get better; fields are never removed or changed.
  • A breaking change is a new version at a new path, such as /points.timeseries/v2 next to /points.timeseries/v1. The old version keeps working.
  • Older versions are marked deprecated in the OpenAPI document and the API reference. Build new code against the newest version.

An app you built keeps working without changes, even when newer versions appear.