Pult Docs

Versioning and the Beta

What the beta means, which changes are safe, and how breaking changes are announced.

The beta

The API's address names its channel: /v1beta. Every endpoint is marked as beta or stable in the reference. During the beta, endpoints may still change, with notice. Pult gives no uptime promise during the beta.

When the API leaves the beta, /v1 will serve the stable endpoints. /v1beta stays and serves every endpoint, stable and beta.

Changes that don't break your integration

  • new endpoints;
  • new optional parameters;
  • new fields in answers;
  • new values in fields that list values, such as a booking's type;
  • new error codes;
  • new scopes, which existing keys never get.

Write your integration so it ignores unknown fields and accepts unknown values and error codes.

Breaking changes

During the beta, a breaking change follows these steps:

  1. The changelog announces it, at least 30 days ahead.
  2. Until it takes effect, answers from the affected endpoint carry a Deprecation header, a Sunset header with the date, and a Link: <url>; rel="deprecation" header that points to a migration note at /api/migrations/<slug>.
  3. After the sunset date, the old behavior is removed.

There are no migration notes yet. Every change is listed in the changelog.

Last updated on

On this page