Skip to content
SimbliaSimbliaSimblia Developers

Versioning

The major version is part of the URL: /v1. The OpenAPI contract has its own version number (now 1.0.0-preview.2), shown in the API reference.

Preview

Section titled “Preview”

Version 1 is in preview. Every v1 response carries the header:

Simblia-API-Status: preview

During the preview, breaking changes can still happen. Each one is announced in the changelog before it takes effect. Simblia decides when v1 leaves the preview and announces that in the changelog too.

After the preview

Section titled “After the preview”

Once v1 leaves the preview:

  • New fields, operations, scopes and enum values can be added at any time. Ignore what you do not recognize.
  • Breaking changes come only in a new major version (/v2). The old version keeps working for at least 6 months after the new one is available. Responses from the old version then carry Deprecation and Sunset headers that say when it stops.